> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Biometrics Face Match

> Perform advanced facial similarity analysis between two images.



## OpenAPI

````yaml api-reference-legacy/openapi.json POST /api/v1/verification/biometricsfacecompare
openapi: 3.0.3
info:
  title: IDmeta API
  description: IDmeta verification and integration API.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://{environment-subdomain}.idmetagroup.com
    description: Your environment (replace `{environment-subdomain}`)
    variables:
      environment-subdomain:
        default: integrate
        description: IDmeta environment subdomain
security:
  - bearerAuth: []
tags:
  - name: Processes
    description: Verification process endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
paths:
  /api/v1/verification/biometricsfacecompare:
    post:
      tags:
        - Compliance
      summary: Biometrics Face Match
      description: Compares two face images and returns a matching score.
      operationId: biometricsFaceMatch
      parameters:
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: false
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BiometricsFaceMatchRequest'
            examples:
              default:
                summary: Face compare request
                value:
                  image1: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
                  image2: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
                  template_id: '{your_trust_flow_id}'
                  verification_id: '{your_created_verification_id}'
      responses:
        '200':
          description: Face match completed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiometricsFaceMatchResponse'
              example:
                status: true
                message: OK
                result:
                  message: success
                  score: 99
                  status: success
components:
  schemas:
    BiometricsFaceMatchRequest:
      type: object
      required:
        - image1
        - image2
        - template_id
        - verification_id
      properties:
        image1:
          type: string
          description: Image for biometric face match.
        image2:
          type: string
          description: Second image for biometric face match.
        template_id:
          type: string
          description: >-
            Identifier used to categorize or group requests for tracking or
            reporting.
        verification_id:
          type: string
          description: >-
            Unique identifier for the verification request, used for
            traceability.
    BiometricsFaceMatchResponse:
      type: object
      properties:
        status:
          type: boolean
        message:
          type: string
        result:
          type: object
          properties:
            message:
              type: string
            score:
              type: number
            status:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````