Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
minLevel1
maxLevel7

...

🆔 IDV Webhooks Examples

...

1️⃣ IdentityVerification.Consented

Code Block
languagejson
{
    "Idid": "e4e148dee4df532d-8fd1a448-4e6443b2-9173a875-00374ed139d2031475695cf2",
    "ApplicationIdapplicationId": "8c7218bda2af2fd1-939460aa-46034549-b8baab2e-1ccea0b5e8d7e6294385af62",
    "CreatedUtccreatedUtc": "2023-0102-10T1221T07:1647:5306.4746293Z196653Z",
    "DeliveredUtcpayload":"2023-01-10T12:16:53.6690350Z {
        "id": "6c14b207-f73f-4a85-9e38-bbfb5ca62858",
  "IsDelivered":true,      "Payloadstatus": "InProgress",
   {     "idapplicationId": "7175fc81a2af2fd1-8ac160aa-418a4549-b2e4ab2e-89d0e8894442e6294385af62",
        "applicationIdcreatedUtc": "8c7218bd2023-9394-4603-b8ba-1ccea0b5e8d702-21T07:46:57.862Z",
        "createdUtcmodifiedUtc": "2023-0102-10T1221T07:1647:5306.319Z14Z",
        "setup": {
     {       "id": "12d8478b27820208-0174e4d0-49e94841-b3e6bacf-45f9063ba0d293e6e709637b",
            "versionId": "03a5ec177cd83758-18afbc5f-4e884aa0-8a3597cc-1f8ebdec2d3ad7f3fa177dca"
        },
        "identityVerificationId":"ef9379b3-652d-44ee-b4c9-8da7a682ce40",step": {
            "statusdocumentSignatures":"Awaiting", [],
            "statusReasonforms":"Unfinished", [],
            "isCrossCheckedconsent":false {
             },   "TypeisConsented":"KycIdentification.Created" true,
 }

...

Code Block
languagejson
{   "Id": "25aa5e86-dd51-4a23-870d-0015e7d98227",   "ApplicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",   "CreatedUtc": "2023-02-20T13:24:32.4234105Z",   "DeliveredUtcconsentedUtc": "2023-02-21T1221T07:1147:4706.7290598Z14Z",
    "IsDelivered": true,   "Payload": {   }
 "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64       }
    },
    "type": "IdentityVerification.Consented"
}

...

2️⃣ IdentityVerification.StatusChanged

Code Block
languagejson
{
    "id": "7a21b0e2-580e-4d2d-8578-00fc32a753ad",
    "applicationId": "8921c61b44575362-a5c0e08e-4f1f4f75-9d44b399-5a83009a29b100d9d8916552",
    "createdUtc": "2023-0201-20T1331T07:2425:2355.938Z6073016Z",
    "setuppayload": {
        "id": "d4915b8c03be8be3-f4a7fbd5-4e944496-a2c3b552-16c68a1aee78bcd3e4918116",
        "versionIdstatus": "f3135842-d53c-4525-8118-be63a12641ba""Completed",
    },     "identityVerificationIdapplicationId": "7b4032ff44575362-3a4ae08e-48464f75-abf3b399-b1ffa9afbe2600d9d8916552",
        "statuscreatedUtc": "Awaiting2023-01-31T07:22:11.313Z",
        "statusReasonmodifiedUtc": "Processing2023-01-31T07:25:55.595Z",
        "isCrossCheckedsetup": false,{
    "document": {       "typeid": "IdCard5f16990b-d00a-4ff2-8102-e7b8d5820c28",
 
    "mrzVerified": false,       "filesversionId": [
  "60e8a778-1885-4162-bd58-d8b07bddba2e"
      {  },
        "createdUtcstep": "2023-02-20T13:24:26Z",{
            "kycIdentification": {
                "fileIdid": "1d712a496df0d302-bcb4f0bb-47eb441a-ba33804c-0652dcebad2f5b114b476fc0",
           "fileName": "c9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg", },
            "fileExtensiondocumentSignatures": "jpeg"[],
            "partforms": "Front",[],
            "fileTypeconsent": "DocumentPhoto"{
        }       ],
      "ocrValidations "isConsented": [true,
        {           "keyconsentedUtc": "Address",2023-01-31T07:22:25.08Z"
           "isValid": false}
        },
    },
   { "type": "IdentityVerification.StatusChanged"
}

...

👤 KYC Webhooks Examples

1️⃣ KycIdentification.Created

Code Block
languagejson
{
       "keyid": "Categorye4e148de-8fd1-4e64-9173-00374ed139d2",
    "applicationId": "8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
    "isValidcreatedUtc": true"2023-01-10T12:16:53.4746293Z",
    "payload": {
  },         {
 "id": "7175fc81-8ac1-418a-b2e4-89d0e8894442",
        "keyapplicationId": "DateOfBirth8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
          "isValidcreatedUtc": false"2023-01-10T12:16:53.319Z",
        },
   "setup": {
    {           "keyid": "DateOfExpiration12d8478b-0174-49e9-b3e6-45f9063ba0d2",
            "isValidversionId": false"03a5ec17-18af-4e88-8a35-1f8ebdec2d3a"
        },
        {
"identityVerificationId": "ef9379b3-652d-44ee-b4c9-8da7a682ce40",
         "keystatus": "DateOfIssueAwaiting",
          "isValidstatusReason": false"Unfinished",
        },
"isCrossChecked": false
    },
  {  "type": "KycIdentification.Created"
}

...

2️⃣ KycIdentification.Processed

Code Block
languagejson
{
      "keyid": "DocumentNumber25aa5e86-dd51-4a23-870d-0015e7d98227",
    "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
    "isValidcreatedUtc": false"2023-02-20T13:24:32.4234105Z",
    "payload": {
  },         {
 "id": "c9fc134b-0386-4e4f-940e-f1349b9d3d64",
        "keyapplicationId": "FirstName8921c61b-a5c0-4f1f-9d44-5a83009a29b1",

         "isValidcreatedUtc": false"2023-02-20T13:24:23.938Z",
        },
 "setup": {
      {           "keyid": "LastNamed4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
            "isValidversionId": false"f3135842-d53c-4525-8118-be63a12641ba"
        },
        {
 "identityVerificationId": "7b4032ff-3a4a-4846-abf3-b1ffa9afbe26",
        "keystatus": "GenderAwaiting",
         "statusReason": "isValidProcessing":,
false        "isCrossChecked": }false,
        "document": {
            "keytype": "NationalityIdCard",
            "isValidmrzVerified": false,
        },    "files": [
   {           "key": "PersonalCode", {
         "isValid": false         } "createdUtc": "2023-02-20T13:24:26Z",
    ]     },           "rulesfileId": ["1d712a49-bcb4-47eb-ba33-0652dcebad2f",
           {         "namefileName": "DocumentNotExpiredc9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg",
          "status": "Fail",         "reasonfileExtension": "DocumentExpirationDateNotFoundjpeg",
      },       {         "namepart": "DocumentHasFaceFront",
         "status": "Fail",           "reasonfileType": "DocumentHasNoFaceDocumentPhoto"
      },       {   }
     "name": "DocumentHasBothSides",      ],
  "status": "Fail",         "reasonocrValidations": "DocumentPartTypeNotRecognized"[
      },          {
          "name": "DocumentTypeNotProhibited",         "statuskey": "SuccessAddress",
      },
      {         "nameisValid": "NotUnder18",false
               "status": "Fail" },
        "reason": "BirthDateNotFound"        {
    },       {         "namekey": "NotProhibitedByCountryOrStateCategory",
          "status": "Fail",         "reasonisValid": "DocumentCountryOrStateUnknown" true
           }     ]},
    "registries": [],     "fraudChecks": [],     "completedUtc": "2023-02-20T13:24:32Z"{
            },   "Type": "KycIdentification.Processed" }

...

Code Block
languagejson
{   "Idkey": "00b6c3c8-8219-4206-a4ab-04554c97fa1a",
  "ApplicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",DateOfBirth",
                    "CreatedUtc": "2023-01-16T23:40:52.4886646Z",
  "DeliveredUtc": "2023-01-16T23:40:54.4748441Z",
  "IsDelivered": true,
  "Payload": {
    "id": "4c0000ac-f116-4dec-93ba-493f3809ca9b",
    "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
    "createdUtc": "2023-01-16T23:40:42.77Z",
    "setup": {
      "id": "04b803f3-6c62-4560-bf5f-9ef75397ce1d",
      "versionId": "fde54820-00ec-4da0-87fa-c70f81729b0e"
    },
    "identityVerificationId": "d1a76177-00d5-494e-bbba-557527501a0e",
    "status": "Approved",
    "statusReason": "AutomaticallyIdentified",
    "isCrossChecked": false,
    "document": {
      "fullName": "NAME MIDDLE SURNAME",
      "firstName": "NAME MIDDLE",
      "lastName": "SURNAME",
      "documentNumber": "1740931767",
      "dateOfIssue": "2018-12-03",
      "dateOfExpiration": "2023-12-01",
      "dateOfBirth": "1985-02-27",
      "personalCode": "000.000.000-17",
      "countryIso3": "BRA",
      "type": "DriverLicense",
      "mrzVerified": true,
      "category": "B",
      "files": [
        {
          "createdUtc": "2023-01-16T23:40:43Z",
          "fileId": "e2ec5e00-0000-40f3-9e1c-c7a435d1fe2f",
          "fileName": "4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg",
 isValid": false
                },
                {
                    "key": "DateOfExpiration",
                    "isValid": false
                },
                {
                    "key": "DateOfIssue",
                    "isValid": false
                },
                {
                    "key": "DocumentNumber",
                    "isValid": false
                },
                {
                    "key": "FirstName",
                    "isValid": false
                },
                {
                    "key": "LastName",
                    "isValid": false
                },
                {
                    "key": "Gender",
                    "isValid": false
                },
                {
                    "key": "Nationality",
                    "isValid": false
                },
                {
                    "key": "PersonalCode",
                    "isValid": false
                }
            ]
        },
        "rules": [
            {
                "name": "DocumentNotExpired",
                "status": "Fail",
                "reason": "DocumentExpirationDateNotFound"
            },
            {
                "name": "DocumentHasFace",
                "status": "Fail",
                "reason": "DocumentHasNoFace"
            },
            {
                "name": "DocumentHasBothSides",
                "status": "Fail",
                "reason": "DocumentPartTypeNotRecognized"
            },
            {
                "name": "DocumentTypeNotProhibited",
                "status": "Success"
            },
            {
                "name": "NotUnder18",
                "status": "Fail",
                "reason": "BirthDateNotFound"
            },
            {
                "name": "NotProhibitedByCountryOrState",
                "status": "Fail",
                "reason": "DocumentCountryOrStateUnknown"
            }
        ],
        "registries": [],
        "fraudChecks": [],
        "completedUtc": "2023-02-20T13:24:32Z"
    },
    "type": "KycIdentification.Processed"
}

...

3️⃣ KycIdentification.Approved

Code Block
languagejson
{
    "id": "00b6c3c8-8219-4206-a4ab-04554c97fa1a",
    "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
    "createdUtc": "2023-01-16T23:40:52.4886646Z",
    "payload": {
        "id": "4c0000ac-f116-4dec-93ba-493f3809ca9b",
        "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
        "createdUtc": "2023-01-16T23:40:42.77Z",
        "setup": {
            "id": "04b803f3-6c62-4560-bf5f-9ef75397ce1d",
            "versionId": "fde54820-00ec-4da0-87fa-c70f81729b0e"
        },
        "identityVerificationId": "d1a76177-00d5-494e-bbba-557527501a0e",
        "status": "Approved",
        "statusReason": "AutomaticallyIdentified",
        "isCrossChecked": false,
        "document": {
            "fullName": "NAME MIDDLE SURNAME",
            "firstName": "NAME MIDDLE",
            "lastName": "SURNAME",
            "documentNumber": "1740931767",
            "dateOfIssue": "2018-12-03",
            "dateOfExpiration": "2023-12-01",
            "dateOfBirth": "1985-02-27",
            "personalCode": "000.000.000-17",
            "countryIso3": "BRA",
            "type": "DriverLicense",
            "mrzVerified": true,
            "category": "B",
            "files": [
                {
                    "createdUtc": "2023-01-16T23:40:43Z",
                    "fileId": "e2ec5e00-0000-40f3-9e1c-c7a435d1fe2f",
                    "fileName": "4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg",
                    "fileExtension": "jpeg",
                    "part": "Front",
                    "fileType": "DocumentPhoto"
                },
                {
                    "createdUtc": "2023-01-16T23:40:43Z",
                    "fileId": "717e98b1-00a-0000-ab51-655b8cf0bb2d",
                    "fileName": "4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg",
                    "fileExtension": "jpeg",
                    "part": "Back",
                    "fileType": "DocumentPhoto"
                }
            ],
            "ocrValidations": [
                {
                    "key": "Address",
                    "isValid": true
                },
                {
                    "key": "Category",
                    "isValid": true
                },
                {
                    "key": "DateOfBirth",
                    "isValid": true
                },
                {
                    "key": "DateOfExpiration",
                    "isValid": true
                },
                {
                    "key": "DateOfIssue",
                    "isValid": true
                },
                {
                    "key": "DocumentNumber",
                    "isValid": true
                },
                {
                    "key": "FirstName",
                    "isValid": true
                },
                {
                    "key": "LastName",
                    "isValid": true
                },
                {
                    "key": "Gender",
                    "isValid": true
                },
                {
                    "key": "Nationality",
                    "isValid": true
                },
                {
                    "key": "PersonalCode",
                    "isValid": true
                }
            ]
        },
        "rules": [
            {
                "name": "DocumentHasBothSides",
                "status": "Success"
            },
            {
                "name": "DocumentNotExpired",
                "status": "Success"
            },
            {
                "name": "DocumentHasFace",
                "status": "Success"
            },
            {
                "name": "DocumentTypeNotProhibited",
                "status": "Success"
            },
            {
                "name": "NotUnder18",
                "status": "Success"
            }
        ],
        "registries": [],
        "fraudChecks": [
            {
                "name": "DocumentManipulation",
                "status": "Success"
            }
        ],
        "completedUtc": "2023-01-16T23:40:51Z"
    },
    "type": "KycIdentification.Approved"
}

...

4️⃣ KycIdentification.Updated

Code Block
languagejson
{
    "id": "a59c2055-7655-43bb-923d-0005928301d7",
    "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
    "createdUtc": "2023-02-16T14:46:33.1467591Z",
    "payload": {
        "id": "9655ae23-7be6-4df4-98e4-df43a58f9620",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
        "createdUtc": "2023-02-16T14:43:40.503Z",
        "setup": {
            "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
            "versionId": "f3135842-d53c-4525-8118-be63a12641ba"
        },
        "identityVerificationId": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199f",
        "status": "Rejected",
        "statusReason": "UnrelatedPhotoSubmit",
        "isCrossChecked": true,
        "document": {
            "type": "DriverLicense",
            "mrzVerified": true,
            "files": [
                {
                    "createdUtc": "2023-02-16T14:43:42Z",
                    "fileId": "25afc22e-9f87-4466-afb4-e1609141798a",
                    "fileName": "9655ae237be64df498e4df43a58f9620_front_144342156.png",
                    "fileExtension": "png",
                    "part": "Front",
                    "fileType": "DocumentPhoto"
                }
            ],
            "ocrValidations": [
                {
                    "key": "Address",
                    "isValid": false
                },
                {
                    "key": "Category",
                    "isValid": false
                },
                {
                    "key": "DateOfBirth",
                    "isValid": false
                },
                {
                    "key": "DateOfExpiration",
                    "isValid": false
                },
                {
                    "key": "DateOfIssue",
                    "isValid": false
                },
                {
                    "key": "DocumentNumber",
                    "isValid": false
                },
                {
                    "key": "FirstName",
                    "isValid": false
                },
                {
                    "key": "LastName",
                    "isValid": false
                },
                {
                    "key": "Gender",
                    "isValid": false
                },
                {
                    "key": "Nationality",
                    "isValid": true
                },
                {
                    "key": "PersonalCode",
                    "isValid": false
                }
            ]
        },
        "rules": [
            {
                "name": "DocumentNotExpired",
                "status": "Fail",
                "reason": "DocumentExpirationDateNotFound"
            },
            {
                "name": "DocumentHasFace",
                "status": "Fail",
                "reason": "DocumentHasNoFace"
            },
            {
                "name": "DocumentHasBothSides",
                "status": "Fail",
                "reason": "DocumentPartTypeNotRecognized"
            },
            {
                "name": "DocumentTypeNotProhibited",
                "status": "Success"
            },
            {
                "name": "NotUnder18",
                "status": "Fail",
                "reason": "BirthDateNotFound"
            },
            {
                "name": "NotProhibitedByCountryOrState",
                "status": "Fail",
                "reason": "DocumentCountryOrStateUnknown"
            }
        ],
        "registries": [],
        "fraudChecks": [],
        "completedUtc": "2023-02-16T14:43:47Z"
    },
    "type": "KycIdentification.Updated"
}

...

5️⃣ KycIdentification.Rejected

Code Block
languagejson
{
    "id": "15df07d7-4b54-4674-9dd5-00354e6cd1a9",
    "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
    "createdUtc": "2023-02-15T15:10:07.6788678Z",
    "payload": {
        "fileExtensionid": "jpeg832f67ab-0f6f-4a57-bfc2-83abb543bbd0",
 
        "partapplicationId": "Front8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
          "fileTypecreatedUtc": "DocumentPhoto"2023-02-15T15:09:57.944Z",
        },
      "setup": {
 {           "createdUtcid": "2023-01-16T23:40:43Zd4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
            "fileIdversionId": "717e98b1f3135842-00ad53c-00004525-ab518118-655b8cf0bb2dbe63a12641ba",
          "fileName": "4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg",
 },
        "fileExtensionidentityVerificationId": "jpeg0458600b-f373-404d-8603-9fcc5c8d5d23",
 
        "partstatus": "BackRejected",
 
        "fileTypestatusReason": "DocumentPhotoUnrelatedPhotoSubmit",
        }
"isCrossChecked": true,
     ],
      "ocrValidationsdocument": [{
        {           "key"type": "AddressPassport",
            "isValidmrzVerified": true,
        },    "files": [
    {            "key": "Category",{
           "isValid": true         },"createdUtc": "2023-02-15T15:09:59Z",
         {           "keyfileId": "DateOfBirthdf72c1a0-cb92-43d5-9c32-f15ead7a6c83",
          "isValid":  true         }"fileName": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",
        {            "keyfileExtension": "DateOfExpirationpng",
           "isValid": true         },"part": "FrontCover",
         {           "keyfileType": "DateOfIssueDocumentPhoto",
            "isValid": true   }
     },       ],
 {           "keyocrValidations": "DocumentNumber",
 [
        "isValid": true       {
 },         {           "key": "FirstNameAddress",

         "isValid": true         },      "isValid": true
  {           "key": "LastName",    },
       "isValid": true        {
},         {           "key": "GenderCategory",
                    "isValid": true
        },        },
     {           "key": "Nationality",{
           "isValid": true         }"key": "DateOfBirth",
        {            "keyisValid": "PersonalCode",false
          "isValid": true     },
   }       ]     }, {
   "rules": [       {         "namekey": "DocumentHasBothSidesDateOfExpiration",
 
      "status": "Success"       },      "isValid": {false
        "name": "DocumentNotExpired",       },
 "status": "Success"       },       {
        "name": "DocumentHasFace",            "statuskey": "SuccessDateOfIssue",
      },
      {         "nameisValid": "DocumentTypeNotProhibited",false
        "status": "Success"       },
      {         "name": "NotUnder18",
   {
     "status": "Success"       }
    ],     "registrieskey": []"DocumentNumber",
    "fraudChecks": [       {         "nameisValid": "DocumentManipulation",false
        "status": "Success"         },
       ],     "completedUtc": "2023-01-16T23:40:51Z"   },{
  "Type": "KycIdentification.Approved" }

...

Code Block
languagejson
{   "Id": "a59c2055-7655-43bb-923d-0005928301d7",   "ApplicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",   "CreatedUtc": "2023-02-16T14:46:33.1467591Z",     "DeliveredUtckey": "2023-02-16T14:46:34.2869411ZFirstName",
  "IsDelivered": true,
  "Payload":                  "isValid": false
                },
                {
    "id": "9655ae23-7be6-4df4-98e4-df43a58f9620",       "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",         "createdUtckey": "2023-02-16T14:43:40.503ZLastName",
       "setup": {             "idisValid": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78", false
          "versionId": "f3135842-d53c-4525-8118-be63a12641ba"     },
                 "identityVerificationId": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199f",{
        "status": "Rejected",     "statusReason": "UnrelatedPhotoSubmit",     "isCrossCheckedkey": true"Gender",
    "document": {       "type": "DriverLicense",       "mrzVerifiedisValid": true,false
         "files": [      },
  {           "createdUtc": "2023-02-16T14:43:42Z",  {
        "fileId": "25afc22e-9f87-4466-afb4-e1609141798a",           "fileNamekey": "9655ae237be64df498e4df43a58f9620_front_144342156.pngNationality",
 
        "fileExtension": "png",           "part": "FrontisValid",: false
         "fileType": "DocumentPhoto"      },
  }       ],       "ocrValidations":{
[         {           "key": "AddressPersonalCode",
                    "isValid": false
                },
        {    ]
      "key": "Category"  },
          "isValidrules": false[
         },   {
     {           "keyname": "DateOfBirthDocumentNotExpired",
          "isValid": false         },
  "status": "Fail",
     {           "keyreason": "DateOfExpirationDocumentExpirationDateNotFound",
            "isValid": false},
         },   {
     {           "keyname": "DateOfIssueDocumentHasFace",
          "isValid": false         },
"status": "Fail",
       {           "keyreason": "DocumentNumberDocumentHasNoFace",
            "isValid": false},
         },   {
     {           "keyname": "FirstNameDocumentHasBothSides",
                "isValidstatus": false"Fail",
         },       "reason": "DocumentPartTypeNotRecognized"
{           "key": "LastName", },
            {
       "isValid": false         },
 "name": "DocumentTypeNotProhibited",
      {           "keystatus": "GenderSuccess",
            "isValid": false},
         },   {
     {           "keyname": "NationalityNotUnder18",
          "isValid": true         }"status": "Fail",
        {           "keyreason": "PersonalCodeBirthDateNotFound",
             "isValid": false},
            }{
      ]     },     "rulesname": ["NotProhibitedByCountryOrState",
       {         "namestatus": "DocumentNotExpiredFail",
        "status": "Fail",         "reason": "DocumentExpirationDateNotFoundDocumentCountryOrStateUnknown"
       },     }
        {],
        "nameregistries": "DocumentHasFace"[],
        "statusfraudChecks": "Fail"[],
        "reasoncompletedUtc": "DocumentHasNoFace2023-02-15T15:10:02Z"
      },
    "type": "KycIdentification.Rejected"
}

...

🏢 KYB Webhooks Examples

1️⃣ KybIdentification.Created

Code Block
languagejson
{
        "nameid": "DocumentHasBothSides019346d0-770c-47a5-b693-049a79d19c51",
        "statusapplicationId": "Fail0068a566-b5d2-46f1-b5c3-22fdf895953a",
   
    "reasoncreatedUtc": "DocumentPartTypeNotRecognized"
      }2023-01-02T14:08:01.4572198Z",
    "payload":  {
        "nameid": "DocumentTypeNotProhibitedd91b5007-4af7-4980-8c48-b9658826673e",
        "statuscreatedUtc": "Success"2023-01-02T14:08:01.02",
      },    "setup": [],
  {         "nameapplicationId": "NotUnder180068a566-b5d2-46f1-b5c3-22fdf895953a",
        "statuslegalEntity": "Fail",{
            "reasonname": "BirthDateNotFound"Test company SmartId 2",
      },       {"code": "401038386"
        "name": "NotProhibitedByCountryOrState"},
        "statusverificationFormId": "Faila632cc2d-2717-4183-bee0-1efe1c868904",
        "reasonidentityVerificationId": "DocumentCountryOrStateUnknown"
 00000000-0000-0000-0000-000000000000",
    }     ],
    "registries"representatives": [],
     "fraudChecks": [],     "completedUtc": "2023-02-16T14:43:47Z"37cab687-a53c-4228-a1ad-d3cac0bcaac7",
  },    "Type": "KycIdentification.Updated" }

...

Code Block
languagejson
{   "Id": "15df07d728e92146-4b54d3e3-4674443c-9dd58d4e-00354e6cd1a9",50471481cbfe"
        ],
        "ApplicationIdstatus": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1Pending",
   "CreatedUtc": "2023-02-15T15:10:07.6788678Z",     "DeliveredUtclastStatusChangedUtc": "2023-0201-16T1302T14:5608:0001.5567215Z02",
   "IsDelivered": true},
    "Payloadtype": "KybIdentification.Created"
}

...

2️⃣ KybIdentification.Approved

Code Block
languagejson
{
    "id": "832f67ab54ec3990-0f6f4bfb-4a5740d2-bfc284c1-83abb543bbd0080ba15be61f",
    "applicationId": "8921c61b5d2567dc-a5c01e4e-4f1f44bc-9d44a651-5a83009a29b17f330a80bd23",
    "createdUtc": "20232022-0212-15T1514T16:0938:5701.944Z6026518Z",
    "setuppayload": {
        "id": "d4915b8cdc81eb25-f4a78ccb-4e944ea9-a2c39dde-16c68a1aee78c8b46e2f12d1",
        "versionIdcreatedUtc": "f31358422022-d53c-4525-8118-be63a12641ba"12-13T15:55:45.983",
        "setup": {
    },         "id": null,
            "identityVerificationIdversionId": "0458600b-f373-404d-8603-9fcc5c8d5d23", null
       "status": "Rejected" },
        "statusReasonapplicationId": "UnrelatedPhotoSubmit5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "isCrossCheckedlegalEntity": true,{
    "document": {       "typename": "Passport\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
      "mrzVerified": true,       "filescode": ["\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        {
 },
        "createdUtcverificationFormId": "2023-02-15T15:09:59Z"null,
          "fileIdidentityVerificationId": "df72c1a0a586a568-cb92b464-43d5420f-9c32a7b3-f15ead7a6c83368f2f208b33",
 
        "fileNamerepresentatives": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",[
           "fileExtension": "pngaea305f5-6123-4f1f-a266-535955e2584d",
          "part": "FrontCover",
   "e118640c-7e5d-471d-83e7-8cfc43504a03"
        ],
        "fileTypestatus": "DocumentPhotoApproved",
        }
"statusReason": null,
     ],       "ocrValidationsstatusDescription": [null,
        {
"lastStatusChangedUtc": "2022-12-14T16:38:01.53"
    },
    "keytype": "AddressKybIdentification.Approved",

}

...

3️⃣ KybIdentification.Rejected

Code Block
languagejson
{
    "id": "cbc8f716-425e-4519-990a-584023f9c880",
    "isValidapplicationId": true"5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        }"createdUtc": "2022-12-14T16:23:50.0805263Z",
        {
 "payload": {
        "keyid": "Categorydc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
          "isValidcreatedUtc": true"2022-12-13T15:55:45.983",
        },
    "setup": {
   {           "keyid": "DateOfBirth"null,
            "isValidversionId": falsenull
        },
        {

         "keyapplicationId": "DateOfExpiration5d2567dc-1e4e-44bc-a651-7f330a80bd23",
          "isValidlegalEntity": false
        },
       {
 {           "keyname": "DateOfIssue\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
            "isValidcode": false"\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        },
        {
"verificationFormId": null,
         "keyidentityVerificationId": "DocumentNumbera586a568-b464-420f-a7b3-368f2f208b33",
        "representatives": [
      "isValid": false      "aea305f5-6123-4f1f-a266-535955e2584d",
            },"e118640c-7e5d-471d-83e7-8cfc43504a03"
        {],
          "keystatus": "FirstNameRejected",
        "statusReason":  "isValidDataNotMatch":,
false        "statusDescription": }null,
        {
"lastStatusChangedUtc": "2022-12-14T16:23:50.033"
    },
    "keytype": "LastNameKybIdentification.Rejected",

}

...

4️⃣ KybIdentification.Document.Created

Code Block
languagejson
{
         "isValidid": false"696ec22d-304a-412a-b719-6eeca663e5fe",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
  },  "createdUtc": "2022-12-12T10:12:59.4204Z",
    "payload": {

         "keyid": "Gender701ded06-f832-45f3-9a66-4378d0ba55ed",
         "applicationId": "isValid": false5d2567dc-1e4e-44bc-a651-7f330a80bd23",
         }"identificationId": "eccae495-46fb-4f2c-9eba-863f5f407fb0",
        {
"createdUtc": "2022-12-12T10:12:59.4121043Z",
        "lastActionUtc": "key": "Nationality",
 2022-12-12T10:12:59.4121045Z",
        "isValidlastStatusChangedUtc": false
        }null,
        {
 "fileId": null,
        "keystatus": "PersonalCodeNeedReview",
          "isValidpurpose": false"ExternalRegistry",
        }
"title": "SkyNet.pdf"
     ]
    },
    "rulestype": [
      {
   "KybIdentification.Document.Created"
}

...

5️⃣ KybIdentification.Document.Deleted

Code Block
languagejson
{
    "nameid": "DocumentNotExpired29cbf14a-9baf-40a1-ba05-e9cf0ed8dee7",
 
      "statusapplicationId": "Fail5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "reasoncreatedUtc": "DocumentExpirationDateNotFound"
      }2022-12-12T10:15:08.4286841Z",
    "payload":  {
        "nameid": "DocumentHasFace701ded06-f832-45f3-9a66-4378d0ba55ed",
        "statusapplicationId": "Fail5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "reasonidentificationId": "DocumentHasNoFace"eccae495-46fb-4f2c-9eba-863f5f407fb0",
      },       {"createdUtc": "2022-12-12T10:12:59.413",
         "namelastActionUtc": "DocumentHasBothSides2022-12-12T10:13:00.57",
        "statuslastStatusChangedUtc": "Fail"null,
        "reasonfileId": "DocumentPartTypeNotRecognizedkybid-2aa9a9c735894ecdabd1451471a604aa",
      },    "status": "NeedReview",
  {         "namepurpose": "DocumentTypeNotProhibitedExternalRegistry",
        "statustitle": "SuccessSkyNet.pdf"
      },
    "type": "KybIdentification.Document.Deleted"
}

...

6️⃣ KybIdentification.Document.Updated

Code Block
languagejson
{
        "nameid": "NotUnder1821e2e190-bc8b-43ef-914f-3c8ab630d2fa",
   
    "statusapplicationId": "Fail5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "reasoncreatedUtc": "BirthDateNotFound"
      }2022-12-13T09:46:15.6314497Z",
     "payload": {
        "nameid": "NotProhibitedByCountryOrStateef0dbfa6-5533-4463-a4a8-493aeff7d942",
        "statusapplicationId": "Fail5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "reasonidentificationId": "DocumentCountryOrStateUnknown"
      }
    ],
    "registries": []53953073-3acb-4062-bb34-e2830b01d86d",
    "fraudChecks": [],     "completedUtccreatedUtc": "20232022-0212-15T1511T09:1049:02Z49.35",
  },      "TypelastActionUtc": "KycIdentification.Rejected"
}

IDV Webhooks Examples

...

Code Block
languagejson
{2022-12-13T09:46:15.58",
        "IdlastStatusChangedUtc": "e4df532d2022-a448-43b2-a875-031475695cf212-13T09:46:15.577",
  "ApplicationId      "fileId": "a2af2fd1-60aa-4549-ab2e-e6294385af62kybid-f1126a9b929d4bd2ba1249058140eb52",
  "CreatedUtc      "status": "2023-02-21T07:47:06.196653ZInvalidated",
  "DeliveredUtc      "purpose": "2023-02-21T07:47:06.3234729ZExternalRegistry",
        "IsDeliveredtitle": true, "backend (19).txt"
   "Payload": { },
    "Idtype": "6c14b207-f73f-4a85-9e38-bbfb5ca62858",KybIdentification.Document.Updated"
}

...

7️⃣ KybIdentification.Document.Uploaded

Code Block
languagejson
{
    "Statusid": "InProgress5d9a674a-1d28-45f1-a7fd-cfe920bbdf21",
    "ApplicationIdapplicationId": "a2af2fd15d2567dc-60aa1e4e-454944bc-ab2ea651-e6294385af627f330a80bd23",
    "CreatedUtccreatedUtc": "20232022-0212-21T0712T12:4659:5733.862Z146706Z",
    "ModifiedUtcpayload": "2023-02-21T07:47:06.14Z", {
        "Setupid": { "dd8e3b9e-bece-4b79-8c0d-e74412c19067",
        "IdapplicationId": "278202085d2567dc-e4d01e4e-484144bc-bacfa651-93e6e709637b7f330a80bd23",
        "VersionIdidentificationId": "7cd8375885edabe9-bc5f3902-4aa0483a-97cc9533-d7f3fa177dcaf5d48a842d42",
    },    "createdUtc": "Step": {2022-12-12T12:59:32.303",
        "DocumentSignatureslastActionUtc": []"2022-12-12T12:59:33.123",
        "FormslastStatusChangedUtc": []null,
        "ConsentfileId": {"kybid-29b125e08eb8410ea9234de3371f665a",
        "IsConsentedstatus": true"NeedReview",
        "ConsentedUtcpurpose": "2023-02-21T07:47:06.14Z"ExternalRegistry",
      }  "title": "SkyNet.pdf"
 }   },
    "Typetype": "IdentityVerificationKybIdentification.Document.ConsentedUploaded"
}

...