Update a document

Request

Update records of a created document object

Security

API-Key

Path

document_idstring, = 36 charactersrequired

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

Example:27c5caea93ee4656881ef9a30fadd21a3768

Bodyapplication/json

typestring

A type of a document object

Enum:"ADDRESS_DOCUMENT""AUTHORISED_PERSON""BANK_STATEMENT""COMPANY_LEGAL_ADDRESS""COMPANY_OWNERSHIP""CREDIT_CARD""DOMESTIC_PASSPORT""DRIVERS_LICENSE""FINANCIAL_DOCUMENT""FOREIGN_CITIZEN_PASSPORT"

Example:"DOMESTIC_PASSPORT"

document_numberstring or null, <= 50 characters

A number of a document

Example:"TH703318A"

additional_numberstring or null, <= 50 characters

An additional number located on a document (e.g. tax ID number located on an ID card)

Example:"E2100007T-5"

issue_datestring or null, (date), <= 10 characters

An issue date of a document in YYYY-MM-DD format

Example:"2020-11-04"

expiry_datestring or null, (date), <= 10 characters

The date of document expiration, formatted according to ISO 8601

Example:"2028-11-04"

issuing_authoritystring or null, <= 255 characters

A name of a govenment entity that issues official documents

Example:"Social Security Administration"

income_sourcesArray of strings

Category of a person or an entity earnings

Items Enum:"SALARY""DIVIDENDS""SALE_PROPERTY""SAVINGS""DIVORCE_SETTLEMENTS""INHERITANCE""LOAN""INVESTMENTS""OTHER"

Example:

[
  "SAVINGS",
  "OTHER"
]

annual_incomestring or null

An annual income group that categorizes persons or entities based on their total yearly income. There are four groups available:

ANNUAL_INCOME_GROUP_1: less than 50,000 EUR
ANNUAL_INCOME_GROUP_2: between 50,000 and 100,000 EUR
ANNUAL_INCOME_GROUP_3: between 100,000 and 300,000 EUR
ANNUAL_INCOME_GROUP_4: more than 300,000 EUR

Enum:"ANNUAL_INCOME_GROUP_1""ANNUAL_INCOME_GROUP_2""ANNUAL_INCOME_GROUP_3""ANNUAL_INCOME_GROUP_4"null

Example:"ANNUAL_INCOME_GROUP_2"

transaction_amountnumber or null, (float)

The amount of a financial transaction

Example:1468.55

transaction_currencystring or null, <= 3 characters

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)

Example:"EUR"

transaction_datetimestring or null

A date and time of a financial transaction in YYYY-MM-DD HH:mm:ss format

Example:"2024-11-16 14:22:54"

transaction_purposestring or null, <= 255 characters

A definition of an intended reason or objective for a financial transaction

Example:"Payment for additional services"

origin_fundsstring or null, <= 255 characters

A source of financial resources

Example:"Business revenues"

card_numberstring or null, [ 12 .. 19 ] characters

A number of a credit card for payments

Example:"5375411422962063"

account_numberstring or null, <= 50 characters

A bank account number (e.g. IBAN)

Example:"UA383220010000026200000000000"

front_side_idstring or null, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

back_side_idstring or null, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

other_side_1_idstring or null, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

other_side_2_idstring or null, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

other_side_3_idstring or null, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

{
  "type": "DOMESTIC_PASSPORT",
  "document_number": "TH703318A",
  "additional_number": "E2100007T-5",
  "issue_date": "2020-11-04",
  "expiry_date": "2028-11-04",
  "issuing_authority": "Social Security Administration",
  "income_sources": [
    "SAVINGS",
    "OTHER"
  ],
  "annual_income": "ANNUAL_INCOME_GROUP_2",
  "transaction_amount": 1468.55,
  "transaction_currency": "EUR",
  "transaction_datetime": "2024-11-16 14:22:54",
  "transaction_purpose": "Payment for additional services",
  "origin_funds": "Business revenues",
  "card_number": "5375411422962063",
  "account_number": "UA383220010000026200000000000",
  "front_side_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "back_side_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_1_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_2_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_3_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}

Responses

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

Bodyapplication/json

document_idstring, = 36 characters

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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

Response

{
  "document_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}