{ "openapi": "3.1.0", "info": { "title": "Overview", "version": "1.0", "termsOfService": "https://kycaid.com/terms-and-conditions/" }, "servers": [ { "url": "https://api.kycaid.com" } ], "components": { "securitySchemes": { "API-Key": { "type": "apiKey", "in": "header", "name": "API-Key" } }, "schemas": { "400": { "type": "object", "properties": { "type": { "type": "string", "example": "bad_request" }, "errors": { "type": "array" } } }, "402": { "type": "object", "properties": { "type": { "type": "string", "example": "insufficient_funds" }, "errors": { "type": "array" } } }, "429": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "limit_exceeded" }, "message": { "type": "string", "example": "Rate limit exceeded" } } } } } }, "500": { "type": "object", "properties": { "type": { "type": "string", "example": "internal_server" }, "errors": { "type": "array" } } }, "502": { "type": "string", "example": "502502 Bad Gateway" }, "applicant_id": { "title": "Applicant ID", "type": "string", "minLength": 36, "maxLength": 36, "example": "723f46ab04feb64f442946f2953a67eaecf7", "description": "A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request" }, "type--address--person": { "type": "string", "enum": [ "REGISTERED", "ADDITIONAL" ], "example": "REGISTERED", "description": "A type of an address object. The possible types are:\n* `REGISTERED` for the residential address of a person\n* `ADDITIONAL` for any other address associated with a person\n" }, "full_address": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255, "example": "45 High Street, Flat 2A, London, SW1A 1AA, United Kingdom", "description": "A full address of an object, including a street address, a unit, a city, a postal code, a country" }, "country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2, "example": "GB", "description": "A country of an object. A two-letter country code according to ISO 3166-2" }, "state": { "title": "State", "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": null, "description": "A state of a person or a company" }, "region": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "Scotland", "description": "A region of a country of an object" }, "province": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "Ontario", "description": "A province (a sub-region of a country) of an object" }, "city": { "title": "City", "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "London", "description": "A city or a town of a person or a company" }, "district": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "Westminster", "description": "The district (an area of a city) of an object" }, "address": { "title": "Address", "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "45 High Street, Flat 2A", "description": "An address (a street name, a building number, and a unit number) of a person or a company" }, "postal_code": { "title": "Postal code", "type": [ "string", "null" ], "minLength": 1, "maxLength": 20, "example": "SW1A 1AA", "description": "A postal code (zip code, postcode) of a person or a company" }, "street_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "High Street", "description": "A street name of an object" }, "building_number": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 20, "example": "45", "description": "A number of a building of an object" }, "unit_number": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 20, "example": "Flat 2A", "description": "A number of a unit (flat, apartment) of an object" }, "type--address--company": { "type": "string", "enum": [ "REGISTERED", "BUSINESS", "ADDITIONAL" ], "example": "REGISTERED", "description": "A type of an address object. The possible types are:\n* `REGISTERED` for the registered address of a company\n* `BUSINESS` for the primary business location of a company\n* `ADDITIONAL` for any other address associated with a company\n" }, "affiliated_person_id": { "title": "Affiliated person ID", "type": "string", "minLength": 36, "maxLength": 36, "example": "74cec9e50f844748be0bc321a2bf66638f54", "description": "A unique identifier of an affiliated person object, that is assigned by our system after an affiliated person object was created with a “Create an affiliated person” request" }, "type--address--affiliated_person": { "type": "string", "enum": [ "REGISTERED", "ADDITIONAL" ], "example": "REGISTERED", "description": "A type of an address object. The possible types are:\n* `REGISTERED` for the residential address of an affiliated person\n* `ADDITIONAL` for any other address associated with an affiliated person\n" }, "address_id": { "type": "string", "minLength": 36, "maxLength": 36, "example": "723f46ab04feb64f442946f2953a67eaecf7", "description": "A unique identifier of an address object, that is assigned by our system after an address entity was created" }, "type--address--full": { "type": "string", "enum": [ "REGISTERED", "BUSINESS", "ADDITIONAL" ], "example": "REGISTERED", "description": "A type of an address object. The possible types are:\n* `REGISTERED` for the residential address of a person or an affiliated person, or the registered address of a company\n* `BUSINESS` for the primary business location of a company\n* `ADDITIONAL` for any other address associated with a person, an affiliated person, or a company\n" }, "type--affiliated-person--authorised": { "type": "string", "enum": [ "AUTHORISED" ], "example": "AUTHORISED", "description": "A type of an affiliated person object. `AUTHORISED` type is used for adding an authorised affiliated person object" }, "first_name": { "title": "First name", "type": [ "string", "null" ], "format": "name", "minLength": 2, "maxLength": 64, "pattern": "^[a-zA-Z ,.''-]{1,64}$", "example": "Josh", "description": "The first name of a person" }, "last_name": { "title": "Last name", "type": [ "string", "null" ], "format": "name", "minLength": 2, "maxLength": 64, "pattern": "^[a-zA-Z ,.''-]{1,64}$", "example": "Coffey", "description": "The last name of a person" }, "title": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 36, "example": "CDO", "description": "A title of an authorised affiliated person object in a company" }, "dob": { "type": [ "string", "null" ], "format": "date", "example": "1976-02-21", "description": "The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601" }, "residence_country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2, "example": "GB", "description": "A residence country of an object. A two-letter country code according to ISO 3166-2" }, "nationality": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2, "example": "GB", "description": "A nationality country of a person. A two-letter country code according to ISO 3166-2" }, "email": { "title": "Email address", "type": [ "string", "null" ], "format": "email", "minLength": 1, "maxLength": 254, "example": "josh.coffey@example.com", "description": "The email address of a person or a company" }, "type--affiliated-person--beneficial": { "type": "string", "enum": [ "BENEFICIAL" ], "example": "BENEFICIAL", "description": "A type of an affiliated person object. `BENEFICIAL` type is used for adding an beneficial affiliated person" }, "share": { "type": [ "number", "null" ], "format": "float", "minimum": 0, "maximum": 100, "example": 13.05, "description": "A share in percents of a beneficial affiliated person object in a company" }, "type--applicant--person": { "type": "string", "enum": [ "PERSON" ], "example": "PERSON", "description": "A type of an applicant object. `PERSON` type is used for KYC process, and `COMPANY` type is used for KYB process" }, "middle_name": { "title": "Middle name", "type": [ "string", "null" ], "format": "name", "minLength": 2, "maxLength": 64, "pattern": "^[a-zA-Z ,.''-]{1,64}$", "example": "David", "description": "The middle name of a person" }, "gender": { "type": [ "string", "null" ], "enum": [ "M", "F" ], "example": "M", "description": "The gender of a person. `M` indicates male; `F` indicates female" }, "pep": { "type": [ "boolean", "null" ], "enum": [ true, false ], "example": false, "description": "The status of a person as a politically exposed person (PEP)" }, "phone": { "title": "Phone number", "type": [ "string", "null" ], "minLength": 1, "maxLength": 15, "example": "441172345678", "description": "The phone number of a person or a company" }, "telegram_username": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 32, "example": "JoshCoffey", "description": "A username of an object in Telegram instant messaging service" }, "wallet_address": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 50, "example": "0xb96FdB81a90Ee8aB5b69B2b5Eb7a401ab8c274D8", "description": "A cryptocurrency wallet address of an object" }, "external_applicant_id": { "title": "External applicant ID", "type": [ "string", "null" ], "minLength": 0, "maxLength": 50, "example": "cb1eebbe-9945-4e64-8f60-c920f1e3e237", "description": "A unique identifier of your user in your system" }, "custom_field": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 2048, "example": "This applicant was marked as suspicious by Mark L. at 11:40", "description": "A custom parameter to store additional data for an object by your managers" }, "type--applicant--company": { "type": "string", "enum": [ "COMPANY" ], "example": "COMPANY", "description": "A type of an applicant object. `PERSON` type is used for KYC process, and `COMPANY` type is used for KYB process" }, "company_name": { "type": "string", "minLength": 1, "maxLength": 255, "example": "Acme", "description": "A name of a company" }, "business_activity_id": { "type": "string", "minLength": 36, "maxLength": 36, "example": "4e46f42a001ee740a40ae35416507b121d00", "description": "A business activity identifier of a an object. The full list of business activities and their identifiers is accessible in “Business activities” section" }, "registration_country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2, "example": "GB", "description": "A registration country of an object. A two-letter country code according to ISO 3166-2" }, "applicant--post--200": { "type": "object", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" } } }, "applicant--post--429": { "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "example": "The limit for creating applicants has been exceeded (last minute)" } } } } } }, "created_at": { "type": "string", "example": "2024-07-01 15:27:15", "description": "A date and time of creation of an object, set by our system" }, "profile_status": { "type": [ "string", "null" ], "enum": [ "valid", "invalid" ], "example": "valid", "description": "A status of an object profile verification, set by our system or our manager" }, "profile_comment": { "type": [ "string", "null" ], "example": "Suspicious activity", "description": "A custom comment left by our manager for an object" }, "origin_first_name": { "type": [ "string", "null" ], "format": "name", "minLength": 1, "maxLength": 64, "example": "Джош", "description": "A first name of an object, set in a native language" }, "origin_middle_name": { "type": [ "string", "null" ], "format": "name", "minLength": 1, "maxLength": 64, "pattern": "^[a-zA-Z ,.''-]{1,64}$", "example": "Conrad", "description": "A middle name of an object, set in a native language" }, "origin_last_name": { "type": [ "string", "null" ], "format": "name", "minLength": 1, "maxLength": 64, "example": "Кофі", "description": "A last name of an entity, set in a native language" }, "phone_status": { "type": [ "string", "null" ], "enum": [ "valid", "invalid" ], "example": "valid", "description": "A status of an object phone verification, set by our system or our manager" }, "applicant--get--200--person": { "type": "object", "title": "KYC applicant (a person)", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "external_applicant_id": { "$ref": "#/components/schemas/external_applicant_id" }, "type": { "$ref": "#/components/schemas/type--applicant--person" }, "created_at": { "$ref": "#/components/schemas/created_at" }, "profile_status": { "$ref": "#/components/schemas/profile_status" }, "profile_comment": { "$ref": "#/components/schemas/profile_comment" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "origin_first_name": { "$ref": "#/components/schemas/origin_first_name" }, "middle_name": { "$ref": "#/components/schemas/middle_name" }, "origin_middle_name": { "$ref": "#/components/schemas/origin_middle_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "origin_last_name": { "$ref": "#/components/schemas/origin_last_name" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "dob": { "$ref": "#/components/schemas/dob" }, "gender": { "$ref": "#/components/schemas/gender" }, "email": { "$ref": "#/components/schemas/email" }, "phone": { "$ref": "#/components/schemas/phone" }, "phone_status": { "$ref": "#/components/schemas/phone_status" }, "wallet_address": { "$ref": "#/components/schemas/wallet_address" }, "telegram_username": { "$ref": "#/components/schemas/telegram_username" }, "pep": { "$ref": "#/components/schemas/pep" }, "custom_field_1": { "$ref": "#/components/schemas/custom_field" }, "custom_field_2": { "$ref": "#/components/schemas/custom_field" }, "custom_field_3": { "$ref": "#/components/schemas/custom_field" }, "custom_field_4": { "$ref": "#/components/schemas/custom_field" }, "custom_field_5": { "$ref": "#/components/schemas/custom_field" }, "decline_reasons": {}, "addresses": {}, "documents": {}, "questionnaires": {}, "verification_status": {}, "verifications_count": {} } }, "decline_reasons--verification": { "type": "array", "items": { "type": "string", "enum": [ "AGE_RESTRICTION", "BAD_QUALITY", "COMPROMISED_PERSON", "COMPULSION", "DIFFERENT_FACES", "DOCUMENT_DAMAGED", "DOCUMENT_INCOMPLETE", "DUPLICATE", "EDITED_DOCUMENT", "EXPIRED_DOCUMENT", "EXPIRES_LESS_3_MONTHS", "FAKE_DOCUMENT", "MULTIPLE_PERSON", "NO_SELFIE", "OTHER", "PROHIBITED_JURISDICTION", "WRONG_DOB", "WRONG_DOCUMENT", "WRONG_INFO", "WRONG_NAME" ] }, "example": [ "NO_SELFIE", "WRONG_NAME" ], "description": "A reason for verification decline for an entity, set by our system" }, "applicant--get--200--company": { "type": [ "object", "array" ], "title": "KYC applicant (a company)", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "external_applicant_id": { "$ref": "#/components/schemas/external_applicant_id" }, "type": { "$ref": "#/components/schemas/type--applicant--company" }, "created_at": { "$ref": "#/components/schemas/created_at" }, "profile_status": { "$ref": "#/components/schemas/profile_status" }, "profile_comment": { "$ref": "#/components/schemas/profile_comment" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "origin_first_name": { "$ref": "#/components/schemas/origin_first_name" }, "middle_name": { "$ref": "#/components/schemas/middle_name" }, "origin_middle_name": { "$ref": "#/components/schemas/origin_middle_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "origin_last_name": { "$ref": "#/components/schemas/origin_last_name" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "dob": { "$ref": "#/components/schemas/dob" }, "gender": { "$ref": "#/components/schemas/gender" }, "email": { "$ref": "#/components/schemas/email" }, "phone": { "$ref": "#/components/schemas/phone" }, "phone_status": { "$ref": "#/components/schemas/phone_status" }, "wallet_address": { "$ref": "#/components/schemas/wallet_address" }, "telegram_username": { "$ref": "#/components/schemas/telegram_username" }, "pep": { "$ref": "#/components/schemas/pep" }, "custom_field_1": { "$ref": "#/components/schemas/custom_field" }, "custom_field_2": { "$ref": "#/components/schemas/custom_field" }, "custom_field_3": { "$ref": "#/components/schemas/custom_field" }, "custom_field_4": { "$ref": "#/components/schemas/custom_field" }, "custom_field_5": { "$ref": "#/components/schemas/custom_field" }, "decline_reasons": { "$ref": "#/components/schemas/decline_reasons--verification" }, "addresses": {}, "documents": {}, "questionnaires": {}, "verification_status": {}, "verifications_count": {} } }, "applicant--get--404--applicant_id": { "type": "object", "title": "Applicant was not found", "description": "No applicant with such applicant ID", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant was not found" } } } } } }, "applicant--get--404--verification_id": { "type": "object", "title": "Verification was not found", "description": "No verification with such verification ID", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "Verification was not found" } } } } } }, "applicant--patch--200": { "type": "object", "properties": {} }, "applicant--patch--404--applicant_id": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "applicant_id was not found" } } } } } }, "applicant--patch--404--business_activity_id": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "business_activity_id" }, "message": { "type": "string", "example": "business_activity_id was not found" } } } } } }, "document_number--document": { "type": [ "string", "null" ], "maxLength": 50, "example": "TH703318A", "description": "A number of a document" }, "additional_number": { "type": [ "string", "null" ], "maxLength": 50, "example": "E2100007T-5", "description": "An additional number located on a document (e.g. tax ID number located on an ID card)" }, "issue_date": { "title": "Issue date", "type": [ "string", "null" ], "maxLength": 10, "format": "date", "example": "2020-11-04", "description": "An issue date of a document in `YYYY-MM-DD` format" }, "expiry_date": { "title": "Expiration date", "type": [ "string", "null" ], "maxLength": 10, "format": "date", "example": "2028-11-04", "description": "The date of document expiration, formatted according to ISO 8601" }, "issuing_authority": { "title": "Issuing authority", "type": [ "string", "null" ], "maxLength": 255, "example": "Social Security Administration", "description": "A name of a govenment entity that issues official documents" }, "front_side_id": { "title": "Front side (first page) ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "46b05f5c14c162402d186822fa0314c6162c", "description": "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" }, "back_side_id": { "title": "Back side (second page) ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "b969e3d413fb3246f119c4734739f5cac987", "description": "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" }, "other_side_1_id": { "title": "Third page ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "46b05f5c14c162402d186822fa0314c6162c", "description": "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" }, "other_side_2_id": { "title": "Fourth page ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "f57963fa13e42248fb1b64c3357fc97a8737", "description": "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" }, "other_side_3_id": { "title": "Fifth page ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "b56147eb1c31a248401aed83bf5670f2c520", "description": "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" }, "document--post--person--drivers_license": { "type": "object", "title": "Person applicant • Identity • Driver license", "description": "A government-issued document that authorises a person to operate specific types of vehicles. It typically includes a holder photo, a full name, a date of birth, a license class, an expiration date. It is often recognized as a valid form of identification.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "DRIVERS_LICENSE", "default": "DRIVERS_LICENSE" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--foreign_citizen_passport": { "type": "object", "title": "Person applicant • Identity • Foreign citizen passport", "description": "A government-issued travel document issued to a foreign national by their country of citizenship. It certifies a holder identity and nationality, allowing them to travel internationally and return to their home country. It may also be used as a proof of identity for various administrative purposes.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "FOREIGN_CITIZEN_PASSPORT", "default": "FOREIGN_CITIZEN_PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--government_id": { "type": "object", "title": "Person applicant • Identity • Government ID", "description": "A government-issued document used to verify a person identity. Typically provided as a small card, it contains information such as a photo, a full name, a date of birth, a gender, and other personal details.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "GOVERNMENT_ID", "default": "GOVERNMENT_ID" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--passport": { "type": "object", "title": "Person applicant • Identity • Passport", "description": "A government-issued document that certifies a holder identity and nationality, primarily for international travel purposes.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "PASSPORT", "default": "PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--permanent_residence_permit": { "type": "object", "title": "Person applicant • Identity • Permanent residence permit", "description": "A government-issued document that certifies a person permanent resident status in a country where they are not a citizen. It verifies their legal right to reside in that country indefinitely and may also serve as a proof of identity in certain situations.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "PERMANENT_RESIDENCE_PERMIT", "default": "PERMANENT_RESIDENCE_PERMIT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--refugee_card": { "type": "object", "title": "Person applicant • Identity • Refugee card", "description": "An identity document issued by UNHCR or an asylum state to refugees. It certifies a holder refugee status and serves as an official proof of identity, enabling access to essential services and rights within a host country.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "REFUGEE_CARD", "default": "REFUGEE_CARD" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "card_number": { "title": "Card number", "type": [ "string", "null" ], "minLength": 12, "maxLength": 19, "example": "5375411422962063", "description": "A number of a credit card for payments" }, "account_number": { "title": "Account number", "type": [ "string", "null" ], "maxLength": 50, "example": "UA383220010000026200330646508", "description": "A bank account number (e.g. IBAN)" }, "income_sources": { "title": "Income sources", "type": "array", "items": { "type": "string", "enum": [ "SALARY", "DIVIDENDS", "SALE_PROPERTY", "SAVINGS", "DIVORCE_SETTLEMENTS", "INHERITANCE", "LOAN", "INVESTMENTS", "OTHER" ] }, "example": [ "SAVINGS", "OTHER" ], "description": "Category of a person or an entity earnings" }, "annual_income": { "title": "Annual income", "type": [ "string", "null" ], "enum": [ "ANNUAL_INCOME_GROUP_1", "ANNUAL_INCOME_GROUP_2", "ANNUAL_INCOME_GROUP_3", "ANNUAL_INCOME_GROUP_4", null ], "example": "ANNUAL_INCOME_GROUP_2", "description": "An annual income group that categorizes persons or entities based on their total yearly income. There are four groups available:\n- `ANNUAL_INCOME_GROUP_1`: less than 50,000 EUR\n- `ANNUAL_INCOME_GROUP_2`: between 50,000 and 100,000 EUR\n- `ANNUAL_INCOME_GROUP_3`: between 100,000 and 300,000 EUR\n- `ANNUAL_INCOME_GROUP_4`: more than 300,000 EUR\n" }, "transaction_amount": { "title": "Financial transaction amount", "type": [ "number", "null" ], "format": "float", "example": 14008.55, "description": "An amount of a financial transaction" }, "transaction_currency": { "title": "Financial transaction currency", "type": [ "string", "null" ], "maxLength": 3, "example": "EUR", "description": "An amount of a financial transaction. A three-letter currency code according to ISO 4217. Ticker symbols are also accepted (e.g. BTC, ETH, SOL)" }, "transaction_datetime": { "title": "Financial transaction date and time", "type": [ "string", "null" ], "example": "2024-11-16 14:22:54", "description": "A date and time of a financial transaction in `YYYY-MM-DD HH:mm:ss` format" }, "transaction_purpose": { "title": "Financial transaction purpose", "type": [ "string", "null" ], "maxLength": 255, "example": "Payment for additional services", "description": "A definition of an intended reason or objective for a financial transaction" }, "origin_funds": { "title": "Origin of funds", "type": [ "string", "null" ], "maxLength": 255, "example": "Business revenues", "description": "A source of financial resources" }, "document--post--person--bank_statement": { "type": "object", "title": "Person applicant • Proof of funds • Bank statement", "description": "A financial document issued by a bank that provides a detailed summary of account transactions over a specific period. It includes deposits, withdrawals, charges, beginning and ending balances for a specified period.\n\n⚠️ *Only 5 documents with any of:*\n * *`FINANCIAL_DOCUMENT`*\n * *`BANK_STATEMENT`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, 5 new documents may be added for the same applicant object via `applicant_id`, replacing the ones added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "BANK_STATEMENT", "default": "BANK_STATEMENT" }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--financial_document": { "type": "object", "title": "Person applicant • Proof of funds • Financial document", "description": "A formal record of financial activities and position of a business, a person, or another entity. It includes a balance sheet, income statements, and a cash flow statement.\n\n⚠️ *Only 5 documents with any of:*\n * *`FINANCIAL_DOCUMENT`*\n * *`BANK_STATEMENT`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, 5 new documents may be added for the same applicant object via `applicant_id`, replacing the ones added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "FINANCIAL_DOCUMENT", "default": "FINANCIAL_DOCUMENT" }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--selfie_image": { "type": "object", "title": "Person applicant • Selfie", "description": "A digital self-portrait image taken by a person using a smartphone or a camera.\n\n⚠️ *Only one document with any of:*\n * *`SELFIE_IMAGE`*\n * *`SELFIE_WITH_DOCUMENT`*\n * *`SELFIE_WITH_CREDIT_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_IMAGE", "default": "SELFIE_IMAGE" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--selfie_with_credit_card": { "type": "object", "title": "Person applicant • Selfie with a credit card", "description": "A digital self-portrait image with a credit card in a hand taken by an applicant using a smartphone or a camera. It is used to confirm a cardholder.\n\n⚠️ *Only one document with any of:*\n * *`SELFIE_IMAGE`*\n * *`SELFIE_WITH_DOCUMENT`*\n * *`SELFIE_WITH_CREDIT_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_WITH_CREDIT_CARD", "default": "SELFIE_WITH_CREDIT_CARD" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--selfie_with_document": { "type": "object", "title": "Person applicant • Selfie with a document", "description": "A digital self-portrait image with a document in a hand taken by an applicant using a smartphone or a camera. It is used to confirm a document owner.\n\n⚠️ *Only one document with any of:*\n * *`SELFIE_IMAGE`*\n * *`SELFIE_WITH_DOCUMENT`*\n * *`SELFIE_WITH_CREDIT_CARD`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_WITH_DOCUMENT", "default": "SELFIE_WITH_DOCUMENT" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--tax_id_number": { "type": "object", "title": "Person applicant • Tax ID number", "description": "A government-issued unique identifier used to track tax obligations of persons or entities. It is primarily used for tax filing, payment, and reporting purposes.\n\n⚠️ *Only one document with `TAX_ID_NUMBER` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "TAX_ID_NUMBER", "default": "TAX_ID_NUMBER" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--person--video": { "type": "object", "title": "Person applicant • Video", "description": "A digital self-portrait video taken by a person using a smartphone or a camera.\n\n⚠️ *Only one document with `VIDEO` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "VIDEO", "default": "VIDEO" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--company--authorised_person": { "type": "object", "title": "Company applicant • Authorised person confirmation", "description": "A document that certifies a legal authority to act on behalf of a company. It may detail a scope of their authorisation, such as signing documents, making decisions, or representing a company in legal, financial, or administrative matters.\n\n⚠️ *Only one document with `AUTHORISED_PERSON` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "AUTHORISED_PERSON", "default": "AUTHORISED_PERSON" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--company--company_legal_address": { "type": "object", "title": "Company applicant • Company legal address confirmation", "description": "A legal document that confirms a company official registration address. It typically includes a company name, a registration number, a legal address, and a type of business activity.\n\n⚠️ *Only one document with `COMPANY_LEGAL_ADDRESS` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "COMPANY_LEGAL_ADDRESS", "default": "COMPANY_LEGAL_ADDRESS" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--company--company_ownership": { "type": "object", "title": "Company applicant • Company ownership confirmation", "description": "A document that certifies an ownership of a company. It identifies persons or entities that own shares or hold equity in a company, along with their respective ownership percentages.\n\n⚠️ *Only one document with `COMPANY_OWNERSHIP` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "COMPANY_OWNERSHIP", "default": "COMPANY_OWNERSHIP" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document--post--company--registration_company": { "type": "object", "title": "Company applicant • Company registration certificate", "description": "A government-issued certificate that confirms a company legal existence and compliance with local laws and regulations. It typically includes a company name, a registration number, a legal address, and a type of business activity.\n\n⚠️ *Only one document with `REGISTRATION_COMPANY` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "REGISTRATION_COMPANY", "default": "REGISTRATION_COMPANY" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, "document_id": { "title": "Document ID", "type": "string", "minLength": 36, "maxLength": 36, "example": "5f9aeb5e1f25e2441d182f56b6dcbfac12dd", "description": "A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request" }, "document--post--404--applicant_id": { "title": "Applicant ID was not found", "description": "The error is sent by our system when an applicant ID in a request was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant was not found" } } } } } }, "document--post--404--affiliated_person": { "title": "Affiliated person ID was not found", "description": "The error is sent by our system when an affiliated person ID in a request was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "affiliated_person_id" }, "message": { "type": "string", "example": "Affiliated person was not found" } } } } } }, "document--404--front_side_id": { "title": "Front side (first page) ID was not found", "description": "The error is sent by our system when an ID of a file with a document front side (first page) was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "front_side_id" }, "message": { "type": "string", "example": "File was not found" } } } } } }, "document--404--back_side_id": { "title": "Back side (second page) ID was not found", "description": "The error is sent by our system when an ID of a file with a document back side (second page) was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "back_side_id" }, "message": { "type": "string", "example": "File was not found" } } } } } }, "document--404--other_side_1_id": { "title": "Other side 1 (third page) ID was not found", "description": "The error is sent by our system when an ID of a file with a document other side 1 (third page) was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_1_id" }, "message": { "type": "string", "example": "File was not found" } } } } } }, "document--404--other_side_2_id": { "title": "Other side 2 (fourth page) ID was not found", "description": "The error is sent by our system when an ID of a file with a document other side 2 (fourth page) was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_2_id" }, "message": { "type": "string", "example": "File was not found" } } } } } }, "document--404--other_side_3_id": { "title": "Other side 3 (fifth page) ID was not found", "description": "The error is sent by our system when an ID of a file with a document other side 3 (fifth page) was not found in the system", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_3_id" }, "message": { "type": "string", "example": "File was not found" } } } } } }, "document--post--422--document_type": { "title": "Type of document is not valid", "description": "The error is sent by our system when a `type` parameter is missing or a value is not from the list of available document types\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Type of document is not valid" } } } } } }, "document--post--422--applicant_id-affiliated_person_id": { "title": "One of the next parameters are required: applicant_id, affiliated_person_id\n", "description": "The error is sent by our system when there are no `applicant_id` or `affiliated_person_id` parameter in a request\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "*" }, "message": { "type": "string", "example": "One of the next parameters are required: applicant_id, affiliated_person_id" } } } } } }, "document--post--422--applicant_id--invalid": { "title": "Applicant ID is not valid", "description": "The error is sent by our system when an applicant ID in a request has invalid format (not a hash value in 36 characters)\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant ID is not valid." } } } } } }, "document--post--422--additional_number": { "title": "Document additional number is not valid", "description": "The error is sent by our system when a value of an `additional_number` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "additional_number" }, "message": { "type": "string", "example": "Document additional number is not valid" } } } } } }, "document--post--422--issue_date": { "title": "Document issue date is not valid", "description": "The error is sent by our system when a value of an `issue_date` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "issue_date" }, "message": { "type": "string", "example": "Document issue date is not valid" } } } } } }, "document--post--422--expiry_date": { "title": "Document expiry date is not valid", "description": "The error is sent by our system when a value of an `expiry_date` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "expiry_date" }, "message": { "type": "string", "example": "Document expiry date is not valid" } } } } } }, "document--post--422--issuing_authority": { "title": "Issuing authority is not valid", "description": "The error is sent by our system when a value of an `issuing_authority` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "issuing_authority" }, "message": { "type": "string", "example": "Issuing authority is not valid" } } } } } }, "document--post--422--front_side_id": { "title": "Front side is not valid", "description": "The error is sent by our system when a value of an `front_side_id` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "front_side_id" }, "message": { "type": "string", "example": "Front side is not valid" } } } } } }, "document--post--422--back_side_id": { "title": "Back side is not valid", "description": "The error is sent by our system when a value of an `back_side_id` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "back_side_id" }, "message": { "type": "string", "example": "Back side is not valid" } } } } } }, "document--post--422--other_side_1_id": { "title": "Other sie 1 is not valid", "description": "The error is sent by our system when a value of an `other_side_1_id` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_1_id" }, "message": { "type": "string", "example": "Other sie 1 is not valid" } } } } } }, "document--post--422--other_side_2_id": { "title": "Other side 2 is not valid", "description": "The error is sent by our system when a value of an `other_side_2_id` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_2_id" }, "message": { "type": "string", "example": "Other side 2 is not valid" } } } } } }, "document--post--422--other_side_3_id": { "title": "Other side 3 is not valid", "description": "The error is sent by our system when a value of an `other_side_3_id` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "other_side_3_id" }, "message": { "type": "string", "example": "Other side 3 is not valid" } } } } } }, "document--post--422--income_sources": { "title": "Income source is not valid", "description": "The error is sent by our system when a value of an `income_sources` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "income_sources" }, "message": { "type": "string", "example": "Income source is not valid" } } } } } }, "document--post--422--transaction_amount": { "title": "Transaction amount is not valid", "description": "The error is sent by our system when a value of an `transaction_amount` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "transaction_amount" }, "message": { "type": "string", "example": "Transaction amount is not valid" } } } } } }, "document--post--422--transaction_currency": { "title": "Transaction currency is not valid", "description": "The error is sent by our system when a value of an `transaction_currency` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "transaction_currency" }, "message": { "type": "string", "example": "Transaction currency is not valid" } } } } } }, "document--post--422--transaction_datetime": { "title": "Transaction date and time is not valid", "description": "The error is sent by our system when a value of an `transaction_datetime` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "transaction_datetime" }, "message": { "type": "string", "example": "Transaction date and time is not valid" } } } } } }, "document--post--422--transaction_purpose": { "title": "Transaction purpose is not valid", "description": "The error is sent by our system when a value of an `transaction_purpose` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "transaction_purpose" }, "message": { "type": "string", "example": "Transaction purpose is not valid" } } } } } }, "document--post--422--origin_funds": { "title": "Origin funds is not valid", "description": "The error is sent by our system when a value of an `origin_funds` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "origin_funds" }, "message": { "type": "string", "example": "Origin funds is not valid" } } } } } }, "document--post--422--card_number": { "title": "Credit card number is not valid", "description": "The error is sent by our system when a value of a `card_number` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "card_number" }, "message": { "type": "string", "example": "Credit card number is not valid" } } } } } }, "document--post--422--account_number": { "title": "Account number is not valid", "description": "The error is sent by our system when a value of an `account_number` parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "account_number" }, "message": { "type": "string", "example": "Account number is not valid" } } } } } }, "document--post--429--domestic_passport": { "title": "Limit for DOMESTIC_PASSPORT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type DOMESTIC_PASSPORT can not be more than 1" } } } } } }, "document--post--429--drivers_license": { "title": "Limit for DRIVERS_LICENSE documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type DRIVERS_LICENSE can not be more than 1" } } } } } }, "document--post--429--foreign_citizen_passport": { "title": "Limit for FOREIGN_CITIZEN_PASSPORT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type FOREIGN_CITIZEN_PASSPORT can not be more than 1" } } } } } }, "document--post--429--government_id": { "title": "Limit for GOVERNMENT_ID documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type GOVERNMENT_ID can not be more than 1" } } } } } }, "document--post--429--passport": { "title": "Limit for PASSPORT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type PASSPORT can not be more than 1" } } } } } }, "document--post--429--permanent_residence_permit": { "title": "Limit for PERMANENT_RESIDENCE_PERMIT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `DOMESTIC_PASSPORT`, `DRIVERS_LICENSE`, `FOREIGN_CITIZEN_PASSPORT`, `GOVERNMENT_ID`, `PASSPORT`, `PERMANENT_RESIDENCE_PERMIT`, `REFUGEE_CARD` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type PERMANENT_RESIDENCE_PERMIT can not be more than 1" } } } } } }, "document--post--429--refugee_card": { "title": "Limit for REFUGEE_CARD documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: DOMESTIC_PASSPORT, DRIVERS_LICENSE, FOREIGN_CITIZEN_PASSPORT, GOVERNMENT_ID, PASSPORT, PERMANENT_RESIDENCE_PERMIT, REFUGEE_CARD is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type REFUGEE_CARD can not be more than 1" } } } } } }, "document--post--429--bank_statement": { "title": "Limit for BANK_STATEMENT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only 5 documents with any of document types: `BANK_STATEMENT`, `FINANCIAL_DOCUMENT` are allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "array", "items": { "type": "string" }, "example": [ "451f601210d1124403292390664de7d86421", "91a7cee91c5db2485d2abfa0253f9f9e9444", "a54450141a8b124cfb2883d07934702b9ee3", "0e59dde21737b245672ab970bc6dc401b693", "a2ca532e1f65624af6293130c018ef52106f" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type BANK_STATEMENT can not be more than 5" } } } } } }, "document--post--429--financial_document": { "title": "Limit for FINANCIAL_DOCUMENT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only 5 documents with any of document types: `BANK_STATEMENT`, `FINANCIAL_DOCUMENT` are allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "array", "items": { "type": "string" }, "example": [ "451f601210d1124403292390664de7d86421", "91a7cee91c5db2485d2abfa0253f9f9e9444", "a54450141a8b124cfb2883d07934702b9ee3", "0e59dde21737b245672ab970bc6dc401b693", "a2ca532e1f65624af6293130c018ef52106f" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type FINANCIAL_DOCUMENT can not be more than 5" } } } } } }, "document--post--429--credit_card": { "title": "Limit for CREDIT_CARD documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with `CREDIT_CARD` document type is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "a8b90a3715232245ab28a97051dab2ab45f8" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type CREDIT_CARD can not be more than 1" } } } } } }, "document--post--429--selfie_image": { "title": "Limit for SELFIE_IMAGE documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `SELFIE_IMAGE`, `SELFIE_WITH_CREDIT_CARD`, `SELFIE_WITH_DOCUMENT` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "d18278e61f09524a4b296a805f3b785cae8f" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type SELFIE_IMAGE can not be more than 1" } } } } } }, "document--post--429--selfie_with_credit_card": { "title": "Limit for SELFIE_WITH_CREDIT_CARD documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `SELFIE_IMAGE`, `SELFIE_WITH_CREDIT_CARD`, `SELFIE_WITH_DOCUMENT` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "d18278e61f09524a4b296a805f3b785cae8f" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type SELFIE_WITH_CREDIT_CARD can not be more than 1" } } } } } }, "document--post--429--selfie_with_document": { "title": "Limit for SELFIE_WITH_DOCUMENT documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with any of document types: `SELFIE_IMAGE`, `SELFIE_WITH_CREDIT_CARD`, `SELFIE_WITH_DOCUMENT` is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "d18278e61f09524a4b296a805f3b785cae8f" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type SELFIE_WITH_DOCUMENT can not be more than 1" } } } } } }, "document--post--429--tax_id_number": { "title": "Limit for TAX_ID_NUMBER documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with `TAX_ID_NUMBER` document type is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "0dc68aad1a6a6249542a7d70c501056b7c6b" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type TAX_ID_NUMBER can not be more than 1" } } } } } }, "document--post--429--video": { "title": "Limit for VIDEO documents was reached", "description": "The error is sent by our system when limits for creating documents with a specific type were reached. Only one document with `VIDEO` document type is allowed\n", "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "duplicate_document_ids": { "type": "string", "example": "d9f19a881bff524dc5286d607a78f1fad164" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Document with type VIDEO can not be more than 1" } } } } } }, "provider": { "title": "Document provider", "type": "string", "enum": [ "ADMIN", "IN_AADHAAR", "KZ_ADATA", "MANUAL", "RECOGNITION", "UA_BANK_ID", "UA_DIIA" ], "example": "MANUAL", "description": "A person or a service, that created initiated document creation:\n- `ADMIN`: A manager\n- `IN_AADHAAR`: Indian Aahaar service\n- `KZ_ADATA`: Kazakhstan Adata service\n- `MANUAL`: API request or a form initialisation\n- `RECOGNITION`: Recognition service\n- `UA_BANK_ID`: Ukrainian BankID service\n- `UA_DIIA`: Ukrainian Diia service\n" }, "status--document": { "title": "Document verification status", "type": [ "string", "null" ], "enum": [ "new", "valid", "invalid" ], "example": "new", "description": "A status of document verification. This value is set automatically by our system, or manually in the Admin panel or the Dashboard after a review\n- `new`: a newly created document, that was not reviewed\n- `valid`: a reviewed and approved document\n- `invalid`: a reviewed and declined document\n" }, "comment": { "title": "Comment", "type": [ "string", "null" ], "maxLength": 1000, "example": "Low-quality photo of the document", "description": "An additional comment added manually in the Admin panel or in the Dashboard regarding reasons of document verification decline (`invalid` status)" }, "portrait": { "title": "Portrait photo URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://storage.googleapis.com/kycaid/files/90ced843498a0340352bbcf51b9ac3f7fee0.jpg", "description": "A URL of a person portrait photo, extracted from a document file by our system" }, "front_side": { "title": "Document front side (first page) URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://storage.googleapis.com/kycaid/files/90ced843498a0340352bbcf51b9ac3f7fee0.jpg", "description": "A URL of an uploaded front side (first page) of a document file" }, "back_side": { "title": "Document back side (second page) URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://storage.googleapis.com/kycaid/files/90ced843498a0340352bbcf51b9ac3f7fee0.jpg", "description": "A URL of an uploaded back side (second page) of a document" }, "other_side_1": { "title": "Document third page URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://storage.googleapis.com/kycaid/files/90ced843498a0340352bbcf51b9ac3f7fee0.jpg", "description": "A URL of an uploaded third page of a document" }, "other_side_2": { "title": "Document fourth page URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://storage.googleapis.com/kycaid/files/90ced843498a0340352bbcf51b9ac3f7fee0.jpg", "description": "A URL of an uploaded fourth page of a document" }, "decline_reasons_ids": { "title": "Document reasons IDs", "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ], "enum": [ 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36 ] }, "example": [ 29 ], "description": "A list of IDs of reasons why a document was declined.\n* `1`: `OTHER`\n* `2`: `WRONG_NAME`\n* `3`: `WRONG_DOB`\n* `4`: `AGE_RESTRICTION`\n* `5`: `EXPIRED_DOCUMENT`\n* `7`: `BAD_QUALITY`\n* `8`: `FAKE_DOCUMENT`\n* `9`: `WRONG_INFO`\n* `10`: `PROHIBITED_JURISDICTION`\n* `11`: `NO_SELFIE`\n* `12`: `DIFFERENT_FACES`\n* `13`: `WRONG_DOCUMENT`\n* `24`: `DUPLICATE`\n* `25`: `DOCUMENT_DAMAGED`\n* `26`: `DOCUMENT_INCOMPLETE`\n* `27`: `FRAUDULENT`\n* `28`: `TAX_ID_REQUIRED`\n* `29`: `COMPROMISED_PERSON`\n* `30`: `EDITED_DOCUMENT`\n* `31`: `MULTIPLE_PERSON`\n* `32`: `COMPULSION`\n* `33`: `LIMIT_REACHED_OTP`\n* `34`: `IP_MISMATCH`\n* `35`: `ANONYMIZING_NETWORK`\n* `36`: `QES_MISMATCH`\n" }, "decline_reasons--document": { "title": "Document decline reasons", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ], "enum": [ "AGE_RESTRICTION", "BAD_QUALITY", "COMPROMISED_PERSON", "COMPULSION", "DIFFERENT_FACES", "DOCUMENT_DAMAGED", "DOCUMENT_INCOMPLETE", "DUPLICATE", "EDITED_DOCUMENT", "EXPIRED_DOCUMENT", "FAKE_DOCUMENT", "FRAUDULENT", "IP_MISMATCH", "LIMIT_REACHED_OTP", "MULTIPLE_PERSON", "NO_SELFIE", "OTHER", "PROHIBITED_JURISDICTION", "TAX_ID_REQUIRED", "WRONG_DOB", "WRONG_DOCUMENT", "WRONG_INFO", "WRONG_NAME", null ] }, "example": [ "FRAUDULENT", "NO_SELFIE" ], "description": "The explanation of why a document was declined by our system or by a manager.\n* `AGE_RESTRICTION`: A document of a person doesnt meet minimum requirements\n* `ANONYMIZING_NETWORK`: Our system detected that a person uses an anonymous network\n* `BAD_QUALITY`: A document image provided is of poor quality, making it unreadable\n* `COMPROMISED_PERSON`: A person has been flagged as compromised in a blacklist database\n* `COMPULSION`: A document capture may have been forced, indicating potential coercion or lack of consent\n* `DIFFERENT_FACES`: Faces in a document and selfie do not match, indicating a discrepancy\n* `DOCUMENT_DAMAGED`: A document is physically damaged and cannot be recognised\n* `DOCUMENT_INCOMPLETE`: A document is missing required sections or pages for verification\n* `DUPLICATE`: An applicant with a document already exists in our system, creating unallowed duplication\n* `EDITED_DOCUMENT`: A document has been tampered with or edited, leading to concerns about authenticity\n* `EXPIRED_DOCUMENT`: A document has passed its expiration date and is no longer valid \n* `FAKE_DOCUMENT`: A document provided is fraudulent, contains signs of forgery, or does not correspond to an official format\n* `FRAUDULENT`: A document shows clear signs of fraudulent activity or intent\n* `IP_MISMATCH`: An issuing country of a document does not match person IP address\n* `LIMIT_REACHED_OTP`: Wrong one-time passwords (OTP) were entered several times during document confirmation, reaching a limit of the number of attempts\n* `MULTIPLE_PERSON`: A document includes more than one person, which is not permitted\n* `NO_SELFIE`: A required selfie was not provided\n* `OTHER`: Any issue or reason not covered by the predefined categories\n* `PROHIBITED_JURISDICTION`: A document originates from a jurisdiction restricted or prohibited by a policy\n* `QES_MISMATCH`: An information from Qualified Electronic Signature (QES) does not match a person profile\n* `TAX_ID_REQUIRED`: A valid tax identification number is mandatory but was not provided\n* `WRONG_DOB`: A date of birth provided does not match the one on a document\n* `WRONG_DOCUMENT`: A submitted document type is not supported for a document owner type\n* `WRONG_INFO`: An information provided does not match details in a document\n* `WRONG_NAME`: Names provided do not align with the ones on a document\n" }, "document--get--200--person--credit_card": { "type": "object", "title": "Person applicant • Credit card", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "CREDIT_CARD", "default": "CREDIT_CARD" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "$ref": "#/components/schemas/card_number" }, "account_number": { "$ref": "#/components/schemas/account_number" }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--domestic_passport": { "type": "object", "title": "Person applicant • Identity • Domestic passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "DOMESTIC_PASSPORT", "default": "DOMESTIC_PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--drivers_license": { "type": "object", "title": "Person applicant • Identity • Driver license", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "DRIVERS_LICENSE", "default": "DRIVERS_LICENSE" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--foreign_citizen_passport": { "type": "object", "title": "Person applicant • Identity • Foreign citizen passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "FOREIGN_CITIZEN_PASSPORT", "default": "FOREIGN_CITIZEN_PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--government_id": { "type": "object", "title": "Person applicant • Identity • Government ID", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "GOVERNMENT_ID", "default": "GOVERNMENT_ID" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--passport": { "type": "object", "title": "Person applicant • Identity • Passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "PASSPORT", "default": "PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--permanent_residence_permit": { "type": "object", "title": "Person applicant • Identity • Permanent residence permit", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "PERMANENT_RESIDENCE_PERMIT", "default": "PERMANENT_RESIDENCE_PERMIT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--refugee_card": { "type": "object", "title": "Person applicant • Identity • Refugee card", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "REFUGEE_CARD", "default": "REFUGEE_CARD" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--bank_statement": { "type": "object", "title": "Person applicant • Proof of funds • Bank statement", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "BANK_STATEMENT", "default": "BANK_STATEMENT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--financial_document": { "type": "object", "title": "Person applicant • Proof of funds • Financial document", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "FINANCIAL_DOCUMENT", "default": "FINANCIAL_DOCUMENT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--selfie_image": { "type": "object", "title": "Person applicant • Selfie", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_IMAGE", "default": "SELFIE_IMAGE" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--selfie_with_credit_card": { "type": "object", "title": "Person applicant • Selfie with a credit card", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_WITH_CREDIT_CARD", "default": "SELFIE_WITH_CREDIT_CARD" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--selfie_with_document": { "type": "object", "title": "Person applicant • Selfie with a document", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "SELFIE_WITH_DOCUMENT", "default": "SELFIE_WITH_DOCUMENT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--tax_id_number": { "type": "object", "title": "Person applicant • Tax ID number", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "TAX_ID_NUMBER", "default": "TAX_ID_NUMBER" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person--video": { "type": "object", "title": "Person applicant • Video", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "VIDEO", "default": "VIDEO" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--person-company--address_document": { "type": "object", "title": "Person and company applicant • Address document", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "ADDRESS_DOCUMENT", "default": "ADDRESS_DOCUMENT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--company--authorised_person": { "type": "object", "title": "Company applicant • Authorised person confirmation", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "AUTHORISED_PERSON", "default": "AUTHORISED_PERSON" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--company--company_legal_address": { "type": "object", "title": "Company applicant • Company legal address confirmation", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "COMPANY_LEGAL_ADDRESS", "default": "COMPANY_LEGAL_ADDRESS" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--company--company_ownership": { "type": "object", "title": "Company applicant • Company ownership confirmation", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "COMPANY_OWNERSHIP", "default": "COMPANY_OWNERSHIP" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--company--registration_company": { "type": "object", "title": "Company applicant • Company registration certificate", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "REGISTRATION_COMPANY", "default": "REGISTRATION_COMPANY" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--address_document": { "type": "object", "title": "Affiliated person • Address document", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "ADDRESS_DOCUMENT", "default": "ADDRESS_DOCUMENT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "allOf": [ { "$ref": "#/components/schemas/document_number--document", "example": null } ], "example": null }, "additional_number": { "allOf": [ { "$ref": "#/components/schemas/additional_number", "example": null } ], "example": null }, "issue_date": { "allOf": [ { "$ref": "#/components/schemas/issue_date", "example": null } ], "example": null }, "expiry_date": { "allOf": [ { "$ref": "#/components/schemas/expiry_date", "example": null } ], "example": null }, "issuing_authority": { "allOf": [ { "$ref": "#/components/schemas/issuing_authority", "example": null } ], "example": null }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--domestic_passport": { "type": "object", "title": "Affiliated person • Identity • Domestic passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "DOMESTIC_PASSPORT", "default": "DOMESTIC_PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--drivers_license": { "type": "object", "title": "Affiliated person • Identity • Driver license", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "DRIVERS_LICENSE", "default": "DRIVERS_LICENSE" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--foreign_citizen_passport": { "type": "object", "title": "Affiliated person • Identity • Foreign citizen passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "FOREIGN_CITIZEN_PASSPORT", "default": "FOREIGN_CITIZEN_PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--government_id": { "type": "object", "title": "Affiliated person • Identity • Government ID", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "GOVERNMENT_ID", "default": "GOVERNMENT_ID" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--passport": { "type": "object", "title": "Affiliated person • Identity • Passport", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "PASSPORT", "default": "PASSPORT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--permanent_residence_permit": { "type": "object", "title": "Affiliated person • Identity • Permanent residence permit", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "PERMANENT_RESIDENCE_PERMIT", "default": "PERMANENT_RESIDENCE_PERMIT" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--get--200--affiliated_person--refugee_card": { "type": "object", "title": "Affiliated person • Identity • Refugee card", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "REFUGEE_CARD", "default": "REFUGEE_CARD" }, "provider": { "$ref": "#/components/schemas/provider" }, "status": { "$ref": "#/components/schemas/status--document" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/comment", "example": null } ], "example": null }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "allOf": [ { "$ref": "#/components/schemas/income_sources", "example": null } ], "example": [] }, "annual_income": { "allOf": [ { "$ref": "#/components/schemas/annual_income", "example": null } ], "example": null }, "transaction_amount": { "allOf": [ { "$ref": "#/components/schemas/transaction_amount", "example": null } ], "example": null }, "transaction_currency": { "allOf": [ { "$ref": "#/components/schemas/transaction_currency", "example": null } ], "example": null }, "transaction_datetime": { "allOf": [ { "$ref": "#/components/schemas/transaction_datetime", "example": null } ], "example": null }, "transaction_purpose": { "allOf": [ { "$ref": "#/components/schemas/transaction_purpose", "example": null } ], "example": null }, "origin_funds": { "allOf": [ { "$ref": "#/components/schemas/origin_funds", "example": null } ], "example": null }, "card_number": { "allOf": [ { "$ref": "#/components/schemas/card_number", "example": null } ], "example": null }, "account_number": { "allOf": [ { "$ref": "#/components/schemas/account_number", "example": null } ], "example": null }, "portrait": { "allOf": [ { "$ref": "#/components/schemas/portrait", "example": null } ], "example": null }, "front_side_id": { "allOf": [ { "$ref": "#/components/schemas/front_side_id", "example": null } ], "example": null }, "front_side": { "allOf": [ { "$ref": "#/components/schemas/front_side", "example": null } ], "example": null }, "back_side_id": { "allOf": [ { "$ref": "#/components/schemas/back_side_id", "example": null } ], "example": null }, "back_side": { "allOf": [ { "$ref": "#/components/schemas/back_side", "example": null } ], "example": null }, "other_side_1_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_1_id", "example": null } ], "example": null }, "other_side_1": { "allOf": [ { "$ref": "#/components/schemas/other_side_1", "example": null } ], "example": null }, "other_side_2_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_2_id", "example": null } ], "example": null }, "other_side_2": { "allOf": [ { "$ref": "#/components/schemas/other_side_2", "example": null } ], "example": null }, "other_side_3_id": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "other_side_3": { "allOf": [ { "$ref": "#/components/schemas/other_side_3_id", "example": null } ], "example": null }, "created_at": { "$ref": "#/components/schemas/created_at" }, "decline_reasons_ids": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons_ids", "example": null } ], "example": null }, "decline_reasons": { "allOf": [ { "$ref": "#/components/schemas/decline_reasons--document", "example": [] } ], "example": [] } } }, "document--404--document_id": { "title": "Document ID was not found", "description": "The error is sent by our system when an document with the specified document ID in a request was not found in the system\n", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "document_id" }, "message": { "type": "string", "example": "Document was not found" } } } } } }, "document--422--document_id": { "title": "Document ID is not valid", "description": "The error is sent by our system when a document ID in a request has invalid format\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "document_id" }, "message": { "type": "string", "example": "Document ID is not valid." } } } } } }, "document--delete--200": { "type": "object", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" } } }, "document--delete--409": { "title": "Document under verification can not be deleted", "type": "object", "properties": { "type": { "type": "string", "example": "delete_denied" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "document_id" }, "message": { "type": "string", "example": "Document under verification can not be deleted" } } } } } }, "type--document": { "type": "string", "enum": [ "ADDRESS_DOCUMENT", "AUTHORISED_PERSON", "BANK_STATEMENT", "COMPANY_LEGAL_ADDRESS", "COMPANY_OWNERSHIP", "CREDIT_CARD", "DOMESTIC_PASSPORT", "DRIVERS_LICENSE", "FINANCIAL_DOCUMENT", "FOREIGN_CITIZEN_PASSPORT", "GOVERNMENT_ID", "PASSPORT", "PERMANENT_RESIDENCE_PERMIT", "REFUGEE_CARD", "REGISTRATION_COMPANY", "SELFIE_IMAGE", "SELFIE_WITH_CREDIT_CARD", "SELFIE_WITH_DOCUMENT", "TAX_ID_NUMBER", "VIDEO" ], "example": "DOMESTIC_PASSPORT", "description": "A type of a document object" }, "document--update--200": { "type": "object", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" } } }, "document--422--parameter_missing": { "title": "At least one parameter should be set", "description": "The error is sent by our system when there is no parameters in a request body", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "*" }, "message": { "type": "string", "example": "At least one parameter should be set" } } } } } }, "form_id": { "title": "Form ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "d87132ba092d8148ba1891736832d0451ac2", "description": "A unique identifier of a form, assigned by our system after it is created in the Dashboard" }, "redirect_url": { "title": "Redirect URL", "type": [ "string", "null" ], "maxLength": 2048, "example": "https://kyc.example.com/complete", "description": "The URL in your system to which a user will be redirected after completing and submitting a form" }, "form_url": { "title": "Form URL", "type": "string", "maxLength": 2048, "example": "https://forms-new.kycaid.com/7505262b02bb0145c62a04d969eacedb4873", "description": "A one-time URL to a form that includes a form token. The form remains open for completion via the URL until a user completes it" }, "verification_id": { "title": "Verification ID", "type": [ "string", "null" ], "minLength": 36, "maxLength": 36, "example": "d2177cdf067d424a221b5d045dc616bf81f9", "description": "A unique identifier for a verification, assigned by our system after a verification is created using the “Create a verification\" request" }, "form_token": { "title": "Form token", "type": "string", "minLength": 36, "maxLength": 36, "example": "7505262b02bb0145c62a04d969eacedb4873", "description": "A unique token for a form, generated by our system, and included as part of a form URL" }, "verification_attempts_left": { "title": "Verification attempts left", "type": [ "integer", "null" ], "format": "number", "example": 5, "description": "A number of verification attempts available for a user, set in form settings in the Dashboard. A `null` value means “not limited”. It equals `0` if set in the settings" }, "form--post--200": { "title": "Request is successful", "type": "object", "properties": { "form_id": { "$ref": "#/components/schemas/form_id" }, "form_url": { "$ref": "#/components/schemas/form_url" }, "verificaiton_id": { "$ref": "#/components/schemas/verification_id" }, "form_token": { "$ref": "#/components/schemas/form_token" }, "verification_attempts_left": { "$ref": "#/components/schemas/verification_attempts_left" } } }, "form--post--404--form_id": { "title": "Form not found", "description": "The error is returned by our system when a form with the specified `form_id` query parameter is not found\n", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "form_id" }, "message": { "type": "string", "example": "Form was not found" } } } } } }, "form--post--404--applicant_id": { "title": "Applicant not found", "description": "The error is returned by our system when an applicant with the specified `applicant_id` request parameter is not found\n", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant was not found" } } } } } }, "form--post--409": { "title": "Applicant type doesn’t match form type", "description": "The error is returned by our system when a form created for a `PERSON` applicant type is used for an applicant with a `COMPANY` applicant type, or vice versa\n", "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant is not compatible with this form" } } } } } }, "form--post--422--form_id": { "title": "Invalid form ID", "description": "The error is sent by our system when a value of an `form_id` query parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "form_id" }, "message": { "type": "string", "example": "Form ID is not valid." } } } } } }, "form--post--422--applicant_id": { "title": "Invalid applicant ID", "description": "The error is sent by our system when a value of an `applicant_id` query parameter was not validated by our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant ID is not valid." } } } } } }, "language_code": { "type": "string", "minLength": 2, "maxLength": 2, "example": "EN", "description": "A language of an object. A two-letter language code according to ISO 639-1" }, "verification_status--2": { "title": "Verification status", "type": "string", "enum": [ "approved", "declined" ], "example": "approved", "description": "The status of the verification. This value is set automatically by our system, or manually in the Admin panel or the Dashboard after a review\n- `approved`: a reviewed and approved verification\n- `declined`: a reviewed and declined verification\n" }, "callback_enabled": { "title": "Callback enabled", "type": "boolean", "enum": [ true, false ], "example": true, "description": "If set to `true`, our system will send the “**Verification completed**” callback for the specified verification" }, "project_owner_email_enabled": { "title": "Project owner email enabled", "type": "boolean", "enum": [ true, false ], "example": true, "description": "If set to `true`, a notification email regarding the status of the verification will be sent by our system to the project owner of the project" }, "applicant_email_enabled": { "title": "Applicant email enabled", "type": "boolean", "enum": [ true, false ], "example": true, "description": "If set to `true`, a notification email regarding the status of the verification will be sent by our system directly to the applicant who completed the form" } } }, "security": [ { "API-Key": [] } ], "tags": [ { "name": "Addresses", "description": "Addresses" }, { "name": "Affiliated persons", "description": "Affiliated persons" }, { "name": "Applicants", "description": "Applicants" }, { "name": "Documents", "description": "Documents" }, { "name": "Files", "description": "Files" }, { "name": "Forms", "description": "Forms" }, { "name": "Verifications", "description": "Verifications" } ], "paths": { "/addresses": { "post": { "tags": [ "Addresses" ], "summary": "Create address", "description": "Create and add an address object to an applicant or an affiliated person. Only one address per type may be added to an object\n", "operationId": "address-create", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "Address for KYC applicant (a person)", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "$ref": "#/components/schemas/type--address--person" }, "full_address": { "$ref": "#/components/schemas/full_address" }, "country": { "$ref": "#/components/schemas/country" }, "state": { "$ref": "#/components/schemas/state" }, "region": { "$ref": "#/components/schemas/region" }, "province": { "$ref": "#/components/schemas/province" }, "city": { "$ref": "#/components/schemas/city" }, "district": { "$ref": "#/components/schemas/district" }, "address": { "$ref": "#/components/schemas/address" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "street_name": { "$ref": "#/components/schemas/street_name" }, "building_number": { "$ref": "#/components/schemas/building_number" }, "unit_number": { "$ref": "#/components/schemas/unit_number" } }, "required": [ "applicant_id", "type" ] }, { "type": "object", "title": "Address for KYB applicant (a company)", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "$ref": "#/components/schemas/type--address--company" }, "full_address": { "$ref": "#/components/schemas/full_address" }, "country": { "$ref": "#/components/schemas/country" }, "state": { "$ref": "#/components/schemas/state" }, "region": { "$ref": "#/components/schemas/region" }, "province": { "$ref": "#/components/schemas/province" }, "city": { "$ref": "#/components/schemas/city" }, "district": { "$ref": "#/components/schemas/district" }, "address": { "$ref": "#/components/schemas/address" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "street_name": { "$ref": "#/components/schemas/street_name" }, "building_number": { "$ref": "#/components/schemas/building_number" }, "unit_number": { "$ref": "#/components/schemas/unit_number" } }, "required": [ "applicant_id", "type" ] }, { "type": "object", "title": "Address for KYB applicant (an affiliated person)", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "$ref": "#/components/schemas/type--address--affiliated_person" }, "full_address": { "$ref": "#/components/schemas/full_address" }, "country": { "$ref": "#/components/schemas/country" }, "state": { "$ref": "#/components/schemas/state" }, "region": { "$ref": "#/components/schemas/region" }, "province": { "$ref": "#/components/schemas/province" }, "city": { "$ref": "#/components/schemas/city" }, "district": { "$ref": "#/components/schemas/district" }, "address": { "$ref": "#/components/schemas/address" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "street_name": { "$ref": "#/components/schemas/street_name" }, "building_number": { "$ref": "#/components/schemas/building_number" }, "unit_number": { "$ref": "#/components/schemas/unit_number" } }, "required": [ "affiliated_person_id", "type" ] } ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "address_id": { "$ref": "#/components/schemas/address_id" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "title": "Applicant was not found", "description": "The error is sent by our system when an applicant object with requested `applicant_id` was not found in our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant was not found" } } } } } }, { "title": "Affiliated person was not found", "description": "The error is sent by our system when an affiliated person object with requested `affiliated_person_id` was not found in our system\n", "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "affiliated_person_id" }, "message": { "type": "string", "example": "Affiliated person was not found" } } } } } } ] } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "oneOf": [ { "title": "One of the next parameters are required", "description": "The error is sent by our system when there is no `applicant_id` or `affiliated_person_id` parameter in a request\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "*" }, "message": { "type": "string", "example": "One of the next parameters are required: applicant_id, affiliated_person_id" } } } } } }, { "title": "At least one parameter should be set", "description": "The error is sent by our system when there is no parameters except `applicant_id` (or `affiliated_person_id`) and `type` in a request\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "*" }, "message": { "type": "string", "example": "At least one parameter should be set" } } } } } }, { "title": "Address with type REGISTERED already exists", "description": "The error is sent by our system when an address object with `REGISTERED` type was already created for an applicant. Only one address object with `REGISTERED` type per applicant is available\n", "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Address with type REGISTERED already exists" } } } } } }, { "title": "Address with type BUSINESS already exists", "description": "The error is sent by our system when an address object with `BUSINESS` type was already created for an applicant. Only one address object with `BUSINESS` type per applicant is available\n", "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Address with type BUSINESS already exists" } } } } } }, { "title": "Address with type ADDITIONAL already exists", "description": "The error is sent by our system when an address object with `ADDITIONAL` type was already created for an applicant. Only one address object with `ADDITIONAL` type per applicant is available\n", "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Address with type ADDITIONAL already exists" } } } } } }, { "title": "Applicant ID is not valid", "description": "The error is sent by our system when an ID of an applicant object has wrong format\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant ID is not valid" } } } } } }, { "title": "Type of address is not valid", "description": "The error is sent by our system when a type of an address is not `REGISTERED`, `BUSINESS`, or `ADDITIONAL`\n", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Type of address is not valid" } } } } } } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/addresses/{address_id}": { "patch": { "tags": [ "Addresses" ], "summary": "Update address", "description": "Update records of an address object in our system\n\nIn case when an address becomes a part of a created verification, then our system will create a copy of an address object and will provide you with a different `address_id` in a response\n", "operationId": "address-update", "parameters": [ { "name": "address_id", "in": "path", "schema": { "$ref": "#/components/schemas/address_id" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type--address--full" }, "full_address": { "$ref": "#/components/schemas/full_address" }, "country": { "$ref": "#/components/schemas/country" }, "state": { "$ref": "#/components/schemas/state" }, "region": { "$ref": "#/components/schemas/region" }, "province": { "$ref": "#/components/schemas/province" }, "city": { "$ref": "#/components/schemas/city" }, "district": { "$ref": "#/components/schemas/district" }, "address": { "$ref": "#/components/schemas/address" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "street_name": { "$ref": "#/components/schemas/street_name" }, "building_number": { "$ref": "#/components/schemas/building_number" }, "unit_number": { "$ref": "#/components/schemas/unit_number" } } } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "address_id": { "$ref": "#/components/schemas/address_id", "description": "In case when an address becomes a part of a created verification, then our system will create a copy of an address object and provide you with a different `address_id` in a response" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } }, "delete": { "tags": [ "Addresses" ], "summary": "Delete an address", "description": "Deletes an address object from our system\n\nPlease note, that addresses may be deleted only before a verification was created\n", "operationId": "address-delete", "parameters": [ { "name": "address_id", "in": "path", "schema": { "$ref": "#/components/schemas/address_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "address_id": { "$ref": "#/components/schemas/address_id" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/affiliated-persons": { "post": { "tags": [ "Affiliated persons" ], "summary": "Create affiliated person", "description": "Create and add an affiliated person for an applicant object", "operationId": "affiliated-person-create", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "Authorised affiliated person", "properties": { "type": { "$ref": "#/components/schemas/type--affiliated-person--authorised" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "title": { "$ref": "#/components/schemas/title" }, "dob": { "$ref": "#/components/schemas/dob" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "email": { "$ref": "#/components/schemas/email" } }, "required": [ "type", "applicant_id", "first_name", "last_name", "title", "dob", "residence_country", "nationality", "email" ] }, { "type": "object", "title": "Beneficial affiliated person", "properties": { "type": { "$ref": "#/components/schemas/type--affiliated-person--beneficial" }, "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "share": { "$ref": "#/components/schemas/share" }, "dob": { "$ref": "#/components/schemas/dob" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "email": { "$ref": "#/components/schemas/email" } }, "required": [ "type", "applicant_id", "first_name", "last_name", "share", "dob", "residence_country", "nationality", "email" ] } ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_id" }, "message": { "type": "string", "example": "Applicant was not found" } } } } } } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "type" }, "message": { "type": "string", "example": "Type of affiliated person is required" } } } } } } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "limit_exceeded" }, "message": { "type": "string", "example": "The authorised person is already exists for that applicant" } } } } } } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/affiliated-persons/{affiliated_person_id}": { "patch": { "tags": [ "Affiliated persons" ], "summary": "Update affiliated person", "description": "Update records of an affiliated person object in our system", "operationId": "affiliated-person-update", "parameters": [ { "name": "affiliated_person_id", "in": "path", "schema": { "$ref": "#/components/schemas/affiliated_person_id" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "$ref": "#/components/schemas/first_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "title": { "$ref": "#/components/schemas/title" }, "share": { "$ref": "#/components/schemas/share" }, "dob": { "$ref": "#/components/schemas/dob" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "email": { "$ref": "#/components/schemas/email" } } } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "affiliated_person_id" }, "message": { "type": "string", "example": "Affiliated person was not found" } } } } } } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "*" }, "message": { "type": "string", "example": "At least one parameter should be set" } } } } } } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } }, "delete": { "tags": [ "Affiliated persons" ], "summary": "Delete an affiliated person", "description": "Delete records of an affiliated person object from our system", "operationId": "affiliated-person-delete", "parameters": [ { "name": "affiliated_person_id", "in": "path", "schema": { "$ref": "#/components/schemas/affiliated_person_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" } } } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "affiliated_person_id" }, "message": { "type": "string", "example": "Authorised person was not found" } } } } } } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "affiliated_person_id\"" }, "message": { "type": "string", "example": "Affiliated Person ID is not valid" } } } } } } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/applicants": { "post": { "tags": [ "Applicants" ], "summary": "Create applicant", "description": "Create a new applicant object in the system", "operationId": "applicant-create", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "KYC applicant (a person)", "properties": { "type": { "$ref": "#/components/schemas/type--applicant--person" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "middle_name": { "$ref": "#/components/schemas/middle_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "dob": { "$ref": "#/components/schemas/dob" }, "gender": { "$ref": "#/components/schemas/gender" }, "pep": { "$ref": "#/components/schemas/pep" }, "residence_country": { "$ref": "#/components/schemas/residence_country" }, "nationality": { "$ref": "#/components/schemas/nationality" }, "phone": { "$ref": "#/components/schemas/phone" }, "email": { "$ref": "#/components/schemas/email" }, "telegram_username": { "$ref": "#/components/schemas/telegram_username" }, "wallet_address": { "$ref": "#/components/schemas/wallet_address" }, "external_applicant_id": { "$ref": "#/components/schemas/external_applicant_id" }, "custom_field_1": { "$ref": "#/components/schemas/custom_field" }, "custom_field_2": { "$ref": "#/components/schemas/custom_field" }, "custom_field_3": { "$ref": "#/components/schemas/custom_field" }, "custom_field_4": { "$ref": "#/components/schemas/custom_field" }, "custom_field_5": { "$ref": "#/components/schemas/custom_field" } }, "required": [ "type" ] }, { "type": "object", "title": "KYB applicant (a company)", "properties": { "type": { "$ref": "#/components/schemas/type--applicant--company" }, "company_name": { "$ref": "#/components/schemas/company_name" }, "business_activity_id": { "$ref": "#/components/schemas/business_activity_id" }, "registration_country": { "$ref": "#/components/schemas/registration_country" }, "phone": { "$ref": "#/components/schemas/phone" }, "email": { "$ref": "#/components/schemas/email" }, "external_applicant_id": { "$ref": "#/components/schemas/external_applicant_id" } }, "required": [ "type", "company_name", "business_activity_id", "registration_country", "phone", "email" ] } ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicant--post--200" } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "parameter_name" }, "message": { "type": "string", "example": "parameter_name is not valid" } } } } } } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicant--post--429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/applicants/{applicant_id}": { "get": { "tags": [ "Applicants" ], "summary": "Get applicant", "description": "Get data on a created applicant", "operationId": "applicant-get", "parameters": [ { "name": "applicant_id", "in": "path", "schema": { "$ref": "#/components/schemas/applicant_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/applicant--get--200--person" }, { "$ref": "#/components/schemas/applicant--get--200--company" } ] } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/applicant--get--404--applicant_id" }, { "$ref": "#/components/schemas/applicant--get--404--verification_id" } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } }, "patch": { "tags": [ "Applicants" ], "summary": "Update an applicant", "description": "Update data of a created applicant", "operationId": "applicant-update", "parameters": [ { "name": "applicant_id", "in": "path", "schema": { "$ref": "#/components/schemas/applicant_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicant--patch--200" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/applicant--patch--404--applicant_id" }, { "$ref": "#/components/schemas/applicant--patch--404--business_activity_id" } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\n This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/documents": { "post": { "tags": [ "Documents" ], "summary": "Create document", "description": "Create a new document object in our system", "operationId": "document-create", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "Person applicant • Identity • Domestic passport", "description": "A government-issued internal identity document that certifies a citizen residency and regulates their movement within a country. It serves as a proof of identity and residence for administrative purposes and may be required for accessing certain services or permissions.\n\n⚠️ *Only one document with any of:*\n * *`DOMESTIC_PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "DOMESTIC_PASSPORT", "default": "DOMESTIC_PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, { "$ref": "#/components/schemas/document--post--person--drivers_license" }, { "$ref": "#/components/schemas/document--post--person--foreign_citizen_passport" }, { "$ref": "#/components/schemas/document--post--person--government_id" }, { "$ref": "#/components/schemas/document--post--person--passport" }, { "$ref": "#/components/schemas/document--post--person--permanent_residence_permit" }, { "$ref": "#/components/schemas/document--post--person--refugee_card" }, { "type": "object", "title": "Person applicant • Payment method • Credit card", "description": "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.\n\n⚠️ *Only one document with `CREDIT_CARD` document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same applicant object via `applicant_id`, replacing the one added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "CREDIT_CARD", "default": "CREDIT_CARD" }, "card_number": { "$ref": "#/components/schemas/card_number" }, "account_number": { "$ref": "#/components/schemas/account_number" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, { "type": "object", "title": "Person applicant • Payment method • Bank statement", "description": "A financial document issued by a bank that provides a detailed summary of account transactions over a specific period. It includes deposits, withdrawals, charges, beginning and ending balances for a specified period.\n\n⚠️ *Only 5 documents with any of:*\n * *`FINANCIAL_DOCUMENT`*\n * *`BANK_STATEMENT`*\n\n *document type may be associated with one applicant object via `applicant_id`.*\n\n⚠️ *After a verification was created, 5 new documents may be added for the same applicant object via `applicant_id`, replacing the ones added before.*\n\n---\n", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "type": { "type": "string", "example": "BANK_STATEMENT", "default": "BANK_STATEMENT" }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "applicant_id", "type" ] }, { "$ref": "#/components/schemas/document--post--person--bank_statement" }, { "$ref": "#/components/schemas/document--post--person--financial_document" }, { "$ref": "#/components/schemas/document--post--person--selfie_image" }, { "$ref": "#/components/schemas/document--post--person--selfie_with_credit_card" }, { "$ref": "#/components/schemas/document--post--person--selfie_with_document" }, { "$ref": "#/components/schemas/document--post--person--tax_id_number" }, { "$ref": "#/components/schemas/document--post--person--video" }, { "type": "object", "title": "Affiliated person • Address document", "description": "A government-issued or legally recognized document that confirms a person residential address. Common examples include bank statements, utility bills, or identity documents displaying an address. It typically includes a person full name, address, and a date of issue.\n\n⚠️ *Only one document with `ADDRESS_DOCUMENT` document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id` replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "ADDRESS_DOCUMENT", "default": "ADDRESS_DOCUMENT" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "$ref": "#/components/schemas/document--post--company--authorised_person" }, { "$ref": "#/components/schemas/document--post--company--company_legal_address" }, { "$ref": "#/components/schemas/document--post--company--company_ownership" }, { "$ref": "#/components/schemas/document--post--company--registration_company" }, { "type": "object", "title": "Affiliated person • Address document", "description": "A government-issued or legally recognized document that confirms a person residential address. Common examples include bank statements, utility bills, or identity documents displaying an address. It typically includes a person full name, address, and a date of issue.\n\n⚠️ *Only one document with `ADDRESS_DOCUMENT` document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id` replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "ADDRESS_DOCUMENT", "default": "ADDRESS_DOCUMENT" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Domestic passport", "description": "A government-issued internal identity document that certifies a citizen residency and regulates their movement within a country. It serves as a proof of identity and residence for administrative purposes and may be required for accessing certain services or permissions.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "DOMESTIC_PASSPORT", "default": "DOMESTIC_PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Driver license", "description": "A government-issued document that authorises an person to operate specific types of vehicles. It typically includes a holder photo, a full name, a date of birth, a license class, an expiration date. It is often recognized as a valid form of identification.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "DRIVERS_LICENSE", "default": "DRIVERS_LICENSE" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Foreign citizen passport", "description": "A government-issued travel document issued to a foreign national by their country of citizenship. It certifies a holder identity and nationality, allowing them to travel internationally and return to their home country. It may also be used as a proof of identity for various administrative purposes.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "FOREIGN_CITIZEN_PASSPORT", "default": "FOREIGN_CITIZEN_PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Government ID", "description": "A government-issued document used to verify a person identity. Typically provided as a small card, it contains information such as a photo, a full name, a date of birth, a gender, and other personal details.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "GOVERNMENT_ID", "default": "GOVERNMENT_ID" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Passport", "description": "A government-issued document that certifies a holder identity and nationality, primarily for international travel purposes.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "PASSPORT", "default": "PASSPORT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Permanent residence permit", "description": "A government-issued document that certifies a person permanent resident status in a country where they are not a citizen. It verifies their legal right to reside in that country indefinitely and may also serve as a proof of identity in certain situations.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "PERMANENT_RESIDENCE_PERMIT", "default": "PERMANENT_RESIDENCE_PERMIT" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] }, { "type": "object", "title": "Affiliated person • Identity • Refugee card", "description": "An identity document issued by UNHCR or an asylum state to refugees. It certifies a holder refugee status and serves as an official proof of identity, enabling access to essential services and rights within a host country.\n\n⚠️ *Only one document with any of:*\n * *`GOVERNMENT_ID`*\n * *`PASSPORT`*\n * *`DRIVERS_LICENSE`*\n * *`DOMESTIC_PASSPORT`*\n * *`PERMANENT_RESIDENCE_PERMIT`*\n * *`REFUGEE_CARD`*\n * *`FOREIGN_CITIZEN_PASSPORT`*\n\n *document type may be associated with one affiliated person object via `affiliated_person_id`.*\n\n⚠️ *After a verification was created, a new document may be added for the same affiliated person object via `affiliated_person_id`, replacing the one added before.*\n\n---\n", "properties": { "affiliated_person_id": { "$ref": "#/components/schemas/affiliated_person_id" }, "type": { "type": "string", "example": "REFUGEE_CARD", "default": "REFUGEE_CARD" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } }, "required": [ "affiliated_person_id", "type" ] } ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--post--404--applicant_id" }, { "$ref": "#/components/schemas/document--post--404--affiliated_person" }, { "$ref": "#/components/schemas/document--404--front_side_id" }, { "$ref": "#/components/schemas/document--404--back_side_id" }, { "$ref": "#/components/schemas/document--404--other_side_1_id" }, { "$ref": "#/components/schemas/document--404--other_side_2_id" }, { "$ref": "#/components/schemas/document--404--other_side_3_id" } ] } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--post--422--document_type" }, { "$ref": "#/components/schemas/document--post--422--applicant_id-affiliated_person_id" }, { "$ref": "#/components/schemas/document--post--422--applicant_id--invalid" }, { "$ref": "#/components/schemas/document--post--422--document_type" }, { "$ref": "#/components/schemas/document--post--422--additional_number" }, { "$ref": "#/components/schemas/document--post--422--issue_date" }, { "$ref": "#/components/schemas/document--post--422--expiry_date" }, { "$ref": "#/components/schemas/document--post--422--issuing_authority" }, { "$ref": "#/components/schemas/document--post--422--front_side_id" }, { "$ref": "#/components/schemas/document--post--422--back_side_id" }, { "$ref": "#/components/schemas/document--post--422--other_side_1_id" }, { "$ref": "#/components/schemas/document--post--422--other_side_2_id" }, { "$ref": "#/components/schemas/document--post--422--other_side_3_id" }, { "$ref": "#/components/schemas/document--post--422--income_sources" }, { "$ref": "#/components/schemas/document--post--422--transaction_amount" }, { "$ref": "#/components/schemas/document--post--422--transaction_currency" }, { "$ref": "#/components/schemas/document--post--422--transaction_datetime" }, { "$ref": "#/components/schemas/document--post--422--transaction_purpose" }, { "$ref": "#/components/schemas/document--post--422--origin_funds" }, { "$ref": "#/components/schemas/document--post--422--card_number" }, { "$ref": "#/components/schemas/document--post--422--account_number" } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--post--429--domestic_passport" }, { "$ref": "#/components/schemas/document--post--429--drivers_license" }, { "$ref": "#/components/schemas/document--post--429--foreign_citizen_passport" }, { "$ref": "#/components/schemas/document--post--429--government_id" }, { "$ref": "#/components/schemas/document--post--429--passport" }, { "$ref": "#/components/schemas/document--post--429--permanent_residence_permit" }, { "$ref": "#/components/schemas/document--post--429--refugee_card" }, { "$ref": "#/components/schemas/document--post--429--bank_statement" }, { "$ref": "#/components/schemas/document--post--429--financial_document" }, { "$ref": "#/components/schemas/document--post--429--credit_card" }, { "$ref": "#/components/schemas/document--post--429--selfie_image" }, { "$ref": "#/components/schemas/document--post--429--selfie_with_credit_card" }, { "$ref": "#/components/schemas/document--post--429--selfie_with_document" }, { "$ref": "#/components/schemas/document--post--429--tax_id_number" }, { "$ref": "#/components/schemas/document--post--429--video" } ] } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/500" } ] } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/502" } ] } } } } } } }, "/documents/{document_id}": { "get": { "tags": [ "Documents" ], "summary": "Get document", "description": "Get records of a created document object", "operationId": "document-get", "parameters": [ { "name": "document_id", "in": "path", "schema": { "$ref": "#/components/schemas/document_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--get--200--person--credit_card" }, { "$ref": "#/components/schemas/document--get--200--person--domestic_passport" }, { "$ref": "#/components/schemas/document--get--200--person--drivers_license" }, { "$ref": "#/components/schemas/document--get--200--person--foreign_citizen_passport" }, { "$ref": "#/components/schemas/document--get--200--person--government_id" }, { "$ref": "#/components/schemas/document--get--200--person--passport" }, { "$ref": "#/components/schemas/document--get--200--person--permanent_residence_permit" }, { "$ref": "#/components/schemas/document--get--200--person--refugee_card" }, { "$ref": "#/components/schemas/document--get--200--person--bank_statement" }, { "$ref": "#/components/schemas/document--get--200--person--financial_document" }, { "$ref": "#/components/schemas/document--get--200--person--selfie_image" }, { "$ref": "#/components/schemas/document--get--200--person--selfie_with_credit_card" }, { "$ref": "#/components/schemas/document--get--200--person--selfie_with_document" }, { "$ref": "#/components/schemas/document--get--200--person--tax_id_number" }, { "$ref": "#/components/schemas/document--get--200--person--video" }, { "$ref": "#/components/schemas/document--get--200--person-company--address_document" }, { "$ref": "#/components/schemas/document--get--200--company--authorised_person" }, { "$ref": "#/components/schemas/document--get--200--company--company_legal_address" }, { "$ref": "#/components/schemas/document--get--200--company--company_ownership" }, { "$ref": "#/components/schemas/document--get--200--company--registration_company" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--address_document" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--domestic_passport" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--drivers_license" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--foreign_citizen_passport" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--government_id" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--passport" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--permanent_residence_permit" }, { "$ref": "#/components/schemas/document--get--200--affiliated_person--refugee_card" } ] } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--404--document_id" } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--422--document_id" } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } }, "patch": { "tags": [ "Documents" ], "summary": "Update a document", "description": "Update records of a created document object", "operationId": "document-update", "parameters": [ { "name": "document_id", "in": "path", "schema": { "$ref": "#/components/schemas/document_id" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/type--document" }, "document_number": { "$ref": "#/components/schemas/document_number--document" }, "additional_number": { "$ref": "#/components/schemas/additional_number" }, "issue_date": { "$ref": "#/components/schemas/issue_date" }, "expiry_date": { "$ref": "#/components/schemas/expiry_date" }, "issuing_authority": { "$ref": "#/components/schemas/issuing_authority" }, "income_sources": { "$ref": "#/components/schemas/income_sources" }, "annual_income": { "$ref": "#/components/schemas/annual_income" }, "transaction_amount": { "$ref": "#/components/schemas/transaction_amount" }, "transaction_currency": { "$ref": "#/components/schemas/transaction_currency" }, "transaction_datetime": { "$ref": "#/components/schemas/transaction_datetime" }, "transaction_purpose": { "$ref": "#/components/schemas/transaction_purpose" }, "origin_funds": { "$ref": "#/components/schemas/origin_funds" }, "card_number": { "$ref": "#/components/schemas/card_number" }, "account_number": { "$ref": "#/components/schemas/account_number" }, "front_side_id": { "$ref": "#/components/schemas/front_side_id" }, "back_side_id": { "$ref": "#/components/schemas/back_side_id" }, "other_side_1_id": { "$ref": "#/components/schemas/other_side_1_id" }, "other_side_2_id": { "$ref": "#/components/schemas/other_side_2_id" }, "other_side_3_id": { "$ref": "#/components/schemas/other_side_3_id" } } } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--update--200" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--404--document_id" }, { "$ref": "#/components/schemas/document--404--front_side_id" }, { "$ref": "#/components/schemas/document--404--back_side_id" }, { "$ref": "#/components/schemas/document--404--other_side_1_id" }, { "$ref": "#/components/schemas/document--404--other_side_2_id" }, { "$ref": "#/components/schemas/document--404--other_side_3_id" } ] } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/document--422--document_id" }, { "$ref": "#/components/schemas/document--422--parameter_missing" } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "Delete a document", "description": "Delete records of a created document object", "operationId": "document-delete", "parameters": [ { "name": "document_id", "in": "path", "schema": { "$ref": "#/components/schemas/document_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--delete--200" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--404--document_id" } } } }, "409": { "description": "409 Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--delete--409" } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/document--422--document_id" } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/files": { "post": { "tags": [ "Files" ], "summary": "Create file", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#create-a-file) for this article\n{% /admonition %}\n", "operationId": "file-create" } }, "/files/file_id": { "put": { "tags": [ "Files" ], "summary": "Update file", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#update-a-file) for this article\n{% /admonition %}\n", "operationId": "file-update" } }, "/forms/{form_id}/urls": { "post": { "tags": [ "Forms" ], "summary": "Get a form URL", "description": "Retrieve a URL for a form", "operationId": "form-get-url", "parameters": [ { "name": "form_id", "in": "path", "schema": { "$ref": "#/components/schemas/form_id" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "external_applicant_id": { "$ref": "#/components/schemas/external_applicant_id" }, "redirect_url": { "$ref": "#/components/schemas/redirect_url" } } } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/form--post--200" } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/form--post--404--form_id" }, { "$ref": "#/components/schemas/form--post--404--applicant_id" } ] } } } }, "409": { "description": "**409 Conflict**\n\nThe error is returned by our system when a request can’t be processed due to a conflict with the current state of the resource.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/form--post--409" } ] } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/form--post--422--form_id" }, { "$ref": "#/components/schemas/form--post--422--applicant_id" } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "text/text": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/forms": { "get": { "tags": [ "Forms" ], "summary": "Get forms", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#get-forms) for this article\n{% /admonition %}\n", "operationId": "forms-get" } }, "/verifications": { "post": { "tags": [ "Verifications" ], "summary": "Create verification", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#create-a-verification) for this article\n{% /admonition %}\n", "operationId": "verification-create", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "applicant_id": { "$ref": "#/components/schemas/applicant_id" }, "form_id": { "$ref": "#/components/schemas/form_id" }, "language_code": { "$ref": "#/components/schemas/language_code" } }, "required": [ "applicant_id", "form_id" ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicant--post--200" } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "parameter_name" }, "message": { "type": "string", "example": "parameter_name is not valid" } } } } } } } } }, "429": { "description": "**Too Many Requests**\n\nThis response indicates that a user has sent too many requests in a given amount of time.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicant--post--429" } } } }, "500": { "description": "**Internal Server Error**\n\nThis response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/500" } } } }, "502": { "description": "**Bad Gateway**\n\nThis response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/502" } } } } } } }, "/verifications/{verification_id}": { "get": { "tags": [ "Verifications" ], "summary": "Get verification", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#retrieve-a-verification) for this article\n{% /admonition %}\n", "operationId": "verification-get", "parameters": [ { "name": "verification_id", "in": "path", "schema": {}, "required": true } ] } }, "/verifications/report": { "get": { "tags": [ "Verifications" ], "summary": "Get a report", "description": "{% admonition type=\"info\" name=\"Content migration in progress\" %}\n Please refer to the [**legacy documentation**](https://docs-v1.kycaid.com/#get-verifications-report) for this article\n{% /admonition %}\n", "operationId": "verification-report-get" } }, "/verifications/{verification_id}/status": { "post": { "tags": [ "Verifications" ], "summary": "Update verification status", "description": "This endpoint is used to programmatically change the status of an existing verification record. This is typically utilised by your systems to finalise or adjust a verification's outcome after review\n", "operationId": "verification-update-status", "parameters": [ { "name": "verification_id", "in": "path", "schema": { "$ref": "#/components/schemas/verification_id" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "verification_status": { "$ref": "#/components/schemas/verification_status--2" }, "callback_enabled": { "$ref": "#/components/schemas/callback_enabled" }, "project_owner_email_enabled": { "$ref": "#/components/schemas/project_owner_email_enabled" }, "applicant_email_enabled": { "$ref": "#/components/schemas/applicant_email_enabled" } }, "required": [ "verification_status" ] } } } }, "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "data": { "type": "object", "properties": { "verification_id": { "$ref": "#/components/schemas/verification_id" }, "verification_status": { "$ref": "#/components/schemas/verification_status--2" } } } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can’t be found in our system.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "The verification was not found" } } } } } } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can’t process it due to invalid fields in the request body.\n", "content": { "application/json": { "schema": { "oneOf": [ { "title": "Verification ID is required", "description": "The error is sent by our system when no verification ID detected", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "Value is required" } } } } } }, { "title": "Verification ID is invalid", "description": "The error is sent by our system when `verification_id` value has wrong format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "Value is invalid" } } } } } }, { "title": "Verification status is invalid", "description": "The error is sent by our system when `verification_status` value has wrong format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_status" }, "message": { "type": "string", "example": "Value is invalid" } } } } } }, { "title": "Callback enabled? is invalid", "description": "The error is sent by our system when `callback_enabled` value has wrong format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "callback_enabled" }, "message": { "type": "string", "example": "Value is invalid" } } } } } }, { "title": "Project owner email enabled? is invalid", "description": "The error is sent by our system when `project_owner_email_enabled` value has wrong format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "project_owner_email_enabled" }, "message": { "type": "string", "example": "Value is invalid" } } } } } }, { "title": "Applicant email enabled? is invalid", "description": "The error is sent by our system when `applicant_email_enabled` has wrong format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "applicant_email_enabled" }, "message": { "type": "string", "example": "Value is invalid" } } } } } } ] } } } } } } }, "/verifications/{verification_id}/report": { "get": { "tags": [ "Verifications" ], "summary": "Get verification report", "description": "This endpoint is used to retrieve the URL of a verification report for a specific verification record. The returned URL is a signed link that can be used to download the verification report in PDF format.\n\nIf the report has not been generated yet, our system will initiate report generation and wait for it to complete. This may take up to 60 seconds.\n\nThis endpoint is rate-limited per customer per verification to prevent abuse.\n", "operationId": "verification-get-report", "parameters": [ { "name": "verification_id", "in": "path", "schema": { "$ref": "#/components/schemas/verification_id" }, "required": true } ], "responses": { "200": { "description": "**OK**\n\nThe request was successful, and our system returned an expected response.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "data": { "type": "object", "properties": { "report_url": { "type": "string", "format": "uri", "description": "Signed URL to download the verification report in PDF format", "example": "https://app.kycaid.com/verification-reports/1fad6bae05533340c21b5248f15ed6f75626/b61a6b4f03cfd3450718e5b89790e4afc46d.pdf?signature=xyz" } } } } } } } }, "400": { "description": "**Bad Request**\n\nOur system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400" } } } }, "402": { "description": "**Payment Required**\n\nAccess to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/402" } } } }, "404": { "description": "**Not Found**\n\nThe requested resource does not exist or can't be found in our system.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "not_found" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "The verification was not found" } } } } } } } } }, "408": { "description": "**Request Timeout**\n\nThe report generation process did not complete within the expected time. Please try again later.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "request_timeout" }, "errors": { "type": "array", "items": {}, "example": [] } } } } } }, "422": { "description": "**Unprocessable Content**\n\nOur system understands the request but can't process it due to invalid fields in the request.\n", "content": { "application/json": { "schema": { "oneOf": [ { "title": "Verification ID is required", "description": "The error is sent by our system when no verification ID detected", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "Value is required" } } } } } }, { "title": "Verification ID is not valid", "description": "The error is sent by our system when `verification_id` value does not match the expected UUID format", "type": "object", "properties": { "type": { "type": "string", "example": "validation" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": "string", "example": "verification_id" }, "message": { "type": "string", "example": "Verification ID is not valid" } } } } } } ] } } } }, "429": { "description": "**Too Many Requests**\n\nThe maximum number of report generation attempts for this verification has been exceeded. Please contact support if you need additional access.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "limit_exceeded" }, "errors": { "type": "array", "items": {}, "example": [] } } } } } } } } } } }