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.

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

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!