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]

Create new applicant

post

/api/public/applicant

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Body

externalUserIdstringrequired

A unique applicant identifies on the client side

flowNamestringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/applicant' \
  --header 'x-private-app-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalUserId": "text",
    "flowName": "text",
    "phone": "text",
    "email": "text",
    "lang": "text",
    "suppliedInfo": {}
  }'

201

201

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

Get applicant by id

get

/api/public/applicant/{applicantId}

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/applicant/{applicantId}' \
  --header 'x-private-app-key: text'

200

200

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

Get applicant status by id

get

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

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/applicant/{applicantId}/status' \
  --header 'x-private-app-key: text'

200

200

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

Update Applicant flow

post

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

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Body

flowIdstringrequired

A flow id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/applicant/{applicantId}/moveToFlow' \
  --header 'x-private-app-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "flowId": "text"
  }'

200

201

200

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

Mark applicant for deletion

post

/api/public/applicant/{applicantId}/schedule-deletion

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/applicant/{applicantId}/schedule-deletion' \
  --header 'x-private-app-key: text'

200

201

200

{
  "status": true,
  "statusCode": 200,
  "data": {
    "id": "text",
    "scheduledDeletionDate": "2025-02-28T07:22:18.836Z"
  },
  "time": "2021-08-20T14:52:33.648Z"
}

Restore applicant

post

/api/public/applicant/{applicantId}/restore

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/applicant/{applicantId}/restore' \
  --header 'x-private-app-key: text'

200

201

200

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

Create new verification token

post

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

Path parameters

applicantIdstringrequired

Applicant ID

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Body

localestring

ttlnumber · max: 3153600000required

flowNamestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/applicant/{applicantId}/token' \
  --header 'x-private-app-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "locale": "text",
    "ttl": 1,
    "flowName": "text"
  }'

201

201

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

Create new verification token

post

/api/public/verification

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Body

localestring

externalUserIdstringrequired

ttlnumber · max: 3153600000required

flowNamestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/verification' \
  --header 'x-private-app-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "locale": "text",
    "externalUserId": "text",
    "ttl": 1,
    "flowName": "text"
  }'

201

201

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

Get Questionnaire Schema

get

/api/public/questionnaire/{id}

Path parameters

idstringrequired

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/questionnaire/{id}' \
  --header 'x-private-app-key: text'

200

200

{
  "status": true,
  "statusCode": 200,
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "clientKey": "text",
    "content": {},
    "version": {},
    "createdAt": "2025-02-28T07:22:18.836Z"
  },
  "time": "2021-08-20T14:52:33.648Z"
}

Search Wallet or Transaction Risk Score

post

/api/public/crypto-aml/search

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Body

txHashstringrequired

Pattern: /^(0x)?[a-fA-F0-9]{64}$/

addressstringrequired

blockchainstring · enumrequired

Options: BTC, LTC, BSV, ETH, TRON, POLYGON, BNB, ARBITRUM, BASE, AVALANCHE, MOONBEAM

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/crypto-aml/search' \
  --header 'x-private-app-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "txHash": "text",
    "address": "text",
    "blockchain": "BTC"
  }'

201

201

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

Get aml

get

/api/public/crypto-aml/{amlId}/details

Path parameters

amlIdstringrequired

Query parameters

typestring · enumrequired

Options: WALLET, TRANSACTION

Header parameters

x-private-app-keystringrequired

Private app key

x-workmodeany

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/crypto-aml/{amlId}/details?type=WALLET' \
  --header 'x-private-app-key: text'

200

200

{
  "status": true,
  "statusCode": 200,
  "data": {
    "id": "text",
    "clientKey": "text",
    "applicantId": "text",
    "address": "text",
    "score": 1,
    "amount": "text",
    "isMonitoring": true,
    "lastUpdateDate": "2023-01-01T00:00:00Z",
    "outdated": false,
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-02T00:00:00Z",
    "type": "WALLET",
    "blockchain": "BTC",
    "reviewStatus": "UNKNOWN",
    "uof": [
      {
        "hash": "text",
        "forward": true,
        "owner": "text",
        "score": 1,
        "type": "text",
        "depth": 1,
        "amount": 1,
        "address": "text",
        "share": 1,
        "transactionCount": 1,
        "unidentified": true,
        "unknown": true,
        "amountCur": 1,
        "cluster": 1,
        "directStamp": 1,
        "timestamp": 1,
        "listType": "text",
        "amountDec": 1,
        "directTx": "text"
      }
    ],
    "sof": [
      {
        "hash": "text",
        "forward": true,
        "owner": "text",
        "score": 1,
        "type": "text",
        "depth": 1,
        "amount": 1,
        "address": "text",
        "share": 1,
        "transactionCount": 1,
        "unidentified": true,
        "unknown": true,
        "amountCur": 1,
        "cluster": 1,
        "directStamp": 1,
        "timestamp": 1,
        "listType": "text",
        "amountDec": 1,
        "directTx": "text"
      }
    ],
    "entities": [
      {
        "id": "text",
        "score": 1,
        "scoreType": "text",
        "name": "text",
        "scoreTypeId": "text"
      }
    ],
    "timelines": [
      {
        "id": "text",
        "requestUniqueId": "text",
        "applicantId": "text",
        "appKey": "text",
        "data": {},
        "amlId": "text",
        "userId": 1,
        "createdAt": "2025-02-28T07:22:18.836Z",
        "updatedAt": "2025-02-28T07:22:18.836Z",
        "eventName": "CRYPTO_AML_STATUS_UPDATED",
        "device": {},
        "geo": {}
      }
    ],
    "comments": "[Circular Reference]",
    "addressInfo": {
      "address": "text",
      "owner": "text",
      "description": "text",
      "txCount": 1,
      "txReceivedCount": 1,
      "txSentCount": 1,
      "firstSeen": 1,
      "lastSeen": 1,
      "parentCount": 1,
      "parentNativeCount": 1,
      "addressType": "text",
      "conflict": true,
      "totalETHTxs": 1,
      "totalInternalTxs": 1,
      "totalTokensTxs": 1,
      "tags": [
        []
      ],
      "assets": [
        {
          "supported": true,
          "name": "text",
          "symbol": "text",
          "icon": "text"
        }
      ],
      "type": {
        "id": "text",
        "name": "text",
        "score": 1
      },
      "balance": {
        "amount": "text",
        "price": 1,
        "priceTimestamp": 1,
        "symbol": "text"
      }
    }
  },
  "time": "2021-08-20T14:52:33.648Z"
}