ApplicantDetailsInfoEntity

idstringrequired

Unique identifier for the applicant record, assigned by the system.

externalUserIdstringrequired

An external identifier for the applicant, used for integrations and cross-referencing with external systems.

statusstringrequired

Current review status of the applicant, indicating the progress and outcome of the verification process.

Possible values: [INIT, IN_PROGRESS, INCOMPLETE, REJECTED, APPROVED, COMPLETED, ON_HOLD]

updatedAtstringrequired

Timestamp marking the last time the applicant record was updated. (ISO 8601 format)

createdAtstringrequired

Timestamp indicating when the applicant record was created. (ISO 8601 format)

scheduledDeletionDatestring

Optional timestamp when the applicant is scheduled for deletion, if applicable. (ISO 8601 format)

phonestring

Optional contact phone number provided by the applicant.

emailstring

Optional email address provided by the applicant for communication.

langstring

Optional language preference specified by the applicant (e.g., "en", "es").

dateOfBirthstring

Applicant's date of birth. The format should adhere to a standard date format (e.g., YYYY-MM-DD).

ipstringrequired

IP address of the user during record creation or update.

countrystring

Optional ISO-3166-1 country code representing the applicant's country of residence or origin.

regionstring

Optional ISO 3166-2 code indicating the region or state within the applicant's country.

timezonestring

Optional IANA Time Zone identifier representing the applicant's time zone.

citystring

Optional name of the city associated with the applicant.

imagestring

Optional URL or reference to the applicant's photo, if provided.

fullNamestring

Optional full name of the applicant. This may be auto-populated or directly provided by the applicant.

fullNameSetByUserboolean

Boolean flag indicating whether the applicant's full name was explicitly set by the user.

clientKeystringrequired

Unique client key identifying the partner or client that submitted the applicant data.

flowIdnumberrequired

Identifier for the current applicant verification flow being processed.

review objectrequired

Detailed review entity containing status, comments, and other relevant verification information.

idstringrequired

Unique identifier for the review record.

versionnumberrequired

Revision number of the review, indicating the version of the review record.

statusstringrequired

Current status of the review, representing the outcome of the applicant verification process.

Possible values: [INIT, IN_PROGRESS, INCOMPLETE, REJECTED, APPROVED, COMPLETED, ON_HOLD]

createdAtstring<date-time>

Timestamp indicating when the review was created (ISO 8601 format).

updatedAtstring<date-time>

Timestamp indicating when the review was last updated (ISO 8601 format).

commentstring

Optional comment provided by the reviewer, offering additional context or feedback on the review.

holdDetailsobject

Why the applicant is on hold; meaningful only while status is ON_HOLD

warningsstring

list of verifiocations warnings associated with the review

detailsstring

Additional details and metadata regarding the review, such as warning specifics or duplicate applicant identifiers if applicable.

reviewerIdnumber

Unique identifier of the reviewer who conducted the review.

reviewerFullNamestring

Full name of the reviewer who conducted the review.

statusSetByIdnumber

Unique identifier of the decision maker who set the review status.

statusSetByNamestring

Full name of the decision maker who set the review status.

servicesData object[]

List of services data associated with the applicant

Array [

data objectrequired

Service data

oneOf

idstringrequired

Document ID

docTypenumberrequired

Document type

Possible values: [1, 2, 3, 4, 5, 6, 7]

deactivateAtstring<date-time>

Expiration date of the service

Example: 2023-01-01T00:00:00Z

stepTypestringrequired

Document step type

Possible values: [DOCUMENT_CAPTURE, DOCUMENT_RFID_CAPTURE, BARCODE_CAPTURE, CREDIT_CARD_CAPTURE]

overallResultnumberrequired

Document status

Possible values: [0, 1, 2]

checks objectnullable

Per-check results of the document recognition

docTypenumber

Document type check

Possible values: [0, 1, 2]

expirynumber

Expiration date check

Possible values: [0, 1, 2]

textnumber

Text fields check

Possible values: [0, 1, 2]

mrznumber

MRZ verification

Possible values: [0, 1, 2]

securitynumber

Security checks

Possible values: [0, 1, 2]

imageQAnumber

Image quality check

Possible values: [0, 1, 2]

portraitnumber

Portrait comparison

Possible values: [0, 1, 2]

rfidnumber

RFID check

Possible values: [0, 1, 2]

stopListnumber

Stop list check

Possible values: [0, 1, 2]

elapsedTimenumberrequired

Document processing time in ms

elapsedTimeRFIDnumber

Document rfid processing time in ms

uploadedPagesCountnumberrequired

Document pages uploaded

createdAtstring<date-time>required

Document create date

types object[]required

Document types data

Array [

idstringrequired

Document type ID

docIdstringrequired

Document ID

namestringrequired

Document type name

pageIndexnumberrequired

Document page index

hasMRZbooleanrequired

Document MRZ availability

icaostringrequired

Document ICAO

typenumberrequired

Document type

yearstringrequired

Document year

formatnumberrequired

Document format

Possible values: [0, 1, 2, 5, 1000, 1002]

createdAtstring<date-time>required

Document create date

]

graphics object[]required

Document graphics data

Array [

fieldTypenumberrequired

Document graphic type

data object[]required

Document graphic data

Array [

idstringrequired

Document graphic ID

docIdstringrequired

Document ID

fieldTypenumberrequired

Document graphic type

Possible values: [201, 202, 203, 204, 205, 206, 207, 209, 210, 211, 212, 250, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309]

sourceTypenumberrequired

Document graphic sourceType

Possible values: [-1, 0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 15, 16, 17, 18, 19, 20, 23, 24, 25, 26, 27, 28, 29, 30, 47, 85, 100, 101, 102, 103, 104, 105, 62, 61]

containerTypenumberrequired

Document graphic containerType

pageIndexnumberrequired

Document page index

imagestringrequired

Document graphic url

createdAtstring<date-time>required

Document graphic create date

]

fields object[]required

Document fields data

Array [

fieldTypenumberrequired

Document field type

data object[]required

Document field data

Array [

idstringrequired

Document field ID

docIdstringrequired

Document ID

fieldTypenumberrequired

Document field type

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 220, 221, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495, 496, 497, 498, 499, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 527, 528, 529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 565, 566, 567, 568, 569, 570, 571, 572, 573, 574, 575, 576, 577, 578, 579, 580, 581, 582, 583, 584, 585, 586, 587, 588, 589, 590, 591, 592, 593, 594, 595, 596, 597, 598, 599, 600, 601, 602, 603, 604, 605, 606, 607, 608, 609, 610, 611, 612, 613, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625]

lcidnumberrequired

Document field LCID

Possible values: [0, 1078, 1052, 5121, 15361, 3073, 2049, 11265, 13313, 12289, 4097, 6145, 8193, 16385, 1025, 10241, 7169, 14337, 9217, 1067, 2092, 1068, 1069, 1059, 1026, 1027, 3076, 5124, 2052, 4100, 1028, 1050, 1029, 1030, 1125, 2067, 1043, 3081, 10249, 4105, 9225, 6153, 8201, 5129, 13321, 7177, 11273, 2057, 1033, 12297, 1061, 1080, 1065, 1035, 2060, 3084, 1036, 5132, 6156, 4108, 1071, 1110, 1079, 3079, 1031, 5127, 4103, 2055, 1032, 1095, 1037, 1081, 1038, 1039, 1057, 1040, 2064, 1041, 1099, 1087, 1111, 1042, 1088, 1062, 1063, 1086, 2110, 1102, 1104, 1044, 2068, 1045, 1046, 2070, 1094, 1047, 1048, 1049, 1103, 3098, 2074, 1051, 1060, 11274, 16394, 13322, 9226, 5130, 7178, 12298, 17418, 4106, 18442, 2058, 19466, 6154, 15370, 10250, 20490, 1034, 3082, 14346, 8202, 1089, 1053, 2077, 1114, 1097, 1092, 1098, 1054, 1055, 1064, 1090, 1058, 1056, 2115, 1091, 1066, 50001, 50002]

statusnumberrequired

Document field status

Possible values: [0, 1, 2]

pageIndexnumberrequired

Document page index

probabilitynumberrequired

Document field value recognition probability

validitynumberrequired

Document field value validity enum

Possible values: [0, 1, 2, 3, 4]

valuestringrequired

Document field obtained value

sourceTypenumberrequired

Document field value sourceType enum

comparisonobjectrequired

Document field value comparison

createdAtstring<date-time>required

Document field create date

]

servicestringrequired

Service type

Possible values: [DOCUMENT_CAPTURE, CLEAN_DOCUMENT_CAPTURE, BARCODE_CAPTURE, CREDIT_CARD_CAPTURE, RFID_DOCUMENT_CAPTURE, SPECIFIC_DOCUMENT_CAPTURE, SELFIE_CAPTURE, FACE_CAPTURE, FACE_MATCH, FACE_LIVENESS, PASSIVE_LIVENESS, PASSIVE_FACE_MATCH, SIGNATURE, OTP_VERIFICATION, UTILITY_BILL, DIIA, QUESTIONNAIRE, AML, AML_MONITORING, AI_ASSISTANT_DOCUMENT, EMAIL_VERIFICATION, EMAIL_OTP_VERIFICATION, PHONE_VERIFICATION, PHONE_HLR_VERIFICATION, PHONE_SMS_OTP_VERIFICATION, PHONE_VOICE_OTP_VERIFICATION, ADDRESS_RISK_SCORE, TRANSACTION_RISK_SCORE, TRANSACTION_MONITORING, TRANSACTION_MONITORING_UPDATE, PROOF_OF_ADDRESS, PROOF_OF_ADDRESS_RECOGNITION, PROOF_OF_ADDRESS_MATCH, FACE_MATCH_UNIQUENESS]

statusstringrequired

Service status

Possible values: [REJECTED, ACCEPTED, FAILED , ON_HOLD]

typestringrequired

Flow type

Possible values: [ON_DEMAND, REGULAR]

deactivatedServiceCountnumberrequired

The number of services that have been deactivated

errorMessagestring

An optional error message describing any issues encountered.

holdobject

Present while status is ON_HOLD: which background check put the service on hold and why

reasonstring

An optional reason from aml officer

deactivateAtstring<date-time>

Expiration date of the service

Example: 2023-01-01T00:00:00Z

]

applications objectrequired

List of application records linked with applicant

appKeystringrequired

Application key

flow objectrequired

Object representing the applicant's verification flow, including stages and transitions in the KYC process.

namestringrequired

Flow name

idnumberrequired

Flow id

typestringrequired

Flow type

Possible values: [ON_DEMAND, REGULAR]

autoApprovebooleanrequired

Auto approve applicant

showQrCodebooleanrequired

Show QR code for applicant

referrerUrlstring

Referrer URL for allow url domain

uniqueFaceMatchbooleanrequired

Check applicant uniquenes

notifyApplicantOnDecisionbooleanrequired

When ON, we will automatically email the applicant whenever you set this case to On hold, Accepted, or Rejected.

servicesstring[]required

Flow services

amlMonitoring objectrequired

Object containing AML (Anti-Money Laundering) monitoring settings and results, ensuring compliance with regulatory standards.

idstringrequired

The unique identifier for the applicant AML monitoring entity

applicantIdstringrequired

The unique identifier for the applicant

externalIdstringrequired

The external identifier for the applicant AML monitoring entity

periodstringrequired

The periodicity of the AML monitoring

Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, HALF_EARLY, YEARLY]

isActivebooleanrequired

Indicates whether the applicant AML monitoring entity is active

createdAtstring<date-time>required

The date and time when the applicant AML monitoring entity was created

updatedAtstring<date-time>required

The date and time when the applicant AML monitoring entity was last updated

device objectrequired

Device data

oneOf

BrowserDeviceEntity
AndroidDeviceEntity
IosDeviceEntity

sdkVersionstringrequired

SDK version

ipstringrequired

User ip

countrystring

User country code ISO-3166-1

regionstring

User country region ISO 3166-2

eustring

Europe union flag

timezonestring

User timezone from IANA Time Zone Database

citystring

User city

metronumber

User city metro code

llnumber[]

The latitude and longitude of the city

areanumber

The approximate accuracy radius (km), around the latitude and longitude

userAgentstringrequired

Browser user agent

browserTypestringrequired

Browser type

browserVersionstringrequired

Browser version

ApplicantDetailsInfoEntity
{
  "id": "string",
  "externalUserId": "string",
  "status": "INIT",
  "updatedAt": "string",
  "createdAt": "string",
  "scheduledDeletionDate": "string",
  "phone": "string",
  "email": "string",
  "lang": "string",
  "dateOfBirth": "string",
  "ip": "string",
  "country": "string",
  "region": "string",
  "timezone": "string",
  "city": "string",
  "image": "string",
  "fullName": "string",
  "fullNameSetByUser": true,
  "clientKey": "string",
  "flowId": 0,
  "review": {
    "id": "string",
    "version": 0,
    "status": "INIT",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "comment": "string",
    "holdDetails": {},
    "warnings": "string",
    "details": "string",
    "reviewerId": 0,
    "reviewerFullName": "string",
    "statusSetById": 0,
    "statusSetByName": "string"
  },
  "servicesData": [
    {
      "data": {
        "id": "string",
        "docType": 1,
        "deactivateAt": "2023-01-01T00:00:00Z",
        "stepType": "DOCUMENT_CAPTURE",
        "overallResult": 0,
        "checks": {
          "docType": 0,
          "expiry": 0,
          "text": 0,
          "mrz": 0,
          "security": 0,
          "imageQA": 0,
          "portrait": 0,
          "rfid": 0,
          "stopList": 0
        },
        "elapsedTime": 0,
        "elapsedTimeRFID": 0,
        "uploadedPagesCount": 0,
        "createdAt": "2024-07-29T15:51:28.071Z",
        "types": [
          {
            "id": "string",
            "docId": "string",
            "name": "string",
            "pageIndex": 0,
            "hasMRZ": true,
            "icao": "string",
            "type": 0,
            "year": "string",
            "format": 0,
            "createdAt": "2024-07-29T15:51:28.071Z"
          }
        ],
        "graphics": [
          {
            "fieldType": 0,
            "data": [
              {
                "id": "string",
                "docId": "string",
                "fieldType": 201,
                "sourceType": -1,
                "containerType": -1,
                "pageIndex": 0,
                "image": "string",
                "createdAt": "2024-07-29T15:51:28.071Z"
              }
            ]
          }
        ],
        "fields": [
          {
            "fieldType": 0,
            "data": [
              {
                "id": "string",
                "docId": "string",
                "fieldType": 0,
                "lcid": 0,
                "status": 0,
                "pageIndex": 0,
                "probability": 0,
                "validity": 0,
                "value": "string",
                "sourceType": -1,
                "comparison": {},
                "createdAt": "2024-07-29T15:51:28.071Z"
              }
            ]
          }
        ]
      },
      "service": "DOCUMENT_CAPTURE",
      "status": "REJECTED",
      "type": "ON_DEMAND",
      "deactivatedServiceCount": 0,
      "errorMessage": "string",
      "hold": {},
      "reason": "string",
      "deactivateAt": "2023-01-01T00:00:00Z"
    }
  ],
  "applications": {
    "appKey": "string"
  },
  "flow": {
    "name": "string",
    "id": 0,
    "type": "ON_DEMAND",
    "autoApprove": true,
    "showQrCode": true,
    "referrerUrl": "string",
    "uniqueFaceMatch": true,
    "notifyApplicantOnDecision": true,
    "services": [
      "DOCUMENT_CAPTURE"
    ]
  },
  "amlMonitoring": {
    "id": "string",
    "applicantId": "string",
    "externalId": "string",
    "period": "DAILY",
    "isActive": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "device": {
    "sdkVersion": "string",
    "ip": "string",
    "country": "string",
    "region": "string",
    "eu": "string",
    "timezone": "string",
    "city": "string",
    "metro": 0,
    "ll": [
      0
    ],
    "area": 0,
    "userAgent": "string",
    "browserType": "string",
    "browserVersion": "string"
  }
}