Skip to main content
GET
curl
Read an export started with Export files.
  • PENDING and PROCESSING: the ZIP is being prepared. Read the export again in a few seconds.
  • READY: download_url is a signed link to the ZIP that stays valid for a short time. Read the export again for a new link until expires_at.
  • FAILED: the ZIP could not be prepared. Start a new export.
  • EXPIRED: the ZIP was deleted. Start a new export.
Each read that hands out a download link is written to the session’s audit log. An export of a deleted session returns 404.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

sessionId
string<uuid>
required

UUID of the verification session (the session_id returned by POST /v3/session/). Accepts both User Verification (KYC) and Business Verification (KYB) session IDs. A deleted session returns 404.

Example:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
required

The export_id returned by POST /v3/session/{sessionId}/files-export/.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

Response

The export.

One ZIP with every file of a session, in original quality.

export_id
string<uuid>
required

ID of the export. Pass it to GET /v3/session/{sessionId}/files-export/{exportId}/.

session_id
string<uuid>
required

The session the files are from.

status
enum<string>
required

PENDING and PROCESSING while the ZIP is prepared, READY once it can be downloaded, FAILED when it could not be prepared (request a new export), EXPIRED once the ZIP was deleted.

Available options:
PENDING,
PROCESSING,
READY,
FAILED,
EXPIRED
file_count
integer | null
required

Files in the ZIP. Set only while status is READY.

size_bytes
integer<int64> | null
required

Size of the ZIP in bytes. Set only while status is READY.

download_url
string<uri> | null
required

Signed URL of the ZIP, valid for a short time. Set only while status is READY; read the export again for a new one.

expires_at
string<date-time> | null
required

When the ZIP is deleted, 24 hours after it was ready. Set only while status is READY.

error
string | null
required

Why the export failed, when status is FAILED.

created_at
string<date-time>
required

When the export was requested.

completed_at
string<date-time> | null
required

When the ZIP was ready or the export failed.

Last modified on October 31, 2026