Get Client Documents
Get Client (sub-user) Documents
Display Uploaded or required document for user KYC/KYB verification.
POST METHOD
{{baseUrl}}api/v2/clients/user/documents
{
"email" : "[email protected]",
}
| Field | Required | Data Type | Description |
|---|---|---|---|
| true | Sub User Email Address |
Response
Instance of no Upload document Yet
kycStatus => false
kycList => has object
kycList->upload => false
{
"status": true,
"content": {
"data": {
"document": {
"kycStatus": false,
"kycList": [
{
"upload": false,
"id": 2,
"name": "Proof of Identity",
"nameDesc": true,
"nameId": true,
"issueDate": true,
"expiryDate": true,
"type": "image,pdf",
"required": true,
"module": 1
},
{
"upload": false,
"id": 3,
"name": "Address",
"nameDesc": false,
"nameId": false,
"issueDate": false,
"expiryDate": false,
"type": "image,pdf",
"required": true,
"module": 1
}
]
},
"user": {
"username": "50T-1676031182",
"email": "[email protected]",
"pix": null,
"firstName": "Desola",
"lastName": "Maquie",
"dob": "1998/05/23",
"sex": "Male",
"address": "Somewhere in Lekki",
"state": "Lagos",
"city": "Lekki",
"zipcode": "23402",
"country": "Nigeria",
"countryCode": "NG",
"mobileCode": "+234",
"mobile": "8080808080",
"employmentStatus": "Employed",
"occupation": "Civil Servant",
"sourceOfFund": "Business",
"incomeRange": "1-10000",
"accountDesignation": "Personal",
"created_at": "2023-02-10T12:13:02.000000Z",
"updated_at": "2023-02-10T12:13:02.000000Z"
}
}
}
}
Instance of Uploaded Document (Document under review)
kycStatus => false
kycList => has object
kycList->upload => true
{
"success": true,
"content": {
"data": {
"kycStatus": false,
"kycList": [
{
"upload": true,
"name": "Proof of Identity",
"file": "https://blinqremit.s3.eu-central-1.amazonaws.com/documents/SYj5we986Y1hSvQeV5swsKXYgn9L9GlfpJfUPALSPpJKJOGgTw.jpg|https://blinqremit.s3.eu-central-1.amazonaws.com/documents/ZShoS0qMHcqq4mGBsaHx99hdL4jBkUhxpA5UbhrIqGhJU53LGW.jpg",
"fileDesc": "driver-license",
"fileId": "B0000000",
"fileIssueDate": "1970-01-01",
"fileExpiryDate": "1970-01-01",
"returnedPhoto": null,
"returnedDoc": null,
"verifyStatus": 0,
"verifyResponses": "",
"status": 0
},
{
"upload": true,
"name": "Address",
"file": "https://blinqremit.s3.eu-central-1.amazonaws.com/documents/FJrW0Gi06MXiRpYS3kBR0ZJLjquHmrfFQEGn3GyIFv3so44qgs.jpg",
"fileDesc": null,
"fileId": null,
"fileIssueDate": "1970-01-01",
"fileExpiryDate": "1970-01-01",
"returnedPhoto": null,
"returnedDoc": null,
"verifyStatus": 0,
"verifyResponses": null,
"status": 0
}
]
},
"user": {
"username": "50T-1676031182",
"email": "[email protected]",
"pix": null,
"firstName": "Desola",
"lastName": "Maquie",
"dob": "1998/05/23",
"sex": "Male",
"address": "Somewhere in Lekki",
"state": "Lagos",
"city": "Lekki",
"zipcode": "23402",
"country": "Nigeria",
"countryCode": "NG",
"mobileCode": "+234",
"mobile": "8080808080",
"employmentStatus": "Employed",
"occupation": "Civil Servant",
"sourceOfFund": "Business",
"incomeRange": "1-10000",
"accountDesignation": "Personal",
"created_at": "2023-02-10T12:13:02.000000Z",
"updated_at": "2023-02-10T12:13:02.000000Z"
}
}
}
Instance of Uploaded Document (Document Confirmed)
kycStatus => true
kycList => has object
kycList->upload => true
{
"success": true,
"content": {
"data": {
"kycStatus": true,
"kycList": [
{
"upload": true,
"name": "Proof of Identity",
"file": "https://blinqremit.s3.eu-central-1.amazonaws.com/documents/SYj5we986Y1hSvQeV5swsKXYgn9L9GlfpJfUPALSPpJKJOGgTw.jpg|https://blinqremit.s3.eu-central-1.amazonaws.com/documents/ZShoS0qMHcqq4mGBsaHx99hdL4jBkUhxpA5UbhrIqGhJU53LGW.jpg",
"fileDesc": "driver-license",
"fileId": "B0000000",
"fileIssueDate": "1970-01-01",
"fileExpiryDate": "1970-01-01",
"returnedPhoto": null,
"returnedDoc": null,
"verifyStatus": true,
"verifyResponses": "",
"status": 1
},
{
"upload": true,
"name": "Address",
"file": "https://blinqremit.s3.eu-central-1.amazonaws.com/documents/FJrW0Gi06MXiRpYS3kBR0ZJLjquHmrfFQEGn3GyIFv3so44qgs.jpg",
"fileDesc": null,
"fileId": null,
"fileIssueDate": "1970-01-01",
"fileExpiryDate": "1970-01-01",
"returnedPhoto": null,
"returnedDoc": null,
"verifyStatus": true,
"verifyResponses": null,
"status": 1
}
]
},
"user": {
"username": "50T-1676031182",
"email": "[email protected]",
"pix": null,
"firstName": "Desola",
"lastName": "Maquie",
"dob": "1998/05/23",
"sex": "Male",
"address": "Somewhere in Lekki",
"state": "Lagos",
"city": "Lekki",
"zipcode": "23402",
"country": "Nigeria",
"countryCode": "NG",
"mobileCode": "+234",
"mobile": "8080808080",
"employmentStatus": "Employed",
"occupation": "Civil Servant",
"sourceOfFund": "Business",
"incomeRange": "1-10000",
"accountDesignation": "Personal",
"created_at": "2023-02-10T12:13:02.000000Z",
"updated_at": "2023-02-10T12:13:02.000000Z"
}
}
}
Updated almost 2 years ago