API Reference
Search…
API Reference
v1.7.3
Introduction
Integration
Sandbox and Live
Authentication
Rate Limits
Service Quota
Errors
Pagination
Filtering
Versioning
Core resources
Clients
Addresses
Documents
Create a document
Get a document
Update a document
Upload image attachment
Download image attachment
Delete image attachment
Delete a document
List documents
Filtering documents
Live Photos
Live Videos
Checks
Risk Profile
Check types
AML Screening Check
Document Check
Identity Check
Enhanced Identity Check
Proof of Address Check
Multi-Bureau Check
Face Authentication Check
Lookups
Company Search
Address Search
Tools
Custom Lists
Static Data
Screening Lists
Supported Documents
Other Resources
Flow (Hosted Solution)
Webhooks
SDK Tokens
Autofill
Reports
Team Members
Audit Logs
Account Info
Powered By GitBook
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:
The documents API allows you to create, update, retrieve, upload, and delete documents. You can retrieve a specific document as well as a list of all your client's 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:
  1. 1.
    passport
  2. 2.
    driving_license
  3. 3.
    national_insurance_number
  4. 4.
    social_security_number
  5. 5.
    utility_bill
  6. 6.
    tax_identification_number
  7. 7.
    national_identity_card
  8. 8.
    visa
  9. 9.
    polling_card
  10. 10.
    residence_permit
  11. 11.
    birth_certificate
  12. 12.
    bank_statement
  13. 13.
    change_of_name
  14. 14.
    tax_document
  15. 15.
    company_confirmation_statement
  16. 16.
    company_annual_accounts
  17. 17.
    company_statement_of_capital
  18. 18.
    company_change_of_address
  19. 19.
    company_incorporation
  20. 20.
    company_change_of_officers
  21. 21.
    company_change_of_beneficial_owners
  22. 22.
    unknown
  23. 23.
    other
classification
string
The classification or purpose of this document. Valid values include:
  1. 1.
    proof_of_identity
  2. 2.
    source_of_wealth
  3. 3.
    source_of_funds
  4. 4.
    proof_of_address
  5. 5.
    company_filing
  6. 6.
    other
issuingCountry
string
The document's issuing country. This will be the two-letter country ISO code.
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.

​

Previous
Filtering addresses
Next
Create a document
Last modified 8mo ago
Copy link
Contents
The Document object
The image object