POST
https://exchange-core.whitebird.io/api/v1/merchant/client/{linkId}/sumsub/photos/external/upload
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-api-key | String | Yes | Merchant security key |
Request params
| Name | Type | Required | Description |
|---|---|---|---|
| linkId | String | Yes | Linked client id |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| kycLevelType | String | Yes | MAIN or LIVENESS |
| actionId | String | No | Applied only when not null and kycLevelType = LIVENESS |
| token | String | No | Token for forwarding |
Response
{
"status": "ok"
}
{
"message": "Upload url was not set",
"code": "INVALID_VALUE"
}
{
"message": "link not found",
"code":"404"
"status": "NOT_FOUND"
}
{
"message": "invalid x-api-key",
"code":"401"
"status": "UNAUTHORIZED"
}
Example request
{
"kycLevelType": "MAIN/LIVENESS",
"actionId": "string", //optional. Applied only when not null and kycLevelType = LIVENESS
"token": "token for forwarding"
}
curl -X POST 'https://exchange-core.whitebird.io/api/v1/merchant/client/{linkId}/sumsub/{level_type}' \
-H 'Content-Type: application/json'
When merchant init request for sending data Whitebird send data to merchant as photo arrays.
Each photo in “file” array has:
- content-type header
- filename
Example request
curl --location --request POST '<api-url-set-in-merchant-settings>' \
--form 'file=<sumsub-photo-1>' \
--form 'file=<sumsub-photo-2>' \
--form 'file=<sumsub-photo-3>' \
--form 'file=<sumsub-photo-4>' \
--form 'details="{\"token\": \"token for forwarding\"}"'