← Back to schema index

CreateBeneficiaryImportRequest

Multipart body for `POST /v1/beneficiaries/imports`. Uploads a file with beneficiaries and starts an asynchronous import job. A user may only have one active job at a time — an upload while another non-terminal job exists returns 422.

Properties

Field Type Description
file * string (binary) File to import. Accepted formats: CSV, XLS, XLSX, TXT or PDF. Maximum size: 20 MB.
parse_mode * string Parse mode. `template` — the file follows canonical headers (download the template from `/v1/beneficiaries/imports/template`). `free` — free-form; the system extracts accounts automatically, with an AI fallback for unstructured cases.

Used in operations

  • POST /v1/beneficiaries/imports