Submit KYC/KYB

POST

/api/v1/transformer/entity/kyc/{entityId}/{routingId}

This endpoint allows you to submit collected verification data for processing. This endpoint accepts a structured payload containing the required information and documents based on the requirements obtained from the KYC/KYB Requirements API.

Include transactionHash at the top level if using direct payment, or omit them if using prepaid

Use the fieldId values from the requirements as keys in your submission payload

For section fields, create a nested object with the children fields as key-value pairs

For all other field types, provide the actual value matching the field type

Handle Documents Properly: Ensure documents are properly formatted as base64 URI strings with the correct MIME type

Check for External Steps: Always check for kycLink and tosLink in the response and direct users to complete these steps if present

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

KYC data submitted successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/transformer/entity/kyc//' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionHash": "2R8dvcyQ556o3BniNNn2zrmFoBBNjgFLrKqZxnAGAFpk7JHmHtkXsquCkn8pxv2Krt95DvJcGSBtHeTBhJ67fX9",
    "base64Signature": "kXdG5LGmDW3r5PhN2zjBtw56LGJQ4zfP+JKqdjJ7TF5EVrL/Qx13cVYP0xM6R3B+2V8zLm6dNwrtjXeD84gEBQ==",
    "personal_details": {
        "full_name": "John Smith",
        "date_of_birth": "1985-07-15T00:00:00Z"
    },
    "identity_document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA..."
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "message": "KYC data submitted successfully",
        "kycLink": "https://example.com/kyc-status-page",
        "tosLink": "https://example.com/terms-of-service",
        "kycStatus": "not_started"
    }
}

Modified at 2025-11-11 17:10:26

KYC Requirements

Get KYC Documents