1 of 1

Open API

Introduction

This section provides descriptions and guidelines for making requests to our Public API. All data transmitted via our Public API is encrypted to ensure security. For more information on encryption and how to handle encrypted data, please visit the Encryption page.

You can find full description of API here [Gateway API]

Open API

Introduction

You can find full description of API here [Gateway API]

Get media file by transactionId. It returns a stream

GET/api/public/file/{baseDir}/{fileType}/{transactionId}/{path}

Path parameters

fileType*string

path*string

transactionId*string

baseDir*string

Header parameters

x-private-app-key*string

Private app key

Response

Body

Readable (object)

Request

Response

Create new applicant

POST/api/public/applicant

Header parameters

x-private-app-key*string

Private app key

Body

externalUserId*string

A unique applicant identifies on the client side

flowName*string

A flow name

phonestring

An applicant phone number.

emailstring

An applicant email address.

langstring

The language, in which the verification results should be displayed to applicants.

suppliedInfoobject

Used to compare the data that you provide to us with that we extract from the applicant documents.

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantDetailsInfoEntity (object)

id*string

Applicant identifier

externalUserId*string

external applicant identifier

status*enum

current review status

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

updatedAt*string

last updated date

createdAt*string

applicant created date

phonestring

applicant phone

emailstring

applicant email

langstring

applicant lang

dateOfBirthstring

applicant date Of birth

ip*string

User ip

countrystring

User country code ISO-3166-1

regionstring

User country region ISO 3166-2

timezonestring

User timezone from IANA Time Zone Database

citystring

User city

imagestring

applicant photo

fullNamestring

applicant full name

clientKey*string

Client Key

flowId*number

applicant flow

review*all of

status of review

idstring

Review ID

version*number

Version of Review

status*enum

status of review

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

createdAtstring (date-time)

Review create date

updatedAtstring (date-time)

Review update date

commentstring

Reviewer comment

warningsstring

System warnings

detailsstring

Details about status of review

reviewerIdnumber

Reviewer id

reviewerFullNamestring

Reviewer Full Name

servicesDataarray of ApplicantServicesInfoEntity (object)

Applicant services

data*one of

Service data

id*number

Document ID

stepType*enum

Document step type

DOCUMENT_CAPTUREDOCUMENT_RFID_CAPTUREBARCODE_CAPTURECREDIT_CARD_CAPTURE

overallResult*enum

Document status

012

elapsedTime*number

Document processing time in ms

elapsedTimeRFIDnumber

Document rfid processing time in ms

uploadedPagesCount*number

Document pages uploaded

createdAt*string (date-time)

Document create date

types*array of DocumentTypeEntity (object)

Document types data

id*number

Document type ID

docId*number

Document ID

name*string

Document type name

pageIndex*number

Document page index

hasMRZ*boolean

Document MRZ availability

icao*string

Document ICAO

type*number

Document type

year*string

Document year

format*enum

Document format

012510001002

createdAt*string (date-time)

Document create date

graphics*array of DocumentGraphicInfoEntity (object)

Document graphics data

fieldType*number

Document graphic type

data*array of DocumentGraphicEntity (object)

Document graphic data

id*number

Document graphic ID

docId*number

Document ID

fieldType*enum

Document graphic type

201202203204205206207209210211212250300301302303304305306307308309

sourceType*enum

Document graphic sourceType

-101235678910151617181920232425262728293047851001011021031041056261

containerType*enum

Document graphic containerType

-101235678910151617181920232425262728293047851001011021031041056261

pageIndex*number

Document page index

image*string

Document graphic url

createdAt*string (date-time)

Document graphic create date

fields*array of DocumentFieldInfoEntity (object)

Document fields data

fieldType*number

Document field type

data*array of DocumentFieldEntity (object)

Document field data

id*number

Document field ID

docId*number

Document ID

fieldType*enum

Document field type

0123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200220221251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625

lcid*enum

Document field LCID

010781052512115361307320491126513313122894097614581931638510251024171691433792171067209210681069105910261027307651242052410010281050102910301125206710433081102494105922561538201512913321717711273205710331229710611080106510352060308410365132615641081071111010793079103151274103205510321095103710811038103910571040206410411099108711111042108810621063108621101102110410442068104510462070109410471048104911033098207410511060112741639413322922651307178122981741841061844220581946661541537010250204901034308214346820210891053207711141097109210981054105510641090105810562115109110665000150002

status*enum

Document field status

012

pageIndex*number

Document page index

probability*number

Document field value recognition probability

validity*enum

Document field value validity enum

01234

value*string

Document field obtained value

sourceType*enum

Document field value sourceType enum

-101235678910151617181920232425262728293047851001011021031041056261

comparison*object

Document field value comparison

createdAt*string (date-time)

Document field create date

service*enum

Service type

DOCUMENT_CAPTURECLEAN_DOCUMENT_CAPTUREBARCODE_CAPTURECREDIT_CARD_CAPTURERFID_DOCUMENT_CAPTURESPECIFIC_DOCUMENT_CAPTURESELFIE_CAPTUREFACE_CAPTUREFACE_MATCHFACE_LIVENESSPASSIVE_LIVENESSPASSIVE_FACE_MATCHSIGNATUREOTP_VERIFICATIONUTILITY_BILLDIIAQUESTIONNAIREAMLAML_MONITORING

status*enum

Service status

REJECTEDACCEPTED

type*enum

Flow type

ON_DEMANDREGULAR

applications*all of

status of review

appKey*string

Application key

flow*all of

Applicant Flow

name*string

Flow name

id*number

Flow id

type*enum

Flow type

ON_DEMANDREGULAR

services*array of enum

Flow services

itemsenum

amlMonitoring*all of

Applicant Aml Monitoring Setting

id*number

The unique identifier for the applicant AML monitoring entity

applicantId*string

The unique identifier for the applicant

externalId*string

The external identifier for the applicant AML monitoring entity

period*enum

The periodicity of the AML monitoring

DAILYWEEKLYMONTHLYQUARTERLYHALF_EARLYYEARLY

isActive*boolean

Indicates whether the applicant AML monitoring entity is active

purchased*boolean

Indicates whether the AML monitoring has been purchased

createdAt*string (date-time)

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

updatedAt*string (date-time)

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

device*one of

Device data

sdkVersion*string

SDK version

ip*string

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

llarray of number

The latitude and longitude of the city

itemsnumber

areanumber

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

userAgent*string

Browser user agent

browserType*string

Browser type

browserVersion*string

Browser version

Request

const response = await fetch('/api/public/applicant', {
    method: 'POST',
    headers: {
      "x-private-app-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "externalUserId": "text",
      "flowName": "text"
    }),
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "externalUserId": "text",
    "status": "INIT",
    "updatedAt": "text",
    "createdAt": "text",
    "phone": "text",
    "email": "text",
    "lang": "text",
    "dateOfBirth": "text",
    "ip": "text",
    "country": "text",
    "region": "text",
    "timezone": "text",
    "city": "text",
    "image": "text",
    "fullName": "text",
    "clientKey": "text",
    "flowId": 0,
    "review": {
      "id": "text",
      "version": 0,
      "status": "INIT",
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z",
      "comment": "text",
      "warnings": "text",
      "details": "text",
      "reviewerId": 0,
      "reviewerFullName": "text"
    },
    "servicesData": [
      {
        "data": {
          "id": 0,
          "stepType": "DOCUMENT_CAPTURE",
          "overallResult": 0,
          "elapsedTime": 0,
          "elapsedTimeRFID": 0,
          "uploadedPagesCount": 0,
          "createdAt": "2024-11-21T09:08:05.246Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T09:08:05.246Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ],
          "fields": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 0,
                  "lcid": 0,
                  "status": 0,
                  "pageIndex": 0,
                  "probability": 0,
                  "validity": 0,
                  "value": "text",
                  "sourceType": -1,
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ]
        },
        "service": "DOCUMENT_CAPTURE",
        "status": "REJECTED",
        "type": "ON_DEMAND"
      }
    ],
    "applications": {
      "appKey": "text"
    },
    "flow": {
      "name": "text",
      "id": 0,
      "type": "ON_DEMAND",
      "services": [
        "DOCUMENT_CAPTURE"
      ]
    },
    "amlMonitoring": {
      "id": 0,
      "applicantId": "text",
      "externalId": "text",
      "period": "DAILY",
      "isActive": false,
      "purchased": false,
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z"
    },
    "device": {
      "sdkVersion": "text",
      "ip": "text",
      "country": "text",
      "region": "text",
      "eu": "text",
      "timezone": "text",
      "city": "text",
      "metro": 0,
      "ll": [
        0
      ],
      "area": 0,
      "userAgent": "text",
      "browserType": "text",
      "browserVersion": "text"
    }
  }
}

Get applicant by applicant id

GET/api/public/applicant/{applicantId}

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantDetailsInfoEntity (object)

id*string

Applicant identifier

externalUserId*string

external applicant identifier

status*enum

current review status

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

updatedAt*string

last updated date

createdAt*string

applicant created date

phonestring

applicant phone

emailstring

applicant email

langstring

applicant lang

dateOfBirthstring

applicant date Of birth

ip*string

User ip

countrystring

User country code ISO-3166-1

regionstring

User country region ISO 3166-2

timezonestring

User timezone from IANA Time Zone Database

citystring

User city

imagestring

applicant photo

fullNamestring

applicant full name

clientKey*string

Client Key

flowId*number

applicant flow

review*all of

status of review

idstring

Review ID

version*number

Version of Review

status*enum

status of review

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

createdAtstring (date-time)

Review create date

updatedAtstring (date-time)

Review update date

commentstring

Reviewer comment

warningsstring

System warnings

detailsstring

Details about status of review

reviewerIdnumber

Reviewer id

reviewerFullNamestring

Reviewer Full Name

servicesDataarray of ApplicantServicesInfoEntity (object)

Applicant services

data*one of

Service data

id*number

Document ID

stepType*enum

Document step type

DOCUMENT_CAPTUREDOCUMENT_RFID_CAPTUREBARCODE_CAPTURECREDIT_CARD_CAPTURE

overallResult*enum

Document status

012

elapsedTime*number

Document processing time in ms

elapsedTimeRFIDnumber

Document rfid processing time in ms

uploadedPagesCount*number

Document pages uploaded

createdAt*string (date-time)

Document create date

types*array of DocumentTypeEntity (object)

Document types data

id*number

Document type ID

docId*number

Document ID

name*string

Document type name

pageIndex*number

Document page index

hasMRZ*boolean

Document MRZ availability

icao*string

Document ICAO

type*number

Document type

year*string

Document year

format*enum

Document format

012510001002

createdAt*string (date-time)

Document create date

graphics*array of DocumentGraphicInfoEntity (object)

Document graphics data

fieldType*number

Document graphic type

data*array of DocumentGraphicEntity (object)

Document graphic data

id*number

Document graphic ID

docId*number

Document ID

fieldType*enum

Document graphic type

201202203204205206207209210211212250300301302303304305306307308309

sourceType*enum

Document graphic sourceType

-101235678910151617181920232425262728293047851001011021031041056261

containerType*enum

Document graphic containerType

-101235678910151617181920232425262728293047851001011021031041056261

pageIndex*number

Document page index

image*string

Document graphic url

createdAt*string (date-time)

Document graphic create date

fields*array of DocumentFieldInfoEntity (object)

Document fields data

fieldType*number

Document field type

data*array of DocumentFieldEntity (object)

Document field data

id*number

Document field ID

docId*number

Document ID

fieldType*enum

Document field type

lcid*enum

Document field LCID

status*enum

Document field status

012

pageIndex*number

Document page index

probability*number

Document field value recognition probability

validity*enum

Document field value validity enum

01234

value*string

Document field obtained value

sourceType*enum

Document field value sourceType enum

-101235678910151617181920232425262728293047851001011021031041056261

comparison*object

Document field value comparison

createdAt*string (date-time)

Document field create date

service*enum

Service type

status*enum

Service status

REJECTEDACCEPTED

type*enum

Flow type

ON_DEMANDREGULAR

applications*all of

status of review

appKey*string

Application key

flow*all of

Applicant Flow

name*string

Flow name

id*number

Flow id

type*enum

Flow type

ON_DEMANDREGULAR

services*array of enum

Flow services

itemsenum

amlMonitoring*all of

Applicant Aml Monitoring Setting

id*number

The unique identifier for the applicant AML monitoring entity

applicantId*string

The unique identifier for the applicant

externalId*string

The external identifier for the applicant AML monitoring entity

period*enum

The periodicity of the AML monitoring

DAILYWEEKLYMONTHLYQUARTERLYHALF_EARLYYEARLY

isActive*boolean

Indicates whether the applicant AML monitoring entity is active

purchased*boolean

Indicates whether the AML monitoring has been purchased

createdAt*string (date-time)

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

updatedAt*string (date-time)

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

device*one of

Device data

sdkVersion*string

SDK version

ip*string

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

llarray of number

The latitude and longitude of the city

itemsnumber

areanumber

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

userAgent*string

Browser user agent

browserType*string

Browser type

browserVersion*string

Browser version

Request

const response = await fetch('/api/public/applicant/{applicantId}', {
    method: 'GET',
    headers: {
      "x-private-app-key": "text"
    },
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "externalUserId": "text",
    "status": "INIT",
    "updatedAt": "text",
    "createdAt": "text",
    "phone": "text",
    "email": "text",
    "lang": "text",
    "dateOfBirth": "text",
    "ip": "text",
    "country": "text",
    "region": "text",
    "timezone": "text",
    "city": "text",
    "image": "text",
    "fullName": "text",
    "clientKey": "text",
    "flowId": 0,
    "review": {
      "id": "text",
      "version": 0,
      "status": "INIT",
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z",
      "comment": "text",
      "warnings": "text",
      "details": "text",
      "reviewerId": 0,
      "reviewerFullName": "text"
    },
    "servicesData": [
      {
        "data": {
          "id": 0,
          "stepType": "DOCUMENT_CAPTURE",
          "overallResult": 0,
          "elapsedTime": 0,
          "elapsedTimeRFID": 0,
          "uploadedPagesCount": 0,
          "createdAt": "2024-11-21T09:08:05.246Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T09:08:05.246Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ],
          "fields": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 0,
                  "lcid": 0,
                  "status": 0,
                  "pageIndex": 0,
                  "probability": 0,
                  "validity": 0,
                  "value": "text",
                  "sourceType": -1,
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ]
        },
        "service": "DOCUMENT_CAPTURE",
        "status": "REJECTED",
        "type": "ON_DEMAND"
      }
    ],
    "applications": {
      "appKey": "text"
    },
    "flow": {
      "name": "text",
      "id": 0,
      "type": "ON_DEMAND",
      "services": [
        "DOCUMENT_CAPTURE"
      ]
    },
    "amlMonitoring": {
      "id": 0,
      "applicantId": "text",
      "externalId": "text",
      "period": "DAILY",
      "isActive": false,
      "purchased": false,
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z"
    },
    "device": {
      "sdkVersion": "text",
      "ip": "text",
      "country": "text",
      "region": "text",
      "eu": "text",
      "timezone": "text",
      "city": "text",
      "metro": 0,
      "ll": [
        0
      ],
      "area": 0,
      "userAgent": "text",
      "browserType": "text",
      "browserVersion": "text"
    }
  }
}

Delete applicant by applicant id

DELETE/api/public/applicant/{applicantId}

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataBoolean (object)

Request

const response = await fetch('/api/public/applicant/{applicantId}', {
    method: 'DELETE',
    headers: {
      "x-private-app-key": "text"
    },
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {}
}

Get applicant status by applicant id

GET/api/public/applicant/{applicantId}/status

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantStatusInfoEntity (object)

id*string

Applicant identifier

status*string

current review status

Request

const response = await fetch('/api/public/applicant/{applicantId}/status', {
    method: 'GET',
    headers: {
      "x-private-app-key": "text"
    },
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "status": "text"
  }
}

Update Applicant flow

POST/api/public/applicant/{applicantId}/moveToFlow

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Body

flowId*string

A flow id

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantStatusInfoEntity (object)

id*string

Applicant identifier

status*string

current review status

Request

const response = await fetch('/api/public/applicant/{applicantId}/moveToFlow', {
    method: 'POST',
    headers: {
      "x-private-app-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "flowId": "text"
    }),
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "status": "text"
  }
}

Create new verification token

POST/api/public/applicant/{applicantId}/token

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Body

localestring

ttl*number

flowName*string

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataBrowserVerificationToken (object)

transactionId*string

Browser verification uuid

accessToken*string

Browser verification access token

applicantId*string

Applicant uuid

Request

const response = await fetch('/api/public/applicant/{applicantId}/token', {
    method: 'POST',
    headers: {
      "x-private-app-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ttl": 0,
      "flowName": "text"
    }),
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "transactionId": "text",
    "accessToken": "text",
    "applicantId": "text"
  }
}

const response = await fetch('/api/public/file/{baseDir}/{fileType}/{transactionId}/{path}', {
    method: 'GET',
    headers: {
      "x-private-app-key": "text"
    },
});
const data = await response.json();

Get applicant by applicant id

GET/api/public/applicant/{applicantId}

Path parameters

applicantId*string

Applicant ID

Header parameters

x-private-app-key*string

Private app key

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantDetailsInfoEntity (object)

id*string

Applicant identifier

externalUserId*string

external applicant identifier

status*enum

current review status

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

updatedAt*string

last updated date

createdAt*string

applicant created date

phonestring

applicant phone

emailstring

applicant email

langstring

applicant lang

dateOfBirthstring

applicant date Of birth

ip*string

User ip

countrystring

User country code ISO-3166-1

regionstring

User country region ISO 3166-2

timezonestring

User timezone from IANA Time Zone Database

citystring

User city

imagestring

applicant photo

fullNamestring

applicant full name

clientKey*string

Client Key

flowId*number

applicant flow

review*all of

status of review

idstring

Review ID

version*number

Version of Review

status*enum

status of review

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

createdAtstring (date-time)

Review create date

updatedAtstring (date-time)

Review update date

commentstring

Reviewer comment

warningsstring

System warnings

detailsstring

Details about status of review

reviewerIdnumber

Reviewer id

reviewerFullNamestring

Reviewer Full Name

servicesDataarray of ApplicantServicesInfoEntity (object)

Applicant services

data*one of

Service data

id*number

Document ID

stepType*enum

Document step type

DOCUMENT_CAPTUREDOCUMENT_RFID_CAPTUREBARCODE_CAPTURECREDIT_CARD_CAPTURE

overallResult*enum

Document status

012

elapsedTime*number

Document processing time in ms

elapsedTimeRFIDnumber

Document rfid processing time in ms

uploadedPagesCount*number

Document pages uploaded

createdAt*string (date-time)

Document create date

types*array of DocumentTypeEntity (object)

Document types data

id*number

Document type ID

docId*number

Document ID

name*string

Document type name

pageIndex*number

Document page index

hasMRZ*boolean

Document MRZ availability

icao*string

Document ICAO

type*number

Document type

year*string

Document year

format*enum

Document format

012510001002

createdAt*string (date-time)

Document create date

graphics*array of DocumentGraphicInfoEntity (object)

Document graphics data

fieldType*number

Document graphic type

data*array of DocumentGraphicEntity (object)

Document graphic data

id*number

Document graphic ID

docId*number

Document ID

fieldType*enum

Document graphic type

201202203204205206207209210211212250300301302303304305306307308309

sourceType*enum

Document graphic sourceType

-101235678910151617181920232425262728293047851001011021031041056261

containerType*enum

Document graphic containerType

-101235678910151617181920232425262728293047851001011021031041056261

pageIndex*number

Document page index

image*string

Document graphic url

createdAt*string (date-time)

Document graphic create date

fields*array of DocumentFieldInfoEntity (object)

Document fields data

fieldType*number

Document field type

data*array of DocumentFieldEntity (object)

Document field data

id*number

Document field ID

docId*number

Document ID

fieldType*enum

Document field type

lcid*enum

Document field LCID

status*enum

Document field status

012

pageIndex*number

Document page index

probability*number

Document field value recognition probability

validity*enum

Document field value validity enum

01234

value*string

Document field obtained value

sourceType*enum

Document field value sourceType enum

-101235678910151617181920232425262728293047851001011021031041056261

comparison*object

Document field value comparison

createdAt*string (date-time)

Document field create date

service*enum

Service type

status*enum

Service status

REJECTEDACCEPTED

type*enum

Flow type

ON_DEMANDREGULAR

applications*all of

status of review

appKey*string

Application key

flow*all of

Applicant Flow

name*string

Flow name

id*number

Flow id

type*enum

Flow type

ON_DEMANDREGULAR

services*array of enum

Flow services

itemsenum

amlMonitoring*all of

Applicant Aml Monitoring Setting

id*number

The unique identifier for the applicant AML monitoring entity

applicantId*string

The unique identifier for the applicant

externalId*string

The external identifier for the applicant AML monitoring entity

period*enum

The periodicity of the AML monitoring

DAILYWEEKLYMONTHLYQUARTERLYHALF_EARLYYEARLY

isActive*boolean

Indicates whether the applicant AML monitoring entity is active

purchased*boolean

Indicates whether the AML monitoring has been purchased

createdAt*string (date-time)

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

updatedAt*string (date-time)

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

device*one of

Device data

sdkVersion*string

SDK version

ip*string

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

llarray of number

The latitude and longitude of the city

itemsnumber

areanumber

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

userAgent*string

Browser user agent

browserType*string

Browser type

browserVersion*string

Browser version

Request

const response = await fetch('/api/public/applicant/{applicantId}', {
    method: 'GET',
    headers: {
      "x-private-app-key": "text"
    },
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "externalUserId": "text",
    "status": "INIT",
    "updatedAt": "text",
    "createdAt": "text",
    "phone": "text",
    "email": "text",
    "lang": "text",
    "dateOfBirth": "text",
    "ip": "text",
    "country": "text",
    "region": "text",
    "timezone": "text",
    "city": "text",
    "image": "text",
    "fullName": "text",
    "clientKey": "text",
    "flowId": 0,
    "review": {
      "id": "text",
      "version": 0,
      "status": "INIT",
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z",
      "comment": "text",
      "warnings": "text",
      "details": "text",
      "reviewerId": 0,
      "reviewerFullName": "text"
    },
    "servicesData": [
      {
        "data": {
          "id": 0,
          "stepType": "DOCUMENT_CAPTURE",
          "overallResult": 0,
          "elapsedTime": 0,
          "elapsedTimeRFID": 0,
          "uploadedPagesCount": 0,
          "createdAt": "2024-11-21T09:08:05.246Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T09:08:05.246Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ],
          "fields": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 0,
                  "lcid": 0,
                  "status": 0,
                  "pageIndex": 0,
                  "probability": 0,
                  "validity": 0,
                  "value": "text",
                  "sourceType": -1,
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ]
        },
        "service": "DOCUMENT_CAPTURE",
        "status": "REJECTED",
        "type": "ON_DEMAND"
      }
    ],
    "applications": {
      "appKey": "text"
    },
    "flow": {
      "name": "text",
      "id": 0,
      "type": "ON_DEMAND",
      "services": [
        "DOCUMENT_CAPTURE"
      ]
    },
    "amlMonitoring": {
      "id": 0,
      "applicantId": "text",
      "externalId": "text",
      "period": "DAILY",
      "isActive": false,
      "purchased": false,
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z"
    },
    "device": {
      "sdkVersion": "text",
      "ip": "text",
      "country": "text",
      "region": "text",
      "eu": "text",
      "timezone": "text",
      "city": "text",
      "metro": 0,
      "ll": [
        0
      ],
      "area": 0,
      "userAgent": "text",
      "browserType": "text",
      "browserVersion": "text"
    }
  }
}

Create new applicant

POST/api/public/applicant

Header parameters

x-private-app-key*string

Private app key

Body

externalUserId*string

A unique applicant identifies on the client side

flowName*string

A flow name

phonestring

An applicant phone number.

emailstring

An applicant email address.

langstring

The language, in which the verification results should be displayed to applicants.

suppliedInfoobject

Used to compare the data that you provide to us with that we extract from the applicant documents.

Response

Body

status*boolean

statusCode*number

Example: 200

data*object

time*string

Example: "2021-08-20T14:52:33.648Z"

dataApplicantDetailsInfoEntity (object)

id*string

Applicant identifier

externalUserId*string

external applicant identifier

status*enum

current review status

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

updatedAt*string

last updated date

createdAt*string

applicant created date

phonestring

applicant phone

emailstring

applicant email

langstring

applicant lang

dateOfBirthstring

applicant date Of birth

ip*string

User ip

countrystring

User country code ISO-3166-1

regionstring

User country region ISO 3166-2

timezonestring

User timezone from IANA Time Zone Database

citystring

User city

imagestring

applicant photo

fullNamestring

applicant full name

clientKey*string

Client Key

flowId*number

applicant flow

review*all of

status of review

idstring

Review ID

version*number

Version of Review

status*enum

status of review

INITIN_PROGRESSINCOMPLETEIN_REVIEWREJECTEDAPPROVEDCOMPLETEDON_HOLD

createdAtstring (date-time)

Review create date

updatedAtstring (date-time)

Review update date

commentstring

Reviewer comment

warningsstring

System warnings

detailsstring

Details about status of review

reviewerIdnumber

Reviewer id

reviewerFullNamestring

Reviewer Full Name

servicesDataarray of ApplicantServicesInfoEntity (object)

Applicant services

data*one of

Service data

id*number

Document ID

stepType*enum

Document step type

DOCUMENT_CAPTUREDOCUMENT_RFID_CAPTUREBARCODE_CAPTURECREDIT_CARD_CAPTURE

overallResult*enum

Document status

012

elapsedTime*number

Document processing time in ms

elapsedTimeRFIDnumber

Document rfid processing time in ms

uploadedPagesCount*number

Document pages uploaded

createdAt*string (date-time)

Document create date

types*array of DocumentTypeEntity (object)

Document types data

id*number

Document type ID

docId*number

Document ID

name*string

Document type name

pageIndex*number

Document page index

hasMRZ*boolean

Document MRZ availability

icao*string

Document ICAO

type*number

Document type

year*string

Document year

format*enum

Document format

012510001002

createdAt*string (date-time)

Document create date

graphics*array of DocumentGraphicInfoEntity (object)

Document graphics data

fieldType*number

Document graphic type

data*array of DocumentGraphicEntity (object)

Document graphic data

id*number

Document graphic ID

docId*number

Document ID

fieldType*enum

Document graphic type

201202203204205206207209210211212250300301302303304305306307308309

sourceType*enum

Document graphic sourceType

-101235678910151617181920232425262728293047851001011021031041056261

containerType*enum

Document graphic containerType

-101235678910151617181920232425262728293047851001011021031041056261

pageIndex*number

Document page index

image*string

Document graphic url

createdAt*string (date-time)

Document graphic create date

fields*array of DocumentFieldInfoEntity (object)

Document fields data

fieldType*number

Document field type

data*array of DocumentFieldEntity (object)

Document field data

id*number

Document field ID

docId*number

Document ID

fieldType*enum

Document field type

lcid*enum

Document field LCID

status*enum

Document field status

012

pageIndex*number

Document page index

probability*number

Document field value recognition probability

validity*enum

Document field value validity enum

01234

value*string

Document field obtained value

sourceType*enum

Document field value sourceType enum

-101235678910151617181920232425262728293047851001011021031041056261

comparison*object

Document field value comparison

createdAt*string (date-time)

Document field create date

service*enum

Service type

status*enum

Service status

REJECTEDACCEPTED

type*enum

Flow type

ON_DEMANDREGULAR

applications*all of

status of review

appKey*string

Application key

flow*all of

Applicant Flow

name*string

Flow name

id*number

Flow id

type*enum

Flow type

ON_DEMANDREGULAR

services*array of enum

Flow services

itemsenum

amlMonitoring*all of

Applicant Aml Monitoring Setting

id*number

The unique identifier for the applicant AML monitoring entity

applicantId*string

The unique identifier for the applicant

externalId*string

The external identifier for the applicant AML monitoring entity

period*enum

The periodicity of the AML monitoring

DAILYWEEKLYMONTHLYQUARTERLYHALF_EARLYYEARLY

isActive*boolean

Indicates whether the applicant AML monitoring entity is active

purchased*boolean

Indicates whether the AML monitoring has been purchased

createdAt*string (date-time)

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

updatedAt*string (date-time)

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

device*one of

Device data

sdkVersion*string

SDK version

ip*string

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

llarray of number

The latitude and longitude of the city

itemsnumber

areanumber

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

userAgent*string

Browser user agent

browserType*string

Browser type

browserVersion*string

Browser version

Request

const response = await fetch('/api/public/applicant', {
    method: 'POST',
    headers: {
      "x-private-app-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "externalUserId": "text",
      "flowName": "text"
    }),
});
const data = await response.json();

Response

{
  "status": false,
  "statusCode": 200,
  "time": "2021-08-20T14:52:33.648Z",
  "data": {
    "id": "text",
    "externalUserId": "text",
    "status": "INIT",
    "updatedAt": "text",
    "createdAt": "text",
    "phone": "text",
    "email": "text",
    "lang": "text",
    "dateOfBirth": "text",
    "ip": "text",
    "country": "text",
    "region": "text",
    "timezone": "text",
    "city": "text",
    "image": "text",
    "fullName": "text",
    "clientKey": "text",
    "flowId": 0,
    "review": {
      "id": "text",
      "version": 0,
      "status": "INIT",
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z",
      "comment": "text",
      "warnings": "text",
      "details": "text",
      "reviewerId": 0,
      "reviewerFullName": "text"
    },
    "servicesData": [
      {
        "data": {
          "id": 0,
          "stepType": "DOCUMENT_CAPTURE",
          "overallResult": 0,
          "elapsedTime": 0,
          "elapsedTimeRFID": 0,
          "uploadedPagesCount": 0,
          "createdAt": "2024-11-21T09:08:05.246Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T09:08:05.246Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ],
          "fields": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 0,
                  "lcid": 0,
                  "status": 0,
                  "pageIndex": 0,
                  "probability": 0,
                  "validity": 0,
                  "value": "text",
                  "sourceType": -1,
                  "createdAt": "2024-11-21T09:08:05.246Z"
                }
              ]
            }
          ]
        },
        "service": "DOCUMENT_CAPTURE",
        "status": "REJECTED",
        "type": "ON_DEMAND"
      }
    ],
    "applications": {
      "appKey": "text"
    },
    "flow": {
      "name": "text",
      "id": 0,
      "type": "ON_DEMAND",
      "services": [
        "DOCUMENT_CAPTURE"
      ]
    },
    "amlMonitoring": {
      "id": 0,
      "applicantId": "text",
      "externalId": "text",
      "period": "DAILY",
      "isActive": false,
      "purchased": false,
      "createdAt": "2024-11-21T09:08:05.246Z",
      "updatedAt": "2024-11-21T09:08:05.246Z"
    },
    "device": {
      "sdkVersion": "text",
      "ip": "text",
      "country": "text",
      "region": "text",
      "eu": "text",
      "timezone": "text",
      "city": "text",
      "metro": 0,
      "ll": [
        0
      ],
      "area": 0,
      "userAgent": "text",
      "browserType": "text",
      "browserVersion": "text"
    }
  }
}