Get supporting documents related to an entity
GetSupportingDocumentsByEntityID
GET https://api.icomplykyc.com/api/v2/entities/:id/documents
Get all supporting documents associated with this legal entity
Authentication Type: API Key
Sample Query: https://api.icomplykyc.com/api/v2/entities/1234567e-fcff-4c10-9dd3-da74422e1c30/documents
Path Parameters
| Name | Type | Description |
|---|---|---|
|
* |
String |
The entity ID you wish to retrieve ID documents for |
200: OK
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"documentId": "1234567a-aff8-4b24-8606-f40a6ef6ec90",
"fileName": "Supporting document example 3",
"type": "Proof of Address",
"description": null,
"dateReceived": "2020-09-01 14:38:57",
"documentApproved": false
},
{
"documentId": "1234567a-adf1-4afa-a072-b1f80cdfdef0",
"fileName": "Supporting document example 2",
"type": "Proof of Address",
"description": null,
"dateReceived": "2020-09-01 14:44:39",
"documentApproved": true
},
{
"documentId": "1234567e-3b78-42fb-9547-dd0fb62e8d51",
"fileName": "Supporting document example 1",
"type": "Proof of Wealth",
"description": null,
"dateReceived": "2020-09-02 09:26:34",
"documentApproved": false
},
{
"documentId": "12345672-fadf-4b26-8c9d-bbb3bae5a6cf",
"fileName": "Supporting document example 4",
"type": "Proof of Address",
"description": null,
"dateReceived": "2020-09-02 09:29:24",
"documentApproved": false
}
]
}404: Not Found The entity ID provided was not found
{
// Response
}GetSupportingDocumentByDocumentID
GET https://api.icomplykyc.com/api/v2/documents/:id
Get the details and binary file of the specified document. The document is returned as a base64 encoded string which must be decoded into a binary file.
Authentication Type: Api Key
Sample Query: https://api.icomplykyc.com/api/v2/documents/1234567e-fcff-4c10-9dd3-da74422e1c30
Path Parameters
| Name | Type | Description |
|---|---|---|
|
id |
String |
The ID of the document to retrieve |
200: OK
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"fileName": "SampleFile.jpg_1234567-884b-414a-8ac0-943bba161727.jpg",
"format": "PDF",
"data": "/9j/4AAQSkZJRgABAQEASABIAAD/4gIcSUNDX1...2Q=="
}
]
}404: Not Found
{
"code": 404,
"status": "failure",
"message": "there is no document with given id",
"data": null
}