Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

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?

Proof of Addresses Pilot REST API

The Number Regulatory Compliance REST APIs are currently in a Public Pilot state. The new Regulatory Compliance APIs are under active development and will be debuted in Public Beta in September.

The Pilot Regulatory Compliance APIs will be deprecated when the new Regulatory Compliance APIs move to Public Beta. Please be mindful when building your application.

For access, please fill out the RC pilot request form.

Phone Numbers are a country's natural resource and may have regulations imposed by a given country's telephony regulatory body. To ensure that the phone numbers provisioned to a customer's account (and potentially their end users) remain active, customers will need to comply with the varying levels of regulation that require Proof of Identity and/or Address.

The Proof of Address REST API allows programmatic adding address metadata to a Document that provides some level of proof for address regulations that may be required to provision a phone number.

Proof of Address List Sub-Resource

The Proof of Address list resource represents a list of supporting Documents linked to an Address object.

Resource URI

numbers.twilio.com/v1/RegulatoryCompliance/ProofOfAddress

Resource Properties

Resource Property Description
sid A 34 character string that uniquely identifies the Identity.
        
        
        
        

        HTTP GET

        Fetch a list of Proof of Addresses that link an Identity Document with an associated Address. The list will contain metadata of the Proof of Address.

              
              
              
              
              Link an Identity Document to an Address SID

              Create new Proof of Address

              Link an Identity Document to an Address SID

              HTTP POST

              Creates a new Document associated with an Identity. The Document will not have any metadata passed with it when being uploaded in the short-term. Longer-term, there will be more intelligence where metadata will be required based on country and document type.

              Parameters

              Resource Parameter Description
              file The file to be uploaded to an Identity. The file must be one of the following; PNG, JPG, or PDF and will need to be no more than 5MB.
                    
                    
                    
                    

                    HTTP GET

                    Read a specific instance of a Proof of Address and detail of the metadata associated with the Proof of Address.

                    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.