Menu

Expand
Rate this page:

SupportingDocument Resource

SupportingDocument properties

Resource Properties in REST API format
sid
sid<RD> Not PII

The unique string created by Twilio to identify the Supporting Document resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Document resource.

friendly_name
string Not PII

The string that you assigned to describe the resource.

mime_type
string Not PII

The image type uploaded in the Supporting Document container.

status
enum:status Not PII

The verification status of the Supporting Document resource.

type
string Not PII

The type of the Supporting Document.

attributes

The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Supporting Document resource.

Create a SupportingDocument resource

post
https://trusthub.twilio.com/v1/SupportingDocuments
Parameters
Parameters in REST API format
friendly_name
Required
post string Not PII

The string that you assigned to describe the resource.

type
Required
post string Not PII

The type of the Supporting Document.

attributes
Optional
post object PII MTL: 30 DAYS

The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.

Example 1
Loading Code Sample...
        
        

        Create Supporting Document

        Fetch a SupportingDocument resource

        get
        https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}
        Parameters
        Parameters in REST API format
        sid
        Path
        get sid<RD> Not PII

        The unique string created by Twilio to identify the Supporting Document resource.

        Example 1
        Loading Code Sample...
              
              

              Fetch Supporting Document

              Read multiple SupportingDocument resources

              get
              https://trusthub.twilio.com/v1/SupportingDocuments
              Example 1
              Loading Code Sample...
                    
                    

                    Read Supporting Document

                    Update a SupportingDocument resource

                    post
                    https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    post sid<RD> Not PII

                    The unique string created by Twilio to identify the Supporting Document resource.

                    friendly_name
                    Optional
                    post string Not PII

                    The string that you assigned to describe the resource.

                    attributes
                    Optional
                    post object PII MTL: 30 DAYS

                    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

                    Example 1
                    Loading Code Sample...
                          
                          

                          Update Supporting Document

                          Delete a SupportingDocument resource

                          delete
                          https://trusthub.twilio.com/v1/SupportingDocuments/{Sid}
                          Parameters
                          Parameters in REST API format
                          sid
                          Path
                          delete sid<RD> Not PII

                          The unique string created by Twilio to identify the Supporting Document resource.

                          Example 1
                          Loading Code Sample...
                                
                                

                                Delete Supporting Document

                                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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                                Loading Code Sample...
                                      
                                      
                                      

                                      Thank you for your feedback!

                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

                                      Thanks for your feedback!

                                      thanks-feedback-gif