Get NSS (Async)
Credits: 2 per resolved request — charged when the result resolves; the ACCEPTED acknowledgement is free.
Asynchronous version of Get NSS: retrieves a worker’s NSS (Número de Seguridad Social) from IMSS based on CURP and delivers the result to your webhook instead of keeping the HTTP request open.
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 as Get NSS (except INVALID_REQUEST, which is returned immediately). Every result type, with its example, is in the Webhooks guide.
Autorizaciones
Cuerpo
Respuesta
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.