Trusted Calling with SHAKEN/STIR

Robocalls are calls that are created by an auto-dialer, and typically play pre-recorded messages. Fraudsters use robocalls in combination with spoofing (falsifying caller IDs) to acquire something of value from their victims. In 2020, there were 48.9 billion robocalls in the United States, leading to an erosion of trust in the telephone network and a decline in call answer rates from unidentified phone numbers.

SHAKEN stands for Signature-based Handling of Asserted Information using toKENs. It is a specification designed by the Alliance for Telecommunications Industry Solutions (ATIS) to fight caller ID spoofing. STIR (Secure Telephone Identity Revisited) is a protocol developed by the Internet Engineering Task Force (IETF) to enable end-to-end call authentication, but the protocol is very broad and doesn't ensure that different providers will be able to verify each others' calls. SHAKEN is a set of implementation details that follows the STIR protocol, but streamlines specifications to increase the likelihood of carrier interoperability. This is why you will often see the technology referred to as "SHAKEN/STIR" or "STIR/SHAKEN".

Essentially, SHAKEN/STIR uses encrypted digital signatures to share information about the caller to each provider along a call's path from caller to recipient, such as the caller's identity and whether the caller has the right to use the phone number they provided as the caller ID.

To learn more about the implementation of SHAKEN/STIR, read the following resources:

• Everything You Need to Know About SHAKEN/STIR Right Now (Twilio Blog)
• Combating Spoofed Robocalls with Caller ID Authentication (FCC)
• TRACED Act Implementation (FCC)

Twilio, like all major carriers in the United States, has signing and verifying privileges. Keep reading to learn about the product changes you can expect with SHAKEN/STIR.

• For Programmable Voice customers, a new parameter will be present in incoming webhooks and outgoing calls: StirVerstat.
• For Elastic SIP Trunking customers, there is a new header called X-Twilio-VerStat, and a new Identity header with the SHAKEN PASSporT.

To understand the possible values for the StirVerstat parameter/X-Twilio-VerStat header, you will first need to understand the three different attestation levels:

• A : the highest attestation given by the originating service provider to indicate that the caller is known and has the right to use the phone number as the caller ID
• B : the customer is known, it is unknown if they have the right to use the caller ID being used
• C : it doesn't meet the requirements of A or B including international calls.

The table below describes the possible values for the StirVerstat parameter/X-Twilio-VerStat header.

Twilio Programmable Voice and Elastic SIP Trunking now perform SHAKEN/STIR verification on incoming calls to your Twilio local phone numbers. It can be used to display a trust indicator or to make a routing decision, such as bypassing a voice captcha or IVR and directing the call to an end user.

A verified call that has been given the highest attestation under SHAKEN/STIR means that the carrier that originated the call both (1) knows the identity of the caller, and (2) knows the caller has the right to use the phone number as the caller ID.

Note: The StirVerstat parameter is only present in the incoming call webook when the incoming call has SHAKEN PASSporT identity headers. The X-Twilio-VerStat header is only present in SIP INVITEs for incoming calls that have SHAKEN PASSporT identity headers.

When your application receives a request webhook that has a StirVerstat parameter, Twilio will implicitly pass the StirVerstat to the Client when you <Dial><Client>. The information in the StirVerstat parameter can be used to display a trust indicator to the recipient when an incoming call from the public telephone network has been verified under the SHAKEN/STIR framework.

• The JavaScript Client now has: Connection.CallerInfo.isVerified
• The Android and iOS Mobile SDKs now have the CallerInfo object and TVOCallerInfo class to represent information about the caller.

The Status Callback StirStatus optional parameter will inform you of the attestation Twilio gave your call to the public telephone network. If the call is forwarded (functionality coming soon), this will be attestation of the incoming call that was forwarded.

• <Dial>
• Call Resource
• Voice Webhooks

You may encounter situations in which an incoming call to your Twilio phone number needs to be forwarded to another number. If you want to maintain the original caller's CallerID for the forwarded leg of the call and facilitate SHAKEN/STIR verification, you will need to pass a CallToken from the parent leg of the call to the forwarded leg.

When one of your Twilio phone numbers receives an incoming call, Twilio sends a webhook to your application (this will only happen if you use POST). The request body of this webhook contains a CallToken property. The CallToken contains any SHAKEN/STIR and DIV (diversion) PASSporTs contained in the SIP headers of the incoming call.

In order to forward a call received by your Twilio number, you must:

1. Use the value of the CallToken from the inbound call's incoming webhook as the CallToken parameter when creating a new Call Resource or creating a new Conference Participant.
2. Use the original caller's phone number as the From parameter when creating the new Call Resource or Conference Participant.

Example call forwarding scenario

A caller (+12222222222) dials your Twilio phone number (+15555555555) and you need to forward the call to a new phone number (+18888888888).

Upon receiving the incoming call, your application will receive a webhook with the following request body:

1
{
2
  Called: '+15555555555',
3
  ToState: 'AL',
4
  CallerCountry: 'US',
5
  Direction: 'inbound',
6
  CallerState: 'PA',
7
  ToZip: '33333',
8
  CallSid: 'CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
9
  To: '+15555555555',
10
  CallerZip: '88888',
11
  ToCountry: 'US',
12
  StirVerstat: 'TN-Validation-Passed-A',
13
  CalledZip: '33333',
14
  ApiVersion: '2010-04-01',
15
  CalledCity: 'DOTHAN',
16
  CallStatus: 'ringing',
17
  From: '+12222222222',
18
  AccountSid: 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
19
  CalledCountry: 'US',
20
  CallerCity: 'PHILADELPHIA',
21
  StirPassportToken: 'STIR_TOKEN_IN_JWT_FORM',
22
  ToCity: 'DOTHAN',
23
  FromCountry: 'US',
24
  Caller: '+12222222222',
25
  FromCity: 'PHILADELPHIA',
26
  CalledState: 'AL',
27
  FromZip: '88888',
28
  FromState: 'PA'
29
  CallToken: '%7B%20%22parentCallInfoToken%22%3A%22eyJhbGciOiJFUzI1NiJ9.eyJjYWxsU2lkIjoiQ0FYWFhYLi4uLiIsImZyb20iOiIrMTIyMjIyMjIyMjIiLCJ0byI6IisxNTU1NTU1NTU1NSIsImlhdCI6IjE2MzU5NTc0MjMifQ.jVOxmCbSxxKg2fuzvDT_-PTStRRw_TrWgdh2QaZNzHQwvgwO6Qk_FRPFPYguJQn19x0yZqltPQfHwql4FJt_7g%22%2C%0A%20%20%22identityHeaderTokens%22%3A%5B%0A%20%20%20%20%20%20%22eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9zb21lQ2VydGlmaWNhdGUucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTU1NTU1NTU1NSJdfSwiaWF0IjoxNjM1OTU3NDIzLCJvcmlnIjp7InRuIjoiMTIyMjIyMjIyMjIifSwib3JpZ2lkIjoic29tZS1HVUlELWhlcmUifQ.ygPO2sImJR9MSqoRVD0CvnB2euv3RUYdupNEFS3wpgecs-yi8SU8FtYkkDypn7DC-siwdPY6vvVIx39y5Nb1sg%3Binfo%3D%3Chttps%3A%2F%2Fexample.com%2FsomeCertificate.pem%3E%3Balg%3DES256%3Bppt%3Dshaken%22%0A%20%20%20%20%20%20%5D%0A%7D'
30
}

To forward the call, you will retrieve the CallToken value from the incoming webhook (above) and use this value as the CallToken parameter when you create a new Call Resource.

The code sample below shows how to do that with your chosen Helper Library, cURL, and the Twilio CLI. This code sample only shows how to use the API to create the outbound call leg through which attestation is passed. In order to connect the inbound and outbound calls so that the two parties can speak with each other, you will need to implement a call flow for both calls using Programmable Voice Queues or Conferences. Using the <Dial> instruction is not possible for this call flow.

Note: You use the original caller's number (+12222222222) as the From parameter.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function createCall() {
11
  const call = await client.calls.create({
12
    callToken:
13
      "%7B%20%22parentCallInfoToken%22%3A%22eyJhbGciOiJFUzI1NiJ9.eyJjYWxsU2lkIjoiQ0FYWFhYLi4uLiIsImZyb20iOiIrMTIyMjIyMjIyMjIiLCJ0byI6IisxNTU1NTU1NTU1NSIsImlhdCI6IjE2MzU5NTc0MjMifQ.jVOxmCbSxxKg2fuzvDT_-PTStRRw_TrWgdh2QaZNzHQwvgwO6Qk_FRPFPYguJQn19x0yZqltPQfHwql4FJt_7g%22%2C%0A%20%20%22identityHeaderTokens%22%3A%5B%0A%20%20%20%20%20%20%22eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9zb21lQ2VydGlmaWNhdGUucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTU1NTU1NTU1NSJdfSwiaWF0IjoxNjM1OTU3NDIzLCJvcmlnIjp7InRuIjoiMTIyMjIyMjIyMjIifSwib3JpZ2lkIjoic29tZS1HVUlELWhlcmUifQ.ygPO2sImJR9MSqoRVD0CvnB2euv3RUYdupNEFS3wpgecs-yi8SU8FtYkkDypn7DC-siwdPY6vvVIx39y5Nb1sg%3Binfo%3D%3Chttps%3A%2F%2Fexample.com%2FsomeCertificate.pem%3E%3Balg%3DES256%3Bppt%3Dshaken%22%0A%20%20%20%20%20%20%5D%0A%7D",
14
    from: "+12222222222",
15
    to: "+18888888888",
16
    url: "https://www.example.com",
17
  });
18

19
  console.log(call.sid);
20
}
21

22
createCall();

1
{
2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "annotation": null,
4
  "answered_by": null,
5
  "api_version": "2010-04-01",
6
  "caller_name": null,
7
  "date_created": "Tue, 31 Aug 2010 20:36:28 +0000",
8
  "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000",
9
  "direction": "inbound",
10
  "duration": "15",
11
  "end_time": "Tue, 31 Aug 2010 20:36:44 +0000",
12
  "forwarded_from": "+141586753093",
13
  "from": "+12222222222",
14
  "from_formatted": "(415) 867-5308",
15
  "group_sid": null,
16
  "parent_call_sid": null,
17
  "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18
  "price": "-0.03000",
19
  "price_unit": "USD",
20
  "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
21
  "start_time": "Tue, 31 Aug 2010 20:36:29 +0000",
22
  "status": "completed",
23
  "subresource_uris": {
24
    "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json",
25
    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json",
26
    "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json",
27
    "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json",
28
    "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json",
29
    "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json",
30
    "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json",
31
    "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json",
32
    "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json"
33
  },
34
  "to": "+18888888888",
35
  "to_formatted": "(415) 867-5309",
36
  "trunk_sid": null,
37
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
38
  "queue_time": "1000"
39
}

If an incoming call does not have a SHAKEN PASSporT, Twilio will sign the call with its own SHAKEN PASSporT with Attestation C with DIV signing.

Twilio will use the CallToken in the outgoing leg to verify the CallerID. If the CallerID doesn't match the CallToken, Twilio will reject the call with an error.

The following conditions must be met in order for Twilio to forward the inbound SHAKEN PASSporT along with a DIV PASSporT for the outgoing (forwarded) call:

• The CallerID of the outgoing call matches the CallerID in the CallToken of the outgoing call
• The incoming call contains a SHAKEN PASSporT
• The outbound carrier endpoint supports SHAKEN and DIV PASSporTs

The CallToken property in an incoming call webhook is a string containing a URL-encoded JSON object.

Once decoded, the CallToken will look like this:

1
{
2

3
   "parentCallInfoToken": "eyJhbGciOiJFUzI1NiJ9.eyJjYWxsU2lkIjoiQ0FYWFhYLi4uLiIsImZyb20iOiIrMTIyMjIyMjIyMjIiLCJ0byI6IisxNTU1NTU1NTU1NSIsImlhdCI6IjE2MzU5NTc0MjMifQ.jVOxmCbSxxKg2fuzvDT_-PTStRRw_TrWgdh2QaZNzHQwvgwO6Qk_FRPFPYguJQn19x0yZqltPQfHwql4FJt_7g",
4
   "identityHeaderTokens": [
5
       "eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9zb21lQ2VydGlmaWNhdGUucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTU1NTU1NTU1NSJdfSwiaWF0IjoxNjM1OTU3NDIzLCJvcmlnIjp7InRuIjoiMTIyMjIyMjIyMjIifSwib3JpZ2lkIjoic29tZS1HVUlELWhlcmUifQ.ygPO2sImJR9MSqoRVD0CvnB2euv3RUYdupNEFS3wpgecs-yi8SU8FtYkkDypn7DC-siwdPY6vvVIx39y5Nb1sg;info=<https://example.com/someCertificate.pem>;alg=ES256;ppt=\"shaken\""
6
   ]
7

8
}

parentCallInfoToken property of a CallToken

The parentCallInfoToken is a JSON Web Token (JWT). When decoded, the header and payload of the JWT will have the following shape:

1
// Header
2

3
   {
4
     "alg": "ES256"
5
   }
6

7
// Payload
8

9
   {
10
     "callSid": "CAXXXX....",
11
     "from": "+12222222222",
12
     "to": "+15555555555",
13
     "iat": "1635957423"
14
   }
15

• The callSid value is the Call SID for the parent incoming Call Resource.
• The from value is the caller's phone number
• The to value is your Twilio number that received the call.
• The iat is a claim that specifies the timestamp for when the parent call's PASSporT was created, which is necessary for further SHAKEN/STIR validation.

identityHeaderTokens property of a CallToken

In order to verify forwarded calls, terminating service providers need the original SHAKEN PASSporT and the DIV PASSporTs for each diversion. The identityHeaderTokens property contains the information needed for Twilio to add a DIV PASSporT to the outgoing call if necessary (See Attestation section above for more information).

The identityHeaderTokens value is an array of all of the SHAKEN and DIV PASSporTs that were included as identity headers in the inbound leg of the call. If the call is signed, the array will contain one SHAKEN PASSporT, along with any DIV PASSporTs (if the call was diverted/forwarded) present on the inbound call.

Below is an example of the decoded JWT from the identityHeaderTokens array. This represents the original SHAKEN PASSporT from the incoming call.

1
// Headers
2

3
{
4
   "alg": "ES256",
5
   "ppt": "shaken",
6
   "typ": "passport",
7
   "x5u": "https://example.com/someCertificate.pem"
8
 }
9

10
// Payload
11

12
{
13
   "attest": "A",
14
   "dest": {
15
     "tn": [
16
       "15555555555"
17
     ]
18
   },
19
   "iat": 1635957423,
20
   "orig": {
21
     "tn": "12222222222"
22
   },
23
   "origid": "some-GUID-here"
24
 }

Since there is only one string in the CallToken's identityHeaderTokens array, this means the call was not diverted before it reached your Twilio number. If the call was diverted before it reached your Twilio number, you would see a DIV PASSporT for each diversion in the identityHeaderTokens array, as well.