Skip to content Skip to navigation Skip to topbar

EndUsers resource

(warning)

Public Beta release

Twilio released the Regulatory Compliance API v2 under Public Beta.

The end user represents an individual or business that must comply with regulations. This end user answers a phone call or receives a message from a phone number. To learn more about supported end user categories, see the EndUserType resource.

To meet regulatory compliance, you must submit a Regulatory Bundle to the regulator. These bundles combine end users who use the phone number and supporting documents that verify the end user, number, and, if needed, company.

After you create an empty Regulatory Bundle, you can assign end users created with this resource to that bundle.

EndUsers response properties

The EndUsers resource returns a response in JSON format. To learn more about Twilio SIDs, see the glossary entry on SIDs.

Property nameTypeRequiredPIIDescriptionChild properties

sidSID<IT>

Optional

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34

accountSidSID<AC>

Optional

The SID of the Account that created the End User resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendlyNamestring

Optional

The string that you assigned to describe the resource.

typeenum<string>

Optional

The type of end user of the Bundle resource - can be individual or business.

Possible values:

individualbusiness

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.

dateCreatedstring<date-time>

Optional

The date and time in GMT when the resource was created specified in ISO 8601 format.

dateUpdatedstring<date-time>

Optional

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>

Optional

The absolute URL of the End User resource.

Create one end user instance

POST https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers

To provision or port a phone number to Twilio, create an end user for that phone number.

Each end user represents the individual or business who answers a phone call or receives a text message.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

required

The string that you assigned to describe the resource.

typeenum<string>

required

The type of end user of the Bundle resource - can be individual or business.

Possible values:

individualbusiness

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Create one end user instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createEndUser() {
14  const endUser = await client.numbers.v2.regulatoryCompliance.endUsers.create({
15    attributes: {
16      business_name: "Twilio",
17      vat: "2348132",
18      business_description: "Communications Platform as a Service",
19    },
20    friendlyName: "Twilio, Inc.",
21    type: "business",
22  });
23
24  console.log(endUser.sid);
25}
26
27createEndUser();

Response

1{
2  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Twilio, Inc.",
5  "type": "business",
6  "attributes": {
7    "business_name": "Twilio",
8    "vat": "2348132",
9    "business_description": "Communications Platform as a Service"
10  },
11  "date_created": "2019-07-30T21:57:45Z",
12  "date_updated": "2019-07-30T21:57:45Z",
13  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
14}

Fetch one end user instance

GET https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<IT>

required

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch one end user Instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function fetchEndUser() {
14  const endUser = await client.numbers.v2.regulatoryCompliance
15    .endUsers("ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .fetch();
17
18  console.log(endUser.sid);
19}
20
21fetchEndUser();

Response

1{
2  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "friendly_name",
5  "type": "individual",
6  "attributes": {
7    "email": "foobar@twilio.com"
8  },
9  "date_created": "2019-07-30T21:57:45Z",
10  "date_updated": "2019-07-30T21:57:45Z",
11  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
12}

List all end users for one SID

GET https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

pageinteger

Optional

The page index. This value is simply for client state.

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

List all end user instances for one SID

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function listEndUser() {
14  const endUsers = await client.numbers.v2.regulatoryCompliance.endUsers.list({
15    limit: 20,
16  });
17
18  endUsers.forEach((e) => console.log(e.sid));
19}
20
21listEndUser();

Response

1{
2  "results": [],
3  "meta": {
4    "page": 0,
5    "page_size": 50,
6    "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0",
7    "previous_page_url": null,
8    "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0",
9    "next_page_url": null,
10    "key": "results"
11  }
12}

Update one end user instance

POST https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<IT>

required

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

friendlyNamestring

Optional

The string that you assigned to describe the resource.

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Update one end user instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function updateEndUser() {
14  const endUser = await client.numbers.v2.regulatoryCompliance
15    .endUsers("ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
16    .update({
17      attributes: {
18        email: "foobar@twilio.com",
19        first_name: "Jeff",
20      },
21      friendlyName: "Twilio",
22    });
23
24  console.log(endUser.sid);
25}
26
27updateEndUser();

Response

1{
2  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Twilio",
5  "type": "individual",
6  "attributes": {
7    "email": "foobar@twilio.com",
8    "first_name": "Jeff"
9  },
10  "date_created": "2019-07-30T21:57:45Z",
11  "date_updated": "2019-07-30T21:57:45Z",
12  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13}

Delete one end user instance

DELETE https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<IT>

required

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete one end user instance

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function deleteEndUser() {
14  await client.numbers.v2.regulatoryCompliance
15    .endUsers("ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
16    .remove();
17}
18
19deleteEndUser();