CreateBeneficiaryImportResponse
Response from `POST /v1/beneficiaries/imports` (HTTP 202). Returns a minimal JSON:API envelope with the job ID and its initial status (`pending`). Poll `GET /v1/beneficiaries/imports/{id}` every 2s until the status is `preview_ready` or `failed`.
Properties
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type* | string | JSON:API resource type. Always `beneficiary_import`. |
id* | string | Numeric job ID expressed as a string (JSON:API format). |
attributes* | object | Initial job attributes returned upon creation. |
status* | string | Initial job status. The only possible value is `pending`. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC` — the canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601` — explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
POST /v1/beneficiaries/imports