Versions Compared

Version Old Version 3 New Version Current
Changes made by

Jurgita Krukonyte (Deactivated)

Priit Aavik

Saved on

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
{
    "id": "e4e148dee4df532d-8fd1a448-4e6443b2-9173a875-00374ed139d2031475695cf2",
    "applicationId": "8c7218bda2af2fd1-939460aa-46034549-b8baab2e-1ccea0b5e8d7e6294385af62",
    "createdUtc": "2023-0102-10T1221T07:1647:5306.4746293Z196653Z",
    "deliveredUtc": "2023-01-10T12:16:53.6690350Z",
    "isDelivered": true,
    "payload": {
        "id": "7175fc816c14b207-8ac1f73f-418a4a85-b2e4-89d0e88944429e38-bbfb5ca62858",
        "status": "InProgress",
        "applicationId": "8c7218bda2af2fd1-939460aa-46034549-b8baab2e-1ccea0b5e8d7e6294385af62",
        "createdUtc": "2023-02-21T07:46:57.862Z",
        "modifiedUtc": "2023-0102-10T1221T07:1647:5306.319Z14Z",
        "setup": {
            "id": "12d8478b27820208-0174e4d0-49e94841-b3e6bacf-45f9063ba0d293e6e709637b",
            "versionId": "03a5ec177cd83758-18afbc5f-4e884aa0-8a3597cc-1f8ebdec2d3ad7f3fa177dca"
        },
        "identityVerificationIdstep": "ef9379b3-652d-44ee-b4c9-8da7a682ce40", {
            "statusdocumentSignatures": "Awaiting"[],
            "statusReasonforms": "Unfinished",[],
            "isCrossCheckedconsent": false{
    },     "type": "KycIdentification.Created" }

...

Code Block
languagejson
{     "idisConsented": "25aa5e86-dd51-4a23-870d-0015e7d98227"true,
    "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",     "createdUtc": "2023-02-20T13:24:32.4234105Z",     "deliveredUtcconsentedUtc": "2023-02-21T1221T07:1147:4706.7290598Z14Z",
    "isDelivered": true,     "payload": {  }
        }
    },
    "type": "IdentityVerification.Consented"
}

...

2️⃣ IdentityVerification.StatusChanged

Code Block
languagejson
{
    "id": "c9fc134b7a21b0e2-0386580e-4e4f4d2d-940e8578-f1349b9d3d6400fc32a753ad",

       "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",
        },
        "identityVerificationId"applicationId": "7b4032ff44575362-3a4ae08e-48464f75-abf3b399-b1ffa9afbe2600d9d8916552",
        "statuscreatedUtc": "Awaiting2023-01-31T07:22:11.313Z",
        "statusReasonmodifiedUtc": "Processing2023-01-31T07:25:55.595Z",
        "isCrossCheckedsetup": false,{
            "documentid": {"5f16990b-d00a-4ff2-8102-e7b8d5820c28",
            "typeversionId": "IdCard",60e8a778-1885-4162-bd58-d8b07bddba2e"
        },
        "mrzVerifiedstep": false,{
            "fileskycIdentification": [{
                {
"id": "6df0d302-f0bb-441a-804c-5b114b476fc0"
                   "createdUtc": "2023-02-20T13:24:26Z"},
                    "fileId"documentSignatures": "1d712a49-bcb4-47eb-ba33-0652dcebad2f",
      [],
             "fileNameforms": "c9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg",
       [],
            "fileExtensionconsent": "jpeg",
 {
                  "partisConsented": "Front"true,
                    "fileTypeconsentedUtc": "DocumentPhoto2023-01-31T07:22:25.08Z"
            }
   }     }
       ]},
    "type": "IdentityVerification.StatusChanged"
}

...

👤 KYC Webhooks Examples

1️⃣ KycIdentification.Created

Code Block
languagejson
{
    "id": "ocrValidations": [e4e148de-8fd1-4e64-9173-00374ed139d2",
    "applicationId": "8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
    "createdUtc": "2023-01-10T12:16:53.4746293Z",
    "payload": {
           "id": "7175fc81-8ac1-418a-b2e4-89d0e8894442",
        "keyapplicationId": "Address8c7218bd-9394-4603-b8ba-1ccea0b5e8d7",
              "createdUtc": "2023-01-10T12:16:53.319Z",
        "isValidsetup": false{
                }"id": "12d8478b-0174-49e9-b3e6-45f9063ba0d2",
            "versionId": "03a5ec17-18af-4e88-8a35-1f8ebdec2d3a"
  {      },
              "key"identityVerificationId": "Categoryef9379b3-652d-44ee-b4c9-8da7a682ce40",
           "status": "Awaiting",
        "isValidstatusReason": true"Unfinished",
           "isCrossChecked": false
    },
    "type": "KycIdentification.Created"
}

...

2️⃣ KycIdentification.Processed

Code Block
languagejson
{
     "id": "25aa5e86-dd51-4a23-870d-0015e7d98227",
   { "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
    "createdUtc": "2023-02-20T13:24:32.4234105Z",
    "payload": {
        "keyid": "DateOfBirthc9fc134b-0386-4e4f-940e-f1349b9d3d64",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
          "isValidcreatedUtc": false"2023-02-20T13:24:23.938Z",
        "setup": {
      },                 {"id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
                    "key"versionId": "DateOfExpiration",f3135842-d53c-4525-8118-be63a12641ba"
        },
           "isValididentityVerificationId": false"7b4032ff-3a4a-4846-abf3-b1ffa9afbe26",
        "status": "Awaiting",
      },  "statusReason": "Processing",
        "isCrossChecked": false,
   {     "document":  {
             "keytype": "DateOfIssueIdCard",
     
              "isValidmrzVerified": false,
                },"files": [
                {
                    "keycreatedUtc": "DocumentNumber",2023-02-20T13:24:26Z",
                    "isValidfileId": false"1d712a49-bcb4-47eb-ba33-0652dcebad2f",
                    },"fileName": "c9fc134b03864e4f940ef1349b9d3d64_front_132425267.jpeg",
                     {"fileExtension": "jpeg",
                    "keypart": "FirstNameFront",
                    "isValidfileType": false"DocumentPhoto"
                }
            ],
            "ocrValidations": [
                {
                    "key": "LastNameAddress",
                    "isValid": false
                },
                {
                    "key": "GenderCategory",
                    "isValid": falsetrue
                },
                {
                    "key": "NationalityDateOfBirth",
                    "isValid": false
                },
                {
                    "key": "PersonalCodeDateOfExpiration",
                    "isValid": false
                },
            ]    {
    },         "rules": [         "key": "DateOfIssue",
   {                 "nameisValid": "DocumentNotExpired",false
                "status": "Fail"},
                "reason": "DocumentExpirationDateNotFound"{
             },       "key": "DocumentNumber",
    {                 "nameisValid": "DocumentHasFace",false
                "status": "Fail"},
                "reason": "DocumentHasNoFace"{
             },         "key": "FirstName",
   {                 "nameisValid": "DocumentHasBothSides",false
                "status": "Fail"},
                "reason": "DocumentPartTypeNotRecognized"{
             },       "key": "LastName",
    {                 "nameisValid": "DocumentTypeNotProhibited",false
                 "status": "Success"},
             },   {
         {                 "name"key": "NotUnder18Gender",
                "status": "Fail",   "isValid": false
            "reason": "BirthDateNotFound"     },
       },         {
   {                 "namekey": "NotProhibitedByCountryOrStateNationality",
                    "statusisValid": "Fail", false
                },
     "reason": "DocumentCountryOrStateUnknown"          {
  }         ],         "registrieskey": [],"PersonalCode",
          "fraudChecks": [],         "completedUtcisValid": "2023-02-20T13:24:32Z" false
     },     "type": "KycIdentification.Processed"
}

...

Code Block
languagejson
{
    "id": "00b6c3c8-8219-4206-a4ab-04554c97fa1a",
    "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
    "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"},
        "rules": [
  "lastName": "SURNAME",         {
   "documentNumber": "1740931767",             "dateOfIssuename": "2018-12-03DocumentNotExpired",
                "dateOfExpirationstatus": "2023-12-01Fail",
                "dateOfBirthreason": "1985-02-27",DocumentExpirationDateNotFound"
            },
 "personalCode": "000.000.000-17",          {
  "countryIso3": "BRA",             "typename": "DriverLicenseDocumentHasFace",
                "mrzVerifiedstatus": true,"Fail",
                "categoryreason": "BDocumentHasNoFace",
            "files": [
 },
              {
   
                "createdUtcname": "2023-01-16T23:40:43ZDocumentHasBothSides",
   
                "fileIdstatus": "e2ec5e00-0000-40f3-9e1c-c7a435d1fe2fFail",
   
                "fileNamereason": "4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg",DocumentPartTypeNotRecognized"
            },
       "fileExtension": "jpeg",    {
                "partname": "FrontDocumentTypeNotProhibited",
   
                "fileTypestatus": "DocumentPhotoSuccess"
            },
   },         {
            {    "name": "NotUnder18",
                "createdUtcstatus": "2023-01-16T23:40:43ZFail",
   
                "fileIdreason": "717e98b1-00a-0000-ab51-655b8cf0bb2d",BirthDateNotFound"
            },
       "fileName": "4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg",    {
                "fileExtensionname": "jpegNotProhibitedByCountryOrState",
  
                 "partstatus": "BackFail",
   
                "fileTypereason": "DocumentPhotoDocumentCountryOrStateUnknown"
            }
     }   ],
        "registries": [],
        "fraudChecks": [],
        "completedUtc"ocrValidations": [
  : "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": {
          "keyid": "Address4c0000ac-f116-4dec-93ba-493f3809ca9b",
          "applicationId": "00cabb1f-4d7c-41d9-9a97-55482d920160",
         "isValidcreatedUtc": true
                }"2023-01-16T23:40:42.77Z",
        "setup": {
      {      "id": "04b803f3-6c62-4560-bf5f-9ef75397ce1d",
             "keyversionId": "Category",fde54820-00ec-4da0-87fa-c70f81729b0e"
        },
           "isValididentityVerificationId": true"d1a76177-00d5-494e-bbba-557527501a0e",
        "status": "Approved",
      },  "statusReason": "AutomaticallyIdentified",
        "isCrossChecked": false,
   {     "document":  {
             "keyfullName": "DateOfBirthNAME MIDDLE SURNAME",
 
                  "isValid"firstName": true"NAME MIDDLE",
            "lastName": "SURNAME",
  },          "documentNumber": "1740931767",
     {       "dateOfIssue": "2018-12-03",
            "keydateOfExpiration": "DateOfExpiration2023-12-01",
            "dateOfBirth": "1985-02-27",
            "isValidpersonalCode": true"000.000.000-17",
            "countryIso3": "BRA",
  },          "type": "DriverLicense",
     {       "mrzVerified": true,
            "keycategory": "DateOfIssueB",
            "files": [
      "isValid": true         {
       },                 {"createdUtc": "2023-01-16T23:40:43Z",
                    "keyfileId": "DocumentNumbere2ec5e00-0000-40f3-9e1c-c7a435d1fe2f",
                    "isValidfileName": true"4c4811acf1164dec93ba493f3809ca9b_front_234040000.jpeg",
                     },"fileExtension": "jpeg",
                  {   "part": "Front",
                    "keyfileType": "FirstNameDocumentPhoto",
                },
   "isValid": true            {
    },                 {"createdUtc": "2023-01-16T23:40:43Z",
                    "keyfileId": "LastName",717e98b1-00a-0000-ab51-655b8cf0bb2d",
                    "fileName": "4c4811acf1164dec93ba493f3809ca9b_back_234043541.jpeg",
         "isValid": true          "fileExtension": "jpeg",
     },               "part": "Back",
{
                    "keyfileType": "Gender",DocumentPhoto"
                }
        "isValid": true   ],
             },"ocrValidations": [
                {
                    "key": "NationalityAddress",
                    "isValid": true
                },
                {
                    "key": "PersonalCodeCategory",
                    "isValid": true
                },
                {
  ]         },         "ruleskey": ["DateOfBirth",
            {        "isValid": true
        "name": "DocumentHasBothSides",       },
         "status": "Success"      {
      },             { "key": "DateOfExpiration",
              "name": "DocumentNotExpired",     "isValid": true
          "status": "Success"     },
       },         {
   {                 "namekey": "DocumentHasFaceDateOfIssue",
                    "statusisValid": "Success"true
                },
                {
                    "namekey": "DocumentTypeNotProhibitedDocumentNumber",
                "status": "Success"    "isValid": true
       },         },
   {              {
  "name": "NotUnder18",                 "statuskey": "SuccessFirstName",
            }        "isValid": true
],         "registries": [],      },
  "fraudChecks": [             {
                    "namekey": "DocumentManipulationLastName",
     
          "status": "Success"           "isValid": true
}         ],       },
 "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.2869411Z"Gender",
    "isDelivered": true,     "payload": {         "idisValid": "9655ae23-7be6-4df4-98e4-df43a58f9620",true
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",         "createdUtc": "2023-02-16T14:43:40.503Z",},
         "setup": {      {
      "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",             "versionIdkey": "f3135842-d53c-4525-8118-be63a12641ba"Nationality",
           },         "identityVerificationIdisValid": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199f",true
          "status": "Rejected",     },
   "statusReason": "UnrelatedPhotoSubmit",         "isCrossChecked": true,  {
      "document": {             "typekey": "DriverLicensePersonalCode",
            "mrzVerified": true,             "filesisValid": [true
                {}
            ]
       "createdUtc": "2023-02-16T14:43:42Z" },
        "rules": [
          "fileId": "25afc22e-9f87-4466-afb4-e1609141798a",
    {
                "fileNamename": "9655ae237be64df498e4df43a58f9620_front_144342156.pngDocumentHasBothSides",
   
                "fileExtensionstatus": "pngSuccess",
            },
       "part": "Front",    {
                "fileTypename": "DocumentPhotoDocumentNotExpired",
                 }"status": "Success"
            ]},
            "ocrValidations":{
[                 {
"name": "DocumentHasFace",
                   "keystatus": "AddressSuccess",
            },
       "isValid": false    {
            },    "name": "DocumentTypeNotProhibited",
           {     "status": "Success"
            },
 "key": "Category",          {
          "isValid": false     "name": "NotUnder18",
          },      "status": "Success"
         {   }
        ],
        "keyregistries": "DateOfBirth",[],
        "fraudChecks": [
            "isValid":{
false                 }"name": "DocumentManipulation",
                {
"status": "Success"
            }
      "key": "DateOfExpiration"  ],
        "completedUtc": "2023-01-16T23:40:51Z"
     },
    "isValidtype": false
"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",
          "keyapplicationId": "DateOfIssue8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
           "createdUtc": "2023-02-16T14:43:40.503Z",
        "isValidsetup": false{
            "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
  },          "versionId": "f3135842-d53c-4525-8118-be63a12641ba"
       { },
           "identityVerificationId": "67c8dad4-b8ea-40aa-bced-7cdfb1e3199f",
        "keystatus": "DocumentNumberRejected",
        "statusReason": "UnrelatedPhotoSubmit",
          "isValidisCrossChecked": false
                }true,
        "document": {
      {      "type": "DriverLicense",
             "keymrzVerified": "FirstName"true,
            "files": [
      "isValid": false         {
       },             "createdUtc": "2023-02-16T14:43:42Z",
  {                     "keyfileId": "LastName25afc22e-9f87-4466-afb4-e1609141798a",
                    "isValidfileName": false "9655ae237be64df498e4df43a58f9620_front_144342156.png",
                     },"fileExtension": "png",
                    {"part": "Front",
                    "keyfileType": "Gender",DocumentPhoto"
                }
       "isValid": false    ],
            },"ocrValidations": [
                {
                    "key": "NationalityAddress",
                    "isValid": truefalse
                },
                {
                    "key": "PersonalCodeCategory",
                    "isValid": false
                }
   
        ]         },
        "rules": [       {
     {                 "namekey": "DocumentNotExpiredDateOfBirth",
                "status": "Fail",              "isValid": false
  "reason": "DocumentExpirationDateNotFound"              },
                {
                    "namekey": "DocumentHasFaceDateOfExpiration",
                "status": "Fail",   "isValid": false
            "reason": "DocumentHasNoFace"   },
         },       {
     {                 "namekey": "DocumentHasBothSidesDateOfIssue",

               "status": "Fail",    "isValid": false
           "reason": "DocumentPartTypeNotRecognized"     },
       },         {
   {                 "namekey": "DocumentTypeNotProhibitedDocumentNumber",
                "status": "Success"   "isValid": false
        },        },
    {            {
    "name": "NotUnder18",                 "statuskey": "FailFirstName",
                    "reasonisValid": "BirthDateNotFound"false
                },
                {
                    "namekey": "NotProhibitedByCountryOrStateLastName",
                "status": "Fail",   "isValid": false
            "reason": "DocumentCountryOrStateUnknown"   },
         }       {
 ],         "registries": [],         "fraudCheckskey": []"Gender",
        "completedUtc": "2023-02-16T14:43:47Z"       },     "typeisValid": "KycIdentification.Updated"
}

...

Code Block
languagejson
{ false
         "id": "15df07d7-4b54-4674-9dd5-00354e6cd1a9",     "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1" },
    "createdUtc": "2023-02-15T15:10:07.6788678Z",           "deliveredUtc": "2023-02-16T13:56:00.5567215Z", {
    "isDelivered": true,     "payload": {         "idkey": "832f67ab-0f6f-4a57-bfc2-83abb543bbd0Nationality",
          "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",         "createdUtcisValid": "2023-02-15T15:09:57.944Z",true
        "setup": {        },
    "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",           {
 "versionId": "f3135842-d53c-4525-8118-be63a12641ba"         },         "identityVerificationIdkey": "0458600b-f373-404d-8603-9fcc5c8d5d23PersonalCode",
          "status": "Rejected",         "statusReasonisValid": false
"UnrelatedPhotoSubmit",         "isCrossChecked": true,      }
  "document": {         ]
   "type": "Passport",    },
        "mrzVerifiedrules": true,[
            "files":{
[                 {
   "name": "DocumentNotExpired",
                "createdUtcstatus": "2023-02-15T15:09:59ZFail",
   
                "fileIdreason": "df72c1a0-cb92-43d5-9c32-f15ead7a6c83",DocumentExpirationDateNotFound"
            },
       "fileName": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",    {
                "fileExtensionname": "pngDocumentHasFace",

                   "partstatus": "FrontCoverFail",
   
                "fileTypereason": "DocumentPhotoDocumentHasNoFace"
            },
   }         {
   ],             "ocrValidationsname": ["DocumentHasBothSides",
                {
   "status": "Fail",
                "keyreason": "Address",DocumentPartTypeNotRecognized"
            },
            {
                "isValidname": true "DocumentTypeNotProhibited",
                "status": "Success"
    },        },
        {    {
                "keyname": "CategoryNotUnder18",
                "status": "Fail",
   "isValid":  true           "reason": "BirthDateNotFound"
    },        },
        {    {
                "keyname": "DateOfBirthNotProhibitedByCountryOrState",
  
                 "isValidstatus": false"Fail",
                },
"reason": "DocumentCountryOrStateUnknown"
            }
  {        ],
            "keyregistries": "DateOfExpiration"[],
           "fraudChecks": [],
        "isValidcompletedUtc": false
           "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": {
        "keyid": "DateOfIssue832f67ab-0f6f-4a57-bfc2-83abb543bbd0",
     
              "isValid": false
   "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
            }"createdUtc": "2023-02-15T15:09:57.944Z",
        "setup": {
      {        "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
            "keyversionId": "DocumentNumber",f3135842-d53c-4525-8118-be63a12641ba"
           },
        "isValididentityVerificationId": false"0458600b-f373-404d-8603-9fcc5c8d5d23",
        "status": "Rejected",
      },  "statusReason": "UnrelatedPhotoSubmit",
        "isCrossChecked": true,
   {        "document": {
            "keytype": "FirstNamePassport",
       
            "isValidmrzVerified": falsetrue,
                },"files": [
                {
                    "keycreatedUtc": "LastName2023-02-15T15:09:59Z",
                    "isValidfileId": false"df72c1a0-cb92-43d5-9c32-f15ead7a6c83",
                     },"fileName": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",
                     {"fileExtension": "png",
                    "keypart": "GenderFrontCover",
                    "isValidfileType": false"DocumentPhoto"
                },
            ],
   {                     "key"ocrValidations": "Nationality",[
                {
   "isValid": false                 }"key": "Address",
                {    "isValid": true
               "key": "PersonalCode" },
                {
   "isValid": false                 }"key": "Category",
            ]         },"isValid": true
        "rules": [        },
    {            {
    "name": "DocumentNotExpired",
                "statuskey": "FailDateOfBirth",
                "reason": "DocumentExpirationDateNotFound"   "isValid": false
        },        },
    {            {
    "name": "DocumentHasFace",                 "statuskey": "FailDateOfExpiration",
                "reason": "DocumentHasNoFace"   "isValid":  false
       },         },
   {             {
   "name": "DocumentHasBothSides",                 "statuskey": "FailDateOfIssue",
                "reason": "DocumentPartTypeNotRecognized"   "isValid": false
        },        },
    {            {
    "name": "DocumentTypeNotProhibited",                 "statuskey": "SuccessDocumentNumber",
            },        "isValid": false
   {             },
   "name": "NotUnder18",             {
   "status": "Fail",                 "reasonkey": "BirthDateNotFoundFirstName",
            },        "isValid": false
   {             },
   "name": "NotProhibitedByCountryOrState",            {
    "status": "Fail",                 "reasonkey": "DocumentCountryOrStateUnknownLastName",
              }      "isValid": false
 ],         "registries": [],     },
   "fraudChecks": [],         "completedUtc": "2023-02-15T15:10:02Z"  {
  },     "type": "KycIdentification.Rejected" }

IDV Webhooks Examples

...

Code Block
languagejson
{     "id": "e4df532d-a448-43b2-a875-031475695cf2",     "applicationIdkey": "a2af2fd1-60aa-4549-ab2e-e6294385af62Gender",
    "createdUtc": "2023-02-21T07:47:06.196653Z",
    "deliveredUtc": "2023-02-21T07:47:06.3234729Z",            "isDeliveredisValid": true,false
     "payload": {         "id": "6c14b207-f73f-4a85-9e38-bbfb5ca62858" },
        "status": "InProgress",        {
"applicationId": "a2af2fd1-60aa-4549-ab2e-e6294385af62",         "createdUtc": "2023-02-21T07:46:57.862Z",         "modifiedUtckey": "2023-02-21T07:47:06.14ZNationality",
        "setup": {             "idisValid": "27820208-e4d0-4841-bacf-93e6e709637b",
   false
         "versionId": "7cd83758-bc5f-4aa0-97cc-d7f3fa177dca"         },
         "step": {      {
      "documentSignatures": [],             "formskey": [],"PersonalCode",
                    "consentisValid": false
 {               }
  "isConsented": true,         ]
       "consentedUtc": "2023-02-21T07:47:06.14Z" },
        "rules": [
  }         } {
   },     "type": "IdentityVerification.Consented"
}

...

Code Block
languagejson
{       "idname": "7a21b0e2-580e-4d2d-8578-00fc32a753adDocumentNotExpired",
    "applicationId            "status": "44575362-e08e-4f75-b399-00d9d8916552",Fail",
                "createdUtcreason": "2023-01-31T07:25:55.6073016Z",DocumentExpirationDateNotFound"
     "deliveredUtc": "2023-01-31T07:25:55.9777022Z",     "isDelivered": true},
    "payload": {        {
      "id": "03be8be3-fbd5-4496-b552-bcd3e4918116",         "statusname": "CompletedDocumentHasFace",
        "applicationId": "44575362-e08e-4f75-b399-00d9d8916552",         "createdUtcstatus": "2023-01-31T07:22:11.313ZFail",
 
      "modifiedUtc": "2023-01-31T07:25:55.595Z",         "setupreason": {"DocumentHasNoFace"
            "id": "5f16990b-d00a-4ff2-8102-e7b8d5820c28"},
            "versionId": "60e8a778-1885-4162-bd58-d8b07bddba2e"{
         },        "name": "step": {DocumentHasBothSides",
                "kycIdentificationstatus": {"Fail",
                "idreason": "6df0d302-f0bb-441a-804c-5b114b476fc0DocumentPartTypeNotRecognized"
            },
            {
  "documentSignatures": [],             "formsname": []"DocumentTypeNotProhibited",
            "consent": {   "status": "Success"
            "isConsented": true},
            {
   "consentedUtc": "2023-01-31T07:22:25.08Z"             }
 "name": "NotUnder18",
      }     },     "typestatus": "IdentityVerification.StatusChangedFail"
}

...

Code Block
languagejson
{,
     "id": "183a05a1-0941-429a-8fc0-270a8bc94fe8",           "applicationIdreason": "0736cd0c-5a8d-45f8-a000-b5205ff4922d",BirthDateNotFound"
     "createdUtc": "2022-11-17T06:31:23.7154751Z",     "deliveredUtc": "2022-11-17T06:31:26.8995965Z" },
    "isDelivered": true,       "payload": {
                "idname": "81ae25a8a47a45f8b790105d72963684NotProhibitedByCountryOrState",
    },     "type": "Identification.DocumentSigning.Signed"
}

...

Code Block
languagejson
{       "idstatus": "5ed7cebf-3e47-45a4-b022-3aea6b5b429dFail",
    "applicationId            "reason": "4ddbdb56-f0a6-4425-8f53-a577e6f2b4bf",DocumentCountryOrStateUnknown"
            }
 "createdUtc": "2022-08-22T12:50:28.4325941Z",     "deliveredUtc": "2022-08-22T12:50:29.1375543Z", ],
        "isDeliveredregistries": true[],
        "payloadfraudChecks": {[],
        "idcompletedUtc": "6a237e710cb34da7b57c7c08f242e7152023-02-15T15:10:02Z"
    },
    "type": "Identification.VideoCallKycIdentification.UploadedRejected"
}

...

🏢 KYB Webhooks Examples

1️⃣ KybIdentification.Created

Code Block
languagejson
{
    "id": "019346d0-770c-47a5-b693-049a79d19c51",
    "applicationId": "0068a566-b5d2-46f1-b5c3-22fdf895953a",
    "createdUtc": "2023-01-02T14:08:01.4572198Z",

   "deliveredUtc": "2023-01-02T14:08:03.5340204Z",
    "isDelivered": true,
    "payload": {
        "id": "d91b5007-4af7-4980-8c48-b9658826673e",
        "createdUtc": "2023-01-02T14:08:01.02",
        "setup": [],
        "applicationId": "0068a566-b5d2-46f1-b5c3-22fdf895953a",
        "legalEntity": {
            "name": "Test company SmartId 2",
            "code": "401038386"
        },
        "verificationFormId": "a632cc2d-2717-4183-bee0-1efe1c868904",
        "identityVerificationId": "00000000-0000-0000-0000-000000000000",
        "representatives": [
            "37cab687-a53c-4228-a1ad-d3cac0bcaac7",
            "28e92146-d3e3-443c-8d4e-50471481cbfe"
        ],
        "status": "Pending",
        "lastStatusChangedUtc": "2023-01-02T14:08:01.02"
    },
    "type": "KybIdentification.Created"
}

...

2️⃣ KybIdentification.

...

Approved

Code Block
languagejson
{
    "id": "696ec22d54ec3990-304a4bfb-412a40d2-b71984c1-6eeca663e5fe080ba15be61f",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-12T1014T16:1238:59.4204Z",01.6026518Z",
    "payload": {
        "id": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
        "deliveredUtccreatedUtc": "2022-12-12T1413T15:5955:1045.1592004Z983",
    "isDelivered": true,
    "payloadsetup": {
            "id": "701ded06-f832-45f3-9a66-4378d0ba55ed"null,
            "applicationIdversionId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23" null
        },
        "identificationIdapplicationId": "eccae4955d2567dc-46fb1e4e-4f2c44bc-9ebaa651-863f5f407fb07f330a80bd23",
        "createdUtclegalEntity": "2022-12-12T10:12:59.4121043Z", {
            "lastActionUtcname": "2022-12-12T10:12:59.4121045Z",
        "lastStatusChangedUtc": null,\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
            "fileIdcode": null,"\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        "status": "NeedReview"},
        "purposeverificationFormId": "ExternalRegistry"null,
        "titleidentityVerificationId": "SkyNet.pdf"
a586a568-b464-420f-a7b3-368f2f208b33",
   },     "typerepresentatives": "KybIdentification.Document.Created"
}

...

Code Block
languagejson
{[
     "id": "54ec3990-4bfb-40d2-84c1-080ba15be61f",     "applicationId": "5d2567dcaea305f5-1e4e6123-44bc4f1f-a651a266-7f330a80bd23535955e2584d",
     "createdUtc": "2022-12-14T16:38:01.6026518Z",     "deliveredUtc": "2022-12-14T16:38:02.0542466Z",e118640c-7e5d-471d-83e7-8cfc43504a03"
    "isDelivered": true,     "payload": {],
        "idstatus": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1Approved",
        "createdUtcstatusReason": "2022-12-13T15:55:45.983"null,
        "setupstatusDescription": {null,
            "idlastStatusChangedUtc": null,
 "2022-12-14T16:38:01.53"
     },
    "versionIdtype": null
"KybIdentification.Approved"
}

...

3️⃣ KybIdentification.Rejected

Code Block
languagejson
{
       },
   "id": "cbc8f716-425e-4519-990a-584023f9c880",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-14T16:23:50.0805263Z",
    "legalEntitypayload": {
   
        "nameid": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
           "codecreatedUtc": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"2022-12-13T15:55:45.983",
        "setup": {
 },           "verificationFormIdid": null,
        "identityVerificationId": "a586a568-b464-420f-a7b3-368f2f208b33",   "versionId": null
    "representatives": [   },
        "applicationId": "aea305f55d2567dc-61231e4e-4f1f44bc-a266a651-535955e2584d7f330a80bd23",
        "legalEntity": {
    "e118640c-7e5d-471d-83e7-8cfc43504a03"         ],"name": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
            "status": "Approved",code": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        "statusReason": null},
        "statusDescriptionverificationFormId": null,
        "lastStatusChangedUtcidentityVerificationId": "2022-12-14T16:38:01.53"
a586a568-b464-420f-a7b3-368f2f208b33",
   },     "typerepresentatives": "KybIdentification.Approved"
}

...

Code Block
languagejson
{[
     "id": "cbc8f716-425e-4519-990a-584023f9c880",     "applicationId": "5d2567dcaea305f5-1e4e6123-44bc4f1f-a651a266-7f330a80bd23535955e2584d",
    "createdUtc": "2022-12-14T16:23:50.0805263Z",
      "deliveredUtc": "2022-12-14T16:40:31.7492473Z",     "isDelivered": true,e118640c-7e5d-471d-83e7-8cfc43504a03"
       "payload": { ],
        "idstatus": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1Rejected",
        "createdUtcstatusReason": "2022-12-13T15:55:45.983DataNotMatch",
        "setupstatusDescription": {
   null,
        "idlastStatusChangedUtc": null,"2022-12-14T16:23:50.033"
       },
    "versionIdtype": null
 "KybIdentification.Rejected"
}

...

4️⃣ KybIdentification.Document.Created

Code Block
languagejson
{
      },
   "id": "696ec22d-304a-412a-b719-6eeca663e5fe",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",

       "legalEntitycreatedUtc": {
       "2022-12-12T10:12:59.4204Z",
    "namepayload": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
   {
        "codeid": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        }701ded06-f832-45f3-9a66-4378d0ba55ed",
        "verificationFormIdapplicationId": null"5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "identityVerificationIdidentificationId": "a586a568eccae495-b46446fb-420f4f2c-a7b39eba-368f2f208b33863f5f407fb0",
        "representativescreatedUtc": [
            "aea305f5-6123-4f1f-a266-535955e2584d"2022-12-12T10:12:59.4121043Z",
           "lastActionUtc": "e118640c2022-7e5d-471d-83e7-8cfc43504a03"12-12T10:12:59.4121045Z",
        "lastStatusChangedUtc": ]null,
        "statusfileId": "Rejected"null,
        "statusReasonstatus": "DataNotMatchNeedReview",
        "statusDescriptionpurpose": null"ExternalRegistry",
        "lastStatusChangedUtctitle": "2022-12-14T16:23:50.033SkyNet.pdf"
    },
    "type": "KybIdentification.Rejected"
}

...

 "KybIdentification.Document.

...

Created"
}

...

5️⃣ KybIdentification.Document.Deleted

Code Block
languagejson
{
    "id": "29cbf14a-9baf-40a1-ba05-e9cf0ed8dee7",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-12T10:15:08.4286841Z",
    "deliveredUtc": null,
    "isDelivered": false,
    "payload": {
        "id": "701ded06-f832-45f3-9a66-4378d0ba55ed",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "identificationId": "eccae495-46fb-4f2c-9eba-863f5f407fb0",
        "createdUtc": "2022-12-12T10:12:59.413",
        "lastActionUtc": "2022-12-12T10:13:00.57",
        "lastStatusChangedUtc": null,
        "fileId": "kybid-2aa9a9c735894ecdabd1451471a604aa",
        "status": "NeedReview",
        "purpose": "ExternalRegistry",
        "title": "SkyNet.pdf"
    },
    "type": "KybIdentification.Document.Deleted"
}

...

6️⃣ KybIdentification.Document.Updated

Code Block
languagejson
{
    "id": "21e2e190-bc8b-43ef-914f-3c8ab630d2fa",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-13T09:46:15.6314497Z",
    "deliveredUtc": null,
    "isDelivered": false,
    "payload": {
        "id": "ef0dbfa6-5533-4463-a4a8-493aeff7d942",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "identificationId": "53953073-3acb-4062-bb34-e2830b01d86d",
        "createdUtc": "2022-12-11T09:49:49.35",
        "lastActionUtc": "2022-12-13T09:46:15.58",
        "lastStatusChangedUtc": "2022-12-13T09:46:15.577",
        "fileId": "kybid-f1126a9b929d4bd2ba1249058140eb52",
        "status": "Invalidated",
        "purpose": "ExternalRegistry",
        "title": "backend (19).txt"
    },
    "type": "KybIdentification.Document.Updated"
}

...

7️⃣ KybIdentification.Document.Uploaded

...

Code Block
languagejson
{
    "id": "5d9a674a-1d28-45f1-a7fd-cfe920bbdf21",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-12T12:59:33.146706Z",
    "deliveredUtc": "2022-12-12T13:46:17.6066882Z",
    "isDelivered": true,
    "payload": {
        "id": "dd8e3b9e-bece-4b79-8c0d-e74412c19067",
        "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "identificationId": "85edabe9-3902-483a-9533-f5d48a842d42",
        "createdUtc": "2022-12-12T12:59:32.303",
        "lastActionUtc": "2022-12-12T12:59:33.123",
        "lastStatusChangedUtc": null,
        "fileId": "kybid-29b125e08eb8410ea9234de3371f665a",
        "status": "NeedReview",
        "purpose": "ExternalRegistry",
        "title": "SkyNet.pdf"
    },
    "type": "KybIdentification.Document.Uploaded"
}

...