API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page

Was this helpful?

  1. Core resources

Documents

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

PreviousFiltering addressesNextCreate a document

Last updated 5 months ago

Was this helpful?

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

  • Secure and centralised document storage.

  • Perform checks such as and .

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 object, then .

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. passport

  2. driving_license

  3. national_insurance_number

  4. social_security_number

  5. utility_bill

  6. tax_identification_number

  7. national_identity_card

  8. visa

  9. polling_card

  10. residence_permit

  11. birth_certificate

  12. bank_statement

  13. change_of_name

  14. tax_document

  15. company_confirmation_statement

  16. company_annual_accounts

  17. company_statement_of_capital

  18. company_change_of_address

  19. company_incorporation

  20. company_change_of_officers

  21. company_change_of_beneficial_owners

  22. unknown

  23. other

classification

string

The classification or purpose of this document. Valid values include:

  1. proof_of_identity

  2. source_of_wealth

  3. source_of_funds

  4. proof_of_address

  5. company_filing

  6. other

documentNumber

string

The document's number.

issuingCountry

string

issuingState

string

images

array

[object]

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.

The document's issuing country. This will be the .

The state that issued the document. This must be the (e.g. NY, CA, or DE).

The images or attachments associated with the document. This will only appear once a document image is uploaded. Also, see below.

two-letter country ISO code
state's USPS abbreviation
the image object
Document Checks
Identity Checks
upload an image attachment
create a document