Service API · API Docs · eKYC Platform
Index faces
POST/portal/ekyc/index_faces
Indexes one base64-encoded face image, with its label and metadata, into a face collection.
Request
MethodPOST
Path/portal/ekyc/index_faces
Content-Typeapplication/json
Auth requiredYes — JWT access token
Send the JWT access token in the Authorization header.
| Name | Type | Required | Description |
|---|---|---|---|
image_base64 | string | Required | Encode base64 of binary image without prefix, e.g. data:image/jpeg;base64, |
label | string | Required | Label of the image as described at Label table |
metadata | json | Required | More information of the image, e.g. client_uid, phone_number, dob, name. client_uid must not be empty |
collection | string | Optional | Index faces to this collection. Case-sensitive. |
{
"image_base64": string,
"collection": string,
"label": string,
"metadata": JSON
}
Response
On success the HTTP status code is 200.
Failure codes
| Name | Description | Status code | Response Body |
|---|---|---|---|
| Not found | Not found | 404 | {"data":{},"message":"applications not available","time":"2024-10-31T08:27:27Z","verdict":"record_not_found"} |
Parameter, auth, method, rate-limit and server errors are the same on every JWT-authenticated call — see Common objects & errors.