Accounts6

Archives9

Blacklists (Alpha)4

Consent Templates3

Contributions2

Documents2

Employers2

Employments2

Estimated Incomes2

File Types1

Footprints (Alpha)3

Footprints (Beta)9

Forms (Alpha)2

Identities2

Income Estimators (Alpha)3

Incomes2

Insights2

Invite Templates5

Invites4

Liabilities2

Links2

Maws (Alpha)3

Maws (Beta)4

Providers2

Ratings2

Signals (Alpha)3

Signals (Beta)5

Social Securities (Beta)3

Social Security (Alpha)3

Tasks2

Tokens1

Transactions2

Uploads2

Users5

Validations (Alpha)3

Verification3

Webhooks4

Signals (Beta)

Create Signal3

Changed on Sep 14, 2026

Create a Signal3 object.

This endpoint supports different templates depending on region and use case.
Required parameters: consent, templateId, plus additional fields depending on the selected template.

Supported Templates

Template ID	Region(s)	Required Parameters
tpl-sgn003002	MX (Mexico)	phone, fullName, curp
tpl-social-securities-signal-th	TH (Thailand)	fullName, mobileNumber, idType, idNumber

Sandbox Test Values

Template ID	Parameters	Expected Response
tpl-sgn003002	phone = 529559991234, fullName = John Doe, curp = DOEJ800101HDFXXX01	resultCode = SUCCESS
tpl-social-securities-signal-th	mobileNumber = 669178912345, fullName = John Doe, idType = PID, idNumber = 1234567890123	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 Signal3 object will be created with the status of PROCESSING. When the Status becomes COMPLETED or ERROR.

post/beta/signals/createSignal3

Request

Base URL
https://sandbox.smileapi.io/v1
URL
https://sandbox.smileapi.io/v1/beta/signals/createSignal3
Auth
HTTP basic

Request body

Example request

{
  "fullName": "John Doe",
  "phone": "529559991234",
  "curp": "DOEJ800101HDFXXX01",
  "templateId": "tpl-sgn003002",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

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": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "fullName": "John Doe",
      "phone": "529559991234",
      "curp": "DOEJ800101HDFXXX01",
      "templateId": "tpl-sgn003002",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    }
  }
}

Changes

Sep 14, 2026v1a68faef4b017 Revision changes
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  the ///// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///// request property type changed from string to no type, and format from date-time to no format
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
Jan 29, 2026v13f330909f6b8 Revision changes
- breaking
  added to the / response property oneOf list for the response status
- breaking
  the / response's property type changed from object to no type for status
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added tpl-social-securities-signal-th mapping keys to the request discriminator
- info
  removed tpl-social-securities-sgn003003 mapping keys from the request discriminator
- info
  added discriminator to / response property for the response status

Operation history (4 revisions)