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?

Evaluations 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.

The Twilio Evaluations REST API allows you to create new evaluation instances and also providing a list of historical instances for review.

Depending on the configuration of the Regulatory Bundle, the Regulatory Bundle is being assessed against a Regulation (e.g., Germany local phone numbers for a business). Different Regulations need specific Item Assignments combinations of End-User Types and Supporting Document Types with Addresses. Once these Item Assignments have configured the Regulatory Bundle to be containing the correct configuration, Regulatory Bundles can be submitted to Twilio and synchronously evaluated for granular failure reasons.

Evaluations Response Properties

Evaluation Statuses

Status Description
noncompliant The evaluation with context of a Regulation has determined the Regulatory Bundle is non-compliant. Failure reasons have been provided in the response to help debugging.
compliant The evaluation with context of a Regulation has determined the Regulatory Bundle as compliant. The Regulatory Bundle can now be used for assignment with eligible phone numbers.
Resource Properties in REST API format
sid
sid<EL> Not PII

The unique string that identifies the Evaluation resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Bundle resource.

regulation_sid
sid<RN> Not PII

The unique string of a regulation that is associated to the Bundle resource.

bundle_sid
sid<BU> Not PII

The unique string that we created to identify the Bundle resource.

status
enum:status Not PII

The compliance status of the Evaluation resource.

results
object[] Not PII

The results of the Evaluation which includes the valid and invalid attributes.

date_created
date_time<iso8601> Not PII

url
url Not PII

Create a new Evaluation

post
https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations

At any point of a Regulatory Bundle's lifecycle, a Regulatory Bundle can be evaluated. Once a new evaluation of a Bundle has been created, the instance will be persisted in the Bundle's list of evaluations.

Parameters
Parameters in REST API format
bundle_sid
Path
post sid<BU> Not PII

Example 1
        
        
        
        

        Fetch an Evaluation Instance

        get
        https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}

        Fetch a specific Evaluation instance for review.

        Parameters
        Parameters in REST API format
        bundle_sid
        Path
        get sid<BU> Not PII

        The unique string that we created to identify the Bundle resource.

        sid
        Path
        get sid<EL> Not PII

        The unique string that identifies the Evaluation resource.

        Example 1
              
              
              
              

              List of Regulatory Bundles Evaluations

              get
              https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations

              The Evaluations LIST operation allows a developer to view historical instances of a Bundle. There are currently no filters supported. Pagination is supported to view all instances of the Evaluations list.

              Parameters
              Parameters in REST API format
              bundle_sid
              Path
              get sid<BU> Not PII

              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.