> ## 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 Compare

> Compare two face images and return a similarity score.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/biometrics-face-compare
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: Trust Flow Links
    description: Trust Flow link generation endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
  - name: Alternative Verifications
    description: Alternative verification and intelligence endpoints
  - name: OCR
    description: Document OCR extraction endpoints
paths:
  /api/v3/verifications/biometrics-face-compare:
    post:
      tags:
        - Compliance
      summary: Biometrics Face Compare
      description: Compares two face images and returns a similarity score.
      operationId: biometricsFaceCompareV3
      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...
                  trustFlowId: 0
                  trustValidationId: '{your_trust_validation_id}'
      responses:
        '200':
          description: Face compare completed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiometricsFaceMatchResponse'
              example:
                success: true
                message: Face compare verification processed successfully
                data:
                  similarityScore: 99
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: biometrics_face_compare
                metadata: null
components:
  schemas:
    BiometricsFaceMatchRequest:
      type: object
      required:
        - image1
        - image2
        - trustFlowId
        - trustValidationId
      properties:
        image1:
          type: string
          description: >-
            First face image as a base64 data URI (for example,
            data:image/jpeg;base64,...).
        image2:
          type: string
          description: >-
            Second face image as a base64 data URI (for example,
            data:image/jpeg;base64,...).
        trustFlowId:
          type: integer
          description: >-
            Identifier used to categorize or group requests for tracking or
            reporting.
        trustValidationId:
          type: string
          description: A unique ID used to identify your verification request.
    BiometricsFaceMatchResponse:
      type: object
      required:
        - success
        - message
        - data
        - verificationStatus
        - verificationStatusCode
        - trustFlowId
        - trustValidationId
        - verificationType
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            similarityScore:
              type: number
        verificationStatus:
          type: string
        verificationStatusCode:
          type: integer
        trustFlowId:
          type: integer
        trustValidationId:
          type: string
        verificationType:
          type: string
        metadata:
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````