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.
A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
https://api.kycaid.com/documents
{ "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" }
{ "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd" }
https://api.kycaid.com/documents/{document_id}
No request payloadA unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request
A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request
A person or a service, that created initiated document creation:
ADMIN: A managerIN_AADHAAR: Indian Aahaar serviceKZ_ADATA: Kazakhstan Adata serviceMANUAL: API request or a form initialisationRECOGNITION: Recognition serviceUA_BANK_ID: Ukrainian BankID serviceUA_DIIA: Ukrainian Diia serviceA status of document verification. Set automatically by our system or manually in the Admin panel or in the Dashboard after reviewal.
new: a newly created document, that was not reviewedvalid: a reviewed and approved documentinvalid: a reviewed and declined documentAn additional comment added manually in the Admin panel or in the Dashboard regarding reasons of document verification decline (invalid status)
An additional number located on a document (e.g. tax ID number located on an ID card)
An issue date of a document in YYYY-MM-DD format
The date of document expiration, formatted according to ISO 8601
A name of a govenment entity that issues official documents
Category of a person or an entity earnings
An annual income group that categorizes persons or entities based on their total yearly income. There are four groups available:
ANNUAL_INCOME_GROUP_1: less than 50,000 EURANNUAL_INCOME_GROUP_2: between 50,000 and 100,000 EURANNUAL_INCOME_GROUP_3: between 100,000 and 300,000 EURANNUAL_INCOME_GROUP_4: more than 300,000 EURAn amount of a financial transaction. A three-letter currency code according to ISO 4217. Ticker symbols are also accepted (e.g. BTC, ETH, SOL)
A date and time of a financial transaction in YYYY-MM-DD HH:mm:ss format
A definition of an intended reason or objective for a financial transaction
A URL of a person portrait photo, extracted from a document file by our system
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A URL of an uploaded front side (first page) of a document file
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A URL of an uploaded back side (second page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A URL of an uploaded third page of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A URL of an uploaded fourth page of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A list of IDs of reasons why a document was declined.
1: OTHER2: WRONG_NAME3: WRONG_DOB4: AGE_RESTRICTION5: EXPIRED_DOCUMENT7: BAD_QUALITY8: FAKE_DOCUMENT9: WRONG_INFO10: PROHIBITED_JURISDICTION11: NO_SELFIE12: DIFFERENT_FACES13: WRONG_DOCUMENT24: DUPLICATE25: DOCUMENT_DAMAGED26: DOCUMENT_INCOMPLETE27: FRAUDULENT28: TAX_ID_REQUIRED29: COMPROMISED_PERSON30: EDITED_DOCUMENT31: MULTIPLE_PERSON32: COMPULSION33: LIMIT_REACHED_OTP34: IP_MISMATCH35: ANONYMIZING_NETWORK36: QES_MISMATCHAn explanation of why a document was declined by our system or by a manager.
AGE_RESTRICTION: A document of a person doesnt meet minimum requirementsANONYMIZING_NETWORK: Our system detected that a person uses an anonymous networkBAD_QUALITY: A document image provided is of poor quality, making it unreadableCOMPROMISED_PERSON: A person has been flagged as compromised in a blacklist databaseCOMPULSION: A document capture may have been forced, indicating potential coercion or lack of consentDIFFERENT_FACES: Faces in a document and selfie do not match, indicating a discrepancyDOCUMENT_DAMAGED: A document is physically damaged and cannot be recognisedDOCUMENT_INCOMPLETE: A document is missing required sections or pages for verificationDUPLICATE: An applicant with a document already exists in our system, creating unallowed duplicationEDITED_DOCUMENT: A document has been tampered with or edited, leading to concerns about authenticityEXPIRED_DOCUMENT: A document has passed its expiration date and is no longer validFAKE_DOCUMENT: A document provided is fraudulent, contains signs of forgery, or does not correspond to an official formatFRAUDULENT: A document shows clear signs of fraudulent activity or intentIP_MISMATCH: An issuing country of a document does not match person IP addressLIMIT_REACHED_OTP: Wrong one-time passwords (OTP) were entered several times during document confirmation, reaching a limit of the number of attemptsMULTIPLE_PERSON: A document includes more than one person, which is not permittedNO_SELFIE: A required selfie was not providedOTHER: Any issue or reason not covered by the predefined categoriesPROHIBITED_JURISDICTION: A document originates from a jurisdiction restricted or prohibited by a policyQES_MISMATCH: An information from Qualified Electronic Signature (QES) does not match a person profileTAX_ID_REQUIRED: A valid tax identification number is mandatory but was not providedWRONG_DOB: A date of birth provided does not match the one on a documentWRONG_DOCUMENT: A submitted document type is not supported for a document owner typeWRONG_INFO: An information provided does not match details in a documentWRONG_NAME: Names provided do not align with the ones on a document{ "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": [] }
A type of a document object
An additional number located on a document (e.g. tax ID number located on an ID card)
The date of document expiration, formatted according to ISO 8601
A name of a govenment entity that issues official documents
Category of a person or an entity earnings
An annual income group that categorizes persons or entities based on their total yearly income. There are four groups available:
ANNUAL_INCOME_GROUP_1: less than 50,000 EURANNUAL_INCOME_GROUP_2: between 50,000 and 100,000 EURANNUAL_INCOME_GROUP_3: between 100,000 and 300,000 EURANNUAL_INCOME_GROUP_4: more than 300,000 EURAn amount of a financial transaction. A three-letter currency code according to ISO 4217. Ticker symbols are also accepted (e.g. BTC, ETH, SOL)
A date and time of a financial transaction in YYYY-MM-DD HH:mm:ss format
A definition of an intended reason or objective for a financial transaction
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document
https://api.kycaid.com/documents/{document_id}
{ "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" }
{ "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd" }
https://api.kycaid.com/documents/{document_id}
No request payload{ "document_id": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd" }