Skip to main content
WEBHOOK
identificationExpired
{
  "final": true,
  "platform": "PC",
  "status": {
    "overall": "APPROVED",
    "fraudTags": [
      "FACE_IN_BLACKLIST"
    ],
    "mismatchTags": [
      "NAME"
    ],
    "autoFace": "FACE_MATCH",
    "manualFace": "FACE_MATCH",
    "autoDocument": "DOC_VALIDATED",
    "manualDocument": "DOC_VALIDATED",
    "additionalSteps": "VALID"
  },
  "data": {
    "docFirstName": "<string>",
    "docLastName": "<string>",
    "docNumber": "<string>",
    "docPersonalCode": "<string>",
    "docExpiry": "<string>",
    "docDob": "<string>",
    "docDateOfIssue": "<string>",
    "docType": "ID_CARD",
    "docSex": "MALE",
    "docNationality": "<string>",
    "docIssuingCountry": "<string>",
    "manuallyDataChanged": true,
    "fullName": "<string>",
    "selectedCountry": "<string>",
    "orgFirstName": "<string>",
    "orgLastName": "<string>",
    "orgNationality": "<string>",
    "orgBirthPlace": "<string>",
    "orgAuthority": "<string>",
    "orgAddress": "<string>",
    "orgTemporaryAddress": "<string>",
    "orgMothersMaidenName": "<string>",
    "orgPatronymic": "<string>",
    "orgBirthName": "<string>",
    "ageEstimate": "UNDER_13",
    "clientIpProxyRiskLevel": "VERY_LOW",
    "duplicateFaces": [
      "<string>"
    ],
    "duplicateDocFaces": [
      "<string>"
    ],
    "birthPlace": "<string>",
    "authority": "<string>",
    "address": "<string>",
    "docTemporaryAddress": "<string>",
    "mothersMaidenName": "<string>",
    "docBirthName": "<string>",
    "docPatronymic": "<string>",
    "driverLicenseCategory": "<string>",
    "additionalData": {}
  },
  "fileUrls": {},
  "scanRef": "<string>",
  "clientId": "<string>",
  "companyId": "<string>",
  "beneficiaryId": "<string>",
  "startTime": 123,
  "finishTime": 123,
  "clientIp": "<string>",
  "clientIpCountry": "<string>",
  "clientLocation": "<string>",
  "additionalStepPdfUrls": {},
  "AML": [
    {
      "status": {
        "serviceSuspected": true,
        "serviceUsed": true,
        "serviceFound": true,
        "checkSuccessful": true,
        "overallStatus": "SUSPECTED"
      },
      "serviceName": "<string>",
      "serviceGroupType": "<string>",
      "uid": "<string>",
      "errorMessage": "<string>",
      "data": [
        {
          "name": "<string>",
          "surname": "<string>",
          "nationality": "<string>",
          "dob": "<string>",
          "suspicion": "SANCTION",
          "reason": "<string>",
          "listNumber": "<string>",
          "listName": "<string>",
          "score": 123,
          "lastUpdate": "<string>",
          "exitDate": "<string>",
          "isPerson": true,
          "isActive": true,
          "linkedDocument": "<string>",
          "pepLevel": 123,
          "category": "<string>",
          "otherInformation": "<string>",
          "checkDate": "<string>",
          "whitelisted": true
        }
      ]
    }
  ],
  "LID": [
    {
      "status": {
        "serviceSuspected": true,
        "serviceUsed": true,
        "serviceFound": true,
        "checkSuccessful": true,
        "overallStatus": "SUSPECTED"
      },
      "data": [
        {
          "documentNumber": "<string>",
          "documentType": "<string>",
          "valid": true,
          "expiryDate": "<string>",
          "checkDate": "<string>"
        }
      ],
      "serviceName": "<string>",
      "uid": "<string>",
      "errorMessage": "<string>",
      "serviceGroupType": "LID"
    }
  ],
  "CRIMINAL_CHECK": [
    {
      "status": {
        "serviceSuspected": true,
        "serviceUsed": true,
        "serviceFound": true,
        "checkSuccessful": true,
        "overallStatus": "SUSPECTED"
      },
      "data": [
        {
          "offenses": [
            {
              "offense": "<string>",
              "offenseClass": "<string>",
              "offenseDescription": "<string>",
              "offenseLevel": "<string>",
              "sentenceDate": "<string>",
              "courtName": "<string>",
              "courtCaseNumber": "<string>",
              "releaseDate": "<string>"
            }
          ],
          "fullName": "<string>",
          "county": "<string>",
          "region": "AL"
        }
      ],
      "serviceName": "<string>",
      "uid": "<string>",
      "errorMessage": "<string>",
      "serviceGroupType": "CRIMINAL_CHECK"
    }
  ],
  "externalRef": "<string>",
  "gdcMatch": true,
  "manualAddress": "<string>",
  "manualAddressMatch": true,
  "registryCenterCheck": {
    "checkedMrz": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "maidenName": "<string>",
    "mothersMaidenName": "<string>",
    "birthDate": "2023-12-25",
    "birthPlace": "<string>",
    "address": {},
    "residentialAddress": {},
    "nationality": "AF",
    "idCard": {},
    "passport": {},
    "additionalData": {},
    "resourceType": "HungaryRegistryCenterCheck"
  },
  "additionalSteps": {}
}

Headers

Idenfy-Event-Type
enum<string>
required
Available options:
IDENTIFICATION_EXPIRED
Idenfy-Signature
string

Webhook signature

Body

application/json
final
boolean
required
platform
enum<string>
required
Available options:
PC,
MOBILE,
TABLET,
MOBILE_APP,
MOBILE_SDK,
OTHER
status
object
required
data
object
required
fileUrls
object
required
scanRef
string
required
Maximum string length: 36
clientId
string
required
Maximum string length: 100
companyId
string
required
Maximum string length: 36
beneficiaryId
string
required
Maximum string length: 36
startTime
integer
required
finishTime
integer
required
clientIp
string | null
required
Maximum string length: 39
clientIpCountry
string | null
required
Maximum string length: 2
clientLocation
string | null
required
Maximum string length: 100
additionalStepPdfUrls
object
AML
object[] | null

Legacy (v2) object structure. If enabled, use amlCheck (v3), which better aligns with our new schema.

amlCheck
object
LID
object[] | null
CRIMINAL_CHECK
object[] | null
externalRef
string | null
Maximum string length: 40
gdcMatch
boolean | null
manualAddress
string | null
Maximum string length: 255
manualAddressMatch
boolean
registryCenterCheck
object
addressVerification
object
questionnaireAnswers
object
riskAssessment
object
bankVerification
object
emailVerification
object
phoneVerification
object
driverLicenseCheck
object
additionalSteps
object

Response

200

Return a 200 status to indicate that the data was received successfully.