Documentation
  • Welcome!
  • Getting started
    • Onboarding
    • Get your api credentials
  • Integration mode
    • Rest Api
      • 👩‍✈️Platform
      • 🙍KYC
        • ℹ️ID Informations
        • 🔎ID Verification
        • 🆔ID Document Verification
          • 🖥️User filled data verifications
        • ☑️Face match
        • 🧏Liveness check
      • 👨‍💼KYB
        • ℹ️Company Informations
        • 🔎Company Verification
        • 🗃️Company Document Verification
      • 🚨AML
        • PEP
        • Sanction Lists
        • Media Adverse
      • 🔎Retrieve Document Verification result
    • SDK
      • JS
      • Java / Kotlin
      • Python
    • No-Code
      • Danaya Forms
    • WebView or iFrame
  • Webhook
Powered by GitBook
On this page
  1. Integration mode
  2. Rest Api
  3. KYC

Face match

This feature allows identity verification based on a person's image present on an Identity document and a selfie.

This feature works with all identity documents that have a photo ID.

Verify Identity with a selfie and the provided ID document v1

POST v1/verification/face-match

Headers:

  • Api-Key (required): provided by Danaya

  • Api-Secret (required): provided by Danaya

  • Content-Type (required): multipart/form-data

Request Body:

{
  "nni": "file", // Depreciated
  "personalImage": "file", // Depreciated (will be removed in a V2)
  "frontCNIImage": "file", // Depreciated (will be removed in a V2)
  "backCNIImage": "file", // Depreciated (will be removed in a V2)
  "selfie": "file", // Recommanded (will replace "personalImage" in a V2)
  "cniRecto": "file", // Front National ID image
  "cniVerso": "file", // Back National ID image
  "carteConsulaireRecto": "file", // Front Consular Card image
  "carteConsulaireVerso": "file", // Back Consular Card image
  "carteResidentRecto": "file", // Front Resident Card image
  "carteResidentVerso": "file", // Back Resident Card image
  "passport": "file" // Front Passport image
}

⚠️ supported image files are: png, jpeg and jpg

Responses:

  • OK:

    • Code: 200

    • Body

    {
      "type": "FACE_MATCH",
      "faceMatched": true, // true if the score is > 80%
      "similarity": "string", // face matching score
      "comparedImageBase64": "string", // face detected in the provided document
      "faceMatchVerificationType": "GOVERNMENT" //OR OFFLINE; if the selfie is compared within the gov DB IMAGE --> GOVERNMENT, IF Compared with the photo on the ID Card --> OFFLINE
    }
  • Code : 401

  • Code: 400

Verify Identity with a selfie and the provided ID document v2 (not yet available)

POST v2/verification/face-match

Headers:

  • Api-Key (required): provided by Danaya

  • Api-Secret (required): provided by Danaya

  • Content-Type (required): multipart/form-data

Request Body: Front Consular Card image

{
  "selfie": "file", // (required)
  "idDocumentFront": "file", //(required)
  "idDocumentBack": "file",
  "documentType": CNI/PASSPORT/...//(required)
}

⚠️ supported image files are: png, jpeg and jpg

Responses:

  • OK:

    • Code: 200

    • Body

    {
                        "id": "dfe39085-5606-4ebb-bad0-66dae47af562",
                        "status": "EXECUTED",
                        "lastRunDate": "2024-10-11 10:07:48",
                        "type": "FACE_MATCH_CHECK",
                        "scoring": {
                            "type": "FaceMatch",
                            "faceMatched": false,
                            "similarity": "0",
                            "comparedImageBase64": null,
                            "faceMatchVerificationType": "GOVERNMENT"
                        },
                        "clientFileDocumentId": 1255
                    }
  • Code : 401

  • Code: 400

PreviousUser filled data verificationsNextLiveness check

Last updated 8 months ago

🙍
☑️