post
https://sandbox.smileapi.io/v1/alpha/socialSecurities
Create a Social Security object.
This endpoint requires four mandatory parameters:
consent, mobileNumber, fullName, curp, emailAddress, and templateId.
Supported Template
| Template ID | Region(s) | Required Parameters |
|---|---|---|
tpl-sss003001 | MX (Mexico) | mobileNumber, fullName, curp, emailAddress |
Sandbox Test Values
| Parameter | Value | Expected Response |
|---|---|---|
| templateId | tpl-sss003001 | |
| emailAddress | Any valid email address | |
| curp | Any valid curp | |
| fullName | Any string | |
| mobileNumber | 529559991234 | resultCode = 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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…