https://api.veriko.mx/v1/beneficiaries/imports/{id}/commitConfirm the bulk import
How-to guide →Confirms an import job and triggers the persistence of its rows into GET /v1/beneficiaries. The operation is asynchronous: the endpoint responds with HTTP status 202 and the import moves to committing while the worker processes the rows. GET /v1/beneficiaries/imports/{id} accepts polling until the state is completed or failed. Commit rules:
validandcorrectablerows are persisted, with an alias suffix if there was an alias collision. The exception is a phone number without a valid bank (bank_code_required_for_phoneorinvalid_bank_code): it is fixed by choosing the bank in the preview, and if it still has no bank when you confirm it is not saved, becomesfatalwith that same code and counts inskipped_count.fatalandduplicate_accountrows are skipped, except aduplicate_accountwhose account is archived, which is reactivated.- Previously archived accounts with the same number are reactivated instead of duplicated.
| 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 | Import job data after the commit, with its 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.a1b2c3d4e5f66f5e4d3c2b1a |
datetime | object | Companion descriptor present in the {"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. The possible codes are job_not_committable (when the state is not preview_ready), plan_cap_exceeded (when the cap is active) and the generic commit_failed. | ErrorResponse |
| Status | Code | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | permission_denied | You do not have permission to access this resource. Envelope
|
| 422 | job_not_committable | Commit not allowed. Envelope
|