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.
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.
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:
|
classification | string | The classification or purpose of this document. Valid values include:
|
issuingCountry | string | |
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. |
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. |
Last modified 1yr ago