Versions Compared

Key

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

Table of Contents
minLevel1
maxLevel7

IDV Webhooks Examples

Anchor
IdentityVerification.Consented
IdentityVerification.Consented
IdentityVerification.Consented

...

Code Block
languagejson
{
    "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": {
        "id": "832f67ab-0f6f-4a57-bfc2-83abb543bbd0",
        "applicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
        "createdUtc": "2023-02-15T15:09:57.944Z",
        "setup": {
            "id": "d4915b8c-f4a7-4e94-a2c3-16c68a1aee78",
            "versionId": "f3135842-d53c-4525-8118-be63a12641ba"
        },
        "identityVerificationId": "0458600b-f373-404d-8603-9fcc5c8d5d23",
        "status": "Rejected",
        "statusReason": "UnrelatedPhotoSubmit",
        "isCrossChecked": true,
        "document": {
            "type": "Passport",
            "mrzVerified": true,
            "files": [
                {
                    "createdUtc": "2023-02-15T15:09:59Z",
                    "fileId": "df72c1a0-cb92-43d5-9c32-f15ead7a6c83",
                    "fileName": "832f67ab0f6f4a57bfc283abb543bbd0_front_150958998.png",
                    "fileExtension": "png",
                    "part": "FrontCover",
                    "fileType": "DocumentPhoto"
                }
            ],
            "ocrValidations": [
                {
                    "key": "Address",
                    "isValid": true
                },
                {
                    "key": "Category",
                    "isValid": true
                },
                {
                    "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": 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-15T15:10:02Z"
    },
    "type": "KycIdentification.Rejected"
}

KYB Webhooks Examples

Anchor
KybIdentification.Created
KybIdentification.Created
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"
}

Anchor
KybIdentification.

...

Approved
KybIdentification.

...

Approved
KybIdentification.

...

Approved

Code Block
languagejson
{
    "id": "696ec22d54ec3990-304a4bfb-412a40d2-b71984c1-6eeca663e5fe080ba15be61f",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",
    "createdUtc": "2022-12-12T1014T16:1238:5901.4204Z6026518Z",
    "deliveredUtc": "2022-12-12T1414T16:5938:1002.1592004Z0542466Z",
    "isDelivered": true,
    "payload": {
        "id": "701ded06dc81eb25-f8328ccb-45f34ea9-9a669dde-4378d0ba55edc8b46e2f12d1",
        "applicationIdcreatedUtc": "5d2567dc2022-1e4e-44bc-a651-7f330a80bd2312-13T15:55:45.983",
        "identificationIdsetup": "eccae495-46fb-4f2c-9eba-863f5f407fb0", {
            "createdUtcid": "2022-12-12T10:12:59.4121043Z",null,
            "lastActionUtcversionId": "2022-12-12T10:12:59.4121045Z"null
        },
        "lastStatusChangedUtcapplicationId": null"5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "fileIdlegalEntity": {
   null,         "statusname": "NeedReview\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
            "purposecode": "ExternalRegistry"\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        },
        "titleverificationFormId": "SkyNet.pdf"
null,
   },     "typeidentityVerificationId": "KybIdentification.Document.Created"
}

...

Code Block
languagejson
{a586a568-b464-420f-a7b3-368f2f208b33",
        "idrepresentatives": [
            "54ec3990aea305f5-4bfb6123-40d24f1f-84c1a266-080ba15be61f535955e2584d",
         "applicationId":   "5d2567dce118640c-1e4e7e5d-44bc471d-a65183e7-7f330a80bd238cfc43504a03",
       "createdUtc": "2022-12-14T16:38:01.6026518Z", ],
        "deliveredUtcstatus": "2022-12-14T16:38:02.0542466ZApproved",

   "isDelivered": true,     "payloadstatusReason": {null,
        "idstatusDescription": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1"null,
        "createdUtclastStatusChangedUtc": "2022-12-13T1514T16:5538:4501.98353",
    },
    "setuptype": "KybIdentification.Approved"
{
       }

Anchor
KybIdentification.Rejected
KybIdentification.Rejected
KybIdentification.Rejected

Code Block
languagejson
{
    "id": null,
            "versionId": null
        },
   "cbc8f716-425e-4519-990a-584023f9c880",
    "applicationId": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",

       "legalEntitycreatedUtc": {
       "2022-12-14T16:23:50.0805263Z",
    "namedeliveredUtc": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e2022-12-14T16:40:31.7492473Z",
      "isDelivered": true,
     "codepayload": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e" {
         }"id": "dc81eb25-8ccb-4ea9-9dde-c8b46e2f12d1",
        "verificationFormIdcreatedUtc": null"2022-12-13T15:55:45.983",
        "identityVerificationIdsetup": "a586a568-b464-420f-a7b3-368f2f208b33", {
            "representativesid": [null,
            "aea305f5-6123-4f1f-a266-535955e2584d",
versionId": null
           "e118640c-7e5d-471d-83e7-8cfc43504a03"
        ]},
        "statusapplicationId": "Approved5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "statusReasonlegalEntity": {
   null,         "statusDescriptionname": null,"\u041e\u041e\u041e\u041e\u041e\u041e\u041e",
            "lastStatusChangedUtccode": "2022-12-14T16:38:01.53"\u041e\u041e\u041e\u041e\u041e\u041e\u041e"
        },
        "typeverificationFormId": "KybIdentification.Approved"
}

...

Code Block
languagejson
{ null,
        "ididentityVerificationId": "cbc8f716a586a568-425eb464-4519420f-990aa7b3-584023f9c880368f2f208b33",
        "applicationIdrepresentatives": "5d2567dc-1e4e-44bc-a651-7f330a80bd23",[
     "createdUtc": "2022-12-14T16:23:50.0805263Z",     "deliveredUtc": "2022-12-14T16:40:31.7492473Z",aea305f5-6123-4f1f-a266-535955e2584d",
            "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"
    },
    "type":   "versionIdKybIdentification.Rejected": null
}

Anchor
KybIdentification.Document.Created
KybIdentification.Document.Created
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",
            "name"deliveredUtc": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e2022-12-12T14:59:10.1592004Z",
       "isDelivered": true,
    "codepayload": "\u041e\u041e\u041e\u041e\u041e\u041e\u041e" {
         }"id": "701ded06-f832-45f3-9a66-4378d0ba55ed",
        "verificationFormIdapplicationId": null"5d2567dc-1e4e-44bc-a651-7f330a80bd23",
        "identityVerificationIdidentificationId": "a586a568eccae495-b46446fb-420f4f2c-a7b39eba-368f2f208b33863f5f407fb0",
        "representativescreatedUtc": [
            "aea305f52022-6123-4f1f-a266-535955e2584d12-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.RejectedDocument.Created"
}

Anchor
KybIdentification.Document.Deleted
KybIdentification.Document.Deleted
KybIdentification.Document.Deleted

...