Sign in
Social Securities

Create Social Security

Create a Social Security object.

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

Supported Template

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

Sandbox Test Values

ParameterValueExpected Response
templateIdtpl-sss003001
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.

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, it will be notified through the Webhook. Generally, the API will return the result in about 1 minute.

post/alpha/socialSecurities

Request body

emailAddressstring email required
fullNamestring required
mobileNumberstring nullable required

Phone numbers in international E.164 format

curpstring required
templateIdstring required

Example request

{
  "mobileNumber": "+639175551234",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions",
    "consentTemplateId": "ct-4604588d9502491b4c72a67cdb0a2aea"
  }
}

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": {
      "maritalStatus": "Married",
      "currency": "PHP"
    },
    "requestMeta": {
      "mobileNumber": "+639175551234",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions",
        "consentTemplateId": "ct-4604588d9502491b4c72a67cdb0a2aea"
      }
    }
  }
}

Changes