Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Regulation Resource

The v2 Regulatory Compliance APIs are currently in Public Beta. No breaking changes in the API contract will occur when the API moves from Public Beta to GA.

Regulations Response Properties

The Twilio Regulatory Compliance REST API allows you to view and understand Regulations. Regulations are requirements based on End-Users and Supporting Documents set for by each country's government.

A Regulation dictates the Regulatory Bundles composition of Item Assignments.

Regulations can and do change. Please make sure not to hardcode any regulation within your application. The Regulation resource is for you to call and populate the values required for regulatory compliance.

Names in REST API format
sid
sid<RN> Not PII

The unique string that identifies the Regulation resource.

friendly_name
string Not PII

A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business.

iso_country
string Not PII

The ISO country code of the phone number's country.

number_type
string Not PII

The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung.

end_user_type
enum:end_user_type Not PII

The type of End User the regulation requires - can be individual or business.

requirements
object Not PII

The SID of an object that holds the regulatory information of the phone number country, phone number type, and end user type.

url
url Not PII

The absolute URL of the Regulation resource.

Fetch a Regulation Instance

get
https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/{Sid}

A Regulation instance details the End-User Types and values along with Supporting Document Types.

Parameters
Names in REST API format
sid
Path
get sid<RN> Not PII

The unique string that identifies the Regulation resource.

Example 1
        
        
        
        

        Retrieve a list of regulations

        get
        https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations

        The Regulations list is extensive and covers all Twilio's countries in the Phone Number Regulations Guidelines.

        The Regulations LIST endpoint is filterable by IsoCountry, NumberType, and EndUserType so you can select the correct instance of the collection of regulatory requirements.

        Parameters
        Names in REST API format
        end_user_type
        Optional
        get ienum:end_user_type Not PII

        The type of End User the regulation requires - can be individual or business.

        iso_country
        Optional
        get string Not PII

        The ISO country code of the phone number's country.

        number_type
        Optional
        get string Not PII

        The type of phone number that the regulatory requiremnt is restricting.

        Example 1
              
              
              
              
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.