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]

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

Response

200

Body

application/json

Readable (object)

Request

JavaScriptCurlPython

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

Response

200

{}

Create new applicant

POST/api/public/applicant

Header parameters

Body

application/json

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

201

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataApplicantDetailsInfoEntity (object)

Request

JavaScriptCurlPython

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

201

{
  "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-21T06:29:05.382Z",
      "updatedAt": "2024-11-21T06:29:05.382Z",
      "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-21T06:29:05.382Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T06:29:05.382Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T06:29:05.382Z"
                }
              ]
            }
          ],
          "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-21T06:29:05.382Z"
                }
              ]
            }
          ]
        },
        "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-21T06:29:05.382Z",
      "updatedAt": "2024-11-21T06:29:05.382Z"
    },
    "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

Response

200

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataApplicantDetailsInfoEntity (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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-21T06:29:05.382Z",
      "updatedAt": "2024-11-21T06:29:05.382Z",
      "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-21T06:29:05.382Z",
          "types": [
            {
              "id": 0,
              "docId": 0,
              "name": "text",
              "pageIndex": 0,
              "hasMRZ": false,
              "icao": "text",
              "type": 0,
              "year": "text",
              "format": 0,
              "createdAt": "2024-11-21T06:29:05.382Z"
            }
          ],
          "graphics": [
            {
              "fieldType": 0,
              "data": [
                {
                  "id": 0,
                  "docId": 0,
                  "fieldType": 201,
                  "sourceType": -1,
                  "containerType": -1,
                  "pageIndex": 0,
                  "image": "text",
                  "createdAt": "2024-11-21T06:29:05.382Z"
                }
              ]
            }
          ],
          "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-21T06:29:05.382Z"
                }
              ]
            }
          ]
        },
        "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-21T06:29:05.382Z",
      "updatedAt": "2024-11-21T06:29:05.382Z"
    },
    "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

Response

200

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataBoolean (object)

Request

JavaScriptCurlPython

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

Response

200

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

Response

200

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataApplicantStatusInfoEntity (object)

Request

JavaScriptCurlPython

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

Response

200

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

Body

application/json

flowId*string

A flow id

Response

200201

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataApplicantStatusInfoEntity (object)

Request

JavaScriptCurlPython

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

200

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

Body

application/json

localestring

ttl*number

flowName*string

Response

201

Body

application/json

status*boolean

statusCode*number

Example: 200

data*object

time*string

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

dataBrowserVerificationToken (object)

Request

JavaScriptCurlPython

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

201

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