Twilio - Trusthub
This is the public Twilio REST API
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.1",
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"info": {
"contact": {
"email": "support@twilio.com",
"name": "Twilio Support",
"url": "https://support.twilio.com"
},
"description": "This is the public Twilio REST API.",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"termsOfService": "https://www.twilio.com/legal/tos",
"title": "Twilio - Trusthub",
"version": "1.42.0",
"x-apisguru-categories": [
"telecom",
"messaging"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twilio.com_docs_static_img_favicons_favicon_57.c9643fd8d.png"
},
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_trusthub_v1.json",
"version": "3.0"
}
],
"x-providerName": "twilio.com",
"x-serviceName": "twilio_trusthub_v1"
},
"paths": {
"/v1/CustomerProfiles": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Customer-Profiles for an account.",
"operationId": "ListCustomerProfile",
"parameters": [
{
"description": "The verification status of the Customer-Profile resource.",
"in": "query",
"name": "Status",
"schema": {
"$ref": "#/components/schemas/customer_profile_enum_status",
"type": "string"
}
},
{
"description": "The string that you assigned to describe the resource.",
"in": "query",
"name": "FriendlyName",
"schema": {
"type": "string"
}
},
{
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"in": "query",
"name": "PolicySid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile"
},
"type": "array"
}
},
"title": "ListCustomerProfileResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Customer-Profile.",
"operationId": "CreateCustomerProfile",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"type": "string"
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"PolicySid": {
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"StatusCallback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"type": "string"
}
},
"required": [
"FriendlyName",
"Email",
"PolicySid"
],
"title": "CreateCustomerProfileRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles",
"defaultOutputProperties": [
"sid",
"policy_sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Assigned Items for an account.",
"operationId": "ListCustomerProfileChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The SID of an channel endpoint",
"in": "query",
"name": "ChannelEndpointSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "comma separated list of channel endpoint sids",
"in": "query",
"name": "ChannelEndpointSids",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment"
},
"type": "array"
}
},
"title": "ListCustomerProfileChannelEndpointAssignmentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Assigned Item.",
"operationId": "CreateCustomerProfileChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"ChannelEndpointSid": {
"description": "The SID of an channel endpoint",
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"ChannelEndpointType": {
"description": "The type of channel endpoint. eg: phone-number",
"type": "string"
}
},
"required": [
"ChannelEndpointType",
"ChannelEndpointSid"
],
"title": "CreateCustomerProfileChannelEndpointAssignmentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_channel_endpoint_assignment",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "list"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}": {
"delete": {
"description": "Remove an Assignment Item Instance.",
"operationId": "DeleteCustomerProfileChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Assigned Item Instance.",
"operationId": "FetchCustomerProfileChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_channel_endpoint_assignment",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "instance"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Assigned Items for an account.",
"operationId": "ListCustomerProfileEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment"
},
"type": "array"
}
},
"title": "ListCustomerProfileEntityAssignmentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Assigned Item.",
"operationId": "CreateCustomerProfileEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"ObjectSid": {
"description": "The SID of an object bag that holds information of the different items.",
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
}
},
"required": [
"ObjectSid"
],
"title": "CreateCustomerProfileEntityAssignmentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles_entity_assignments",
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_entity_assignments",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "list"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}": {
"delete": {
"description": "Remove an Assignment Item Instance.",
"operationId": "DeleteCustomerProfileEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the Identity resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Assigned Item Instance.",
"operationId": "FetchCustomerProfileEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the Identity resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles_entity_assignments",
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_entity_assignments",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "instance"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Evaluations associated to the customer_profile resource.",
"operationId": "ListCustomerProfileEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation"
},
"type": "array"
}
},
"title": "ListCustomerProfileEvaluationResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Evaluation",
"operationId": "CreateCustomerProfileEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"PolicySid": {
"description": "The unique string of a policy that is associated to the customer_profile resource.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
}
},
"required": [
"PolicySid"
],
"title": "CreateCustomerProfileEvaluationRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles_evaluations",
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_evaluations",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "list"
}
},
"/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Evaluation Instance.",
"operationId": "FetchCustomerProfileEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the customer_profile resource.",
"in": "path",
"name": "CustomerProfileSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that identifies the Evaluation resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^EL[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles_evaluations",
"defaultOutputProperties": [
"sid"
],
"mountName": "customer_profiles_evaluations",
"parent": "/CustomerProfiles/{Sid}",
"pathType": "instance"
}
},
"/v1/CustomerProfiles/{Sid}": {
"delete": {
"description": "Delete a specific Customer-Profile.",
"operationId": "DeleteCustomerProfile",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Customer-Profile instance.",
"operationId": "FetchCustomerProfile",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Updates a Customer-Profile in an account.",
"operationId": "UpdateCustomerProfile",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"type": "string"
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"Status": {
"$ref": "#/components/schemas/customer_profile_enum_status",
"description": "The verification status of the Customer-Profile resource.",
"type": "string"
},
"StatusCallback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"type": "string"
}
},
"title": "UpdateCustomerProfileRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.customer_profile"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "customer_profiles",
"defaultOutputProperties": [
"sid",
"policy_sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/EndUserTypes": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all End-User Types.",
"operationId": "ListEndUserType",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"end_user_types": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.end_user_type"
},
"type": "array"
},
"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",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/EndUserTypes/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific End-User Type Instance.",
"operationId": "FetchEndUserType",
"parameters": [
{
"description": "The unique string that identifies the End-User Type resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.end_user_type"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/EndUsers": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all End User for an account.",
"operationId": "ListEndUser",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.end_user"
},
"type": "array"
}
},
"title": "ListEndUserResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new End User.",
"operationId": "CreateEndUser",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Attributes": {
"description": "The set of parameters that are the attributes of the End User resource which are derived End User Types."
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"Type": {
"description": "The type of end user of the Bundle resource - can be `individual` or `business`.",
"type": "string"
}
},
"required": [
"FriendlyName",
"Type"
],
"title": "CreateEndUserRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.end_user"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/EndUsers/{Sid}": {
"delete": {
"description": "Delete a specific End User.",
"operationId": "DeleteEndUser",
"parameters": [
{
"description": "The unique string created by Twilio to identify the End User resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IT[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific End User Instance.",
"operationId": "FetchEndUser",
"parameters": [
{
"description": "The unique string created by Twilio to identify the End User resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IT[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.end_user"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Update an existing End User.",
"operationId": "UpdateEndUser",
"parameters": [
{
"description": "The unique string created by Twilio to identify the End User resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IT[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Attributes": {
"description": "The set of parameters that are the attributes of the End User resource which are derived End User Types."
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
}
},
"title": "UpdateEndUserRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.end_user"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/Policies": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Policys.",
"operationId": "ListPolicies",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.policies"
},
"type": "array"
}
},
"title": "ListPoliciesResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "policies",
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/Policies/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Policy Instance.",
"operationId": "FetchPolicies",
"parameters": [
{
"description": "The unique string that identifies the Policy resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.policies"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "policies",
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/SupportingDocumentTypes": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Supporting Document Types.",
"operationId": "ListSupportingDocumentType",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"supporting_document_types": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document_type"
},
"type": "array"
}
},
"title": "ListSupportingDocumentTypeResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/SupportingDocumentTypes/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Supporting Document Type Instance.",
"operationId": "FetchSupportingDocumentType",
"parameters": [
{
"description": "The unique string that identifies the Supporting Document Type resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document_type"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/SupportingDocuments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Supporting Document for an account.",
"operationId": "ListSupportingDocument",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document"
},
"type": "array"
}
},
"title": "ListSupportingDocumentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Supporting Document.",
"operationId": "CreateSupportingDocument",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Attributes": {
"description": "The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types."
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"Type": {
"description": "The type of the Supporting Document.",
"type": "string"
}
},
"required": [
"FriendlyName",
"Type"
],
"title": "CreateSupportingDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/SupportingDocuments/{Sid}": {
"delete": {
"description": "Delete a specific Supporting Document.",
"operationId": "DeleteSupportingDocument",
"parameters": [
{
"description": "The unique string created by Twilio to identify the Supporting Document resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RD[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Supporting Document Instance.",
"operationId": "FetchSupportingDocument",
"parameters": [
{
"description": "The unique string created by Twilio to identify the Supporting Document resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RD[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Update an existing Supporting Document.",
"operationId": "UpdateSupportingDocument",
"parameters": [
{
"description": "The unique string created by Twilio to identify the Supporting Document resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RD[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Attributes": {
"description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types."
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
}
},
"title": "UpdateSupportingDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.supporting_document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/TrustProducts": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Customer-Profiles for an account.",
"operationId": "ListTrustProduct",
"parameters": [
{
"description": "The verification status of the Customer-Profile resource.",
"in": "query",
"name": "Status",
"schema": {
"$ref": "#/components/schemas/trust_product_enum_status",
"type": "string"
}
},
{
"description": "The string that you assigned to describe the resource.",
"in": "query",
"name": "FriendlyName",
"schema": {
"type": "string"
}
},
{
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"in": "query",
"name": "PolicySid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.trust_product"
},
"type": "array"
}
},
"title": "ListTrustProductResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Customer-Profile.",
"operationId": "CreateTrustProduct",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"type": "string"
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"PolicySid": {
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"StatusCallback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"type": "string"
}
},
"required": [
"FriendlyName",
"Email",
"PolicySid"
],
"title": "CreateTrustProductRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products",
"defaultOutputProperties": [
"sid",
"policy_sid",
"friendly_name"
],
"pathType": "list"
}
},
"/v1/TrustProducts/{Sid}": {
"delete": {
"description": "Delete a specific Customer-Profile.",
"operationId": "DeleteTrustProduct",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Customer-Profile instance.",
"operationId": "FetchTrustProduct",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Updates a Customer-Profile in an account.",
"operationId": "UpdateTrustProduct",
"parameters": [
{
"description": "The unique string that we created to identify the Customer-Profile resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"type": "string"
},
"FriendlyName": {
"description": "The string that you assigned to describe the resource.",
"type": "string"
},
"Status": {
"$ref": "#/components/schemas/trust_product_enum_status",
"description": "The verification status of the Customer-Profile resource.",
"type": "string"
},
"StatusCallback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"type": "string"
}
},
"title": "UpdateTrustProductRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products",
"defaultOutputProperties": [
"sid",
"policy_sid",
"friendly_name"
],
"pathType": "instance"
}
},
"/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Assigned Items for an account.",
"operationId": "ListTrustProductChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The SID of an channel endpoint",
"in": "query",
"name": "ChannelEndpointSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "comma separated list of channel endpoint sids",
"in": "query",
"name": "ChannelEndpointSids",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment"
},
"type": "array"
}
},
"title": "ListTrustProductChannelEndpointAssignmentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Assigned Item.",
"operationId": "CreateTrustProductChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"ChannelEndpointSid": {
"description": "The SID of an channel endpoint",
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"ChannelEndpointType": {
"description": "The type of channel endpoint. eg: phone-number",
"type": "string"
}
},
"required": [
"ChannelEndpointType",
"ChannelEndpointSid"
],
"title": "CreateTrustProductChannelEndpointAssignmentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_channel_endpoint_assignment",
"parent": "/TrustProducts/{Sid}",
"pathType": "list"
}
},
"/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}": {
"delete": {
"description": "Remove an Assignment Item Instance.",
"operationId": "DeleteTrustProductChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Assigned Item Instance.",
"operationId": "FetchTrustProductChannelEndpointAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the CustomerProfile resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_channel_endpoint_assignment",
"parent": "/TrustProducts/{Sid}",
"pathType": "instance"
}
},
"/v1/TrustProducts/{TrustProductSid}/EntityAssignments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Assigned Items for an account.",
"operationId": "ListTrustProductEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the TrustProduct resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment"
},
"type": "array"
}
},
"title": "ListTrustProductEntityAssignmentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Assigned Item.",
"operationId": "CreateTrustProductEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the TrustProduct resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"ObjectSid": {
"description": "The SID of an object bag that holds information of the different items.",
"maxLength": 34,
"minLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
}
},
"required": [
"ObjectSid"
],
"title": "CreateTrustProductEntityAssignmentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products_entity_assignments",
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_entity_assignments",
"parent": "/TrustProducts/{Sid}",
"pathType": "list"
}
},
"/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}": {
"delete": {
"description": "Remove an Assignment Item Instance.",
"operationId": "DeleteTrustProductEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the TrustProduct resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the Identity resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Assigned Item Instance.",
"operationId": "FetchTrustProductEntityAssignment",
"parameters": [
{
"description": "The unique string that we created to identify the TrustProduct resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that we created to identify the Identity resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products_entity_assignments",
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_entity_assignments",
"parent": "/TrustProducts/{Sid}",
"pathType": "instance"
}
},
"/v1/TrustProducts/{TrustProductSid}/Evaluations": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Evaluations associated to the trust_product resource.",
"operationId": "ListTrustProductEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the trust_product resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"results": {
"items": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation"
},
"type": "array"
}
},
"title": "ListTrustProductEvaluationResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"post": {
"description": "Create a new Evaluation",
"operationId": "CreateTrustProductEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the trust_product resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"PolicySid": {
"description": "The unique string of a policy that is associated to the customer_profile resource.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
}
},
"required": [
"PolicySid"
],
"title": "CreateTrustProductEvaluationRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products_evaluations",
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_evaluations",
"parent": "/TrustProducts/{Sid}",
"pathType": "list"
}
},
"/v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch specific Evaluation Instance.",
"operationId": "FetchTrustProductEvaluation",
"parameters": [
{
"description": "The unique string that we created to identify the trust_product resource.",
"in": "path",
"name": "TrustProductSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The unique string that identifies the Evaluation resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^EL[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"GA"
]
},
"servers": [
{
"url": "https://trusthub.twilio.com"
}
],
"x-twilio": {
"className": "trust_products_evaluations",
"defaultOutputProperties": [
"sid"
],
"mountName": "trust_products_evaluations",
"parent": "/TrustProducts/{Sid}",
"pathType": "instance"
}
}
},
"components": {
"schemas": {
"customer_profile_enum_end_user_type": {
"enum": [
"individual",
"business"
],
"type": "string"
},
"customer_profile_enum_status": {
"enum": [
"draft",
"pending-review",
"in-review",
"twilio-rejected",
"twilio-approved"
],
"type": "string"
},
"customer_profile_evaluation_enum_status": {
"enum": [
"compliant",
"noncompliant"
],
"type": "string"
},
"policies_enum_end_user_type": {
"enum": [
"individual",
"business"
],
"type": "string"
},
"supporting_document_enum_status": {
"enum": [
"draft",
"pending-review",
"rejected",
"approved",
"expired",
"provisionally-approved"
],
"type": "string"
},
"trust_product_enum_end_user_type": {
"enum": [
"individual",
"business"
],
"type": "string"
},
"trust_product_enum_status": {
"enum": [
"draft",
"pending-review",
"in-review",
"twilio-rejected",
"twilio-approved"
],
"type": "string"
},
"trust_product_evaluation_enum_status": {
"enum": [
"compliant",
"noncompliant"
],
"type": "string"
},
"trusthub.v1.customer_profile": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"links": {
"description": "The URLs of the Assigned Items of the Customer-Profile resource.",
"format": "uri-map",
"nullable": true,
"type": "object"
},
"policy_sid": {
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/customer_profile_enum_status",
"description": "The verification status of the Customer-Profile resource.",
"nullable": true,
"type": "string"
},
"status_callback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the Customer-Profile resource.",
"format": "uri",
"nullable": true,
"type": "string"
},
"valid_until": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"channel_endpoint_sid": {
"description": "The SID of an channel endpoint",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"channel_endpoint_type": {
"description": "The type of channel endpoint. eg: phone-number",
"nullable": true,
"type": "string"
},
"customer_profile_sid": {
"description": "The unique string that we created to identify the CustomerProfile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Identity resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.customer_profile.customer_profile_entity_assignment": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"customer_profile_sid": {
"description": "The unique string that we created to identify the CustomerProfile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"object_sid": {
"description": "The SID of an object bag that holds information of the different items.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Identity resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.customer_profile.customer_profile_evaluation": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the customer_profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"customer_profile_sid": {
"description": "The unique string that we created to identify the customer_profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"policy_sid": {
"description": "The unique string of a policy that is associated to the customer_profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"results": {
"description": "The results of the Evaluation which includes the valid and invalid attributes.",
"items": {},
"nullable": true,
"type": "array"
},
"sid": {
"description": "The unique string that identifies the Evaluation resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^EL[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/customer_profile_evaluation_enum_status",
"description": "The compliance status of the Evaluation resource.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.end_user": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"attributes": {
"description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.",
"nullable": true
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string created by Twilio to identify the End User resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IT[0-9a-fA-F]{32}$",
"type": "string"
},
"type": {
"description": "The type of end user of the Bundle resource - can be `individual` or `business`.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the End User resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.end_user_type": {
"properties": {
"fields": {
"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.",
"items": {},
"nullable": true,
"type": "array"
},
"friendly_name": {
"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",
"nullable": true,
"type": "string"
},
"machine_name": {
"description": "A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that identifies the End-User Type resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^OY[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the End-User Type resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.policies": {
"properties": {
"friendly_name": {
"description": "A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy",
"nullable": true,
"type": "string"
},
"requirements": {
"description": "The SID of an object that holds the policy information",
"nullable": true
},
"sid": {
"description": "The unique string that identifies the Policy resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Policy resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.supporting_document": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"attributes": {
"description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.",
"nullable": true
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"mime_type": {
"description": "The image type uploaded in the Supporting Document container.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string created by Twilio to identify the Supporting Document resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RD[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/supporting_document_enum_status",
"description": "The verification status of the Supporting Document resource.",
"nullable": true,
"type": "string"
},
"type": {
"description": "The type of the Supporting Document.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the Supporting Document resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.supporting_document_type": {
"properties": {
"fields": {
"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.",
"items": {},
"nullable": true,
"type": "array"
},
"friendly_name": {
"description": "A human-readable description of the Supporting Document Type resource.",
"nullable": true,
"type": "string"
},
"machine_name": {
"description": "The machine-readable description of the Supporting Document Type resource.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that identifies the Supporting Document Type resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^OY[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Supporting Document Type resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.trust_product": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "The email address that will receive updates when the Customer-Profile resource changes status.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"links": {
"description": "The URLs of the Assigned Items of the Customer-Profile resource.",
"format": "uri-map",
"nullable": true,
"type": "object"
},
"policy_sid": {
"description": "The unique string of a policy that is associated to the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Customer-Profile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/trust_product_enum_status",
"description": "The verification status of the Customer-Profile resource.",
"nullable": true,
"type": "string"
},
"status_callback": {
"description": "The URL we call to inform your application of status changes.",
"format": "uri",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the Customer-Profile resource.",
"format": "uri",
"nullable": true,
"type": "string"
},
"valid_until": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.trust_product.trust_product_channel_endpoint_assignment": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"channel_endpoint_sid": {
"description": "The SID of an channel endpoint",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"channel_endpoint_type": {
"description": "The type of channel endpoint. eg: phone-number",
"nullable": true,
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RA[0-9a-fA-F]{32}$",
"type": "string"
},
"trust_product_sid": {
"description": "The unique string that we created to identify the CustomerProfile resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Identity resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.trust_product.trust_product_entity_assignment": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"object_sid": {
"description": "The SID of an object bag that holds information of the different items.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the Item Assignment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BV[0-9a-fA-F]{32}$",
"type": "string"
},
"trust_product_sid": {
"description": "The unique string that we created to identify the TrustProduct resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the Identity resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"trusthub.v1.trust_product.trust_product_evaluation": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the trust_product resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"policy_sid": {
"description": "The unique string of a policy that is associated to the trust_product resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RN[0-9a-fA-F]{32}$",
"type": "string"
},
"results": {
"description": "The results of the Evaluation which includes the valid and invalid attributes.",
"items": {},
"nullable": true,
"type": "array"
},
"sid": {
"description": "The unique string that identifies the Evaluation resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^EL[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/trust_product_evaluation_enum_status",
"description": "The compliance status of the Evaluation resource.",
"nullable": true,
"type": "string"
},
"trust_product_sid": {
"description": "The unique string that we created to identify the trust_product resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^BU[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"accountSid_authToken": {
"scheme": "basic",
"type": "http"
}
}
},
"x-maturity": [
{
"description": "This product is Generally Available.",
"name": "GA"
}
]
}