POST https://api.veriko.mx/v1/beneficiaries/imports/{id}/commit

Confirm the bulk import

Audience
public
Auth
API key
Permission
beneficiaries:create
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:

  • valid and correctable rows are persisted (with alias suffix on collision).
  • fatal and duplicate_account rows are skipped. - Previously archived accounts with the same number are reactivated instead of duplicated.

The plan cap (beneficiaries_max) is hard-coded to -1 (unlimited) until the corresponding column lands on the plan schema — once it ships the check will surface the plan_cap_exceeded code.

Parameters
Parameter In Type Required Description
id * path integer required

Numeric ID of the import job.

Request
curl -X POST 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/commit' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 202 CommitBeneficiaryImportResponse — Commit enqueued to the worker. The job transitions to `committing`.
Field Type Description
type * string

JSON:API resource type.

id * string

Numeric job ID expressed as a string.

attributes * object

Job attributes returned after commit (transition status).

status * string

New status after enqueuing the commit.

Response status codes POST /v1/beneficiaries/imports/{id}/commit
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 Permisos insuficientes ErrorResponse
404 4xx The resource does not exist or is not visible to the caller 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
Errors from POST /v1/beneficiaries/imports/{id}/commit
Status Code Detail
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
422 job_not_committable

Commit not allowed.

Envelope
meta.request_id
a5b6c7d8e9f0