Documents

Documents can be linked with clients for further checks or for KYC filing purposes.

Documents can be created for a given client for the following purposes:

• Secure and centralised document storage.

• Perform checks such as Document Checks and Identity Checks.

The documents API allows you to create, update, retrieve, upload, and delete documents. You can fetch a specific document or retrieve a list of all your documents.

To upload an image attachment, you first have to create a document object, then upload an image attachment.

The Document object

Attribute	Type	Description
id	string	The unique identifier for a document.
clientId	string	The ID of the client associated with this document.
type	string	The type of document. Valid values include: passport driving_license national_insurance_number social_security_number utility_bill tax_identification_number national_identity_card visa polling_card residence_permit birth_certificate bank_statement change_of_name tax_document company_confirmation_statement company_annual_accounts company_statement_of_capital company_change_of_address company_incorporation company_change_of_officers company_change_of_beneficial_owners unknown other
classification	string	The classification or purpose of this document. Valid values include: proof_of_identity source_of_wealth source_of_funds proof_of_address company_filing other
documentNumber	string	The document's number.
issuingCountry	string	The document's issuing country. This will be the two-letter country ISO code.
issuingState	string	The state that issued the document. This must be the state's USPS abbreviation (e.g. NY, CA, or DE).
images	array [object]	The images or attachments associated with the document. This will only appear once a document image is uploaded. Also, see the image object below.
createdAt	string	The date and time when the document was created.
updatedAt	string	The date and time when the document was updated.

The image object

Attribute	Type	Description
id	string	The unique identifier for a document image attachment.
fileName	string	The file name.
documentSide	string	The side of document: front or back.
downloadLink	string	The download link to the document image.
contentType	string	The content-type of the document image.
size	number	The size of the document image in bytes.
createdAt	string	The date and time when the image was created.
updatedAt	string	The date and time when the image was updated.