https://api.veriko.mx/v1/beneficiaries/imports/{id}/commitConfirm the bulk import
How-to guide →Confirms the import job and triggers the row-by-row persistence into GET /v1/beneficiaries. The operation is asynchronous: the endpoint returns 202 and the job moves to committing while the worker processes rows. Poll GET /v1/beneficiaries/imports/{id} until completed or failed.
Commit rules:
validandcorrectablerows are persisted (with alias suffix on collision).fatalandduplicate_accountrows are skipped.- Previously archived accounts with the same number are reactivated instead of duplicated.
The per-plan beneficiary cap is live and checked here just as it is on an individual create. Every plan sets it to "unlimited" today, so plan_cap_exceeded never fires; it can start firing without a line of code changing, as soon as a price sets a maximum.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id* | path | integer | required | Numeric ID of the import job. e.g.42 |
curl -X POST 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/commit' \
-H 'Authorization: Bearer veriko_••••' \
-H 'Content-Type: application/json'Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with |
type* | string | JSON:API resource type. Always beneficiary_import |
id* | string | Numeric job ID expressed as a string. e.g.42 |
attributes* | object | Job attributes returned after commit (transition status). |
status* | string | New status after enqueuing the commit. The only possible value is committing |
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. e.g.1.47.0 |
api_version | string | API route prefix version (e.g. v1 |
request_id | string | Unique request identifier (hex). e.g.a1b2c3d4e5f6 |
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. e.g.{"timezone":"UTC","format":"ISO 8601"} |
timezone* | string | Always UTC |
format* | string | Always ISO 8601 |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
| Status | Class | Description | Body |
|---|---|---|---|
| 202 | 2xx | Commit enqueued to the worker. The job transitions to committing. | CommitBeneficiaryImportResponse |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 403 | 4xx | Insufficient permissions. | ErrorResponse |
| 404 | 4xx | The resource does not exist or is not visible to the client | Error |
| 422 | 4xx | Commit pre-condition failed. Possible codes: job_not_committable (state != preview_ready), plan_cap_exceeded (when the cap is active) or the generic commit_failed fallback. | ErrorResponse |
| Status | Code | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|
| 422 | job_not_committable | Commit not allowed. Envelope
|