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 Signal

Changed on Sep 14, 2026

Create a Signal object.

This endpoint requires the following mandatory parameters:
consent, phone, countryCode, and templateId.

Supported Template

Template ID	Region	Required Parameters
tpl-sgn003001	PH (default)	consent, templateId, countryCode, phone
signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8 (deprecated)	PH (default)	consent, templateId, countryCode, phone
signalTpl-f250f305c3bf0aa690cca93ef0f0fb03 (deprecated)	PH (default)	consent, templateId, countryCode, phone
signalTpl-f6b74d81a4807f4c01e6a920920775ad (deprecated)	PH (default)	consent, templateId, countryCode, phone
signalTpl-7a01659636c119ca4566308effd05d06 (deprecated)	PH (default)	consent, templateId, countryCode, phone
signalTpl-e5ba74fe8089fe44eeeafb68991b1e70 (deprecated)	PH (default)	consent, templateId, countryCode, phone

Field Guidelines

phone must include the country code (e.g., +639559991234 or 639559991234)
MD5 encryption is supported using the format: MD5(countryCode + phone),
e.g., MD5(+639559991234)

Sandbox Test Values

Parameter	Value	Expected Response
templateId	tpl-sgn003001
countryCode	PH
phone	639559991234	resultCode = SUCCESS

For all other valid phone and countryCode combinations, the response will return:
resultCode = NO_DATA, and no items will be included.

You may also contact Smile to request additional specialized templateIds for other regions or business cases.

post/beta/signals

Request

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

Request body

Example request

{
  "phone": "+639559991234",
  "templateId": "signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  },
  "countryCode": "PH"
}

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
  added to the ///////// request property allOf list
- breaking
  added to the ///////// request property allOf list
- 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 ///////// 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 ///////// 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
  the request's body type changed from object to no type
- 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 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 request discriminator
- info
  added to the request body oneOf list
- info
  added discriminator to / response property for the response status

Operation history (8 revisions)