Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Social Securities (Beta)

Create Social Security

Create a Social Security object.

This endpoint requires mandatory parameters:
consent, mobileNumber, fullName, curp, emailAddress, and templateId.

Supported Template

Template IDRegion(s)Required Parameters
tpl-sss003002MX (Mexico)mobileNumber, fullName, curp, emailAddress

Sandbox Test Values

ParameterValueExpected Response
templateIdtpl-sss003002
emailAddressAny valid email address
curpAny valid curp
fullNameAny string
mobileNumber529559991234resultCode = SUCCESS

For all other valid input combinations, if no mock data match is found, the system returns
resultCode = NO_DATA and the response contains no items.

Remarks

In production mode, if the API request is successful, a SocialSecurity object will be created with the status of PROCESSING. When the Status becomes COMPLETED or ERROR.

post/beta/socialSecurities

Request body

emailAddressstring email

Email address to receive the report.

fullNamestring required

Full name of the person

mobileNumberstring required

Subject's mobile number. Required. Must start with country code i.e. 529178912345, and no leading zeros. MD5‑encrypted input is accepted with the format MD5(countryCode + mobileNumber) i.e. MD5(529559991234).

curpstring required

CURP (Clave Única de Registro de Población)

nssstring

Mexico's social security number (NSS). Required for MX template.

templateIdstring required

The template ID to use for the request.

Example request

{
  "emailAddress": "john.doe@example.com",
  "fullName": "John Doe",
  "mobileNumber": "529559991234",
  "curp": "DOEJ800101HDFXXX01",
  "templateId": "tpl-sss003002",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

Created

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "createdAt": "2021-04-14T09:30:24Z",
    "result": {
      "currency": "PHP"
    },
    "requestMeta": {
      "emailAddress": "john.doe@example.com",
      "fullName": "John Doe",
      "mobileNumber": "529559991234",
      "curp": "DOEJ800101HDFXXX01",
      "templateId": "tpl-sss003002",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    }
  }
}