Skip to main content
GET
Python
Didit’s async Reports API returns an export job and its current failure list. failed_count equals the length of failed_item_ids; deleted sessions are excluded. Find the report using List async reports, then follow retry guidance or retry the export.

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

organization_id
string<uuid>
required

Organization id.

application_id
string<uuid>
required

Application id.

report_uuid
string<uuid>
required

Report uuid.

Response

Retrieve async report.

uuid
string<uuid>
required

Report identifier.

report_type
enum<string>
required

Export or compliance-report kind.

Available options:
SESSION_EXPORT,
TRANSACTION_EXPORT,
BUSINESS_EXPORT,
VENDOR_USER_EXPORT,
VENDOR_BUSINESS_EXPORT,
CASE_EXPORT,
CASE_SLA_EXPORT,
LIST_ENTRY_EXPORT,
EVENT_EXPORT,
COMPLIANCE_KYC_KYB,
COMPLIANCE_AML_LOG,
COMPLIANCE_TRAVEL_RULE,
COMPLIANCE_SANCTIONS_PEP,
COMPLIANCE_RISK_SUMMARY,
COMPLIANCE_SAR_STR_DRAFT,
COMPLIANCE_CTR,
COMPLIANCE_CASE_SUMMARY
report_type_display
string
required

Display label for the report kind.

status
enum<string>
required

Generation state. READY may include individual failures; inspect failed_count.

Available options:
PENDING,
PROCESSING,
READY,
FAILED
status_display
string
required

Display label for the generation state.

parameters
object
required

Original export options; keys depend on report_type.

requested_by_user_id
string<uuid> | null
required

Original requester identity, or null for callers without a user identity.

requested_by_email
string | null
required

Requester email, when available.

requested_by_name
string | null
required

Requester display name, when available.

row_count
integer | null
required

Number of exported records, or null before generation.

failed_item_ids
string<uuid>[]
required

Live session UUIDs that failed in this verification export. Deleted sessions are excluded. Use these IDs for a selective retry.

failed_count
integer
required

Number of entries in failed_item_ids.

Required range: x >= 0
file_size
integer<int64> | null
required

Total generated file size in bytes, or null before generation.

files
object[]
required

Generated file metadata; does not contain download URLs.

scheduled_report
string<uuid> | null
required

Schedule identifier, or null for an unscheduled report.

error_message
string | null
required

Generation error, when available.

deletion_pending
boolean
required

Whether a requested deletion is still in progress.

eta_seconds
integer | null
required

Estimated seconds until completion for a pending or processing report; null without history or when done.

started_at
string<date-time> | null
required

Generation start time.

completed_at
string<date-time> | null
required

Generation completion time.

expires_at
string<date-time>
required

Report expiry time.

created_at
string<date-time>
required

Creation time.

updated_at
string<date-time>
required

Last update time.

Last modified on November 14, 2026