Menu

Expand
Rate this page:

Regulatory Compliance REST APIs

The v2 Regulatory Compliance APIs are powered by the new platform. The new platform is driven by the intelligence of the Regulations that dynamically evaluates Bundles

Resources

The following resources are available to be leveraged with the new v2 Regulatory Compliance platform. If you would like to know more about each resource, please click on the resource header.

Bundles Resource

Bundles Resource API Doc

The Twilio Bundles REST API allows you to create empty Regulatory Bundle containers. The Regulatory Bundles are Item Assignments of End-Users and Supporting Documents for regulatory compliance.

Depending on the configuration of the bundle, the bundle is being assessed against a Regulation (e.g., Germany local phone numbers for a business). Different Regulations need Item Assignments combinations of End-User Types and Supporting Document Types.

End-Users Resource

End-Users Resource API Doc

The Twilio End-User REST API allows you to create End-Users to follow Regulations. The End-User is the entity that answers the phone call or receives the message of a phone number. An entity can be either an individual or a business. You can find more information about the possible End-Users by referencing End-User Type resource.

You will Assign Items to an End-User of a Regulatory Bundle with Supporting Documents. For applications that manage many End-Users, you will need to ensure that you assign the End-User instance to the correct Bundle instance to be in compliance with regulations.

End-Users Type Resource

End-User Types Resource API Doc

The Twilio End-User Type resource of Twilio's Regulatory Compliance API informs you which type of end-user you can create and what the values are. Once you know which end-user type you want to create and the required values, you will create using the End-User resource. Each End-User Type has a different set of values required to be compliant.

You will Assign Items to an End-User of a Regulatory Bundle with Supporting Documents. For applications that manage many End-Users, you will need to ensure that you assign the End-User instance to the correct Bundle instance to be in compliance with regulations.

Supporting Documents Resource

Supporting Documents Resource API Doc

The Supporting Documents resource of Twilio's Regulatory Compliance APIs allows you to create new Supporting Documents with metadata to fulfill Regulations. Each Supporting Document Type may need different information to be compliant, so be sure to pass all of the correct values when creating a new Supporting Document Type.

A collection of Supporting Documents Assigned as Items to a Regulatory Bundle along with an End-User satisfies a Regulation.

Supporting Document Types Resource

Supporting Document Types Resource API Doc

The Supporting Document Type resource of Twilio's Regulatory Compliance API informs you which type of document you create and what the values are. You will then create a new Supporting Document with the correct type and values.

Each Supporting Document Type may need different information to be compliant. Supporting Documents Assigned as Items to a Regulatory Bundle along with an End-User satisfy a Regulation.

Item Assignments Resource

Item Assignments Resource API Doc

The Twilio Item Assignments REST API allows you to assign End-Users and Supporting Documents to Regulatory Bundles.

The configuration of the Regulatory Bundle must pass a Regulation (e.g., Germany local phone numbers for a business). Different Regulations need Item Assignments combinations of End-User Types and Supporting Document Types.

With the correct items assigned to the Regulatory Bundle, you can submit the bundle by changing its status. After submission, the Twilio regulatory reviewers will review the Regulatory Bundle.

Regulations Resource

Regulations Resource API Doc

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.

Note: 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.

Evaluations

Evaluations Resource API Doc

The Evaluations resource allows developers to understand what failed and why when a Regulatory Bundle is submitted to be evaluated against a Regulation. The synchronous request will provide error codes and instant feedback to fix the Regulatory Bundle.

Regulated Items

[coming soon]

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.

        
        
        

        Thank you for your feedback!

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

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more