KYC Service
Upload Documents
This endpoint enables the integrator to upload documents.
Note that the response in the sandbox is mocked/fake data and wouldn’t work for s3 bucket upload.
Upload Document details
Field | Description | Type |
---|---|---|
verificationId | The verification id from the initialized verification | string |
docType | Document type indicating the type of verification to be carried out | string |
docBase64 | The document encoded in base64 | string |
API Response
{
"docType": "biometrics",
"verificationId": "b7535048-76f8-4f60-bdd3-9d659298f9e7",
"docBase64": "data:image/png;name=Screen%20Shot%202023-04-11%20at%209.28.32%20AM.png;base64,iVBORw0KGgoAAAANSUhEUgAABnoAAAQuCAYAAAD7vONVAAAMZmlDQ1BJQ0MgUHJvZmlsZQAASImVVwdUU8kanltSSWiBSCf0Joj0IiWEFkFAq"
}
{
"location": "https://s3.eu-west-1.amazonaws.com/bend-development-kyc-store",
"key": "dab70041b5503cfc2d883be1d3f7ce04bcf88f90f5b2e977a12a074aeae6108c",
"id": "b7535048-76f8-4f60-bdd3-9d659298f9e7",
"verificationId": "b7535048-76f8-4f60-bdd3-9d659298f9e7"
}
API Reference ➡️
Start Face Match
This endpoint enables you to facematch between the uploaded selfie photo and the government issued identity document.
API Request Body
{
"verificationId":"c61060e9-635a-5392-b39d-b1c27479d67c",
"inputs":[
{
"docType":"selfie-photo",
"key":"d468c5897a37902ee259d15b792936512d5a6b67382312f3f4583c6c02f68f71",
"country":"NG"
},
{
"docType":"passport",
"key":"cf7ea57f013b0c17fad6638222c2414aaf26ca751ec0524dbf428fcf576ee536",
"side":"front",
"country":"NG"
}
]
}
{
"verificationId":"c61060e9-635a-5392-b39d-b1c27479d67c",
"inputs":[
{
"docType":"selfie-photo",
"key":"d468c5897a37902ee259d15b792936512d5a6b67382312f3f4583c6c02f68f71",
"country":"NG"
},
{
"docType":"driving_license",
"key":"cf7ea57f013b0c17fad6638222c2414aaf26ca751ec0524dbf428fcf576ee536",
"side":"front",
"country":"NG"
},
{
"docType":"driving_license",
"key":"cf7ea57f013b0c17fad6638222c2414aaf26ca751ec0524dbf428fcf576ee536",
"side":"back",
"country":"NG"
}
]
}
{
"message": "Ok"
}
Face Match Fields
Field | Description | Type |
verificationId | The verification id from the initialized verification | string |
inputs | The information of the documents to upload | Array of object |
inputs.docType | The document type to upload. | string |
inputs.key | The key from the uploaded documentl | string |
inputs.country | The country ISO 3166-1 alpha-2 code. eg NG for Nigeria. | string |
inputs.side | The side of the document which can be front or back | string |
API Reference ➡️
Start Government Issued ID Check
This endpoint enables you to check the authenticity of the uploaded government issued ID or proof of residency.
API Request/Response Body
{
"inputs": [
{
"docType":"passport",
"country":"NG",
“side”:”front”,
"key":"3dd2e8709318275a5250c8b691ca6fce7da8cacbb353c1386486bd11135fba12"
}
],
"verificationId":"c61060e9-635a-5392-b39d-b1c27479d67c"
}
{
"message": "Ok"
}
Government Issued ID Check Fields
Field | Description | Type |
---|---|---|
inputs | The information of the document to upload | Array of object |
inputs.docType | The document type to upload. | string |
inputs.key | The key from the presigned url | string |
inputs.country | The country ISO 3166-1 alpha-2 code. eg NG for Nigeria. | string |
inputs.side | The side of the document which can be front or back | string |
verificationId | The verification id from the initialized verification | string |
API Reference ➡️
Liveness Detection
This endpoint detects if the uploaded selfie video contains a living/real person in it.
API Request Body
{
"input":{
"key":"666714e5e4ea9abfe75be1bcda7f3864825c163ea522a0e56842d47a16b1aaac"
},
"verificationId":"c61060e9-635a-5392-b39d-b1c27479d67c"
}
{
"message": "Ok"
}
Liveness Detection Fields
Field | Description | Type |
input | The information of the document (selfie photo) to upload | object |
input.key | The key from the uploaded document | string |
verificationId | The verification id from the initialized verification | string |
API Reference ➡️
Updated over 1 year ago