Webhook

Certain notifications can be sent to you via webhook

We can send a notification to your systems through a URL that you will need to provide us. The different use cases for notification are listed below. If you identify any additional cases, do not hesitate to contact us so we can determine whether it is possible for us to notify you in those cases.

  • End of KYC/KYB Processing or Change of Client File Status

You have to set up an POST endpoint something like this

POST /your-end-point

give us the full url of the endpoint and be prepare to receive a payload like this:


{
    "id": 962,
    "createdAt": "2024-10-11 10:07:25",
    "clientFileToAnalyzeId": "1671d906-73d7-4dc-86cc-21ebf8624e3c",
    "status": "A_TRAITER",
    "additionalData": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "externalId": "externalId1",
    "errors": [
        {
            "code": "DUPLICATED_EXTERNAL_IDS",
            "duplicatedExternalIds": [
                "externalId1",
                "externalId2"
            ]
        }
    ]
    "score": 0,
    "company": {
        "id": 1,
        "name": "Danaya",
        "verifications": [
            "MRZ_CHECK",
            "DB_CHECK",
            "EXPIRATION_CHECK",
            "PEP_CHECK",
            "FACE_MATCH_CHECK",
            "SANCTION_CHECK",
            "MEDIA_CHECK"
        ]
    },
    "documents": [
        {
            "id": 1256,
            "type": "SELFIE",
            "frontUrl": "url",
            "verificationResults": []
        },
        {
            "id": 1255,
            "type": "CARTE_RESIDENT",
            "frontUrl": "url",
            "backUrl": "url",
             "ocrExtractedData": {
                "mrz": "",
                "nni": "11111111111",
                "image": null,
                "state": null,
                "gender": "M",
                "height": "1,75",
                "message": null,
                "ocr_raw": null,
                "last_name": "",
                "first_name": "name",
                "profession": "NAME",
                "father_name": null,
                "mother_name": null,
                "nationality": "",
                "country_code": null,
                "date_of_birth": "dd/mm/yyyy",
                "document_code": "",
                "place_of_birth": "",
                "document_expiry": "dd/mm/yyyy",
                "document_number": "",
                "father_birthday": null,
                "mother_birthday": null,
                "personal_number": null,
                "permanent_address": null,
                "date_of_birth_yyyy_mm_dd": null,
                "document_expiry_yyyy_mm_dd": null
            },
            "verificationResults": [
                {
                    "id": "ff0226d1-9f0e-4d21-b49e-40e9c442ccf0",
                    "status": "EXECUTED",
                    "lastRunDate": "2024-10-11 10:07:37",
                    "type": "SANCTION_CHECK",
                    "scoring": {
                        "type": "PersonSanctionedScoring",
                        "results": [],
                        "allResults": []
                    },
                    "clientFileDocumentId": 1255
                },
                {
                    "id": "057fe8a8-bfec-4bd4-adb7-2746b5773a77",
                    "status": "EXECUTED",
                    "lastRunDate": "2024-10-11 10:07:48",
                    "type": "EXPIRATION_CHECK",
                    "scoring": {
                        "type": "ExpiryDateScoring",
                        "score": "EXPIRED"
                    },
                    "clientFileDocumentId": 1255
                },
                {
                    "id": "1a14e3d4-0154-4e0e-8356-76eba251c0c1",
                    "status": "EXECUTED",
                    "lastRunDate": "2024-10-11 10:07:41",
                    "type": "MEDIA_CHECK",
                    "scoring": {
                        "type": "MediaScoring",
                        "results": []
                    },
                    "clientFileDocumentId": 1255
                },
                {
                    "id": "fd74cc61-ecf0-43ef-ba6b-d033f618c8ef",
                    "status": "EXECUTED",
                    "lastRunDate": "2024-10-11 10:07:34",
                    "type": "PEP_CHECK",
                    "scoring": {
                        "type": "PepScoring",
                        "results": [],
                        "allResults": [
                     
                        ]
                    },
                    "clientFileDocumentId": 1255
                },
                {
                    "id": "09672d60-22fc-4a52-9ed0-848dc36a57db",
                    "status": "EXECUTED",
                    "lastRunDate": "2024-10-11 10:07:48",
                    "type": "MRZ_CHECK",
                    "scoring": {
                        "type": "MRZScoring",
                        "errors": [
                            "INVALID_MRZ_FOUND"
                        ],
                        "valid": false
                    },
                    "clientFileDocumentId": 1255
                },
                {
                    "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
                },
                {
                    "type": "DB_CHECK",
                    "scoring": {
                        "type": "PersonInfoScoring",
                        "id": 611,
                        "nni": "11111111111111",
                        "iDCardNumber": null,
                        "phoneNumber": null,
                        "firstNameMatchingScore": 100,
                        "lastNameMatchingScore": 100,
                        "dateOfBirthMatchingScore": 100,
                        "genderMatchingScore": 100,
                        "phoneNumberMatchingScore": 0,
                        "comparedWithRealData": true,
                        "rawData": "{}"// JSON containing the gov DB Data
                    },
                    "clientFileDocumentId": 1255
                }
            ]
        }
    ]
}

  • Expired or Near-Expiration Identification Document (To Be Defined)

Last updated