{ "opencollection": "1.0.0", "info": { "name": "Twilio - Accounts A2p Regulatory Compliance API", "version": "1.52.0" }, "items": [ { "info": { "name": "RegulatoryCompliance", "type": "folder" }, "items": [ { "info": { "name": "ListBundle", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles", "params": [ { "name": "Status", "value": "", "type": "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." }, { "name": "FriendlyName", "value": "", "type": "query", "description": "The string that you assigned to describe the resource. The column can contain 255 variable characters." }, { "name": "RegulationSid", "value": "", "type": "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." }, { "name": "IsoCountry", "value": "", "type": "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." }, { "name": "NumberType", "value": "", "type": "query", "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`." }, { "name": "HasValidUntilDate", "value": "", "type": "query", "description": "Indicates that the Bundle is a valid Bundle until a specified expiration date." }, { "name": "SortBy", "value": "", "type": "query", "description": "Can be `valid-until` or `date-updated`. Defaults to `date-created`." }, { "name": "SortDirection", "value": "", "type": "query", "description": "Default is `DESC`. Can be `ASC` or `DESC`." }, { "name": "ValidUntilDate", "value": "", "type": "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." }, { "name": "ValidUntilDate<", "value": "", "type": "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." }, { "name": "ValidUntilDate>", "value": "", "type": "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." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Bundles for an account." }, { "info": { "name": "CreateBundle", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles", "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new Bundle." }, { "info": { "name": "FetchBundle", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch a specific Bundle instance." }, { "info": { "name": "UpdateBundle", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates a Bundle in an account." }, { "info": { "name": "DeleteBundle", "type": "http" }, "http": { "method": "DELETE", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a specific Bundle." }, { "info": { "name": "ListBundleCopy", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/Copies", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Bundles Copies for a Bundle." }, { "info": { "name": "CreateBundleCopy", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/Copies", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that identifies the Bundle to be copied." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle" }, { "info": { "name": "ListEndUser", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUsers", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all End User for an account." }, { "info": { "name": "CreateEndUser", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUsers", "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new End User." }, { "info": { "name": "FetchEndUser", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUsers/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the End User resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch specific End User Instance." }, { "info": { "name": "UpdateEndUser", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUsers/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the End User resource." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update an existing End User." }, { "info": { "name": "DeleteEndUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUsers/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the End User resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a specific End User." }, { "info": { "name": "ListEndUserType", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUserTypes", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all End-User Types." }, { "info": { "name": "FetchEndUserType", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/EndUserTypes/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that identifies the End-User Type resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch a specific End-User Type Instance." }, { "info": { "name": "ListEvaluation", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/Evaluations", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that identifies the Bundle resource." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of Evaluations associated to the Bundle resource." }, { "info": { "name": "CreateEvaluation", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/Evaluations", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that identifies the Bundle resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an evaluation for a bundle" }, { "info": { "name": "FetchEvaluation", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/Evaluations/:Sid", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." }, { "name": "Sid", "value": "", "type": "path", "description": "The unique string that identifies the Evaluation resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch specific Evaluation Instance." }, { "info": { "name": "ListItemAssignment", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Assigned Items for an account." }, { "info": { "name": "CreateItemAssignment", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new Assigned Item." }, { "info": { "name": "FetchItemAssignment", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments/:Sid", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." }, { "name": "Sid", "value": "", "type": "path", "description": "The unique string that we created to identify the Identity resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch specific Assigned Item Instance." }, { "info": { "name": "DeleteItemAssignment", "type": "http" }, "http": { "method": "DELETE", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments/:Sid", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that we created to identify the Bundle resource." }, { "name": "Sid", "value": "", "type": "path", "description": "The unique string that we created to identify the Identity resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Remove an Assignment Item Instance." }, { "info": { "name": "ListRegulation", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Regulations", "params": [ { "name": "EndUserType", "value": "", "type": "query", "description": "The type of End User the regulation requires - can be `individual` or `business`." }, { "name": "IsoCountry", "value": "", "type": "query", "description": "The ISO country code of the phone number's country." }, { "name": "NumberType", "value": "", "type": "query", "description": "The type of phone number that the regulatory requiremnt is restricting." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Regulations." }, { "info": { "name": "FetchRegulation", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Regulations/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that identifies the Regulation resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch specific Regulation Instance." }, { "info": { "name": "CreateReplaceItems", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/Bundles/:BundleSid/ReplaceItems", "params": [ { "name": "BundleSid", "value": "", "type": "path", "description": "The unique string that identifies the Bundle where the item assignments are going to be replaced." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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)" }, { "info": { "name": "ListSupportingDocument", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocuments", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Supporting Document for an account." }, { "info": { "name": "CreateSupportingDocument", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocuments", "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new Supporting Document." }, { "info": { "name": "FetchSupportingDocument", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the Supporting Document resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch specific Supporting Document Instance." }, { "info": { "name": "UpdateSupportingDocument", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the Supporting Document resource." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update an existing Supporting Document." }, { "info": { "name": "DeleteSupportingDocument", "type": "http" }, "http": { "method": "DELETE", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocuments/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string created by Twilio to identify the Supporting Document resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a specific Supporting Document." }, { "info": { "name": "ListSupportingDocumentType", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all Supporting Document Types." }, { "info": { "name": "FetchSupportingDocumentType", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The unique string that identifies the Supporting Document Type resource." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Fetch a specific Supporting Document Type Instance." } ] } ], "bundled": true }