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

# Match Faces

> Compare two face images and return a similarity score.



## OpenAPI

````yaml POST /v1/match/face
openapi: 3.1.0
info:
  title: Kiriku API
  description: >-
    Intelligent Document Processing API for West Africa. Extract structured data
    from ID cards, passports, and more.
  version: 1.0.0
  contact:
    email: contact@kiriku.sn
servers:
  - url: https://api.kiriku.app
    description: Production API
security:
  - bearerAuth: []
paths:
  /v1/match/face:
    post:
      summary: Match Faces
      description: Compare two face images and return a similarity score.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                referenceImage:
                  type: string
                  description: Base64 encoded reference image (e.g., ID card).
                liveImage:
                  type: string
                  description: Base64 encoded live image (e.g., selfie).
              required:
                - referenceImage
                - liveImage
      responses:
        '200':
          description: Face match completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceMatchResponse'
components:
  schemas:
    FaceMatchResponse:
      type: object
      properties:
        match:
          type: boolean
        similarity:
          type: number
        confidence:
          type: string
        distance:
          type: number
        threshold:
          type: number
        processingMs:
          type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT/API Key

````