v1

latestOpenAPI 3.0.32026-07-242644125.9 KB

Bulks

Get Bulk Status

Returns the status and metrics for a bulk job. Works for both consent and verification bulks. The type field tells you which kind of bulk this is.

get/bulks/{bulk_id}

bulk_idstring uuid required

The unique identifier for the bulk job.

Bulk status retrieved successfully.

bulk_idstring uuid required

Unique identifier for this bulk job.

external_idstring nullable

Optional external identifier passed at creation, used to correlate with your internal systems.

type'consent' | 'verification' required

Type of bulk job.

created_atstring date-time required

Timestamp of when the bulk was created.