Skip to content

Overview (1.0)

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

Addresses

Addresses

Operations

Affiliated persons

Affiliated persons

Operations

Applicants

Applicants

Operations

Documents

Documents

Operations

Create a document

Request

Create a new document object in our system

Security
your_api_key
Bodyapplication/json
One of:

A payment card issued by a bank or a financial institution that allows a cardholder to access their bank account. It typically includes a cardholder name, a card number, an expiration date, and a security code.

⚠️ Only one document with CREDIT_CARD document type may be associated with one applicant object via applicant_id.

⚠️ After a verification was created, a new document may be added for the same applicant object via applicant_id, replacing the one added before.

applicant_idstring= 36 charactersrequired
typestringrequired
Default "CREDIT_CARD"
Example: "CREDIT_CARD"
card_numberstring or null[ 12 .. 19 ] characters
account_numberstring or null<= 50 characters
front_side_idstring or null= 36 characters
back_side_idstring or null= 36 characters
other_side_1_idstring or null= 36 characters
other_side_2_idstring or null= 36 characters
other_side_3_idstring or null= 36 characters
application/json
{
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7",
  "type": "CREDIT_CARD",
  "card_number": "5375411422962063",
  "account_number": "UA383220010000026200330646508",
  "front_side_id": "46b05f5c14c162402d186822fa0314c6162c",
  "back_side_id": "b969e3d413fb3246f119c4734739f5cac987",
  "other_side_1_id": "46b05f5c14c162402d186822fa0314c6162c",
  "other_side_2_id": "f57963fa13e42248fb1b64c3357fc97a8737",
  "other_side_3_id": "b56147eb1c31a248401aed83bf5670f2c520"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
document_idstring= 36 characters
Response
application/json
{
  "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd"
}

Get a document

Request

Get records of a created document object

Security
your_api_key
Path
document_idstring= 36 charactersrequired

A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request

Example: 5f9aeb5e1f25e2441d182f56b6dcbfac12dd
No request payload

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
One of:
document_idstring= 36 characters
applicant_idstring= 36 characters
typestring
Default "CREDIT_CARD"
Example: "CREDIT_CARD"
providerstring
Enum"ADMIN""IN_AADHAAR""KZ_ADATA""MANUAL""RECOGNITION""UA_BANK_ID""UA_DIIA"
statusstring or null
Enum"new""valid""invalid"
commentstring or null<= 1000 characters
Example: null
document_numberstring or null<= 50 characters
Example: null
additional_numberstring or null<= 50 characters
Example: null
issue_datestring or null(date)<= 10 characters
Example: null
expiry_datestring or null(date)<= 10 characters
Example: null
issuing_authoritystring or null<= 255 characters
Example: null
income_sourcesArray of strings
Items Enum"SALARY""DIVIDENDS""SALE_PROPERTY""SAVINGS""DIVORCE_SETTLEMENTS""INHERITANCE""LOAN""INVESTMENTS""OTHER"
Example: null
annual_incomestring or null
Enum"ANNUAL_INCOME_GROUP_1""ANNUAL_INCOME_GROUP_2""ANNUAL_INCOME_GROUP_3""ANNUAL_INCOME_GROUP_4"null
Example: null
transaction_amountnumber or null(float)
Example: null
transaction_currencystring or null<= 3 characters
Example: null
transaction_datetimestring or null(date-time)
Example: null
transaction_purposestring or null<= 255 characters
Example: null
origin_fundsstring or null<= 255 characters
Example: null
card_numberstring or null[ 12 .. 19 ] characters
account_numberstring or null<= 50 characters
portraitstring or null<= 2048 characters
Example: null
front_side_idstring or null= 36 characters
Example: null
front_sidestring or null<= 2048 characters
Example: null
back_side_idstring or null= 36 characters
Example: null
back_sidestring or null<= 2048 characters
Example: null
other_side_1_idstring or null= 36 characters
Example: null
other_side_1string or null<= 2048 characters
Example: null
other_side_2_idstring or null= 36 characters
Example: null
other_side_2string or null<= 2048 characters
Example: null
other_side_3_idstring or null= 36 characters
Example: null
other_side_3string or null= 36 characters
Example: null
created_atstring(date-time)
decline_reasons_idsArray of integers or null or null
Enum123457891011
Example: null
decline_reasonsArray of strings or null or null
Enum"AGE_RESTRICTION""BAD_QUALITY""COMPROMISED_PERSON""COMPULSION""DIFFERENT_FACES""DOCUMENT_DAMAGED""DOCUMENT_INCOMPLETE""DUPLICATE""EDITED_DOCUMENT""EXPIRED_DOCUMENT"
Example: []
Response
application/json
{
  "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd",
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7",
  "type": "CREDIT_CARD",
  "provider": "MANUAL",
  "status": "new",
  "comment": null,
  "document_number": null,
  "additional_number": null,
  "issue_date": null,
  "expiry_date": null,
  "issuing_authority": null,
  "income_sources": [],
  "annual_income": null,
  "transaction_amount": null,
  "transaction_currency": null,
  "transaction_datetime": null,
  "transaction_purpose": null,
  "origin_funds": null,
  "card_number": "5375411422962063",
  "account_number": "UA383220010000026200330646508",
  "portrait": null,
  "front_side_id": null,
  "front_side": null,
  "back_side_id": null,
  "back_side": null,
  "other_side_1_id": null,
  "other_side_1": null,
  "other_side_2_id": null,
  "other_side_2": null,
  "other_side_3_id": null,
  "other_side_3": null,
  "created_at": "2024-07-01 15:27:15",
  "decline_reasons_ids": null,
  "decline_reasons": []
}

Update a document

Request

Update records of a created document object

Security
your_api_key
Path
document_idstring= 36 charactersrequired

A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request

Example: 5f9aeb5e1f25e2441d182f56b6dcbfac12dd
Bodyapplication/json
typestring
Enum"ADDRESS_DOCUMENT""AUTHORISED_PERSON""BANK_STATEMENT""COMPANY_LEGAL_ADDRESS""COMPANY_OWNERSHIP""CREDIT_CARD""DOMESTIC_PASSPORT""DRIVERS_LICENSE""FINANCIAL_DOCUMENT""FOREIGN_CITIZEN_PASSPORT"
document_numberstring or null<= 50 characters
additional_numberstring or null<= 50 characters
issue_datestring or null(date)<= 10 characters
expiry_datestring or null(date)<= 10 characters
issuing_authoritystring or null<= 255 characters
income_sourcesArray of strings
Items Enum"SALARY""DIVIDENDS""SALE_PROPERTY""SAVINGS""DIVORCE_SETTLEMENTS""INHERITANCE""LOAN""INVESTMENTS""OTHER"
annual_incomestring or null
Enum"ANNUAL_INCOME_GROUP_1""ANNUAL_INCOME_GROUP_2""ANNUAL_INCOME_GROUP_3""ANNUAL_INCOME_GROUP_4"null
transaction_amountnumber or null(float)
transaction_currencystring or null<= 3 characters
transaction_datetimestring or null(date-time)
transaction_purposestring or null<= 255 characters
origin_fundsstring or null<= 255 characters
card_numberstring or null[ 12 .. 19 ] characters
account_numberstring or null<= 50 characters
front_side_idstring or null= 36 characters
back_side_idstring or null= 36 characters
other_side_1_idstring or null= 36 characters
other_side_2_idstring or null= 36 characters
other_side_3_idstring or null= 36 characters
application/json
{
  "type": "DOMESTIC_PASSPORT",
  "document_number": "TH703318A",
  "additional_number": "E2100007T-5",
  "issue_date": "2020-11-04",
  "expiry_date": "2028-11-04",
  "issuing_authority": "Social Security Administration",
  "income_sources": [
    "SAVINGS",
    "OTHER"
  ],
  "annual_income": "ANNUAL_INCOME_GROUP_2",
  "transaction_amount": 14008.55,
  "transaction_currency": "EUR",
  "transaction_datetime": "2024-11-16 14:22:54",
  "transaction_purpose": "Payment for additional services",
  "origin_funds": "Business revenues",
  "card_number": "5375411422962063",
  "account_number": "UA383220010000026200330646508",
  "front_side_id": "46b05f5c14c162402d186822fa0314c6162c",
  "back_side_id": "b969e3d413fb3246f119c4734739f5cac987",
  "other_side_1_id": "46b05f5c14c162402d186822fa0314c6162c",
  "other_side_2_id": "f57963fa13e42248fb1b64c3357fc97a8737",
  "other_side_3_id": "b56147eb1c31a248401aed83bf5670f2c520"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
document_idstring= 36 characters
Response
application/json
{
  "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd"
}

Delete a document

Request

Delete records of a created document object

Security
your_api_key
Path
document_idstring= 36 charactersrequired

A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request

Example: 5f9aeb5e1f25e2441d182f56b6dcbfac12dd
No request payload

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
document_idstring= 36 characters
Response
application/json
{
  "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd"
}

Files

Files

Operations

Forms

Forms

Operations

Verifications

Verifications

Operations