components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: numbers.v2.authorization_document: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this AuthorizationDocument. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. status: $ref: '#/components/schemas/authorization_document_enum_status' email: type: string nullable: true description: Email that this AuthorizationDocument will be sent to for signing. x-twilio: pii: handling: standard deleteSla: 30 cc_emails: type: array items: type: string nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true authorization_document_enum_status: type: string enum: - opened - signing - signed - canceled - failed description: '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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.' numbers.v2.bulk_hosted_number_order: type: object properties: bulk_hosting_sid: type: string minLength: 34 maxLength: 34 pattern: ^BH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this BulkHostedNumberOrder. request_status: $ref: '#/components/schemas/bulk_hosted_number_order_enum_request_status' friendly_name: type: string nullable: true description: A 128 character string that is a human-readable text that describes this resource. x-twilio: pii: handling: standard deleteSla: 30 notification_email: type: string nullable: true description: Email address used for send notifications about this Bulk hosted number request. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_completed: type: string format: date-time nullable: true description: The date that this resource was completed, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this BulkHostedNumberOrder resource. total_count: type: integer default: 0 description: The total count of phone numbers in this Bulk hosting request. results: type: array items: {} nullable: true description: Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'. x-twilio: pii: handling: standard deleteSla: 30 bulk_hosted_number_order_enum_request_status: type: string enum: - QUEUED - IN_PROGRESS - PROCESSED description: 'A string that shows the status of the current Bulk Hosting request, it can vary between these values: ''QUEUED'',''IN_PROGRESS'',''PROCESSED''' numbers.v2.regulatory_compliance.bundle: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a regulation that is associated to the Bundle resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/bundle_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until. email: type: string nullable: true description: The email address that will receive updates when the Bundle resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Bundle resource. links: type: object format: uri-map nullable: true description: The URLs of the Assigned Items of the Bundle resource. bundle_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved - provisionally-approved description: The verification status of the Bundle resource. bundle_enum_end_user_type: type: string enum: - individual - business bundle_enum_sort_by: type: string enum: - valid-until - date-updated bundle_enum_sort_direction: type: string enum: - ASC - DESC numbers.v2.bundle_clone: type: object properties: bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a regulation that is associated to the Bundle resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/bundle_clone_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until. email: type: string nullable: true description: The email address that will receive updates when the Bundle resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The URL of this resource. bundle_clone_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved - provisionally-approved description: The verification status of the Bundle resource. numbers.v2.regulatory_compliance.bundle.bundle_copy: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a regulation that is associated to the Bundle resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/bundle_copy_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until. email: type: string nullable: true description: The email address that will receive updates when the Bundle resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. bundle_copy_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved - provisionally-approved description: The verification status of the Bundle resource. bundle_copy_enum_end_user_type: type: string enum: - individual - business numbers.v2.authorization_document.dependent_hosted_number_order: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Authorization Document bulk_hosting_request_sid: type: string minLength: 34 maxLength: 34 pattern: ^BH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder. next_step: type: string nullable: true description: The next step you need to take to complete the hosted number order and request it successfully. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. incoming_phone_number_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number. signing_document_sid: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder. phone_number: type: string format: phone-number nullable: true description: An E164 formatted phone number hosted by this HostedNumberOrder. capabilities: type: object format: phone-number-capabilities x-class-extra-annotation: '@JsonInclude(JsonInclude.Include.NON_NULL)' properties: mms: type: boolean sms: type: boolean voice: type: boolean fax: type: boolean nullable: true description: A mapping of capabilities this hosted phone number will have enabled on Twilio's platform. friendly_name: type: string nullable: true description: A human readable description of this resource, up to 128 characters. x-twilio: pii: handling: standard deleteSla: 30 status: $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' failure_reason: type: string nullable: true description: A message that explains why a hosted_number_order went to status "action-required" date_created: type: string format: date-time nullable: true description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. email: type: string nullable: true description: Email of the owner of this phone number that is being hosted. x-twilio: pii: handling: standard deleteSla: 30 cc_emails: type: array items: type: string nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed x-twilio: pii: handling: standard deleteSla: 30 contact_title: type: string nullable: true description: The title of the person authorized to sign the Authorization Document for this phone number. contact_phone_number: type: string format: phone-number nullable: true description: The contact phone number of the person authorized to sign the Authorization Document. dependent_hosted_number_order_enum_status: type: string enum: - received - verified - pending-loa - carrier-processing - completed - failed - action-required description: '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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.' numbers.v2.regulatory_compliance.end_user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify the End User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. type: $ref: '#/components/schemas/end_user_enum_type' attributes: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the End User resource. end_user_enum_type: type: string enum: - individual - business description: The type of end user of the Bundle resource - can be `individual` or `business`. numbers.v2.regulatory_compliance.end_user_type: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the End-User Type resource. friendly_name: type: string nullable: true description: A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc machine_name: type: string nullable: true description: A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc. fields: type: array items: {} nullable: true description: The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals. url: type: string format: uri nullable: true description: The absolute URL of the End-User Type resource. numbers.v2.regulatory_compliance.bundle.evaluation: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a regulation that is associated to the Bundle resource. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. status: $ref: '#/components/schemas/evaluation_enum_status' results: type: array items: {} nullable: true description: The results of the Evaluation which includes the valid and invalid attributes. date_created: type: string format: date-time nullable: true url: type: string format: uri nullable: true evaluation_enum_status: type: string enum: - compliant - noncompliant description: The compliance status of the Evaluation resource. numbers.v2.hosted_number_order: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this HostedNumberOrder. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the account. incoming_phone_number_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted. address_sid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number. signing_document_sid: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign. phone_number: type: string format: phone-number nullable: true description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212 x-twilio: pii: handling: standard deleteSla: 30 capabilities: type: object format: phone-number-capabilities x-class-extra-annotation: '@JsonInclude(JsonInclude.Include.NON_NULL)' properties: mms: type: boolean sms: type: boolean voice: type: boolean fax: type: boolean nullable: true description: Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported. friendly_name: type: string nullable: true description: A 128 character string that is a human-readable text that describes this resource. x-twilio: pii: handling: standard deleteSla: 30 status: $ref: '#/components/schemas/hosted_number_order_enum_status' failure_reason: type: string nullable: true description: A message that explains why a hosted_number_order went to status "action-required" date_created: type: string format: date-time nullable: true description: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format. email: type: string nullable: true description: Email of the owner of this phone number that is being hosted. x-twilio: pii: handling: standard deleteSla: 30 cc_emails: type: array items: type: string nullable: true description: A list of emails that LOA document for this HostedNumberOrder will be carbon copied to. x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true description: The URL of this HostedNumberOrder. contact_title: type: string nullable: true description: The title of the person authorized to sign the Authorization Document for this phone number. contact_phone_number: type: string format: phone-number nullable: true description: The contact phone number of the person authorized to sign the Authorization Document. bulk_hosting_request_sid: type: string minLength: 34 maxLength: 34 pattern: ^BH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder. next_step: type: string nullable: true description: The next step you need to take to complete the hosted number order and request it successfully. verification_attempts: type: integer default: 0 description: The number of attempts made to verify ownership via a call for the hosted phone number. verification_call_sids: type: array items: type: string nullable: true description: The Call SIDs that identify the calls placed to verify ownership. verification_call_delay: type: integer default: 0 description: The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive. verification_call_extension: type: string nullable: true description: The numerical extension to dial when making the ownership verification call. verification_code: type: string nullable: true description: The digits the user must pass in the ownership verification call. verification_type: $ref: '#/components/schemas/hosted_number_order_enum_verification_type' hosted_number_order_enum_status: type: string enum: - twilio-processing - received - pending-verification - verified - pending-loa - carrier-processing - testing - completed - failed - action-required description: 'Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses.' hosted_number_order_enum_verification_type: type: string enum: - phone-call description: 'The method used to verify ownership of the number to be hosted. Can be: `phone-call` or `phone-bill` and the default is `phone-call`.' numbers.v2.regulatory_compliance.bundle.item_assignment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Item Assignment resource. bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource. object_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of an object bag that holds information of the different items. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Identity resource. numbers.v2.regulatory_compliance.regulation: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Regulation resource. friendly_name: type: string nullable: true description: 'A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business.' iso_country: type: string nullable: true description: The ISO country code of the phone number's country. number_type: type: string nullable: true description: The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung. end_user_type: $ref: '#/components/schemas/regulation_enum_end_user_type' requirements: nullable: true description: The SID of an object that holds the regulatory information of the phone number country, phone number type, and end user type. url: type: string format: uri nullable: true description: The absolute URL of the Regulation resource. regulation_enum_end_user_type: type: string enum: - individual - business description: The type of End User the regulation requires - can be `individual` or `business`. numbers.v2.regulatory_compliance: type: object properties: {} numbers.v2.regulatory_compliance.bundle.replace_items: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Bundle resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource. regulation_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a regulation that is associated to the Bundle resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/replace_items_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until. email: type: string nullable: true description: The email address that will receive updates when the Bundle resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. replace_items_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved - provisionally-approved description: The verification status of the Bundle resource. replace_items_enum_end_user_type: type: string enum: - individual - business numbers.v2.regulatory_compliance.supporting_document: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify the Supporting Document resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. mime_type: type: string nullable: true description: The image type uploaded in the Supporting Document container. status: $ref: '#/components/schemas/supporting_document_enum_status' failure_reason: type: string nullable: true description: The failure reason of the Supporting Document Resource. errors: type: array items: {} nullable: true description: A list of errors that occurred during the registering RC Bundle type: type: string nullable: true description: The type of the Supporting Document. attributes: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Supporting Document resource. supporting_document_enum_status: type: string enum: - draft - pending-review - rejected - approved - expired - provisionally-approved description: The verification status of the Supporting Document resource. numbers.v2.regulatory_compliance.supporting_document_type: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Supporting Document Type resource. friendly_name: type: string nullable: true description: A human-readable description of the Supporting Document Type resource. machine_name: type: string nullable: true description: The machine-readable description of the Supporting Document Type resource. fields: type: array items: {} nullable: true description: The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals. url: type: string format: uri nullable: true description: The absolute URL of the Supporting Document Type resource. info: title: Twilio - Numbers description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v2/HostedNumber/AuthorizationDocuments/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: dependent_hosted_number_orders: mapping: signing_document_sid: sid resource_url: /v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders pathType: instance get: description: Fetch a specific AuthorizationDocument. summary: Fetch a specific AuthorizationDocument. tags: - NumbersV2AuthorizationDocument parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.authorization_document' examples: fetch: value: address_sid: AD11111111111111111111111111111111 cc_emails: - aaa@twilio.com - bbb@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com links: dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: signing url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchAuthorizationDocument delete: description: Cancel the AuthorizationDocument request. summary: Cancel the AuthorizationDocument request. tags: - NumbersV2AuthorizationDocument parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteAuthorizationDocument /v2/HostedNumber/AuthorizationDocuments: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: dependent_hosted_number_orders: mapping: signing_document_sid: sid resource_url: /v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders pathType: list get: description: Retrieve a list of AuthorizationDocuments belonging to the account initiating the request. summary: Retrieve a list of AuthorizationDocuments belonging to the account initiating the request. tags: - NumbersV2AuthorizationDocument parameters: - name: Email in: query description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 examples: readEmpty: value: test+hosted@twilio.com - name: Status in: query description: '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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.' schema: $ref: '#/components/schemas/authorization_document_enum_status' examples: readEmpty: value: signed - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/numbers.v2.authorization_document' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListAuthorizationDocumentResponse examples: readEmpty: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 items: [] readFull: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0 items: - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa cc_emails: - test1@twilio.com - test2@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test+hosted@twilio.com links: dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: signing url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListAuthorizationDocument post: description: Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform. summary: Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform. tags: - NumbersV2AuthorizationDocument responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.authorization_document' examples: create: value: address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa cc_emails: - test1@twilio.com - test2@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test+hosted@twilio.com links: dependent_hosted_number_orders: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: signing url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateAuthorizationDocumentRequest properties: AddressSid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ description: A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. Email: type: string description: Email that this AuthorizationDocument will be sent to for signing. ContactPhoneNumber: type: string format: phone-number description: The contact phone number of the person authorized to sign the Authorization Document. HostedNumberOrderSids: type: array items: type: string description: A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform. ContactTitle: type: string description: The title of the person authorized to sign the Authorization Document for this phone number. CcEmails: type: array items: type: string description: Email recipients who will be informed when an Authorization Document has been sent and signed. required: - AddressSid - Email - ContactPhoneNumber - HostedNumberOrderSids examples: create: value: AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Email: test+hosted@twilio.com CcEmails: - test1@twilio.com - test2@twilio.com HostedNumberOrderSids: - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 ContactTitle: Mr. ContactPhoneNumber: '+14155555555' /v2/HostedNumber/Orders/Bulk/{BulkHostingSid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] mountName: bulk_hosted_number_orders pathType: instance get: description: Fetch a specific BulkHostedNumberOrder. summary: Fetch a specific BulkHostedNumberOrder. tags: - NumbersV2BulkHostedNumberOrder parameters: - name: BulkHostingSid in: path description: A 34 character string that uniquely identifies this BulkHostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^BH[0-9a-fA-F]{32}$ required: true - name: OrderStatus in: query description: Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.bulk_hosted_number_order' examples: fetchNoParams: value: friendly_name: test bulk_hosting_sid: BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa notification_email: test@twilio.com request_status: PROCESSED url: https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk/BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2023-06-29T15:19:37Z' date_completed: '2023-06-30T15:19:37Z' total_count: 4 results: - order_status: pending_loa count: '2' get_more_info: null orders: - hosting_order_sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa phone_number: '+12222222222' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa failure_reason: null next_step: null url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa email: test@twilio.com signing_document_sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - hosting_order_sid: HRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb phone_number: '+13333333333' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa failure_reason: null next_step: null url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb email: test@twilio.com signing_document_sid: PXbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - order_status: failed count: '2' get_more_info: 'For more information, call the Hosted Number Eligibility API: https://www.twilio.com/docs/phone-numbers/hosted-numbers-api/eligibility-api-overview' orders: - hosting_order_sid: HRcccccccccccccccccccccccccccccccc phone_number: '+14444444444' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa failure_reason: test failure-reason next_step: test next-step url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRcccccccccccccccccccccccccccccccc email: test@twilio.com signing_document_sid: null - hosting_order_sid: HRdddddddddddddddddddddddddddddddd phone_number: '+15555555555' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa failure_reason: test failure-reason next_step: test next-step url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRdddddddddddddddddddddddddddddddd email: test@twilio.com signing_document_sid: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchBulkHostedNumberOrder /v2/HostedNumber/Orders/Bulk: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] mountName: bulk_hosted_number_orders pathType: list post: description: Host multiple phone numbers on Twilio's platform. summary: Host multiple phone numbers on Twilio's platform. tags: - NumbersV2BulkHostedNumberOrder responses: '202': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.bulk_hosted_number_order' examples: create: value: friendly_name: test bulk_hosting_sid: BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa request_status: QUEUED notification_email: test@twilio.com url: https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk/BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2023-06-29T15:19:37Z' date_completed: null total_count: 4 results: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: CreateBulkHostedNumberOrder requestBody: content: application/json: schema: type: object title: CreateBulkHostedNumberOrderRequest properties: {} /v2/RegulatoryCompliance/Bundles: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name dependentProperties: evaluations: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations item_assignments: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments bundle_copies: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies replace_items: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems parent: /RegulatoryCompliance pathType: list post: description: Create a new Bundle. summary: Create a new Bundle. tags: - NumbersV2Bundle responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' examples: create: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBundle requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBundleRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Bundle resource changes status. StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. RegulationSid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ description: The unique string of a regulation that is associated to the Bundle resource. IsoCountry: type: string description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request. EndUserType: $ref: '#/components/schemas/bundle_enum_end_user_type' NumberType: type: string description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`. IsTest: type: boolean description: Indicates that Bundle is a Test Bundle and will be Auto-Rejected required: - FriendlyName - Email examples: create: value: FriendlyName: friendly_name Email: email RegulationSid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa StatusCallback: http://www.example.com get: description: Retrieve a list of all Bundles for an account. summary: Retrieve a list of all Bundles for an account. tags: - NumbersV2Bundle parameters: - name: Status in: query description: The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details. schema: $ref: '#/components/schemas/bundle_enum_status' examples: readFull: value: draft readApprovedAuMobileWithDate: value: twilio-approved readApprovedAuMobileDateLess: value: twilio-approved readApprovedJapanTollfreeDateBetween: value: twilio-approved - name: FriendlyName in: query description: The string that you assigned to describe the resource. The column can contain 255 variable characters. schema: type: string examples: readFull: value: friendly_name - name: RegulationSid in: query description: The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ examples: readFull: value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request. schema: type: string examples: readFull: value: US readApprovedAuMobileWithDate: value: AU readApprovedAuMobileDateLess: value: AU readApprovedJapanTollfreeDateBetween: value: JP - name: NumberType in: query description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`. schema: type: string examples: readFull: value: mobile readApprovedAuMobileWithDate: value: mobile readApprovedAuMobileDateLess: value: mobile readApprovedJapanTollfreeDateBetween: value: tollfree - name: HasValidUntilDate in: query description: Indicates that the Bundle is a valid Bundle until a specified expiration date. schema: type: boolean examples: readApprovedAuMobileWithDate: value: 'true' - name: SortBy in: query description: Can be `valid-until` or `date-updated`. Defaults to `date-created`. schema: $ref: '#/components/schemas/bundle_enum_sort_by' - name: SortDirection in: query description: Default is `DESC`. Can be `ASC` or `DESC`. schema: $ref: '#/components/schemas/bundle_enum_sort_direction' - name: ValidUntilDate in: query description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format. schema: type: string format: date-time - name: ValidUntilDate< in: query description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format. schema: type: string format: date-time examples: readApprovedAuMobileDateLess: value: '2022-11-29T23:59:59Z' readApprovedJapanTollfreeDateBetween: value: '2022-11-29T23:59:59Z' - name: ValidUntilDate> in: query description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format. schema: type: string format: date-time examples: readApprovedJapanTollfreeDateBetween: value: '2022-01-01T00:00:00Z' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBundleResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: provisionally-approved email: email status_callback: http://www.example.com valid_until: '2020-07-31T01:00:00Z' date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=draft&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&FriendlyName=friendly_name&NumberType=mobile&PageSize=50&Page=0 next_page_url: null key: results readApprovedAuMobileWithDate: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2022-11-29T01:00:00Z' date_created: '2021-08-30T22:29:24Z' date_updated: '2021-08-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&HasValidUntilDate=true&NumberType=mobile&PageSize=50&Page=0 next_page_url: null key: results readApprovedAuMobileDateLess: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2022-11-29T01:00:00Z' date_created: '2021-08-30T22:29:24Z' date_updated: '2021-08-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=AU&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=mobile&PageSize=50&Page=0 next_page_url: null key: results readApprovedJapanTollfreeDateBetween: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2022-11-29T01:00:00Z' date_created: '2021-08-30T22:29:24Z' date_updated: '2021-08-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles?Status=twilio-approved&IsoCountry=JP&ValidUntilDate%3E=2022-01-01T00%3A00%3A00Z&ValidUntilDate%3C=2022-11-29T23%3A59%3A59Z&NumberType=tollfree&PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBundle /v2/RegulatoryCompliance/Bundles/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - regulation_sid - friendly_name dependentProperties: evaluations: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations item_assignments: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments bundle_copies: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies replace_items: mapping: bundle_sid: sid resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems parent: /RegulatoryCompliance pathType: instance get: description: Fetch a specific Bundle instance. summary: Fetch a specific Bundle instance. tags: - NumbersV2Bundle parameters: - name: Sid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' examples: fetch: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft valid_until: null email: email status_callback: http://www.example.com date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchBundle post: description: Updates a Bundle in an account. summary: Updates a Bundle in an account. tags: - NumbersV2Bundle parameters: - name: Sid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle' examples: update: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: evaluations: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations item_assignments: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments bundle_copies: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateBundle requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateBundleRequest properties: Status: $ref: '#/components/schemas/bundle_enum_status' StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Bundle resource changes status. examples: update: value: Status: draft StatusCallback: http://www.example.com FriendlyName: friendly_name Email: email delete: description: Delete a specific Bundle. summary: Delete a specific Bundle. tags: - NumbersV2Bundle parameters: - name: Sid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBundle /v2/RegulatoryCompliance/Bundles/{BundleSid}/Clones: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] mountName: bundle_clone pathType: instance post: description: Creates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle summary: Creates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle tags: - NumbersV2BundleClone parameters: - name: BundleSid in: path description: The unique string that identifies the Bundle to be cloned. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.bundle_clone' examples: create: value: bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved valid_until: '2015-07-30T20:00:00Z' email: email status_callback: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Clones headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBundleClone requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBundleCloneRequest properties: TargetAccountSid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned. MoveToDraft: type: boolean description: If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved FriendlyName: type: string description: The string that you assigned to describe the cloned bundle. required: - TargetAccountSid examples: create: value: FriendlyName: friendly_name TargetAccountSid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] parent: /RegulatoryCompliance/Bundles/{Sid} mountName: bundle_copies pathType: list post: description: Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle summary: Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle tags: - NumbersV2BundleCopy parameters: - name: BundleSid in: path description: The unique string that identifies the Bundle to be copied. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' examples: create: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft valid_until: '2015-07-30T20:00:00Z' email: email status_callback: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBundleCopy requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBundleCopyRequest properties: FriendlyName: type: string description: The string that you assigned to describe the copied bundle. examples: create: value: FriendlyName: friendly_name get: description: Retrieve a list of all Bundles Copies for a Bundle. summary: Retrieve a list of all Bundles Copies for a Bundle. tags: - NumbersV2BundleCopy parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBundleCopyResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2020-07-31T01:00:00Z' date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBundleCopy /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] parent: /HostedNumber/AuthorizationDocuments/{Sid} pathType: list get: description: Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument. summary: Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument. tags: - NumbersV2DependentHostedNumberOrder parameters: - name: SigningDocumentSid in: path description: A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^PX[0-9a-fA-F]{32}$ required: true - name: Status in: query description: '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](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.' schema: $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' examples: readEmpty: value: completed - name: PhoneNumber in: query description: An E164 formatted phone number hosted by this HostedNumberOrder. schema: type: string format: phone-number examples: readEmpty: value: '+19193608000' - name: IncomingPhoneNumberSid in: query description: A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ examples: readEmpty: value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: FriendlyName in: query description: A human readable description of this resource, up to 128 characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 examples: readEmpty: value: example - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/numbers.v2.authorization_document.dependent_hosted_number_order' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListDependentHostedNumberOrderResponse examples: readEmpty: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 items: [] readFull: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 items: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 capabilities: sms: true voice: false cc_emails: - aaa@twilio.com - bbb@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com friendly_name: friendly_name incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa signing_document_sid: PX11111111111111111111111111111111 status: received failure_reason: '' contact_title: contact_title_test contact_phone_number: '+12344444444' bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: Test headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListDependentHostedNumberOrder /v2/RegulatoryCompliance/EndUsers: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: list post: description: Create a new End User. summary: Create a new End User. tags: - NumbersV2EndUser responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' examples: create: value: sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name type: individual attributes: email: foobar@twilio.com date_created: '2019-07-30T21:57:45Z' date_updated: '2019-07-30T21:57:45Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateEndUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateEndUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Type: $ref: '#/components/schemas/end_user_enum_type' Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. required: - FriendlyName - Type examples: create: value: FriendlyName: friendly_name Type: individual Attributes: '{}' get: description: Retrieve a list of all End User for an account. summary: Retrieve a list of all End User for an account. tags: - NumbersV2EndUser parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEndUserResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name type: individual attributes: email: foobar@twilio.com date_created: '2019-07-30T21:57:45Z' date_updated: '2019-07-30T21:57:45Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEndUser /v2/RegulatoryCompliance/EndUsers/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: instance get: description: Fetch specific End User Instance. summary: Fetch specific End User Instance. tags: - NumbersV2EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' examples: fetch: value: sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name type: individual attributes: email: foobar@twilio.com date_created: '2019-07-30T21:57:45Z' date_updated: '2019-07-30T21:57:45Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEndUser post: description: Update an existing End User. summary: Update an existing End User. tags: - NumbersV2EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user' examples: update: value: sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name type: individual attributes: email: foobar@twilio.com date_created: '2019-07-30T21:57:45Z' date_updated: '2019-07-30T21:57:45Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateEndUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. examples: update: value: FriendlyName: friendly_name Attributes: '{}' delete: description: Delete a specific End User. summary: Delete a specific End User. tags: - NumbersV2EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEndUser /v2/RegulatoryCompliance/EndUserTypes: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: list get: description: Retrieve a list of all End-User Types. summary: Retrieve a list of all End-User Types. tags: - NumbersV2EndUserType parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: end_user_types: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEndUserTypeResponse examples: readEmpty: value: end_user_types: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 next_page_url: null key: end_user_types readFull: value: end_user_types: - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name machine_name: machine_name fields: - friendly_name: Business Purpose machine_name: business_purpose constraint: String - friendly_name: Last Name machine_name: last_name constraint: String url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes?PageSize=50&Page=0 next_page_url: null key: end_user_types headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEndUserType /v2/RegulatoryCompliance/EndUserTypes/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: instance get: description: Fetch a specific End-User Type Instance. summary: Fetch a specific End-User Type Instance. tags: - NumbersV2EndUserType parameters: - name: Sid in: path description: The unique string that identifies the End-User Type resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type' examples: fetch: value: sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name machine_name: machine_name fields: - friendly_name: Business Purpose machine_name: business_purpose constraint: String - friendly_name: Last Name machine_name: last_name constraint: String url: https://numbers.twilio.com/v2/RegulatoryCompliance/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /RegulatoryCompliance/Bundles/{Sid} pathType: list post: description: Creates an evaluation for a bundle summary: Creates an evaluation for a bundle tags: - NumbersV2Evaluation parameters: - name: BundleSid in: path description: The unique string that identifies the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' examples: create: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateEvaluation get: description: Retrieve a list of Evaluations associated to the Bundle resource. summary: Retrieve a list of Evaluations associated to the Bundle resource. tags: - NumbersV2Evaluation parameters: - name: BundleSid in: path description: The unique string that identifies the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEvaluationResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEvaluation /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /RegulatoryCompliance/Bundles/{Sid} pathType: instance get: description: Fetch specific Evaluation Instance. summary: Fetch specific Evaluation Instance. tags: - NumbersV2Evaluation parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that identifies the Evaluation resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation' examples: fetch: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEvaluation /v2/HostedNumber/Orders/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] mountName: hosted_number_orders pathType: instance get: description: Fetch a specific HostedNumberOrder. summary: Fetch a specific HostedNumberOrder. tags: - NumbersV2HostedNumberOrder parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.hosted_number_order' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 capabilities: sms: true voice: false cc_emails: - aaa@twilio.com - bbb@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com failure_reason: '' bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: next_step friendly_name: friendly_name incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa signing_document_sid: PX11111111111111111111111111111111 status: received url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_title: contact_title_test contact_phone_number: '+12344444444' verification_attempts: 0 verification_call_sids: [] verification_code: null verification_type: phone-call verification_call_delay: 0 verification_call_extension: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchHostedNumberOrder delete: description: Cancel the HostedNumberOrder (only available when the status is in `received`). summary: Cancel the HostedNumberOrder (only available when the status is in `received`). tags: - NumbersV2HostedNumberOrder parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteHostedNumberOrder post: description: Updates a specific HostedNumberOrder. summary: Updates a specific HostedNumberOrder. tags: - NumbersV2HostedNumberOrder parameters: - name: Sid in: path description: The SID of the HostedNumberOrder resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.hosted_number_order' examples: updateStatus: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 signing_document_sid: PX11111111111111111111111111111111 capabilities: mms: true sms: true voice: false cc_emails: - aaa@twilio.com - bbb@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com failure_reason: '' friendly_name: friendly name incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: '' status: pending-verification url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_title: contact_title_test contact_phone_number: '+12344444444' verification_attempts: 1 verification_call_delay: 15 verification_call_extension: '789' verification_call_sids: [] verification_code: '567890' verification_type: phone-call headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateHostedNumberOrderRequest properties: Status: $ref: '#/components/schemas/hosted_number_order_enum_status' VerificationCallDelay: type: integer description: The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive. VerificationCallExtension: type: string description: The numerical extension to dial when making the ownership verification call. required: - Status examples: updateStatus: value: Status: pending-verification VerificationCallDelay: 15 VerificationCallExtension: '789' /v2/HostedNumber/Orders: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] mountName: hosted_number_orders pathType: list get: description: Retrieve a list of HostedNumberOrders belonging to the account initiating the request. summary: Retrieve a list of HostedNumberOrders belonging to the account initiating the request. tags: - NumbersV2HostedNumberOrder parameters: - name: Status in: query description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`. schema: $ref: '#/components/schemas/hosted_number_order_enum_status' examples: readEmpty: value: completed - name: SmsCapability in: query description: Whether the SMS capability will be hosted on our platform. Can be `true` of `false`. schema: type: boolean - name: PhoneNumber in: query description: An E164 formatted phone number hosted by this HostedNumberOrder. schema: type: string format: phone-number x-twilio: pii: handling: standard deleteSla: 30 examples: readEmpty: value: '+19193608000' - name: IncomingPhoneNumberSid in: query description: A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ examples: readEmpty: value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: FriendlyName in: query description: A human readable description of this resource, up to 128 characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 examples: readEmpty: value: example - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/numbers.v2.hosted_number_order' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListHostedNumberOrderResponse examples: readEmpty: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/Orders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 items: [] readFull: value: meta: first_page_url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://numbers.twilio.com/v2/HostedNumber/Orders?PageSize=50&Page=0 items: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 capabilities: sms: true voice: false cc_emails: - aaa@twilio.com - bbb@twilio.com date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com failure_reason: '' friendly_name: friendly_name bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: next_step incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa signing_document_sid: PX11111111111111111111111111111111 status: received url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_title: contact_title_test contact_phone_number: '+12344444444' verification_attempts: 0 verification_call_sids: [] verification_code: null verification_type: phone-call verification_call_delay: 0 verification_call_extension: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListHostedNumberOrder post: description: Host a phone number's capability on Twilio's platform. summary: Host a phone number's capability on Twilio's platform. tags: - NumbersV2HostedNumberOrder responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.hosted_number_order' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 capabilities: sms: true voice: false cc_emails: [] date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com failure_reason: '' friendly_name: null incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: next_step sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa signing_document_sid: null status: received url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_title: contact_title_test contact_phone_number: '+12344444444' verification_attempts: 0 verification_call_sids: [] verification_code: null verification_type: phone-call verification_call_delay: 0 verification_call_extension: null createWithoutOptionalLoaFields: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address_sid: AD11111111111111111111111111111111 capabilities: sms: true voice: false cc_emails: [] date_created: '2017-03-28T20:06:39Z' date_updated: '2017-03-28T20:06:39Z' email: test@twilio.com contact_title: null failure_reason: '' friendly_name: null incoming_phone_number_sid: PN11111111111111111111111111111111 phone_number: '+14153608311' bulk_hosting_request_sid: BH11111111111111111111111111111111 next_step: next_step sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa signing_document_sid: null status: received url: https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_phone_number: '+12344444444' verification_attempts: 0 verification_call_sids: [] verification_code: null verification_type: phone-call verification_call_delay: 0 verification_call_extension: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateHostedNumberOrderRequest properties: PhoneNumber: type: string format: phone-number description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format ContactPhoneNumber: type: string format: phone-number description: The contact phone number of the person authorized to sign the Authorization Document. AddressSid: type: string minLength: 34 maxLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ description: Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number. Email: type: string description: Optional. Email of the owner of this phone number that is being hosted. AccountSid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ description: This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to. FriendlyName: type: string description: A 128 character string that is a human readable text that describes this resource. CcEmails: type: array items: type: string description: Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to. SmsUrl: type: string format: uri description: The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource. SmsMethod: type: string format: http-method enum: - GET - POST description: The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource. SmsFallbackUrl: type: string format: uri description: A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource. SmsCapability: type: boolean description: Used to specify that the SMS capability will be hosted on Twilio's platform. SmsFallbackMethod: type: string format: http-method enum: - GET - POST description: The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource. StatusCallbackUrl: type: string format: uri description: Optional. The Status Callback URL attached to the IncomingPhoneNumber resource. StatusCallbackMethod: type: string format: http-method enum: - GET - POST description: Optional. The Status Callback Method attached to the IncomingPhoneNumber resource. SmsApplicationSid: type: string minLength: 34 maxLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ description: Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application. ContactTitle: type: string description: The title of the person authorized to sign the Authorization Document for this phone number. required: - PhoneNumber - ContactPhoneNumber - AddressSid - Email examples: create: value: AddressSid: AD11111111111111111111111111111111 PhoneNumber: '+14153608311' ContactPhoneNumber: '+12344444444' ContactTitle: contact_title_test Email: test@twilio.com createWithoutOptionalLoaFields: value: PhoneNumber: '+14153608311' ContactPhoneNumber: '+12344444444' Email: test@twilio.com AddressSid: AD11111111111111111111111111111111 /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /RegulatoryCompliance/Bundles/{Sid} pathType: list post: description: Create a new Assigned Item. summary: Create a new Assigned Item. tags: - NumbersV2ItemAssignment parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' examples: create: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateItemAssignment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateItemAssignmentRequest properties: ObjectSid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ description: The SID of an object bag that holds information of the different items. required: - ObjectSid examples: create: value: ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. summary: Retrieve a list of all Assigned Items for an account. tags: - NumbersV2ItemAssignment parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListItemAssignmentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListItemAssignment /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /RegulatoryCompliance/Bundles/{Sid} pathType: instance get: description: Fetch specific Assigned Item Instance. summary: Fetch specific Assigned Item Instance. tags: - NumbersV2ItemAssignment parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment' examples: fetch: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ItemAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchItemAssignment delete: description: Remove an Assignment Item Instance. summary: Remove an Assignment Item Instance. tags: - NumbersV2ItemAssignment parameters: - name: BundleSid in: path description: The unique string that we created to identify the Bundle resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteItemAssignment /v2/RegulatoryCompliance/Regulations: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: list get: description: Retrieve a list of all Regulations. summary: Retrieve a list of all Regulations. tags: - NumbersV2Regulation parameters: - name: EndUserType in: query description: The type of End User the regulation requires - can be `individual` or `business`. schema: $ref: '#/components/schemas/regulation_enum_end_user_type' examples: readEmpty: value: business - name: IsoCountry in: query description: The ISO country code of the phone number's country. schema: type: string examples: readEmpty: value: US - name: NumberType in: query description: The type of phone number that the regulatory requiremnt is restricting. schema: type: string examples: readEmpty: value: mobile - name: IncludeConstraints in: query description: A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields schema: type: boolean examples: readEmpty: value: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListRegulationResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&IncludeConstraints=true&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&IncludeConstraints=true&EndUserType=business&NumberType=mobile&PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: 'Australia: Local - Individual' iso_country: AU number_type: local end_user_type: individual requirements: end_user: - name: Individual type: individual requirement_name: individual_info url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual fields: - first_name - last_name detailed_fields: - machine_name: first_name friendly_name: First Name description: First name of the Individual - machine_name: last_name friendly_name: Last Name description: Last name of the Individual supporting_document: - - name: Address type: document requirement_name: proof_of_address description: The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required. accepted_documents: - name: Address Validation type: address url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address fields: - address_sids detailed_fields: - machine_name: address_sids friendly_name: Address sid(s) description: Address sid of the individual url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListRegulation /v2/RegulatoryCompliance/Regulations/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: instance get: description: Fetch specific Regulation Instance. summary: Fetch specific Regulation Instance. tags: - NumbersV2Regulation parameters: - name: Sid in: path description: The unique string that identifies the Regulation resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ required: true - name: IncludeConstraints in: query description: A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields schema: type: boolean examples: fetch: value: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation' examples: fetch: value: sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: 'Australia: Local - Individual' iso_country: AU number_type: local end_user_type: individual requirements: end_user: - name: Individual type: individual requirement_name: individual_info url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual fields: - first_name - last_name detailed_fields: - machine_name: first_name friendly_name: First Name description: First name of the Individual - machine_name: last_name friendly_name: Last Name description: Last name of the Individual supporting_document: - - name: Address type: document requirement_name: proof_of_address description: The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required. accepted_documents: - name: Address Validation type: address url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address fields: - address_sids detailed_fields: - machine_name: address_sids friendly_name: Address sid(s) description: Address sid of the individual url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchRegulation /v2/RegulatoryCompliance: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] pathType: list /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: [] parent: /RegulatoryCompliance/Bundles/{Sid} className: replace_items pathType: list post: description: Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param) summary: Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param) tags: - NumbersV2ReplaceItems parameters: - name: BundleSid in: path description: The unique string that identifies the Bundle where the item assignments are going to be replaced. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items' examples: create: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulation_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft valid_until: '2015-07-30T20:00:00Z' email: email status_callback: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateReplaceItems requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateReplaceItemsRequest properties: FromBundleSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: The source bundle sid to copy the item assignments from. required: - FromBundleSid examples: create: value: FromBundleSid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb /v2/RegulatoryCompliance/SupportingDocuments: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: list post: description: Create a new Supporting Document. summary: Create a new Supporting Document. tags: - NumbersV2SupportingDocument responses: '201': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' examples: create: value: sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name mime_type: mime_type status: draft failure_reason: null errors: null type: type attributes: first_name: foo last_name: bar date_created: '2019-07-31T02:11:52Z' date_updated: '2019-07-31T02:11:52Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSupportingDocumentRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Type: type: string description: The type of the Supporting Document. Attributes: description: The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types. required: - FriendlyName - Type examples: create: value: FriendlyName: friendly_name Type: type Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. summary: Retrieve a list of all Supporting Document for an account. tags: - NumbersV2SupportingDocument parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSupportingDocumentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name mime_type: mime_type status: draft failure_reason: null errors: null type: type attributes: first_name: foo last_name: bar date_created: '2019-07-31T02:11:52Z' date_updated: '2019-07-31T02:11:52Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 next_page_url: null key: results readRejectedDocument: value: results: - sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name mime_type: mime_type status: rejected failure_reason: Some failure reason. errors: - code: 18001 type: type attributes: first_name: foo last_name: bar date_created: '2019-07-31T02:11:52Z' date_updated: '2019-07-31T02:11:52Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument /v2/RegulatoryCompliance/SupportingDocuments/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: instance get: description: Fetch specific Supporting Document Instance. summary: Fetch specific Supporting Document Instance. tags: - NumbersV2SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' examples: fetch: value: sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name mime_type: mime_type status: draft failure_reason: null errors: null type: type attributes: first_name: foo last_name: bar date_created: '2019-07-31T02:11:52Z' date_updated: '2019-07-31T02:11:52Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument post: description: Update an existing Supporting Document. summary: Update an existing Supporting Document. tags: - NumbersV2SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document' examples: update: value: sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name mime_type: mime_type status: draft failure_reason: null errors: null type: type attributes: first_name: foo last_name: bar date_created: '2019-07-31T02:11:52Z' date_updated: '2019-07-31T02:11:52Z' url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateSupportingDocumentRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. examples: update: value: FriendlyName: friendly_name Attributes: '{}' delete: description: Delete a specific Supporting Document. summary: Delete a specific Supporting Document. tags: - NumbersV2SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSupportingDocument /v2/RegulatoryCompliance/SupportingDocumentTypes: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: list get: description: Retrieve a list of all Supporting Document Types. summary: Retrieve a list of all Supporting Document Types. tags: - NumbersV2SupportingDocumentType parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: supporting_document_types: type: array items: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSupportingDocumentTypeResponse examples: readEmpty: value: supporting_document_types: [] meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 next_page_url: null key: supporting_document_types readFull: value: supporting_document_types: - sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Passport machine_name: passport fields: - friendly_name: Last Name machine_name: last_name constraint: String url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 previous_page_url: null url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=50&Page=0 next_page_url: null key: supporting_document_types headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}: servers: - url: https://numbers.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name parent: /RegulatoryCompliance pathType: instance get: description: Fetch a specific Supporting Document Type Instance. summary: Fetch a specific Supporting Document Type Instance. tags: - NumbersV2SupportingDocumentType parameters: - name: Sid in: path description: The unique string that identifies the Supporting Document Type resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type' examples: fetch: value: sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Passport machine_name: passport fields: - friendly_name: Last Name machine_name: last_name constraint: String url: https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType servers: - url: https://numbers.twilio.com tags: - name: NumbersV2AuthorizationDocument - name: NumbersV2BulkHostedNumberOrder - name: NumbersV2Bundle - name: NumbersV2BundleClone - name: NumbersV2BundleCopy - name: NumbersV2DependentHostedNumberOrder - name: NumbersV2EndUser - name: NumbersV2EndUserType - name: NumbersV2Evaluation - name: NumbersV2HostedNumberOrder - name: NumbersV2ItemAssignment - name: NumbersV2Regulation - name: NumbersV2ReplaceItems - name: NumbersV2SupportingDocument - name: NumbersV2SupportingDocumentType - name: NumbersV2Version security: - accountSid_authToken: []