Service API · API Docs · eKYC Platform

Upload image

POST/portal/ekyc/upload/image

Uploads a single image file to eKYC and returns the image id that can be referenced later instead of re-sending the bytes.

Request

MethodPOST
Path/portal/ekyc/upload/image
Content-Typemultipart/form-data
Auth requiredYes — JWT access token

Send the JWT access token in the Authorization header.

Form fields:

FieldTypeRequiredDescription
filefileRequiredImage file. Must be non-empty. Maximum size is governed by the server's tv_max_file_size setting.
labelstringOptionalImage label as described at Label table.
metadatastringOptionalJSON-encoded string with per-image metadata.

Response

data.image_id is the id that can be referenced by other eKYC Platform Service API batch endpoints' images[].id field instead of re-sending the bytes.

JSON
{
  "data": {
    "image_id": "8fdcb17e-5d41-4814-8d4f-8c1bfb51df20"
  },
  "message": "image uploaded",
  "time": "2026-05-04T09:00:00+07:00",
  "verdict": "success"
}