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

# Compare Faces

> Compare two face images and return a similarity score.



## OpenAPI

````yaml POST /api/v1/merchant/face/compare
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /api/v1/merchant/face/compare:
    post:
      tags:
        - Identity Verification
      summary: Compare Faces
      description: >-
        Compare a source image against a target image and return a similarity
        score.
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Request content type
          required: true
          schema:
            type: string
            enum:
              - application/json
          example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaceCompareRequest'
            examples:
              default:
                summary: Face comparison request
                value:
                  source_image: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
                  target_image: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
      responses:
        '200':
          description: Face comparison response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceCompareResponse'
              examples:
                successfulVerification:
                  summary: Successful face comparison
                  value:
                    success: true
                    message: Face comparison completed successfully
                    data:
                      similarity: '0.93'
                    charges:
                      charged: false
                      charged_amount: '0.00'
        '402':
          description: >-
            Verification could not be processed because the wallet balance is
            insufficient
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationPaymentErrorResponse'
              examples:
                insufficientBalance:
                  summary: Insufficient wallet balance
                  value:
                    success: false
                    message: >-
                      Your wallet balance is insufficient for this request.
                      Required 25.00, available 0. Please fund your wallet and
                      try again.
                    details:
                      - >-
                        Your wallet balance is insufficient for this request.
                        Required 25.00, available 0. Please fund your wallet and
                        try again.
      servers:
        - url: https://api.payvessel.com/kyc
        - url: https://sandbox.payvessel.com/kyc
components:
  schemas:
    FaceCompareRequest:
      type: object
      required:
        - source_image
        - target_image
      properties:
        source_image:
          type: string
          description: Source face image as a URL or base64 string
          example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
        target_image:
          type: string
          description: Target face image as a URL or base64 string
          example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
    FaceCompareResponse:
      type: object
      required:
        - success
        - message
        - data
        - charges
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Face comparison completed successfully
        data:
          $ref: '#/components/schemas/FaceCompareData'
        charges:
          $ref: '#/components/schemas/VerificationCharges'
    VerificationPaymentErrorResponse:
      type: object
      required:
        - success
        - message
        - details
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully
          example: false
        message:
          type: string
          description: Reason the request could not be processed
          example: >-
            Your wallet balance is insufficient for this request. Required
            25.00, available 0. Please fund your wallet and try again.
        details:
          type: array
          description: Detailed error messages returned by the API
          items:
            type: string
          example:
            - >-
              Your wallet balance is insufficient for this request. Required
              25.00, available 0. Please fund your wallet and try again.
    FaceCompareData:
      type: object
      required:
        - similarity
      properties:
        similarity:
          type: string
          description: Similarity score returned by the comparison engine
          example: '0.93'
    VerificationCharges:
      type: object
      required:
        - charged
        - charged_amount
      properties:
        charged:
          type: boolean
          description: Whether the verification request was billed
        charged_amount:
          type: string
          description: Amount charged for the verification request
          example: '0.00'

````