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?

Authorization Document Resource

Hosted Numbers API is currently in private Developer Preview

An Authorization Document is a resource representing a legally binding document between Twilio and a customer to Authorize Twilio to run SMS traffic on a given set of Phone Numbers.

Hosted Number Orders can be assigned to an Authorization Document detailing which Address a Hosted Number Order is activated with. Once the Authorization Document has been signed, the Hosted Number Orders will then be registered to Twilio for routing capability.

AuthorizationDocument properties

Names in PHP format
sid
sid<PX> Not PII

A 34 character string that uniquely identifies this AuthorizationDocument.

addressSid
sid<AD> Not PII

A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

status
enum:status Not PII

Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

email

Email that this AuthorizationDocument will be sent to for signing.

ccEmails
string[] PII MTL: 30 DAYS

Email recipients who will be informed when an Authorization Document has been sent and signed.

dateCreated
date_time<iso8601> Not PII

The date this resource was created, given as GMT RFC 2822 format.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was updated, given as GMT RFC 2822 format.

url
url Not PII

links
uri_map Not PII

Status Values

Status Description
opened Document is open and mutable.
signing Document has been sent out to the Email for signature and is immutable.
signed Document has been signed by the Email recipient and is immutable.
canceled Document has been canceled by the Email recipient and is immutable.
failed Document has failed with an error and is immutable.

Create an AuthorizationDocument resource

post
https://preview.twilio.com/HostedNumbers/AuthorizationDocuments

Create an Authorization Document for authorizing the hosting of phone numbers' capability on Twilio's platform.

The resource is explicit and all Hosted Number Orders added upon creation are the entire list of numbers that are assigned to the Authorization Document. Once the POST to create a new Authorization Document has been created, the LOA will immediately be sent out for signature.

Parameters
Names in None format
hosted_number_order_sids
Required
post string[] Not PII

A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.

address_sid
Required
post sid<AD> Not PII

A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

email
Required
post string PII MTL: 30 DAYS

Email that this AuthorizationDocument will be sent to for signing.

contact_title
Required
post string Not PII

The title of the person authorized to sign the Authorization Document for this phone number.

contact_phone_number
Required
post string PII MTL: 30 DAYS

The contact phone number of the person authorized to sign the Authorization Document.

cc_emails
Optional
post string[] PII MTL: 30 DAYS

Email recipients who will be informed when an Authorization Document has been sent and signed.

Example
        
        
        
        

        Fetch an AuthorizationDocument resource

        get
        https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/{Sid}
        Parameters
        Names in None format
        sid
        Required
        get sid<PX> Not PII

        A 34 character string that uniquely identifies this AuthorizationDocument.

        Example
              
              
              
              

              Read multiple AuthorizationDocument resources

              get
              https://preview.twilio.com/HostedNumbers/AuthorizationDocuments
              Parameters
              Names in None format
              email
              Optional
              get string PII MTL: 30 DAYS

              Email that this AuthorizationDocument will be sent to for signing.

              status
              Optional
              get enum:status Not PII

              Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

              Example
                    
                    
                    
                    

                    Update an AuthorizationDocument resource

                    post
                    https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/{Sid}

                    Requests to update a single, existing Authorization Documents instance resource’s properties and returns the updated resource representation if successful.

                    Authorization Documents can only be updated when in opened status. To update the Authorization Document, update the Status to opened.

                    Parameters
                    Names in None format
                    hosted_number_order_sids
                    Optional
                    post string[] Not PII

                    A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.

                    address_sid
                    Optional
                    post sid<AD> Not PII

                    A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

                    email
                    Optional
                    post string PII MTL: 30 DAYS

                    Email that this AuthorizationDocument will be sent to for signing.

                    cc_emails
                    Optional
                    post string[] PII MTL: 30 DAYS

                    Email recipients who will be informed when an Authorization Document has been sent and signed

                    status
                    Optional
                    post enum:status Not PII

                    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

                    contact_title
                    Optional
                    post string Not PII

                    The title of the person authorized to sign the Authorization Document for this phone number.

                    contact_phone_number
                    Optional
                    post string PII MTL: 30 DAYS

                    The contact phone number of the person authorized to sign the Authorization Document.

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