Employment Status (Async)
Credits: 2 per resolved request — charged when the result resolves; the ACCEPTED acknowledgement is free. includePdf adds no extra credits.
Asynchronous version of Employment Status: returns the current IMSS employment status of a worker identified by CURP and delivers the result to your webhook instead of keeping the HTTP request open.
nss is optional: when you send it, it is checked against the NSS registered for the CURP and a difference returns MISMATCH_CURP_NSS. Set includePdf: true to also receive the official IMSS report as a PDF in data.files[].
Immediate response: ACCEPTED with the transactionId, or INVALID_REQUEST if the request is not valid.
Result: delivered to your webhook with the same result types and data as Employment Status (except INVALID_REQUEST, which is returned immediately). Every result type, with its example, is in the Webhooks guide.
Authorizations
Body
18-character CURP.
"GARM900101HDFRZA01"
Where the result of an asynchronous request is delivered (HTTP POST with a JSON body).
Optional 11-digit NSS, checked against the NSS registered for the CURP.
^\d{11}$"92038109713"
Also return the official IMSS report as a PDF in data.files[]. No extra credits.
Response
Immediate response (Strict Envelope Pattern). The result is delivered to your webhook.
High-level outcome. OK means the request was successfully processed (regardless of business result). ERROR means the request was rejected or could not be processed.
OK, ERROR Stable result type code. Includes generic codes (SUCCESS, INVALID_REQUEST, UNAUTHORIZED, SERVICE_UNAVAILABLE, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED) plus endpoint-specific result codes — see this endpoint's response examples.
Human-readable summary of the result. Always in English (per Language Conventions in the API overview).
Unique identifier of this request, generated by the API Gateway. Propagated end-to-end for traceability.
ISO 8601 datetime with Mexico City offset (-06:00). Always set by the API Gateway when the response leaves the system.
Whether this request will be charged against the client's plan. Typically true for successful business results and false for validation errors or system errors that prevented processing.
Response payload. null on error responses. Shape depends on the endpoint — see each operation's response schema.
Per-field error details. Present only on INVALID_REQUEST responses.