Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Signals (Beta)

Create Signal3

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 IDRegion(s)Required Parameters
tpl-sgn003002MX (Mexico)phone, fullName, curp
tpl-social-securities-signal-thTH (Thailand)fullName, mobileNumber, idType, idNumber

Sandbox Test Values

Template IDParametersExpected Response
tpl-sgn003002phone = 529559991234, fullName = John Doe, curp = DOEJ800101HDFXXX01resultCode = SUCCESS
tpl-social-securities-signal-thmobileNumber = 669178912345, fullName = John Doe, idType = PID, idNumber = 1234567890123resultCode = 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 body

OR

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

OK

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": {
    "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"
      }
    }
  }
}