Create an Import

Triggers an asynchronous import. The records to import can be supplied in one of two ways:

  • From a document: pass attributes.document_id referencing a previously uploaded document.
  • Inline payload: pass attributes.records as an array of record objects directly in the request body.

Exactly one of document_id or records must be provided. Inline payloads are capped at 1000 records.

The import runs in the background. Use GET /api/v1/imports/{id} to track its state, and GET /api/v1/imports/{id}/entries to retrieve per-row results once available.

The type attribute determines which resource is being imported, which permission is required, and which file formats are accepted for the linked document. Inline records are accepted for all types:

  • trustpair/company_account_audits_import — CSV or JSON document, or inline records; requires company_account_audits_write
  • trustpair/company_account_checks_import — CSV or JSON document, or inline records; requires company_account_checks_write
  • trustpair/payments_import — CSV, XML, or JSON document, or inline records; requires payment_checks_write
  • trustpair/payments_history_import — CSV, XML, or JSON document, or inline records; requires paid_payments_write

Only one import can run at a time per customer workspace. Attempting to start a new import while another is in progress will return a 422 error.

Required permission depends on the import type:

  • Company account audits imports: company_account_audits_write
  • Company account checks imports: company_account_checks_write
  • Payment checks imports: payment_checks_write
  • Paid payments imports: paid_payments_write
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
data
object
required
Headers
string
enum
Allowed:
Responses

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