Create Export

Requests an asynchronous CSV export of a completed verification bulk. One file is generated per entity. The company is always taken from the API key, never from the request body.

Requests are idempotent: the same bulk_id with the same entities returns 202 with the same export_id instead of generating a duplicate. A failed or expired export can be requested again.

When the files are ready, the export.completed webhook event is sent (no download links in the event). Webhooks created before this feature launched must subscribe to the event via PATCH /webhooks/{webhook_id}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

A completed verification bulk that belongs to your account.

entities
array of strings
required
length ≥ 1

Entities to export; one CSV file is generated per entity. Order and duplicates are ignored.

entities*
Allowed:
boolean
Defaults to false

Optional. When true, invoices.csv includes a payment_info column with the payment details of each invoice, with the same fields as GET /invoices?include_payment_info=true. Invoices with no associated payments carry an empty array []. The flag is part of the idempotency key: the same bulk_id and entities with a different include_payment_info value is a new export. Defaults to false.

estimates
object

Optional. Options for estimates.csv, with the same values, defaults and validation as GET /estimates/{identifier}. Only allowed when entities includes estimates; otherwise the request fails with 400. An invalid value fails with 400 invalid_parameter. The resolved options are part of the idempotency key: the same bulk_id and entities with different estimates options is a new export.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json