Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

KYC

...

Webhooks Examples

Anchor
KycIdentification.Created
KycIdentification.Created
KycIdentification.Created

...

Anchor
KycIdentification.Updated
KycIdentification.Updated
KycIdentification.Updated

Code Block
languagejson
{
  "Id": "a59c2055-7655-43bb-923d-0005928301d7",
  "ApplicationId": "8921c61b-a5c0-4f1f-9d44-5a83009a29b1",
  "CreatedUtc": "2023-02-16T14:46:33.1467591Z",
  "DeliveredUtc": "2023-02-16T14:46:34.2869411Z",
  "IsDelivered": true,
  "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"
}

Anchor
KycIdentification.Rejected
KycIdentification.Rejected
KycIdentification.Rejected

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"
}

IDV Webhooks Examples

Anchor
IdentityVerification.Consented
IdentityVerification.Consented
IdentityVerification.Consented

Code Block
languagejson
{
  "Id": "e4df532d-a448-43b2-a875-031475695cf2",
  "ApplicationId": "a2af2fd1-60aa-4549-ab2e-e6294385af62",
  "CreatedUtc": "2023-02-21T07:47:06.196653Z",
  "DeliveredUtc": "2023-02-21T07:47:06.3234729Z",
  "IsDelivered": true,
  "Payload": {
    "Id": "6c14b207-f73f-4a85-9e38-bbfb5ca62858",
    "Status": "InProgress",
    "ApplicationId": "a2af2fd1-60aa-4549-ab2e-e6294385af62",
    "CreatedUtc": "2023-02-21T07:46:57.862Z",
    "ModifiedUtc": "2023-02-21T07:47:06.14Z",
    "Setup": {
      "Id": "27820208-e4d0-4841-bacf-93e6e709637b",
      "VersionId": "7cd83758-bc5f-4aa0-97cc-d7f3fa177dca"
    },
    "Step": {
      "DocumentSignatures": [],
      "Forms": [],
      "Consent": {
        "IsConsented": true,
        "ConsentedUtc": "2023-02-21T07:47:06.14Z"
      }
    }
  },
  "Type": "IdentityVerification.Consented"
}