The STIR/SHAKEN Verify Token API is a RESTful-compliant service which may be accessed via HTTPS using an API Key. You may obtain your API Key from your web portal or from your TILTX sales representative. All results are returned as JSON.
Below, please find the endpoints and examples:
Endpoint: https://api.shaken.tiltx.com/Validate/verify-token?
Method: POST
Parameters:
ToNumber: Any correctly formatted telephone number.
FromNumber: 11 digit, US telephone number. For example, 13155564800.
Identity: Token to validate.
Headers:
x-api-key: Your API key.
Sample Response:
{
"RequestGuid": "5b503d0d-7502-4cd0-ac4b-7f0ffaa103d7",
"AccountGuid": "535900e6-6965-454e-9eac-2ecb31ec7ed8",
"ToNumber": "3155564800",
"FromNumber": "18003816311",
"IPAddress": "34.225.24.242",
"Identity":"eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jci5zYW5zYXkuY29tL1RlY2hub2xvZ3lfSW5ub3ZhdGlvbl9MYWJfNTk5SiJ9.eyJhdHRlc3QiOiJCIiwiZGVzdCI6eyJ0biI6WyIxMzE1MjQ1ODk3OCJdfSwiaWF0IjoxNjM3MTc5ODExLCJvcmlnIjp7InRuIjoiMTgwMDM4MTYzMTEifSwib3JpZ2lkIjoiNWU0ZDMyNzgtNDdlMi0xMWVjLTg3ZTAtYmRjMWMxZDI4ODg4In0.wfBg-TLuEllPXKis8h5DTPa8G7OkdFUxMwCQcTycz9005swKyHunRL7iVtECCV_q_gI3Uk0ujOXD-7BPMdJNCQ;info=<https://ca.tiltx.com/599J>;alg=ES256;ppt=shaken",
"ValidToken":true
"TILTXID": "5b503d0d-7502-4cd0-ac4b-7f0ffaa103d7",
"RequestedAt": "2021-05-13T19:27:49.7204732Z",
"CompletedAt": "2021-05-13T19:27:50.0033054Z",
"ProcessingTime": "32.8322",
"ReturnCode": 200,
"ReturnStatus": "Success"
}
RequestGuid: a unique identifier assigned to this request.
AccountGuid: a unique identifier assigned to your account.
ToNumber: The phone number sent in the 'ToNumber' parameter.
FromNumber: The phone number sent in the 'FromNumber' parameter.
IPAddress: The IP address where the request originated from.
Identity: The Identity received in the original request.
ValidToken: Whether or not the token is valid:
true if the token is valid.
false if the token is not valid.
TILTXID: the tracking identifier for this request.
RequestedAt: When we received the request to provide a token.
CompletedAt: When the request finished processing.
ProcessingTime: How much time, in milliseconds, this request required.
ReturnCode:
200: Succussful
404: ReturnStatus will contain the reason.
503: ReturnStatus will contain the reason.