Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Sign Up button located at the top right corner of the homepage.




My Team section.
This page explains the steps an applicant will go through to receive and complete their verification.
This page explains how to manage access control within the platform
The UI Customization functionality within the Flow Builder allows you to personalize the appearance of your verification workflows.
This functionality empowers you to halt the verification process if they find discrepancies or issues during any stage of the applicant’s verification.
Here we describe types and enums, which we are using in our system
@ApiPropertyOptional means that property is optional. 































To enable applicant verification, you need to obtain a token. There are two methods for initiating the verification process: through the workplace interface or by using our automated SDK.









































const axios = require('axios');
async function createToken() {
const response = await axios.post('https://billing.elkyc.com/api/public/verification', {
flowName: 'yourFlowName',
externalUserId: 'user123',
ttl: 3600,
locale: 'uk'
}, {
headers: {
'x-private-app-key': 'yourPrivateAppKey'
}
});
return response.data.accessToken;
}export class ResponseEntity {
@ApiProperty()
status: boolean;
@ApiProperty({ example: 200 })
statusCode: number;
@ApiProperty({ type: String })
data: string;
@ApiProperty({ example: '2021-08-20T14:52:33.648Z' })
time: string;
constructor(data: string) {
this.status = true;
this.statusCode = 200;
this.data = data;
this.time = new Date().toISOString();
}
}API Keys section under Company to retrieve your API keys.







The Applications page is where you configure key settings and credentials needed to interact with our Public API and Webhooks. This guide will walk you through creating and managing applications:
Refresh to update the displayed information with the latest blockchain activity and risk analysis. This ensures you are working with the most up-to-date data.






































<div id="allpass"></div>const accessToken = 'ACCESS_TOKEN_FROM_PUBLIC_API';
Allpass.start(accessToken);<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link rel="icon" href="favicon.ico">
<title>Title</title>
</head>
<body>
<div id="app">
<div id="header">
<h1>My Test Application</h1>
</div>
<div id="container">
<div>
<h3>Content</h3>
<img id="loader" alt="loader" style="display: none" src="loader.gif"/>
<button id="start">Start Verification</button>
</div>
<div id="allpass"></div>
</div>
<div id="footer">
<p>Footer</p>
</div>
<script src="integration.js" async></script>
</div>
</body>
</html>const accessToken = 'ACCESS_TOKEN_FROM_PUBLIC_API';
(() => {
const allpassId = 'allpass';
/** UI actions */
const setElmsDisplay = (hide, show) => {
document.getElementById(hide).style.display = 'none';
document.getElementById(show).style.display = 'block';
}
const finishUI = () => {
setTimeout(() => {
setElmsDisplay(allpassId, 'start');
window.Allpass.close();
}, 10000);
};
/** event handlers */
const onLoad = (e) => {
console.log('onLoad', e);
setElmsDisplay('loader', allpassId);
};
const onRestart = (e) => {
console.log('onRestart', e);
setElmsDisplay('start', 'loader');
};
const onStart = (e) => {
console.log('onStart', e);
};
const onPassStep = (e) => {
console.log('onPassStep', e);
};
const onComplete = (e) => {
console.log('onComplete', e);
finishUI();
};
const onError = (e) => {
console.log('onError', e);
finishUI();
};
/** initialize Allpass SDK */
const init = () => {
window.Allpass.init({
onLoad,
onRestart,
onStart,
onPassStep,
onComplete,
onError,
}).restart();
};
/** create Allpass library */
const script = document.createElement('script');
script.src = 'https://unpkg.com/@allpass/web-sdk';
script.async = true;
script.onload = () => init();
document.body.appendChild(script);
/** start verification process */
document.getElementById('start').onclick = async () => {
setElmsDisplay('start', 'loader');
await window.Allpass.start(accessToken);
};
})();

let onLoad: () => void;let onStart: (event: {
appKey: string;
transactionId: string;
externalUserId: string;
flowId: number;
mode: 'LIVE' | 'TEST';
}) => void;let onRestart: (event: {
appKey: string;
transactionId: string;
externalUserId: string;
flowId: number;
mode: 'LIVE' | 'TEST';
}) => void;let onPassStep: (event: {
appKey: string;
transactionId: string;
stepType: string;
externalUserId: string;
flowId: number;
mode: 'LIVE' | 'TEST';
}) => void;Allpass.init({
onLoad: () => {},
onRestart: ({appKey, transactionId, externalUserId}) => {},
onStart: ({appKey, transactionId, externalUserId}) => {},
onPassStep: ({appKey, transactionId, stepType, externalUserId}) => {},
onComplete: ({appKey, transactionId, externalUserId}) => {},
onError: ({appKey, transactionId, error, stepType, externalUserId}) => {},
});Allpass.restart();Allpass
.init({onComplete: ({appKey, transactionId, externalUserId, flowId, mode}) => {}})
.start(accessToken);




























let onComplete: (event: {
appKey: string;
transactionId: string;
externalUserId: string;
flowId: number;
mode: 'LIVE' | 'TEST';
}) => void;let onError: (event: {
appKey: string;
transactionId: string;
error: string;
stepType?: string;
externalUserId: string;
flowId: number;
mode: 'LIVE' | 'TEST';
}) => void;Ukraine

{
"data": "encryptedString"
}{
"data": "encryptedString"
}const crypto = require('crypto');
const cryptoKey = 'your-encryption-key';
const hmacKey = 'your-hmac-key';
const algorithm = 'aes-256-cbc';
function encrypt(text) {
const keyBuff = Buffer.from(cryptoKey, 'hex');
const iv = crypto.randomBytes(16);
const cipher = crypto.createCipheriv(algorithm, keyBuff, iv);
let encrypted = cipher.update(data, 'utf8', 'hex');
encrypted += cipher.final('hex');
const payload = iv.toString('hex') + encrypted;
const hmacKeyBuff = Buffer.from(hmacKey, 'hex');
const hmac = crypto.createHmac('sha256', hmacKeyBuff);
hmac.update(payload);
const hmacDigest = hmac.digest('hex');
return {
payload,
signature: hmacDigest,
};
}
const data = JSON.stringify({ key: 'value' });
const { payload, signature } = encrypt(data);
const request = { data: encryptedData };
console.log(request);const crypto = require('crypto');
const cryptoKey = 'your-encryption-key';
const algorithm = 'aes-256-gcm';
function encrypt(text) {
const keyBuff = Buffer.from(cryptoKey, 'hex');
const iv = crypto.randomBytes(12);
const cipher = crypto.createCipheriv(algorithm, keyBuff, iv);
const encrypted = Buffer.concat([
cipher.update(data, 'utf8'),
cipher.final(),
]);
const authTag = cipher.getAuthTag();
return {
payload: iv.toString('hex') + encrypted.toString('hex'),
signature: authTag.toString('hex'),
};
}
const data = JSON.stringify({ key: 'value' });
const { payload, signature } = encrypt(data);
const request = { data: encryptedData };
console.log(request);const crypto = require('crypto');
function decryptData(
encryptedTextWithIv: string,
cryptoKey: string,
hmacKey: string,
signature: string
): string {
const hmacKeyBuff = Buffer.from(hmacKey, 'hex');
const hmac = crypto.createHmac('sha256', hmacKeyBuff);
hmac.update(encryptedTextWithIv);
const computedSignature = hmac.digest('hex');
if (computedSignature !== signature) {
throw new Error('Invalid signature');
}
const keyBuff = Buffer.from(cryptoKey, 'hex');
const iv = Buffer.from(encryptedTextWithIv.slice(0, 32), 'hex');
const encryptedText = encryptedTextWithIv.slice(32);
const decipher = crypto.createDecipheriv('aes-256-cbc', keyBuff, iv);
let decrypted = decipher.update(encryptedText, 'hex', 'utf8');
decrypted += decipher.final('utf8');
return decrypted;
}
const cryptoKey = `*************`; // Your crypt key from application page
const hmacKey = `*************`; // Your hmac key from application page
const signature = response.headers['x-allpass-signature']
const encryptedDataString = '... Encrypted data in Base64 ...';
const decryptedDataString = decryptData( encryptedDataString,
cryptoKey,
hmacKey,
signature
);
console.log('Decrypted data object:', JSON.parse(decryptedDataString));const crypto = require('crypto');
function decryptData(
encryptedTextWithIv: string,
cryptoKey: string,
signature: string
): string {
const iv = Buffer.from(encryptedTextWithIv.slice(0, 24), 'hex');
const encryptedData = encryptedTextWithIv.slice(24);
const decipher = crypto.createDecipheriv(
'aes-256-gcm',
Buffer.from(cryptoKey, 'hex'),
iv,
);
decipher.setAuthTag(Buffer.from(signature, 'hex'));
const decrypted = Buffer.concat([
decipher.update(Buffer.from(encryptedData, 'hex')),
decipher.final(),
]);
return decrypted.toString('utf8');
}
const cryptoKey = `*************`; // Your crypt key from application page
const signature = response.headers['x-allpass-signature']
const encryptedDataString = '... Encrypted data in Base64 ...';
const decryptedDataString = decryptData( encryptedDataString,
cryptoKey,
signature
);
console.log('Decrypted data object:', JSON.parse(decryptedDataString));const iv = Buffer.from(response.headers['x-initialization-vector'], 'hex');const crypto = require('crypto');
const fs = require('fs');
const http = require('http');
const { promisify } = require('util');
const { pipeline } = require('stream');
const pipelineAsync = promisify(pipeline);
async function downloadAndDecryptFile(url, outputPath, encryptionKey) {
try {
const response = await new Promise((resolve, reject) => {
const request = http.get(url, {
headers: {
'X-Private-App-Key': 'string',
},
}, (response) => {
if (response.statusCode !== 200) {
reject(new Error(`Failed to get '${url}' (${response.statusCode})`));
} else {
resolve(response);
}
});
request.on('error', (err) => {
reject(err);
});
});
// Retrieve the IV from the headers
const iv = Buffer.from(response.headers['x-initialization-vector'], 'hex');
if (!iv || iv.length !== 16) {
throw new Error('Invalid or missing initialization vector (IV)');
}
const keyBuff = Buffer.from(encryptionKey, 'hex');
// Create a decipher for decryption
const decipher = crypto.createDecipheriv('aes-256-cbc', keyBuff, iv);
// Create a write stream for the output file
const writeStream = fs.createWriteStream(outputPath);
// Pipe the encrypted stream through the decipher and into the write stream
await pipelineAsync(response, decipher, writeStream);
console.log('File downloaded and decrypted successfully.');
} catch (err) {
console.error('Error downloading or decrypting file:', err);
}
}A unique applicant identifies on the client side
A flow name
An applicant phone number.
An applicant email address.
The language, in which the verification results should be displayed to applicants.
Used to compare the data that you provide to us with that we extract from the applicant documents.
Internal ID or an external user identifier.
Internal ID or an external user identifier.
Internal ID or an external user identifier.
A flow id
Internal ID or an external user identifier.
Applicant identifier
Applicant deletion date
Internal ID or an external user identifier.
Applicant identifier
Internal ID or an external user identifier.
Optional locale specifying the language for the verification token. Must be a valid locale string (e.g., "en-US").
Optional time-to-live (TTL) for the verification token in seconds.
Optional name of the verification flow to be applied
Blockchain network to perform the AML search. Accepted values are defined in the BlockchainEnum.
Optional transaction hash for the AML search. Must be a 64-character hexadecimal string, optionally prefixed with "0x". This field is mutually exclusive with "address".
^(0x)?[a-fA-F0-9]{64}$Optional blockchain address for the AML search. Must be a valid blockchain address and is mutually exclusive with "txHash".
POST /api/public/applicant HTTP/1.1
x-private-app-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"externalUserId": "text",
"flowName": "text",
"phone": "text",
"email": "text",
"lang": "text",
"suppliedInfo": {}
}{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"externalUserId": "text",
"status": "INIT",
"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,
"review": {
"id": "text",
"version": 1,
"status": "INIT",
"createdAt": "2026-03-07T05:25:04.723Z",
"updatedAt": "2026-03-07T05:25:04.723Z",
"comment": "text",
"warnings": "text",
"details": "text",
"reviewerId": 1,
"reviewerFullName": "text",
"statusSetById": 1,
"statusSetByName": "text"
},
"servicesData": [
{
"data": {
"id": "text",
"stepType": "DOCUMENT_CAPTURE",
"overallResult": 0,
"elapsedTime": 1,
"elapsedTimeRFID": 1,
"uploadedPagesCount": 1,
"createdAt": "2026-03-07T05:25:04.723Z",
"types": [
{
"id": "text",
"docId": "text",
"name": "text",
"pageIndex": 1,
"hasMRZ": true,
"icao": "text",
"type": 1,
"year": "text",
"format": 0,
"createdAt": "2026-03-07T05:25:04.723Z"
}
],
"graphics": [
{
"fieldType": 1,
"data": [
{
"id": "text",
"docId": "text",
"fieldType": 201,
"sourceType": -1,
"containerType": -1,
"pageIndex": 1,
"image": "text",
"createdAt": "2026-03-07T05:25:04.723Z"
}
]
}
],
"fields": [
{
"fieldType": 1,
"data": [
{
"id": "text",
"docId": "text",
"fieldType": 0,
"lcid": 0,
"status": 0,
"pageIndex": 1,
"probability": 1,
"validity": 0,
"value": "text",
"sourceType": -1,
"comparison": {},
"createdAt": "2026-03-07T05:25:04.723Z"
}
]
}
]
},
"service": "DOCUMENT_CAPTURE",
"status": "REJECTED",
"type": "ON_DEMAND",
"deactivatedServiceCount": 1,
"errorMessage": "text",
"reason": "text"
}
],
"applications": {
"appKey": "text"
},
"flow": {
"name": "text",
"id": 1,
"type": "ON_DEMAND",
"autoApprove": true,
"uniqueFaceMatch": true,
"services": [
"DOCUMENT_CAPTURE"
]
},
"amlMonitoring": {
"id": "text",
"applicantId": "text",
"externalId": "text",
"period": "DAILY",
"isActive": true,
"createdAt": "2026-03-07T05:25:04.723Z",
"updatedAt": "2026-03-07T05:25:04.723Z"
},
"device": {
"sdkVersion": "text",
"ip": "text",
"country": "text",
"region": "text",
"eu": "text",
"timezone": "text",
"city": "text",
"metro": 1,
"ll": [
1
],
"area": 1,
"userAgent": "text",
"browserType": "text",
"browserVersion": "text"
}
},
"time": "2021-08-20T14:52:33.648Z"
}GET /api/public/applicant/{applicantId} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"externalUserId": "text",
"status": "INIT",
"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,
"review": {
"id": "text",
"version": 1,
"status": "INIT",
"createdAt": "2026-03-07T05:25:04.723Z",
"updatedAt": "2026-03-07T05:25:04.723Z",
"comment": "text",
"warnings": "text",
"details": "text",
"reviewerId": 1,
"reviewerFullName": "text",
"statusSetById": 1,
"statusSetByName": "text"
},
"servicesData": [
{
"data": {
"id": "text",
"stepType": "DOCUMENT_CAPTURE",
"overallResult": 0,
"elapsedTime": 1,
"elapsedTimeRFID": 1,
"uploadedPagesCount": 1,
"createdAt": "2026-03-07T05:25:04.723Z",
"types": [
{
"id": "text",
"docId": "text",
"name": "text",
"pageIndex": 1,
"hasMRZ": true,
"icao": "text",
"type": 1,
"year": "text",
"format": 0,
"createdAt": "2026-03-07T05:25:04.723Z"
}
],
"graphics": [
{
"fieldType": 1,
"data": [
{
"id": "text",
"docId": "text",
"fieldType": 201,
"sourceType": -1,
"containerType": -1,
"pageIndex": 1,
"image": "text",
"createdAt": "2026-03-07T05:25:04.723Z"
}
]
}
],
"fields": [
{
"fieldType": 1,
"data": [
{
"id": "text",
"docId": "text",
"fieldType": 0,
"lcid": 0,
"status": 0,
"pageIndex": 1,
"probability": 1,
"validity": 0,
"value": "text",
"sourceType": -1,
"comparison": {},
"createdAt": "2026-03-07T05:25:04.723Z"
}
]
}
]
},
"service": "DOCUMENT_CAPTURE",
"status": "REJECTED",
"type": "ON_DEMAND",
"deactivatedServiceCount": 1,
"errorMessage": "text",
"reason": "text"
}
],
"applications": {
"appKey": "text"
},
"flow": {
"name": "text",
"id": 1,
"type": "ON_DEMAND",
"autoApprove": true,
"uniqueFaceMatch": true,
"services": [
"DOCUMENT_CAPTURE"
]
},
"amlMonitoring": {
"id": "text",
"applicantId": "text",
"externalId": "text",
"period": "DAILY",
"isActive": true,
"createdAt": "2026-03-07T05:25:04.723Z",
"updatedAt": "2026-03-07T05:25:04.723Z"
},
"device": {
"sdkVersion": "text",
"ip": "text",
"country": "text",
"region": "text",
"eu": "text",
"timezone": "text",
"city": "text",
"metro": 1,
"ll": [
1
],
"area": 1,
"userAgent": "text",
"browserType": "text",
"browserVersion": "text"
}
},
"time": "2021-08-20T14:52:33.648Z"
}GET /api/public/applicant/{applicantId}/status HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"status": "text"
},
"time": "2021-08-20T14:52:33.648Z"
}POST /api/public/applicant/{applicantId}/moveToFlow HTTP/1.1
x-private-app-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"flowId": "text"
}{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"status": "text"
},
"time": "2021-08-20T14:52:33.648Z"
}POST /api/public/applicant/{applicantId}/schedule-deletion HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"scheduledDeletionDate": "2026-03-07T05:25:04.723Z"
},
"time": "2021-08-20T14:52:33.648Z"
}POST /api/public/applicant/{applicantId}/restore HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"id": "text"
},
"time": "2021-08-20T14:52:33.648Z"
}POST /api/public/applicant/{applicantId}/token HTTP/1.1
x-private-app-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"locale": "text",
"ttl": 1,
"flowName": "text"
}{
"status": true,
"statusCode": 200,
"data": {
"transactionId": "text",
"accessToken": "text",
"link": "text",
"applicantId": "text",
"ttl": 1
},
"time": "2021-08-20T14:52:33.648Z"
}GET /api/public/questionnaire/{id} HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"name": "text",
"description": "text",
"clientKey": "text",
"content": {},
"version": {},
"createdAt": "2026-03-07T05:25:04.723Z"
},
"time": "2021-08-20T14:52:33.648Z"
}POST /api/public/crypto-aml/search HTTP/1.1
x-private-app-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"blockchain": "BTC",
"txHash": "text",
"address": "text"
}{
"status": true,
"statusCode": 200,
"data": {
"id": "text",
"type": "WALLET"
},
"time": "2021-08-20T14:52:33.648Z"
}GET /api/public/crypto-aml/{amlId}/details?type=WALLET HTTP/1.1
x-private-app-key: YOUR_API_KEY
Accept: */*
{
"status": true,
"statusCode": 200,
"data": {
"type": "WALLET",
"id": "text",
"clientKey": "text",
"applicantId": "text",
"blockchain": "BTC",
"reviewStatus": "UNKNOWN",
"address": "text",
"score": 1,
"amount": "text",
"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"
}
],
"addressInfo": {
"address": "text",
"owner": "text",
"description": "text",
"type": {
"id": "text",
"name": "text",
"score": 1
},
"txCount": 1,
"txReceivedCount": 1,
"txSentCount": 1,
"tags": [
[]
],
"balance": {
"amount": "text",
"price": 1,
"priceTimestamp": 1,
"symbol": "text"
},
"firstSeen": 1,
"lastSeen": 1,
"parentCount": 1,
"parentNativeCount": 1,
"addressType": "text",
"conflict": true,
"totalETHTxs": 1,
"totalInternalTxs": 1,
"totalTokensTxs": 1,
"assets": [
{
"supported": true,
"name": "text",
"symbol": "text",
"icon": "text"
}
]
},
"entities": [
{
"id": "text",
"score": 1,
"scoreType": "text",
"name": "text",
"scoreTypeId": "text"
}
],
"isMonitoring": true,
"lastUpdateDate": "2023-01-01T00:00:00Z",
"outdated": false,
"createdAt": "2023-01-01T00:00:00Z",
"timelines": [
{
"id": "text",
"requestUniqueId": "text",
"eventName": "CRYPTO_AML_STATUS_UPDATED",
"applicantId": "text",
"appKey": "text",
"data": {},
"amlId": "text",
"userId": 1,
"device": {},
"geo": {},
"createdAt": "2026-03-07T05:25:04.723Z",
"updatedAt": "2026-03-07T05:25:04.723Z"
}
],
"comments": [
{
"id": "text",
"content": "text",
"amlId": "text",
"authorId": 1,
"parentId": "text",
"authorName": "text",
"updatedAt": "2026-03-07T05:25:04.723Z",
"createdAt": "2026-03-07T05:25:04.723Z",
"parentComment": "[Circular Reference]"
}
],
"updatedAt": "2023-01-02T00:00:00Z"
},
"time": "2021-08-20T14:52:33.648Z"
}export class VerificationStepPassedEntity {
@ApiProperty({
type: String,
description: 'Allpass transactionId (UUIDv4)',
})
transactionId: string;
@ApiProperty({
type: String,
description: 'Session identifier in your system',
})
clientSession: string;
@ApiProperty({
type: String,
description: 'Your own Allpass client key',
})
clientKey: string;
@ApiProperty({
type: String,
description: 'Your own Allpass application key (API key)',
})
appKey: string;
@ApiProperty({ enum: VerificationStepEnum, description: 'Passed step' })
passedStep: VerificationStepEnum;
@ApiPropertyOptional({
enum: VerificationSubstepEnum,
description: 'Passed substep',
})
passedSubstep?: VerificationSubstepEnum;
@ApiPropertyOptional({
enum: VerificationStepEnum,
description: 'Next step'
})
nextStep?: VerificationStepEnum;
@ApiPropertyOptional({
enum: VerificationSubstepEnum,
description: 'Next substep',
})
nextSubstep?: VerificationSubstepEnum;
}export class VerificationCompleteEntity {
@ApiProperty({
type: String,
description: 'Verification transaction ID',
})
transactionId: string;
@ApiProperty({ type: String, description: 'Client key' })
clientKey: string;
@ApiProperty({ type: String, description: 'Application key' })
appKey: string;
@ApiProperty({
enum: VerificationStatusEnum,
description: 'Verification status',
})
status: VerificationStatusEnum;
@ApiProperty({ enum: PlatformEnum, description: 'Customer platform' })
platform: PlatformEnum;
@ApiProperty({
type: [HistoryEntity],
isArray: true,
description: 'Verification history data',
})
histories: HistoryEntity[];
@ApiPropertyOptional({
type: [VerificationServiceInfoEntity],
isArray: true,
description: 'Verification services',
})
servicesData?: VerificationServiceInfoEntity[];
@ApiPropertyOptional({
description: 'Device data',
oneOf: [
{ $ref: getSchemaPath(BrowserDeviceEntity) },
{ $ref: getSchemaPath(AndroidDeviceEntity) },
{ $ref: getSchemaPath(IosDeviceEntity) },
],
})
device?: BrowserDeviceEntity | AndroidDeviceEntity | IosDeviceEntity;
@ApiPropertyOptional({
type: WebhookDeliveryStateEntity,
description: 'Verification webhook delivery state',
})
webhookDeliveryState?: WebhookDeliveryStateEntity;
@ApiPropertyOptional({ type: String, description: 'Client session' })
clientSession?: string;
@ApiPropertyOptional({ type: String, description: 'Sdk Version' })
sdkVersion?: string;
@ApiPropertyOptional({
enum: ServiceEnum,
isArray: true,
description: 'Verification success services',
})
services?: ServiceEnum[];
@ApiPropertyOptional({
enum: ServiceEnum,
description: 'Verification failed service',
})
failedService?: ServiceEnum;
@ApiPropertyOptional({
type: String,
description: 'Verification error message',
})
error?: string;
@ApiProperty({
type: Boolean,
description: 'Verification cloud flag (for web always == true)',
})
isCloud: boolean;
@ApiPropertyOptional({
type: [String],
description: 'Verification service hashes (only for mobile platforms)',
})
hashes?: string[];
@ApiProperty({ type: Date, description: 'Verification created time' })
createdAt: Date;
@ApiProperty({ type: Date, description: 'Verification confirmation time' })
updatedAt: Date;
}yexport class HistoryEntity {
@ApiProperty({ enum: HistoryEventEnum, description: 'Event type' })
event: HistoryEventEnum;
@ApiProperty({ type: String, description: 'Event description' })
description: string;
@ApiProperty({ type: Date, description: 'Event time' })
createdAt: Date;
@ApiPropertyOptional({ type: UserEntity, description: 'User' })
user?: UserEntity;
@ApiPropertyOptional({ type: Number, description: 'User id' })
userId?: number;
}export class UserEntity {
@ApiProperty({
name: 'id',
type: Number,
description: 'User id',
})
id: number;
@ApiProperty({
type: String,
description: "User's full name",
example: 'Viktor Plotnikov',
})
fullName: string;
@ApiProperty({ type: String, description: "User's position", example: '
position: string;
}export class WebhookDeliveryStateEntity {
@ApiProperty({ type: Number, description: 'Webhook Id' })
webhookId: number;
@ApiProperty({ enum: DeliveryStatusEnum, description: 'Webhook status' })
status: DeliveryStatusEnum;
@ApiProperty({ enum: WebhookEventsEnum, description: 'Webhook event type' })
eventType: WebhookEventsEnum;
@ApiPropertyOptional({ type: String, description: 'Webhook error message' })
errorMessage?: string;
}export class VerificationServiceInfoEntity {
@ApiProperty({ enum: ServiceEnum, description: 'Service type' })
service: ServiceEnum;
@ApiProperty({
description: 'Service data',
isArray: true,
oneOf: [
{ $ref: getSchemaPath(DocumentInfoEntity) },
{ $ref: getSchemaPath(LivenessInfoEntity) },
{ $ref: getSchemaPath(FacematchInfoEntity) },
{ $ref: getSchemaPath(OtpEntity) },
{ $ref: getSchemaPath(InnEntity) },
{ $ref: getSchemaPath(ImageEntity) },
{ $ref: getSchemaPath(PassiveLivenessInfoEntity) },
{ $ref: getSchemaPath(PassiveFacematchInfoEntity) },
],
})
data: VerificationServiceInfoDataType;
}export class LivenessInfoEntity {
@ApiPropertyOptional({
enum: LivenessStatusEnum,
description: 'Liveness detection status',
})
liveness?: LivenessStatusEnum;
@ApiPropertyOptional({
type: String,
description: 'Liveness detection error message',
})
livenessError?: string;
@ApiPropertyOptional({
type: String,
description: 'Liveness detection video file name',
})
guid?: string;
@ApiProperty({ type: Date, description: 'Liveness created date' })
createdAt: Date;
}export class FacematchInfoEntity {
@ApiPropertyOptional({
type: Boolean,
description: 'Face match result status',
})
facematchResult?: boolean;
@ApiPropertyOptional({
type: Number,
description: 'Face match similarity number',
})
similarity?: number;
@ApiPropertyOptional({
type: String,
description: 'Face match error message',
})
facematchError?: string;
@ApiPropertyOptional({
type: [String],
isArray: true,
description: 'System names of saved images',
})
images?: string[];
@ApiProperty({ type: Date, description: 'Face match created date' })
createdAt: Date;
}export class OtpEntity {
@ApiProperty({ type: Number, description: 'Otp ID' })
id: number;
@ApiPropertyOptional({ type: String, description: 'Otp email' })
email?: string;
@ApiPropertyOptional({ type: String, description: 'Otp phone' })
phone?: string;
@ApiPropertyOptional({ type: Boolean, description: 'Checked email status' })
checkedEmail?: boolean;
@ApiPropertyOptional({ type: String, description: 'Checked phone status' })
checkedPhone?: boolean;
@ApiProperty({ type: Date, description: 'Otp step created date' })
createdAt: Date;
@ApiProperty({ type: Date, description: 'Otp step updated date' })
updatedAt: Date;
}export class InnEntity {
@ApiProperty({ type: String, description: 'Inn ID' })
id: number;
@ApiProperty({ type: String, description: 'Inn number' })
number: string;
@ApiProperty({ type: String, description: 'Inn image url' })
image: string;
@ApiProperty({ type: Date, description: 'Inn create date' })
createdAt: Date;
}export class ImageEntity {
@ApiProperty({ type: Number, description: 'Image ID' })
id: number;
@ApiProperty({ enum: ImageStepTypeEnum, description: 'Image type' })
type: ImageStepTypeEnum;
@ApiProperty({ type: String, description: 'Image url' })
image: string;
@ApiProperty({ type: Date, description: 'Image created date' })
createdAt: Date;
}export class PassiveLivenessInfoEntity {
@ApiPropertyOptional({
enum: LivenessStatusEnum,
description: 'Passive liveness detection status',
})
liveness?: LivenessStatusEnum;
@ApiPropertyOptional({
type: [SourceMediaEntity],
isArray: true,
description: 'Passive liveness error message',
})
sources?: SourceMediaEntity[];
@ApiPropertyOptional({
type: String,
description: 'Passive liveness detection error message',
})
livenessError?: string;
@ApiProperty({
type: Date,
description: 'Passive liveness step created date',
})
createdAt: Date;
}export class SourceMediaEntity {
@ApiProperty({ type: String, description: 'Media resource id' })
mediaId: string;
@ApiProperty({ enum: MediaTypeEnum, description: 'Media resource type' })
resourceType: MediaTypeEnum;
}export class PassiveFacematchInfoEntity {
@ApiPropertyOptional({
type: Boolean,
description: 'Passive face match result status',
})
facematchResult?: boolean;
@ApiPropertyOptional({
type: Number,
description: 'Passive face match similarity number',
})
similarity?: number;
@ApiPropertyOptional({
type: [SourceMediaEntity],
description: 'Face match error message',
})
sources?: SourceMediaEntity[];
@ApiPropertyOptional({
type: String,
description: 'Passive face match error message',
})
facematchError?: string;
@ApiProperty({
type: Date,
description: 'Passive face match step created date',
})
createdAt: Date;
}export class DocumentInfoEntity {
@ApiProperty({ type: Number, description: 'Document ID' })
id: number;
@ApiProperty({
enum: DocumentStepTypeEnum,
description: 'Document step type',
})
stepType: DocumentStepTypeEnum;
@ApiProperty({ enum: CheckResultEnum, description: 'Document status' })
overallResult: CheckResultEnum;
@ApiProperty({ type: Number, description: 'Document processing time in ms' })
elapsedTime: number;
@ApiProperty({
type: Number,
description: 'Document rfid processing time in ms',
required: false,
})
elapsedTimeRFID: number;
@ApiProperty({
type: Number,
description: 'Document more pages availability',
})
morePagesAvailable: number;
@ApiProperty({
type: [DocumentTypeEntity],
isArray: true,
description: 'Document types data',
})
types: DocumentTypeEntity[];
@ApiProperty({
type: [DocumentGraphicInfoEntity],
isArray: true,
description: 'Document graphics data',
})
graphics: DocumentGraphicInfoEntity[];
@ApiProperty({
type: [DocumentFieldInfoEntity],
isArray: true,
description: 'Document fields data',
})
fields: DocumentFieldInfoEntity[];
@ApiProperty({ type: Date, description: 'Document create date' })
createdAt: Date;
}export class DocumentTypeEntity {
@ApiProperty({ type: Number, description: 'Document type ID' })
id: number;
@Exclude()
@ApiProperty({ type: Number, description: 'Document ID' })
docId: number;
@ApiProperty({ type: String, description: 'Document type name' })
name: string;
@ApiProperty({ type: Number, description: 'Document page index' })
pageIndex: number;
@ApiProperty({ type: Boolean, description: 'Document MRZ availability' })
hasMRZ: boolean;
@ApiProperty({ type: String, description: 'Document ICAO' })
icao: string;
@ApiProperty({ enum: Number, description: 'Document type' })
type: number;
@ApiProperty({ type: String, description: 'Document year' })
year: string;
@ApiProperty({ enum: DocFormatEnum, description: 'Document format' })
format: DocFormatEnum;
@ApiProperty({ type: Date, description: 'Document create date' })
createdAt: Date;
}export class DocumentGraphicInfoEntity {
@ApiProperty({
enum: GraphicFieldTypeEnum,
description: 'Document graphic type',
})
fieldType: GraphicFieldTypeEnum;
@ApiProperty({
type: [DocumentGraphicEntity],
isArray: true,
description: 'Document graphic data',
})
data: DocumentGraphicEntity[];
}export class DocumentGraphicEntity {
@ApiProperty({ type: Number, description: 'Document graphic ID' })
id: number;
@ApiProperty({
enum: GraphicFieldTypeEnum,
description: 'Document graphic type',
})
fieldType: GraphicFieldTypeEnum;
@ApiProperty({
enum: ResultTypeEnum,
description: 'Document graphic sourceType',
})
sourceType: ResultTypeEnum;
@ApiProperty({ type: Number, description: 'Document page index' })
pageIndex: number;
@ApiProperty({ type: String, description: 'Document graphic url' })
image: string;
@ApiProperty({ type: Date, description: 'Document graphic create date' })
createdAt: Date;
}yexport class DocumentFieldInfoEntity {
@ApiProperty({
enum: VisualFieldTypeEnum,
description: 'Document field type',
})
fieldType: VisualFieldTypeEnum;
@ApiProperty({
type: [DocumentFieldEntity],
isArray: true,
description: 'Document field data',
})
data: DocumentFieldEntity[];
}export class DocumentFieldEntity {
@ApiProperty({ type: Number, description: 'Document field ID' })
id: number;
@ApiProperty({ enum: LcidEnum, description: 'Document field LCID' })
lcid: LcidEnum;
@ApiProperty({ enum: CheckResultEnum, description: 'Document field status' })
status: CheckResultEnum;
@ApiProperty({ type: Number, description: 'Document page index' })
pageIndex: number;
@ApiProperty({
type: Number,
description: 'Document field value recognition probability',
})
probability: number;
@ApiProperty({
enum: FieldVerificationResultEnum,
description: 'Document field value validity enum',
})
validity: FieldVerificationResultEnum;
@ApiProperty({ type: String, description: 'Document field obtained value' })
value: string;
@ApiProperty({
enum: ResultTypeEnum,
description: 'Document field value sourceType enum',
})
sourceType: ResultTypeEnum;
@ApiProperty({ type: Object, description: 'Document field value comparison' })
comparison: DocFieldValueComparisonType;
}
export type DocFieldValueComparisonType = {
[s: string]: number;
};{
"type":"applicantCreated",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"timestamp": 1737977546178
}{
"type":"applicantInProgress",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INCOMPLETE",
"newStatus": "IN_PROGRESS",
"timestamp": 1737977546178
}{
"type":"applicantIncomplete",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INIT",
"newStatus": "INCOMPLETE",
"timestamp": 1737977546178
}{
"type":"applicantInReview",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"timestamp": 1737977546178
}{
"type":"applicantRejected",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "COMPLETED",
"newStatus": "REJECTED",
"timestamp": 1737977546178
}{
"type":"applicantApproved",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "COMPLETED",
"newStatus": "APPROVED",
"timestamp": 1737977546178
}{
"type":"applicantCompleted",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"fullName": "John Back",
"previousStatus": "INCOMPLETE",
"newStatus": "COMPLETED",
"timestamp": 1737977546178
}{
"type":"applicantOnHold",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"previousStatus": "IN_PROGRESS",
"newStatus": "ON_HOLD",
"timestamp": 1737977546178
}{
"type":"applicantStepPassed",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"stepName": "liveness",
"timestamp": 1737977546178
}{
"type":"applicantDuplicateDocument",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_DOCUMENT",
"timestamp": 1737977546178
}{
"type":"expiredDocument",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "EXPIRED_DOCUMENT",
"timestamp": 1737977546178
}{
"type":"additionalDocumentStepError",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "ADDITIONAL_DOCUMENT_STEP_ERROR",
"timestamp": 1737977546178
}{
"type":"applicantDuplicateEmail",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_EMAIL",
"timestamp": 1737977546178
}{
"type":"applicantDuplicatePhone",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_PHONE",
"timestamp": 1737977546178
}{
"type":"amlPositiveCases",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_POSITIVE_CASES",
"timestamp": 1737977546178
}{
"type":"amlCannotStarted",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_CANNOT_STARTED",
"timestamp": 1737977546178
}{
"type":"amlResultUpdated",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "AML_RESULT_UPDATED",
"timestamp": 1737977546178
}{
"type":"cryptoAmlResult",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"data": {
"type": "WALLET",
"id": "text",
"clientKey": "text",
"applicantId": "text",
"blockchain": "BTC",
"reviewStatus": "UNKNOWN",
"address": "text",
"score": 0,
"amount": "text",
"uof": [
{
"hash": "text",
"forward": false,
"owner": "text",
"score": 0,
"type": "text",
"depth": 0,
"amount": 0,
"address": "text",
"share": 0,
"transactionCount": 0,
"unidentified": false,
"unknown": false,
"amountCur": 0,
"cluster": 0,
"directStamp": 0,
"timestamp": 0,
"listType": "text",
"amountDec": 0,
"directTx": "text"
}
],
"sof": [
{
"hash": "text",
"forward": false,
"owner": "text",
"score": 0,
"type": "text",
"depth": 0,
"amount": 0,
"address": "text",
"share": 0,
"transactionCount": 0,
"unidentified": false,
"unknown": false,
"amountCur": 0,
"cluster": 0,
"directStamp": 0,
"timestamp": 0,
"listType": "text",
"amountDec": 0,
"directTx": "text"
}
],
"addressInfo": {
"address": "text",
"owner": "text",
"description": "text",
"type": {
"id": "text",
"name": "text",
"score": 0
},
"txCount": 0,
"txReceivedCount": 0,
"txSentCount": 0,
"tags": [
[]
],
"balance": {
"amount": "text",
"price": 0,
"priceTimestamp": 0,
"symbol": "text"
},
"firstSeen": 0,
"lastSeen": 0,
"parentCount": 0,
"parentNativeCount": 0,
"addressType": "text",
"conflict": false,
"totalETHTxs": 0,
"totalInternalTxs": 0,
"totalTokensTxs": 0,
"assets": [
{
"supported": false,
"name": "text",
"symbol": "text",
"icon": "text"
}
]
},
"entities": [
{
"id": "text",
"score": 0,
"scoreType": "text",
"name": "text",
"scoreTypeId": "text"
}
],
"isMonitoring": true,
"lastUpdateDate": "2023-01-01T00:00:00Z",
"outdated": false,
"createdAt": "2023-01-01T00:00:00Z",
"timelines": [
{
"id": "text",
"requestUniqueId": "text",
"eventName": "CRYPTO_AML_STATUS_UPDATED",
"applicantId": "text",
"appKey": "text",
"amlId": "text",
"userId": 0,
"device": {},
"geo": {},
"createdAt": "2025-02-09T12:20:36.671Z",
"updatedAt": "2025-02-09T12:20:36.671Z"
}
],
"updatedAt": "2023-01-02T00:00:00Z"
}
"timestamp": 1737977546178
}{
"type":"cryptoAmlResult",
"eventId": "5bd44413-3309-4029-929e-f73b34d1",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"data": {
"statusCode": 17000,
"error": "Blockchain Address does not find"
},
"timestamp": 1737977546178
}{
"type":"applicantDuplicateCryptoAddress",
"id":"e007bf91-f78d-459d-a48d-408982f886f1",
"externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
"appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
"warning": "APPLICANT_DUPLICATE_CRYPTO_ADDRESS",
"timestamp": 1737977546178
}export enum ServiceEnum {
DocumentCapture = 'DOCUMENT_CAPTURE',
CleanDocumentCapture = 'CLEAN_DOCUMENT_CAPTURE',
BarcodeCapture = 'BARCODE_CAPTURE',
CreditCardCapture = 'CREDIT_CARD_CAPTURE',
RfidDocumentCapture = 'RFID_DOCUMENT_CAPTURE',
SpecificDocumentCapture = 'SPECIFIC_DOCUMENT_CAPTURE',
SelfieCapture = 'SELFIE_CAPTURE',
FaceCapture = 'FACE_CAPTURE',
FaceMatch = 'FACE_MATCH',
Liveness = 'FACE_LIVENESS',
PassiveLiveness = 'PASSIVE_LIVENESS',
PassiveFaceMatch = 'PASSIVE_FACE_MATCH',
Signature = 'SIGNATURE',
OtpVerification = 'OTP_VERIFICATION',
UtilityBill = 'UTILITY_BILL',
Diia = 'DIIA',
Questionnaire = 'QUESTIONNAIRE',
Aml = 'AML',
AmlMonitoring = 'AML_MONITORING',
}export enum HistoryEventEnum {
Create = 'create',
Update = 'update',
Delete = 'delete',
}export enum DeliveryStatusEnum {
Success = 'success',
Failed = 'failed',
}export enum VerificationStatusEnum {
New = 'new',
Success = 'success',
Failed = 'failed',
Pending = 'pending',
Approved = 'approved',
Declined = 'declined',
}export enum LivenessStatusEnum {
PASSED = 'passed',
UNKNOWN = 'unknown',
FAIL = 'fail',
}export enum ImageStepTypeEnum {
FaceCapture = 'FACE_CAPTURE',
Selfie = 'SELFIE_CAPTURE',
Signature = 'SIGNATURE',
UtilityBill = 'UTILITY_BILL',
SpecialDocument = 'SPECIAL_DOCUMENT',
}export enum MediaTypeEnum {
IMAGE_USER_PROFILE = 'IMAGE_USER_PROFILE',
IMAGE_FOLDER = 'IMAGE_FOLDER',
IMAGE_SHOTS_SET = 'IMAGE_SHOTS_SET',
IMAGE_RESULT_ANALYSE_SINGLE = 'IMAGE_RESULT_ANALYSE_SINGLE',
IMAGE_RESULT_ANALYSE_GROUP = 'IMAGE_RESULT_ANALYSE_GROUP',
IMAGE_COLLECTION_PERSON = 'IMAGE_COLLECTION_PERSON',
SHOTS_SET_FOLDER = 'SHOTS_SET_FOLDER',
VIDEO_FOLDER = 'VIDEO_FOLDER',
PASSIVE_FACEMATCH = 'PASSIVE_FACEMATCH',
PASSIVE_LIVENESS = 'PASSIVE_LIVENESS',
PASSIVE_LIVENESS_VIDEO = 'PASSIVE_LIVENESS_VIDEO',
}export enum DocumentStepTypeEnum {
Document = 'DOCUMENT_CAPTURE',
DocumentRFID = 'DOCUMENT_RFID_CAPTURE',
BarCode = 'BARCODE_CAPTURE',
CreditCard = 'CREDIT_CARD_CAPTURE',
}export enum CheckResultEnum {
ERROR = 0,
OK = 1,
WAS_NOT_DONE = 2,
}export enum DocFormatEnum {
ID1 = 0,
ID2 = 1,
ID3 = 2,
ID3_x2 = 5,
CUSTOM = 1000,
FLEXIBLE = 1002,
}export enum ResultTypeEnum {
NONE = -1,
RPRM_RESULT_TYPE_EMPTY = 0,
RPRM_RESULT_TYPE_RAW_IMAGE = 1,
RPRM_RESULT_TYPE_FILE_IMAGE = 2,
RPRM_RESULT_TYPE_MRZ_OCR_EXTENDED = 3,
RPRM_RESULT_TYPE_BARCODES = 5,
RPRM_RESULT_TYPE_GRAPHICS = 6,
RPRM_RESULT_TYPE_MRZ_TEST_QUALITY = 7,
RPRM_RESULT_TYPE_DOCUMENT_TYPES_CANDIDATES = 8,
RPRM_RESULT_TYPE_CHOSEN_DOCUMENT_TYPE_CANDIDATE = 9,
RPRM_RESULT_TYPE_DOCUMENTS_INFO_LIST = 10,
RPRM_RESULT_TYPE_OCR_LEXICAL_ANALYZE = 15,
RPRM_RESULT_TYPE_RAW_UNCROPPED_IMAGE = 16,
RPRM_RESULT_TYPE_VISUAL_OCR_EXTENDED = 17,
RPRM_RESULT_TYPE_BAR_CODES_TEXT_DATA = 18,
RPRM_RESULT_TYPE_BAR_CODES_IMAGE_DATA = 19,
RPRM_RESULT_TYPE_AUTHENTICITY = 20,
RPRM_RESULT_TYPE_EOS_IMAGE = 23,
RPRM_RESULT_TYPE_BAYER_IMAGE = 24,
RPRM_RESULT_TYPE_MAGNETIC_STRIPE = 25,
RPRM_RESULT_TYPE_MAGNETIC_STRIPE_TEXT_DATA = 26,
RPRM_RESULT_TYPE_FIELD_FILE_IMAGE = 27,
RPRM_RESULT_TYPE_DATABASE_CHECK = 28,
RPRM_RESULT_TYPE_FINGERPRINT_TEMPLATE_ISO = 29,
RPRM_RESULT_TYPE_INPUT_IMAGE_QUALITY = 30,
RPRM_RESULT_TYPE_HOLO_PARAMS = 47,
RPRM_RESULT_TYPE_DOCUMENT_POSITION = 85,
RPRM_RESULT_TYPE_CUSTOM = 100,
RFID_RESULT_TYPE_RFID_RAW_DATA = 101,
RFID_RESULT_TYPE_RFID_TEXT_DATA = 102,
RFID_RESULT_TYPE_RFID_IMAGE_DATA = 103,
RFID_RESULT_TYPE_RFID_BINARY_DATA = 104,
RFID_RESULT_TYPE_RFID_ORIGINAL_GRAPHICS = 105,
RPRM_RESULT_TYPE_BARCODE_POSITION = 62,
RPRM_RESULT_TYPE_MRZ_POSITION = 61,
}export enum GraphicFieldTypeEnum {
PORTRAIT = 201,
FINGERPR = 202,
EYE = 203,
SIGNATURE = 204,
BAR_CODE = 205,
PROOF_OF_CITIZENSHIP = 206,
DOCUMENT_IMAGE = 207,
COLOR_DYNAMIC = 209,
GHOST_PORTRAIT = 210,
STAMP = 211,
PORTRAIT_OF_CHILD = 212,
OTHER = 250,
FINGER_LEFT_THUMB = 300,
FINGER_LEFT_INDEX = 301,
FINGER_LEFT_MIDDLE = 302,
FINGER_LEFT_RING = 303,
FINGER_LEFT_LITTLE = 304,
FINGER_RIGHT_THUMB = 305,
FINGER_RIGHT_INDEX = 306,
FINGER_RIGHT_MIDDLE = 307,
FINGER_RIGHT_RING = 308,
FINGER_RIGHT_LITTLE = 309,
}export enum VisualFieldTypeEnum {
DOCUMENT_CLASS_CODE = 0,
ISSUING_STATE_CODE = 1,
DOCUMENT_NUMBER = 2,
DATE_OF_EXPIRY = 3,
DATE_OF_ISSUE = 4,
DATE_OF_BIRTH = 5,
PLACE_OF_BIRTH = 6,
PERSONAL_NUMBER = 7,
SURNAME = 8,
GIVEN_NAMES = 9,
MOTHERS_NAME = 10,
NATIONALITY = 11,
SEX = 12,
HEIGHT = 13,
WEIGHT = 14,
EYES_COLOR = 15,
HAIR_COLOR = 16,
ADDRESS = 17,
DONOR = 18,
SOCIAL_SECURITY_NUMBER = 19,
DL_CLASS = 20,
DL_ENDORSED = 21,
DL_RESTRICTION_CODE = 22,
DL_UNDER_21_DATE = 23,
AUTHORITY = 24,
SURNAME_AND_GIVEN_NAMES = 25,
NATIONALITY_CODE = 26,
PASSPORT_NUMBER = 27,
INVITATION_NUMBER = 28,
VISA_ID = 29,
VISA_CLASS = 30,
VISA_SUB_CLASS = 31,
MRZ_STRING_1 = 32,
MRZ_STRING_2 = 33,
MRZ_STRING_3 = 34,
MRZ_TYPE = 35,
OPTIONAL_DATA = 36,
DOCUMENT_CLASS_NAME = 37,
ISSUING_STATE_NAME = 38,
PLACE_OF_ISSUE = 39,
DOCUMENT_NUMBER_CHECKSUM = 40,
DATE_OF_BIRTH_CHECKSUM = 41,
DATE_OF_EXPIRY_CHECKSUM = 42,
PERSONAL_NUMBER_CHECKSUM = 43,
FINAL_CHECKSUM = 44,
PASSPORT_NUMBER_CHECKSUM = 45,
INVITATION_NUMBER_CHECKSUM = 46,
VISA_ID_CHECKSUM = 47,
SURNAME_AND_GIVEN_NAMES_CHECKSUM = 48,
VISA_VALID_UNTIL_CHECKSUM = 49,
OTHER = 50,
MRZ_STRINGS = 51,
NAME_SUFFIX = 52,
NAME_PREFIX = 53,
DATE_OF_ISSUE_CHECKSUM = 54,
DATE_OF_ISSUE_CHECK_DIGIT = 55,
DOCUMENT_SERIES = 56,
REG_CERT_REG_NUMBER = 57,
REG_CERT_CAR_MODEL = 58,
REG_CERT_CAR_COLOR = 59,
REG_CERT_BODY_NUMBER = 60,
REG_CERT_CAR_TYPE = 61,
REG_CERT_MAX_WEIGHT = 62,
REG_CERT_WEIGHT = 63,
ADDRESS_AREA = 64,
ADDRESS_STATE = 65,
ADDRESS_BUILDING = 66,
ADDRESS_HOUSE = 67,
ADDRESS_FLAT = 68,
PLACE_OF_REGISTRATION = 69,
DATE_OF_REGISTRATION = 70,
RESIDENT_FROM = 71,
RESIDENT_UNTIL = 72,
AUTHORITY_CODE = 73,
PLACE_OF_BIRTH_AREA = 74,
PLACE_OF_BIRTH_STATE_CODE = 75,
ADDRESS_STREET = 76,
ADDRESS_CITY = 77,
ADDRESS_JURISDICTION_CODE = 78,
ADDRESS_POSTAL_CODE = 79,
DOCUMENT_NUMBER_CHECK_DIGIT = 80,
DATE_OF_BIRTH_CHECK_DIGIT = 81,
DATE_OF_EXPIRY_CHECK_DIGIT = 82,
PERSONAL_NUMBER_CHECK_DIGIT = 83,
FINAL_CHECK_DIGIT = 84,
PASSPORT_NUMBER_CHECK_DIGIT = 85,
INVITATION_NUMBER_CHECK_DIGIT = 86,
VISA_ID_CHECK_DIGIT = 87,
SURNAME_AND_GIVEN_NAMES_CHECK_DIGIT = 88,
VISA_VALID_UNTIL_CHECK_DIGIT = 89,
PERMIT_DL_CLASS = 90,
PERMIT_DATE_OF_EXPIRY = 91,
PERMIT_IDENTIFIER = 92,
PERMIT_DATE_OF_ISSUE = 93,
PERMIT_RESTRICTION_CODE = 94,
PERMIT_ENDORSED = 95,
ISSUE_TIMESTAMP = 96,
NUMBER_OF_DUPLICATES = 97,
MEDICAL_INDICATOR_CODES = 98,
NON_RESIDENT_INDICATOR = 99,
VISA_TYPE = 100,
VISA_VALID_FROM = 101,
VISA_VALID_UNTIL = 102,
DURATION_OF_STAY = 103,
NUMBER_OF_ENTRIES = 104,
DAY = 105,
MONTH = 106,
YEAR = 107,
UNIQUE_CUSTOMER_IDENTIFIER = 108,
COMMERCIAL_VEHICLE_CODES = 109,
AKA_DATE_OF_BIRTH = 110,
AKA_SOCIAL_SECURITY_NUMBER = 111,
AKA_SURNAME = 112,
AKA_GIVEN_NAMES = 113,
AKA_NAME_SUFFIX = 114,
AKA_NAME_PREFIX = 115,
MAILING_ADDRESS_STREET = 116,
MAILING_ADDRESS_CITY = 117,
MAILING_ADDRESS_JURISDICTION_CODE = 118,
MAILING_ADDRESS_POSTAL_CODE = 119,
AUDIT_INFORMATION = 120,
INVENTORY_NUMBER = 121,
RACE_ETHNICITY = 122,
JURISDICTION_VEHICLE_CLASS = 123,
JURISDICTION_ENDORSEMENT_CODE = 124,
JURISDICTION_RESTRICTION_CODE = 125,
FAMILY_NAME = 126,
GIVEN_NAMES_RUS = 127,
VISA_ID_RUS = 128,
FATHERS_NAME = 129,
FATHERS_NAME_RUS = 130,
SURNAME_AND_GIVEN_NAMES_RUS = 131,
PLACE_OF_BIRTH_RUS = 132,
AUTHORITY_RUS = 133,
ISSUING_STATE_CODE_NUMERIC = 134,
NATIONALITY_CODE_NUMERIC = 135,
ENGINE_POWER = 136,
ENGINE_VOLUME = 137,
CHASSIS_NUMBER = 138,
ENGINE_NUMBER = 139,
ENGINE_MODEL = 140,
VEHICLE_CATEGORY = 141,
IDENTITY_CARD_NUMBER = 142,
CONTROL_NO = 143,
PARRENTS_GIVEN_NAMES = 144,
SECOND_SURNAME = 145,
MIDDLE_NAME = 146,
REG_CERT_VIN = 147,
REG_CERT_VIN_CHECK_DIGIT = 148,
REG_CERT_VIN_CHECKSUM = 149,
LINE_1_CHECK_DIGIT = 150,
LINE_2_CHECK_DIGIT = 151,
LINE_3_CHECK_DIGIT = 152,
LINE_1_CHECKSUM = 153,
LINE_2_CHECKSUM = 154,
LINE_3_CHECKSUM = 155,
REG_CERT_REG_NUMBER_CHECK_DIGIT = 156,
REG_CERT_REG_NUMBER_CHECKSUM = 157,
REG_CERT_VEHICLE_ITS_CODE = 158,
CARD_ACCESS_NUMBER = 159,
MARITAL_STATUS = 160,
COMPANY_NAME = 161,
SPECIAL_NOTES = 162,
SURNAME_OF_SPOSE = 163,
TRACKING_NUMBER = 164,
BOOKLET_NUMBER = 165,
CHILDREN = 166,
COPY = 167,
SERIAL_NUMBER = 168,
DOSSIER_NUMBER = 169,
AKA_SURNAME_AND_GIVEN_NAMES = 170,
TERRITORIAL_VALIDITY = 171,
MRZ_STRINGS_WITH_CORRECT_CHECK_SUMS = 172,
DL_CDL_RESTRICTION_CODE = 173,
DL_UNDER_18_DATE = 174,
DL_RECORD_CREATED = 175,
DL_DUPLICATE_DATE = 176,
DL_ISS_TYPE = 177,
MILITARY_BOOK_NUMBER = 178,
DESTINATION = 179,
BLOOD_GROUP = 180,
SEQUENCE_NUMBER = 181,
REG_CERT_BODY_TYPE = 182,
REG_CERT_CAR_MARK = 183,
TRANSACTION_NUMBER = 184,
AGE = 185,
FOLIO_NUMBER = 186,
VOTER_KEY = 187,
ADDRESS_MUNICIPALITY = 188,
ADDRESS_LOCATION = 189,
SECTION = 190,
OCR_NUMBER = 191,
FEDERAL_ELECTIONS = 192,
REFERENCE_NUMBER = 193,
OPTIONAL_DATA_CHECKSUM = 194,
OPTIONAL_DATA_CHECK_DIGIT = 195,
VISA_NUMBER = 196,
VISA_NUMBER_CHECKSUM = 197,
VISA_NUMBER_CHECK_DIGIT = 198,
VOTER = 199,
PREVIOUS_TYPE = 200,
FIELD_FROM_MRZ = 220,
CURRENT_DATE = 221,
STATUS_DATE_OF_EXPIRY = 251,
BANKNOTE_NUMBER = 252,
CSC_CODE = 253,
ARTISTIC_NAME = 254,
ACADEMIC_TITLE = 255,
ADDRESS_COUNTRY = 256,
ADDRESS_ZIPCODE = 257,
E_ID_RESIDENCE_PERMIT_1 = 258,
E_ID_RESIDENCE_PERMIT_2 = 259,
E_ID_PLACE_OF_BIRTH_STREET = 260,
E_ID_PLACE_OF_BIRTH_CITY = 261,
E_ID_PLACE_OF_BIRTH_STATE = 262,
E_ID_PLACE_OF_BIRTH_COUNTRY = 263,
E_ID_PLACE_OF_BIRTH_ZIPCODE = 264,
CDL_CLASS = 265,
DL_UNDER_19_DATE = 266,
WEIGHT_POUNDS = 267,
LIMITED_DURATION_DOCUMENT_INDICATOR = 268,
ENDORSEMENT_EXPIRATION_DATE = 269,
REVISION_DATE = 270,
COMPLIANCE_TYPE = 271,
FAMILY_NAME_TRUNCATION = 272,
FIRST_NAME_TRUNCATION = 273,
MIDDLE_NAME_TRUNCATION = 274,
EXAM_DATE = 275,
ORGANIZATION = 276,
DEPARTMENT = 277,
PAY_GRADE = 278,
RANK = 279,
BENEFITS_NUMBER = 280,
SPONSOR_SERVICE = 281,
SPONSOR_STATUS = 282,
SPONSOR = 283,
RELATIONSHIP = 284,
USCIS = 285,
CATEGORY = 286,
CONDITIONS = 287,
IDENTIFIER = 288,
CONFIGURATION = 289,
DISCRETIONARY_DATA = 290,
LINE_1_OPTIONAL_DATA = 291,
LINE_2_OPTIONAL_DATA = 292,
LINE_3_OPTIONAL_DATA = 293,
EQV_CODE = 294,
ALT_CODE = 295,
BINARY_CODE = 296,
PSEUDO_CODE = 297,
FEE = 298,
STAMP_NUMBER = 299,
SBH_SECURITYOPTIONS = 300,
SBH_INTEGRITYOPTIONS = 301,
DATE_OF_CREATION = 302,
VALIDITY_PERIOD = 303,
PATRON_HEADER_VERSION = 304,
BDB_TYPE = 305,
BIOMETRIC_TYPE = 306,
BIOMETRIC_SUBTYPE = 307,
BIOMETRIC_PRODUCTID = 308,
BIOMETRIC_FORMAT_OWNER = 309,
BIOMETRIC_FORMAT_TYPE = 310,
PHONE = 311,
PROFESSION = 312,
TITLE = 313,
PERSONAL_SUMMARY = 314,
OTHER_VALID_ID = 315,
CUSTODY_INFO = 316,
OTHER_NAME = 317,
OBSERVATIONS = 318,
TAX = 319,
DATE_OF_PERSONALIZATION = 320,
PERSONALIZATION_SN = 321,
OTHERPERSON_NAME = 322,
PERSONTONOTIFY_DATE_OF_RECORD = 323,
PERSONTONOTIFY_NAME = 324,
PERSONTONOTIFY_PHONE = 325,
PERSONTONOTIFY_ADDRESS = 326,
DS_CERTIFICATE_ISSUER = 327,
DS_CERTIFICATE_SUBJECT = 328,
DS_CERTIFICATE_VALIDFROM = 329,
DS_CERTIFICATE_VALIDTO = 330,
VRC_DATAOBJECT_ENTRY = 331,
TYPE_APPROVAL_NUMBER = 332,
ADMINISTRATIVE_NUMBER = 333,
DOCUMENT_DISCRIMINATOR = 334,
DATA_DISCRIMINATOR = 335,
ISO_ISSUER_ID_NUMBER = 336,
GNIB_NUMBER = 340,
DEPT_NUMBER = 341,
TELEX_CODE = 342,
ALLERGIES = 343,
SP_CODE = 344,
COURT_CODE = 345,
CTY = 346,
SPONSOR_SSN = 347,
DO_D_NUMBER = 348,
MC_NOVICE_DATE = 349,
DUF_NUMBER = 350,
AGY = 351,
PNR_CODE = 352,
FROM_AIRPORT_CODE = 353,
TO_AIRPORT_CODE = 354,
FLIGHT_NUMBER = 355,
DATE_OF_FLIGHT = 356,
SEAT_NUMBER = 357,
DATE_OF_ISSUE_BOARDING_PASS = 358,
CCW_UNTIL = 359,
REFERENCE_NUMBER_CHECKSUM = 360,
REFERENCE_NUMBER_CHECK_DIGIT = 361,
ROOM_NUMBER = 362,
RELIGION = 363,
REMAINDER_TERM = 364,
ELECTRONIC_TICKET_INDICATOR = 365,
COMPARTMENT_CODE = 366,
CHECK_IN_SEQUENCE_NUMBER = 367,
AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER = 368,
AIRLINE_NUMERIC_CODE = 369,
TICKET_NUMBER = 370,
FREQUENT_FLYER_AIRLINE_DESIGNATOR = 371,
FREQUENT_FLYER_NUMBER = 372,
FREE_BAGGAGE_ALLOWANCE = 373,
PDF_417_CODEC = 374,
IDENTITY_CARD_NUMBER_CHECKSUM = 375,
IDENTITY_CARD_NUMBER_CHECK_DIGIT = 376,
VETERAN = 377,
DL_CLASS_CODE_A_1_FROM = 378,
DL_CLASS_CODE_A_1_TO = 379,
DL_CLASS_CODE_A_1_NOTES = 380,
DL_CLASS_CODE_A_FROM = 381,
DL_CLASS_CODE_A_TO = 382,
DL_CLASS_CODE_A_NOTES = 383,
DL_CLASS_CODE_B_FROM = 384,
DL_CLASS_CODE_B_TO = 385,
DL_CLASS_CODE_B_NOTES = 386,
DL_CLASS_CODE_C_1_FROM = 387,
DL_CLASS_CODE_C_1_TO = 388,
DL_CLASS_CODE_C_1_NOTES = 389,
DL_CLASS_CODE_C_FROM = 390,
DL_CLASS_CODE_C_TO = 391,
DL_CLASS_CODE_C_NOTES = 392,
DL_CLASS_CODE_D_1_FROM = 393,
DL_CLASS_CODE_D_1_TO = 394,
DL_CLASS_CODE_D_1_NOTES = 395,
DL_CLASS_CODE_D_FROM = 396,
DL_CLASS_CODE_D_TO = 397,
DL_CLASS_CODE_D_NOTES = 398,
DL_CLASS_CODE_BE_FROM = 399,
DL_CLASS_CODE_BE_TO = 400,
DL_CLASS_CODE_BE_NOTES = 401,
DL_CLASS_CODE_C_1_E_FROM = 402,
DL_CLASS_CODE_C_1_E_TO = 403,
DL_CLASS_CODE_C_1_E_NOTES = 404,
DL_CLASS_CODE_CE_FROM = 405,
DL_CLASS_CODE_CE_TO = 406,
DL_CLASS_CODE_CE_NOTES = 407,
DL_CLASS_CODE_D_1_E_FROM = 408,
DL_CLASS_CODE_D_1_E_TO = 409,
DL_CLASS_CODE_D_1_E_NOTES = 410,
DL_CLASS_CODE_DE_FROM = 411,
DL_CLASS_CODE_DE_TO = 412,
DL_CLASS_CODE_DE_NOTES = 413,
DL_CLASS_CODE_M_FROM = 414,
DL_CLASS_CODE_M_TO = 415,
DL_CLASS_CODE_M_NOTES = 416,
DL_CLASS_CODE_L_FROM = 417,
DL_CLASS_CODE_L_TO = 418,
DL_CLASS_CODE_L_NOTES = 419,
DL_CLASS_CODE_T_FROM = 420,
DL_CLASS_CODE_T_TO = 421,
DL_CLASS_CODE_T_NOTES = 422,
DL_CLASS_CODE_AM_FROM = 423,
DL_CLASS_CODE_AM_TO = 424,
DL_CLASS_CODE_AM_NOTES = 425,
DL_CLASS_CODE_A_2_FROM = 426,
DL_CLASS_CODE_A_2_TO = 427,
DL_CLASS_CODE_A_2_NOTES = 428,
DL_CLASS_CODE_B_1_FROM = 429,
DL_CLASS_CODE_B_1_TO = 430,
DL_CLASS_CODE_B_1_NOTES = 431,
SURNAME_AT_BIRTH = 432,
CIVIL_STATUS = 433,
NUMBER_OF_SEATS = 434,
NUMBER_OF_STANDING_PLACES = 435,
MAX_SPEED = 436,
FUEL_TYPE = 437,
EC_ENVIRONMENTAL_TYPE = 438,
POWER_WEIGHT_RATIO = 439,
MAX_MASS_OF_TRAILER_BRAKED = 440,
MAX_MASS_OF_TRAILER_UNBRAKED = 441,
TRANSMISSION_TYPE = 442,
TRAILER_HITCH = 443,
ACCOMPANIED_BY = 444,
POLICE_DISTRICT = 445,
FIRST_ISSUE_DATE = 446,
PAYLOAD_CAPACITY = 447,
NUMBER_OF_AXELS = 448,
PERMISSIBLE_AXLE_LOAD = 449,
PRECINCT = 450,
INVITED_BY = 451,
PURPOSE_OF_ENTRY = 452,
SKIN_COLOR = 453,
COMPLEXION = 454,
AIRPORT_FROM = 455,
AIRPORT_TO = 456,
AIRLINE_NAME = 457,
AIRLINE_NAME_FREQUENT_FLYER = 458,
LICENSE_NUMBER = 459,
IN_TANKS = 460,
EXEPT_IN_TANKS = 461,
FAST_TRACK = 462,
OWNER = 463,
MRZ_STRINGS_ICAO_RFID = 464,
NUMBER_OF_CARD_ISSUANCE = 465,
NUMBER_OF_CARD_ISSUANCE_CHECKSUM = 466,
NUMBER_OF_CARD_ISSUANCE_CHECK_DIGIT = 467,
CENTURY_DATE_OF_BIRTH = 468,
DL_CLASSCODE_A3_FROM = 469,
DL_CLASSCODE_A3_TO = 470,
DL_CLASSCODE_A3_NOTES = 471,
DL_CLASSCODE_C2_FROM = 472,
DL_CLASSCODE_C2_TO = 473,
DL_CLASSCODE_C2_NOTES = 474,
DL_CLASSCODE_B2_FROM = 475,
DL_CLASSCODE_B2_TO = 476,
DL_CLASSCODE_B2_NOTES = 477,
DL_CLASSCODE_D2_FROM = 478,
DL_CLASSCODE_D2_TO = 479,
DL_CLASSCODE_D2_NOTES = 480,
DL_CLASSCODE_B2E_FROM = 481,
DL_CLASSCODE_B2E_TO = 482,
DL_CLASSCODE_B2E_NOTES = 483,
DL_CLASSCODE_G_FROM = 484,
DL_CLASSCODE_G_TO = 485,
DL_CLASSCODE_G_NOTES = 486,
DL_CLASSCODE_J_FROM = 487,
DL_CLASSCODE_J_TO = 488,
DL_CLASSCODE_J_NOTES = 489,
DL_CLASSCODE_LC_FROM = 490,
DL_CLASSCODE_LC_TO = 491,
DLC_LASSCODE_LC_NOTES = 492,
BANKCARDNUMBER = 493,
BANKCARDVALIDTHRU = 494,
TAX_NUMBER = 495,
HEALTH_NUMBER = 496,
GRANDFATHERNAME = 497,
SELECTEE_INDICATOR = 498,
MOTHER_SURNAME = 499,
MOTHER_GIVENNAME = 500,
FATHER_SURNAME = 501,
FATHER_GIVENNAME = 502,
MOTHER_DATEOFBIRTH = 503,
FATHER_DATEOFBIRTH = 504,
MOTHER_PERSONALNUMBER = 505,
FATHER_PERSONALNUMBER = 506,
MOTHER_PLACEOFBIRTH = 507,
FATHER_PLACEOFBIRTH = 508,
MOTHER_COUNTRYOFBIRTH = 509,
FATHER_COUNTRYOFBIRTH = 510,
DATE_FIRST_RENEWAL = 511,
DATE_SECOND_RENEWAL = 512,
PLACE_OF_EXAMINATION = 513,
APPLICATION_NUMBER = 514,
VOUCHER_NUMBER = 515,
AUTHORIZATION_NUMBER = 516,
FACULTY = 517,
FORM_OF_EDUCATION = 518,
DNI_NUMBER = 519,
RETIREMENT_NUMBER = 520,
PROFESSIONAL_ID_NUMBER = 521,
AGE_AT_ISSUE = 522,
YEARS_SINCE_ISSUE = 523,
DLCLASSCODE_BTP_FROM = 524,
DLCLASSCODE_BTP_NOTES = 525,
DLCLASSCODE_BTP_TO = 526,
DLCLASSCODE_C3_FROM = 527,
DLCLASSCODE_C3_NOTES = 528,
DLCLASSCODE_C3_TO = 529,
DLCLASSCODE_E_FROM = 530,
DLCLASSCODE_E_NOTES = 531,
DLCLASSCODE_E_TO = 532,
DLCLASSCODE_F_FROM = 533,
DLCLASSCODE_F_NOTES = 534,
DLCLASSCODE_F_TO = 535,
DLCLASSCODE_FA_FROM = 536,
DLCLASSCODE_FA_NOTES = 537,
DLCLASSCODE_FA_TO = 538,
DLCLASSCODE_FA1_FROM = 539,
DLCLASSCODE_FA1_NOTES = 540,
DLCLASSCODE_FA1_TO = 541,
DLCLASSCODE_FB_FROM = 542,
DLCLASSCODE_FB_NOTES = 543,
DLCLASSCODE_FB_TO = 544,
DLCLASSCODE_G1_FROM = 545,
DLCLASSCODE_G1_NOTES = 546,
DLCLASSCODE_G1_TO = 547,
DLCLASSCODE_H_FROM = 548,
DLCLASSCODE_H_NOTES = 549,
DLCLASSCODE_H_TO = 550,
DLCLASSCODE_I_FROM = 551,
DLCLASSCODE_I_NOTES = 552,
DLCLASSCODE_I_TO = 553,
DLCLASSCODE_K_FROM = 554,
DLCLASSCODE_K_NOTES = 555,
DLCLASSCODE_K_TO = 556,
DLCLASSCODE_LK_FROM = 557,
DLCLASSCODE_LK_NOTES = 558,
DLCLASSCODE_LK_TO = 559,
DLCLASSCODE_N_FROM = 560,
DLCLASSCODE_N_NOTES = 561,
DLCLASSCODE_N_TO = 562,
DLCLASSCODE_S_FROM = 563,
DLCLASSCODE_S_NOTES = 564,
DLCLASSCODE_S_TO = 565,
DLCLASSCODE_TB_FROM = 566,
DLCLASSCODE_TB_NOTES = 567,
DLCLASSCODE_TB_TO = 568,
DLCLASSCODE_TM_FROM = 569,
DLCLASSCODE_TM_NOTES = 570,
DLCLASSCODE_TM_TO = 571,
DLCLASSCODE_TR_FROM = 572,
DLCLASSCODE_TR_NOTES = 573,
DLCLASSCODE_TR_TO = 574,
DLCLASSCODE_TV_FROM = 575,
DLCLASSCODE_TV_NOTES = 576,
DLCLASSCODE_TV_TO = 577,
DLCLASSCODE_V_FROM = 578,
DLCLASSCODE_V_NOTES = 579,
DLCLASSCODE_V_TO = 580,
DLCLASSCODE_W_FROM = 581,
DLCLASSCODE_W_NOTES = 582,
DLCLASSCODE_W_TO = 583,
URL = 584,
CALIBER = 585,
MODEL = 586,
MAKE = 587,
NUMBER_OF_CYLINDERS = 588,
SURNAME_OF_HUSBAND_AFTER_REGISTRATION = 589,
SURNAME_OF_WIFE_AFTER_REGISTRATION = 590,
DATE_OF_BIRTH_OF_WIFE = 591,
DATE_OF_BIRTH_OF_HUSBAND = 592,
CITIZENSHIP_OF_FIRST_PERSON = 593,
CITIZENSHIP_OF_SECOND_PERSON = 594,
CVV = 595,
DATE_OF_INSURANCE_EXPIRY = 596,
MORTGAGE_BY = 597,
OLD_DOCUMENT_NUMBER = 598,
OLD_DATE_OF_ISSUE = 599,
OLD_PLACE_OF_ISSUE = 600,
DLCLASSCODE_LR_FROM = 601,
DLCLASSCODE_LR_TO = 602,
DLCLASSCODE_LR_NOTES = 603,
DLCLASSCODE_MR_FROM = 604,
DLCLASSCODE_MR_TO = 605,
DLCLASSCODE_MR_NOTES = 606,
DLCLASSCODE_HR_FROM = 607,
DLCLASSCODE_HR_TO = 608,
DLCLASSCODE_HR_NOTES = 609,
DLCLASSCODE_HC_FROM = 610,
DLCLASSCODE_HC_TO = 611,
DLCLASSCODE_HC_NOTES = 612,
DLCLASSCODE_MC_FROM = 613,
DLCLASSCODE_MC_TO = 614,
DLCLASSCODE_MC_NOTES = 615,
DLCLASSCODE_RE_FROM = 616,
DLCLASSCODE_RE_TO = 617,
DLCLASSCODE_RE_NOTES = 618,
DLCLASSCODE_R_FROM = 619,
DLCLASSCODE_R_TO = 620,
DLCLASSCODE_R_NOTES = 621,
DLCLASSCODE_CA_FROM = 622,
DLCLASSCODE_CA_TO = 623,
DLCLASSCODE_CA_NOTES = 624,
CITIZENSHIP_STATUS = 625,
}export enum LcidEnum {
LATIN = 0,
AFRIKAANS = 1078,
ALBANIAN = 1052,
ARABIC_ALGERIA = 5121,
ARABIC_BAHRAIN = 15361,
ARABIC_EGYPT = 3073,
ARABIC_IRAQ = 2049,
ARABIC_JORDAN = 11265,
ARABIC_KUWAIT = 13313,
ARABIC_LEBANON = 12289,
ARABIC_LIBYA = 4097,
ARABIC_MOROCCO = 6145,
ARABIC_OMAN = 8193,
ARABIC_QATAR = 16385,
ARABIC_SAUDI_ARABIA = 1025,
ARABIC_SYRIA = 10241,
ARABIC_TUNISIA = 7169,
ARABIC_UAE = 14337,
ARABIC_YEMEN = 9217,
ARABIC_ARMENIAN = 1067,
AZERI_CYRILIC = 2092,
AZERI_LATIN = 1068,
BASQUE = 1069,
BELARUSIAN = 1059,
BULGARIAN = 1026,
CATALAN = 1027,
CHINESE_HONGKONG_SAR = 3076,
CHINESE_MACAO_SAR = 5124,
CHINESE = 2052,
CHINESE_SINGAPORE = 4100,
CHINESE_TAIWAN = 1028,
CROATIAN = 1050,
CZECH = 1029,
DANISH = 1030,
DIVEHI = 1125,
DUTCH_BELGIUM = 2067,
DUTCH_NETHERLANDS = 1043,
ENGLISH_AUSTRALIA = 3081,
ENGLISH_BELIZE = 10249,
ENGLISH_CANADA = 4105,
ENGLISH_CARRIBEAN = 9225,
ENGLISH_IRELAND = 6153,
ENGLISH_JAMAICA = 8201,
ENGLISH_NEW_ZEALAND = 5129,
ENGLISH_PHILIPPINES = 13321,
ENGLISH_SOUTH_AFRICA = 7177,
ENGLISH_TRINIDAD = 11273,
ENGLISH_UK = 2057,
ENGLISH_US = 1033,
ENGLISH_ZIMBABWE = 12297,
ESTONIAN = 1061,
FAEROESE = 1080,
FARSI = 1065,
FINNISH = 1035,
FRENCH_BELGIUM = 2060,
FRENCH_CANADA = 3084,
FRENCH_FRANCE = 1036,
FRENCH_LUXEMBOURG = 5132,
FRENCH_MONACO = 6156,
FRENCH_SWITZERLAND = 4108,
FYRO_MACEDONIAN = 1071,
GALICIAN = 1110,
GEORGIAN = 1079,
GERMAN_AUSTRIA = 3079,
GERMAN_GERMANY = 1031,
GERMAN_LIECHTENSTEIN = 5127,
GERMAN_LUXEMBOURG = 4103,
GERMAN_SWITZERLAND = 2055,
GREEK = 1032,
GUJARATI = 1095,
HEBREW = 1037,
HINDI_INDIA = 1081,
HUNGARIAN = 1038,
ICELANDIC = 1039,
INDONESIAN = 1057,
ITALIAN_ITALY = 1040,
ITALIAN_SWITZERLAND = 2064,
JAPANESE = 1041,
KANNADA = 1099,
KAZAKH = 1087,
KONKANI = 1111,
KOREAN = 1042,
KYRGYZ_CYRILICK = 1088,
LATVIAN = 1062,
LITHUANIAN = 1063,
MALAY_MALAYSIA = 1086,
MALAY_BRUNEI_DARUSSALAM = 2110,
MARATHI = 1102,
MONGOLIAN_CYRILIC = 1104,
NORWEGIAN_BOKMAL = 1044,
NORWEGIAN_NYORSK = 2068,
POLISH = 1045,
PORTUGUESE_BRAZIL = 1046,
PORTUGUESE_PORTUGAL = 2070,
PUNJABI = 1094,
RHAETO_ROMANIC = 1047,
ROMANIAN = 1048,
RUSSIAN = 1049,
SANSKRIT = 1103,
SERBIAN_CYRILIC = 3098,
SERBIAN_LATIN = 2074,
SLOVAK = 1051,
SLOVENIAN = 1060,
SPANISH_ARGENTINA = 11274,
SPANISH_BOLIVIA = 16394,
SPANISH_CHILE = 13322,
SPANICH_COLOMBIA = 9226,
SPANISH_COSTA_RICA = 5130,
SPANISH_DOMINICAN_REPUBLIC = 7178,
SPANISH_ECUADOR = 12298,
SPANISH_EL_SALVADOR = 17418,
SPANISH_GUATEMALA = 4106,
SPANISH_HONDURAS = 18442,
SPANISH_MEXICO = 2058,
SPANISH_NICARAGUA = 19466,
SPANISH_PANAMA = 6154,
SPANISH_PARAGUAY = 15370,
SPANISH_PERU = 10250,
SPANISH_PUERTO_RICO = 20490,
SPANISH_TRADITIONAL_SORT = 1034,
SPANISH_INTERNATIONAL_SORT = 3082,
SPANISH_URUGUAY = 14346,
SPANISH_VENEZUELA = 8202,
SWAHILI = 1089,
SWEDISH = 1053,
SWEDISH_FINLAND = 2077,
SYRIAC = 1114,
TAMIL = 1097,
TATAR = 1092,
TELUGU = 1098,
THAI_THAILAND = 1054,
TURKISH = 1055,
TAJIK_CYRILLIC = 1064,
TURKMEN = 1090,
UKRAINIAN = 1058,
URDU = 1056,
UZBEK_CYRILIC = 2115,
UZBEK_LATIN = 1091,
VIETNAMESE = 1066,
CTC_SIMPLIFIED = 50001,
CTC_TRADITIONAL = 50002,
}export enum ReviewStatusEnum {
INIT = 'INIT',
IN_PROGRESS = 'IN_PROGRESS',
INCOMPLETE = 'INCOMPLETE',
REJECTED = 'REJECTED',
APPROVED = 'APPROVED',
COMPLETED = 'COMPLETED',
ON_HOLD = 'ON_HOLD',
}export enum FieldVerificationResultEnum {
DISABLED = 0,
VERIFIED = 1,
NOT_VERIFIED = 2,
COMPARE_TRUE = 3,
COMPARE_FALSE = 4,
}// ```typescript
enum WebhookApplicantEventsEnum {
APPLICANT_CREATED = 'applicantCreated',
APPLICANT_IN_PROGRESS = 'applicantInProgress',
APPLICANT_INCOMPLETE = 'applicantIncomplete',
APPLICANT_IN_REVIEW = 'applicantInReview',
APPLICANT_REJECTED = 'applicantRejected',
APPLICANT_APPROVED = 'applicantApproved',
APPLICANT_COMPLETED = 'applicantCompleted',
APPLICANT_AML_UPDATED = 'applicantAmlUpdated',
APPLICANT_STEP_PASSED = 'applicantStepPassed',
APPLICANT_DUPLICATE_DOCUMENT = 'applicantDuplicateDocument',
EXPIRED_DOCUMENT = 'expiredDocument',
ADDITIONAL_DOCUMENT_STEP_ERROR = 'additionalDocumentStepError',
APPLICANT_DUPLICATE_EMAIL = 'applicantDuplicateEmail',
APPLICANT_DUPLICATE_PHONE = 'applicantDuplicatePhone',
AML_POSITIVE_CASES = 'amlPositiveCases',
AML_CANNOT_STARTED = 'amlCannotStarted',
AML_RESULT_UPDATED = 'amlResultUpdated',
CRYPTO_AML_RESULT = 'cryptoAmlResult',
APPLICANT_DUPLICATE_CRYPTO_ADDRESS = 'applicantDuplicateCryptoAddress',
}
```