Download a KYC logs archive

Purpose

Use this call to download the archive whose name filter sessions returned when you ordered an export. The archive is built after the order is answered. Retry after a short pause when the archive is not found yet.

Request

POST <API_BASE_URL>/kyc/download. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.

This operation takes no permanent API token in the body. Send a user token in the token header. See authentication and user authorization. The body of this request holds archiveName only.

Content type: application/json.

Field	Type	Required	Description
`archiveName`	string	yes	The archive name returned by the export order.

Response

HTTP 200. The archive itself, with the content type application/zip. There is no JSON body.

Errors

400: The request could not be turned into a path, in practice a missing archiveName. The body carries a message under an error key and has no status field.
401: The token header is missing, expired or unknown.
404: The archive was not found or has expired. The body carries a message under an error key and has no status field.

A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.

Example

Request:

curl -X POST "<API_BASE_URL>/kyc/download" \
  -H "Content-Type: application/json" \
  -H "token: <your user token>" \
  -d '{
    "archiveName": "<archive name from the export order>"
  }'

Response:

<binary zip archive>