components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: trusthub.v1.compliance_inquiry: type: object properties: inquiry_id: type: string nullable: true description: The unique ID used to start an embedded compliance registration session. inquiry_session_token: type: string nullable: true description: The session token used to start an embedded compliance registration session. customer_id: type: string nullable: true description: The CustomerID matching the Customer Profile that should be resumed or resubmitted for editing. url: type: string format: uri nullable: true description: The URL of this resource. trusthub.v1.compliance_registration: type: object properties: inquiry_id: type: string nullable: true description: The unique ID used to start an embedded compliance registration session. inquiry_session_token: type: string nullable: true description: The session token used to start an embedded compliance registration session. registration_id: type: string nullable: true description: The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing. url: type: string format: uri nullable: true description: The URL of this resource. compliance_registration_enum_end_user_type: type: string enum: - Individual - Business compliance_registration_enum_phone_number_type: type: string enum: - local - national - mobile - toll-free compliance_registration_enum_business_identity_type: type: string enum: - direct_customer - isv_reseller_or_partner - unknown compliance_registration_enum_business_registration_authority: type: string enum: - UK:CRN - US:EIN - CA:CBN - AU:ACN - Other trusthub.v1.compliance_tollfree_inquiry: type: object properties: inquiry_id: type: string nullable: true description: The unique ID used to start an embedded compliance registration session. inquiry_session_token: type: string nullable: true description: The session token used to start an embedded compliance registration session. registration_id: type: string nullable: true description: The TolfreeId matching the Tollfree Profile that should be resumed or resubmitted for editing. url: type: string format: uri nullable: true description: The URL of this resource. compliance_tollfree_inquiry_enum_status: type: string enum: - PENDING_REVIEW - IN_REVIEW - TWILIO_APPROVED - TWILIO_REJECTED compliance_tollfree_inquiry_enum_opt_in_type: type: string enum: - VERBAL - WEB_FORM - PAPER_FORM - VIA_TEXT - MOBILE_QR_CODE trusthub.v1.customer_profile: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Customer-Profile resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Customer-Profile resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a policy that is associated to the Customer-Profile resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/customer_profile_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until. email: type: string nullable: true description: The email address that will receive updates when the Customer-Profile resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Customer-Profile resource. links: type: object format: uri-map nullable: true description: The URLs of the Assigned Items of the Customer-Profile resource. errors: type: array items: {} nullable: true description: The error codes associated with the rejection of the Customer-Profile. customer_profile_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved description: The verification status of the Customer-Profile resource. customer_profile_enum_end_user_type: type: string enum: - individual - business trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Item Assignment resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the CustomerProfile resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource. channel_endpoint_type: type: string nullable: true description: 'The type of channel endpoint. eg: phone-number' channel_endpoint_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of an channel endpoint date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Identity resource. trusthub.v1.customer_profile.customer_profile_entity_assignment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Item Assignment resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the CustomerProfile resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource. object_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of an object bag that holds information of the different items. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Identity resource. trusthub.v1.customer_profile.customer_profile_evaluation: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the customer_profile resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a policy that is associated to the customer_profile resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the customer_profile resource. status: $ref: '#/components/schemas/customer_profile_evaluation_enum_status' results: type: array items: {} nullable: true description: The results of the Evaluation which includes the valid and invalid attributes. date_created: type: string format: date-time nullable: true url: type: string format: uri nullable: true customer_profile_evaluation_enum_status: type: string enum: - compliant - noncompliant description: The compliance status of the Evaluation resource. trusthub.v1.end_user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify the End User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. type: type: string nullable: true description: The type of end user of the Bundle resource - can be `individual` or `business`. attributes: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the End User resource. trusthub.v1.end_user_type: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the End-User Type resource. friendly_name: type: string nullable: true description: A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc machine_name: type: string nullable: true description: A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc. fields: type: array items: {} nullable: true description: The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals. url: type: string format: uri nullable: true description: The absolute URL of the End-User Type resource. trusthub.v1.policies: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Policy resource. friendly_name: type: string nullable: true description: A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy requirements: nullable: true description: The SID of an object that holds the policy information url: type: string format: uri nullable: true description: The absolute URL of the Policy resource. policies_enum_end_user_type: type: string enum: - individual - business trusthub.v1.supporting_document: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify the Supporting Document resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. mime_type: type: string nullable: true description: The image type uploaded in the Supporting Document container. status: $ref: '#/components/schemas/supporting_document_enum_status' type: type: string nullable: true description: The type of the Supporting Document. attributes: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Supporting Document resource. supporting_document_enum_status: type: string enum: - DRAFT - PENDING_REVIEW - REJECTED - APPROVED - EXPIRED - PROVISIONALLY_APPROVED description: The verification status of the Supporting Document resource. trusthub.v1.supporting_document_type: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^OY[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Supporting Document Type resource. friendly_name: type: string nullable: true description: A human-readable description of the Supporting Document Type resource. machine_name: type: string nullable: true description: The machine-readable description of the Supporting Document Type resource. fields: type: array items: {} nullable: true description: The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals. url: type: string format: uri nullable: true description: The absolute URL of the Supporting Document Type resource. trusthub.v1.trust_product: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Trust Product resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Trust Product resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of the policy that is associated with the Trust Product resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. status: $ref: '#/components/schemas/trust_product_enum_status' valid_until: type: string format: date-time nullable: true description: The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format until which the resource will be valid. email: type: string nullable: true description: The email address that will receive updates when the Trust Product resource changes status. status_callback: type: string format: uri nullable: true description: The URL we call to inform your application of status changes. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Trust Product resource. links: type: object format: uri-map nullable: true description: The URLs of the Assigned Items of the Trust Product resource. errors: type: array items: {} nullable: true description: The error codes associated with the rejection of the Trust Product. trust_product_enum_status: type: string enum: - draft - pending-review - in-review - twilio-rejected - twilio-approved description: The verification status of the Trust Product resource. trust_product_enum_end_user_type: type: string enum: - individual - business trusthub.v1.trust_product.trust_product_channel_endpoint_assignment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Item Assignment resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the CustomerProfile resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource. channel_endpoint_type: type: string nullable: true description: 'The type of channel endpoint. eg: phone-number' channel_endpoint_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of an channel endpoint date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Identity resource. trusthub.v1.trust_product.trust_product_entity_assignment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Item Assignment resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the TrustProduct resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource. object_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of an object bag that holds information of the different items. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Identity resource. trusthub.v1.trust_product.trust_product_evaluation: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Evaluation resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the trust_product resource. policy_sid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ nullable: true description: The unique string of a policy that is associated to the trust_product resource. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the trust_product resource. status: $ref: '#/components/schemas/trust_product_evaluation_enum_status' results: type: array items: {} nullable: true description: The results of the Evaluation which includes the valid and invalid attributes. date_created: type: string format: date-time nullable: true url: type: string format: uri nullable: true trust_product_evaluation_enum_status: type: string enum: - compliant - noncompliant description: The compliance status of the Evaluation resource. info: title: Twilio - Trusthub description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/ComplianceInquiries/Customers/Initialize: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - inquiry_id - session_token - customer_id mountName: compliance_inquiries className: compliance_inquiries pathType: list post: description: Create a new Compliance Inquiry for the authenticated account. This is necessary to start a new embedded session. summary: Create a new Compliance Inquiry for the authenticated account. This is necessary to start a new embedded session. tags: - TrusthubV1ComplianceInquiries responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.compliance_inquiry' examples: create: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize createWithNotificationEmail: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize createWithThemeSetId: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateComplianceInquiry requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateComplianceInquiryRequest properties: PrimaryProfileSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile. NotificationEmail: type: string description: The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used. ThemeSetId: type: string description: Theme id for styling the inquiry form. required: - PrimaryProfileSid examples: create: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithNotificationEmail: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa NotificationEmail: pfarnsworth@twilio.com createWithThemeSetId: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa NotificationEmail: pfarnsworth@twilio.com ThemeSetId: th_xxxxx /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - inquiry_id - session_token - customer_id mountName: compliance_inquiries className: compliance_inquiries pathType: instance post: description: Resume a specific Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing. summary: Resume a specific Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing. tags: - TrusthubV1ComplianceInquiries parameters: - name: CustomerId in: path description: The unique CustomerId matching the Customer Profile/Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Compliance Inquiry creation call. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.compliance_inquiry' examples: update: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize updateWithThemeSetId: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateComplianceInquiry requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateComplianceInquiryRequest properties: PrimaryProfileSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile. ThemeSetId: type: string description: Theme id for styling the inquiry form. required: - PrimaryProfileSid examples: update: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa updateWithThemeSetId: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ThemeSetId: th_xxxxx /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - inquiry_id - session_token - registration_id mountName: compliance_registration_inquiries className: compliance_registration_inquiries pathType: list post: description: Create a new Compliance Registration Inquiry for the authenticated account. This is necessary to start a new embedded session. summary: Create a new Compliance Registration Inquiry for the authenticated account. This is necessary to start a new embedded session. tags: - TrusthubV1ComplianceRegistrationInquiries responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.compliance_registration' examples: create: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token registration_id: tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RegulatoryCompliance/GB/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateComplianceRegistration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateComplianceRegistrationRequest properties: EndUserType: $ref: '#/components/schemas/compliance_registration_enum_end_user_type' PhoneNumberType: $ref: '#/components/schemas/compliance_registration_enum_phone_number_type' BusinessIdentityType: $ref: '#/components/schemas/compliance_registration_enum_business_identity_type' BusinessRegistrationAuthority: $ref: '#/components/schemas/compliance_registration_enum_business_registration_authority' BusinessLegalName: type: string description: he name of the business or organization using the Tollfree number. NotificationEmail: type: string description: he email address to receive the notification about the verification result. AcceptedNotificationReceipt: type: boolean description: The email address to receive the notification about the verification result. BusinessRegistrationNumber: type: string description: Business registration number of the business BusinessWebsiteUrl: type: string description: The URL of the business website FriendlyName: type: string description: Friendly name for your business information AuthorizedRepresentative1FirstName: type: string description: First name of the authorized representative AuthorizedRepresentative1LastName: type: string description: Last name of the authorized representative AuthorizedRepresentative1Phone: type: string description: Phone number of the authorized representative AuthorizedRepresentative1Email: type: string description: Email address of the authorized representative AuthorizedRepresentative1DateOfBirth: type: string description: Birthdate of the authorized representative AddressStreet: type: string description: Street address of the business AddressStreetSecondary: type: string description: Street address of the business AddressCity: type: string description: City of the business AddressSubdivision: type: string description: State or province of the business AddressPostalCode: type: string description: Postal code of the business AddressCountryCode: type: string description: Country code of the business EmergencyAddressStreet: type: string description: Street address of the business EmergencyAddressStreetSecondary: type: string description: Street address of the business EmergencyAddressCity: type: string description: City of the business EmergencyAddressSubdivision: type: string description: State or province of the business EmergencyAddressPostalCode: type: string description: Postal code of the business EmergencyAddressCountryCode: type: string description: Country code of the business UseAddressAsEmergencyAddress: type: boolean description: Use the business address as the emergency address FileName: type: string description: The name of the verification document to upload File: type: string description: The verification document to upload FirstName: type: string description: The first name of the Individual User. LastName: type: string description: The last name of the Individual User. DateOfBirth: type: string description: The date of birth of the Individual User. IndividualEmail: type: string description: The email address of the Individual User. IndividualPhone: type: string description: The phone number of the Individual User. IsIsvEmbed: type: boolean description: Indicates if the inquiry is being started from an ISV embedded component. IsvRegisteringForSelfOrTenant: type: string description: Indicates if the isv registering for self or tenant. StatusCallbackUrl: type: string description: The url we call to inform you of bundle changes. ThemeSetId: type: string description: Theme id for styling the inquiry form. required: - EndUserType - PhoneNumberType examples: create: value: EndUserType: Individual FirstName: firstname LastName: lastname DateOfBirth: '1990-01-01' IndividualEmail: test@test.com IndividualPhone: '123456' PhoneNumberType: national BusinessLegalName: Owl, Inc. NotificationEmail: test@test.com AcceptedNotificationReceipt: true BusinessRegistrationNumber: '123456789' BusinessWebsiteUrl: https://twilio.co FriendlyName: Owl AuthorizedRepresentative1FirstName: firstname AuthorizedRepresentative1LastName: lastname AuthorizedRepresentative1Email: test@test.com AuthorizedRepresentative1DateOfBirth: '1990-01-01' AuthorizedRepresentative1Phone: '+9199992222222' AddressStreet: 123 Main St AddressStreetSecondary: Apt 1 AddressCity: San Francisco AddressSubdivision: CA AddressPostalCode: '94107' AddressCountryCode: US UseAddressAsEmergencyAddress: true EmergencyAddressStreet: 123 Main St EmergencyAddressStreetSecondary: Apt 1 EmergencyAddressCity: San Francisco EmergencyAddressSubdivision: CA EmergencyAddressPostalCode: '94107' EmergencyAddressCountryCode: US FileName: fileName File: file BusinessIdentityType: direct_customer BusinessRegistrationAuthority: UK:CRN IsIsvEmbed: true IsvRegisteringForSelfOrTenant: my_customer StatusCallbackUrl: https://status.com ThemeSetId: th_xxxxx /v1/ComplianceInquiries/Registration/{RegistrationId}/RegulatoryCompliance/GB/Initialize: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - inquiry_id - session_token - registration_id mountName: compliance_registration_inquiries className: compliance_registration_inquiries pathType: instance post: description: Resume a specific Regulatory Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing. summary: Resume a specific Regulatory Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing. tags: - TrusthubV1ComplianceRegistrationInquiries parameters: - name: RegistrationId in: path description: The unique RegistrationId matching the Regulatory Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Regulatory Compliance Inquiry creation call. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.compliance_registration' examples: update: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token registration_id: tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registration.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registration.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RegulatoryCompliance/GB/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateComplianceRegistration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateComplianceRegistrationRequest properties: IsIsvEmbed: type: boolean description: Indicates if the inquiry is being started from an ISV embedded component. ThemeSetId: type: string description: Theme id for styling the inquiry form. examples: update: value: ThemeSetId: th_xxxxx IsIsvEmbed: true /v1/ComplianceInquiries/Tollfree/Initialize: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - inquiry_id - session_token - registration_id mountName: compliance_tollfree_inquiries className: compliance_tollfree_inquiries pathType: list post: description: Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session. summary: Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session. tags: - TrusthubV1ComplianceTollfreeInquiries responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.compliance_tollfree_inquiry' examples: create: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token registration_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize create2: value: inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa inquiry_session_token: new.session.token registration_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateComplianceTollfreeInquiry requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateComplianceTollfreeInquiryRequest properties: TollfreePhoneNumber: type: string format: phone-number description: The Tollfree phone number to be verified NotificationEmail: type: string description: The email address to receive the notification about the verification result. BusinessName: type: string description: The name of the business or organization using the Tollfree number. BusinessWebsite: type: string description: The website of the business or organization using the Tollfree number. UseCaseCategories: type: array items: type: string description: The category of the use case for the Tollfree Number. List as many are applicable.. UseCaseSummary: type: string description: Use this to further explain how messaging is used by the business or organization. ProductionMessageSample: type: string description: An example of message content, i.e. a sample message. OptInImageUrls: type: array items: type: string description: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL. OptInType: $ref: '#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type' MessageVolume: type: string description: Estimate monthly volume of messages from the Tollfree Number. BusinessStreetAddress: type: string description: The address of the business or organization using the Tollfree number. BusinessStreetAddress2: type: string description: The address of the business or organization using the Tollfree number. BusinessCity: type: string description: The city of the business or organization using the Tollfree number. BusinessStateProvinceRegion: type: string description: The state/province/region of the business or organization using the Tollfree number. BusinessPostalCode: type: string description: The postal code of the business or organization using the Tollfree number. BusinessCountry: type: string description: The country of the business or organization using the Tollfree number. AdditionalInformation: type: string description: Additional information to be provided for verification. BusinessContactFirstName: type: string description: The first name of the contact for the business or organization using the Tollfree number. BusinessContactLastName: type: string description: The last name of the contact for the business or organization using the Tollfree number. BusinessContactEmail: type: string description: The email address of the contact for the business or organization using the Tollfree number. BusinessContactPhone: type: string format: phone-number description: The phone number of the contact for the business or organization using the Tollfree number. ThemeSetId: type: string description: Theme id for styling the inquiry form. SkipMessagingUseCase: type: boolean description: Skip the messaging use case screen of the inquiry form. required: - TollfreePhoneNumber - NotificationEmail examples: create: value: TollfreePhoneNumber: '+123445566' NotificationEmail: jeff@twilio.com create2: value: TollfreePhoneNumber: '+123445566' NotificationEmail: jeff@twilio.com BusinessName: Owl, Inc. BusinessStreetAddress: 123 Main Street BusinessStreetAddress2: Suite 101 BusinessCity: Anytown BusinessStateProvinceRegion: AA BusinessPostalCode: '11111' BusinessCountry: US BusinessWebsite: http://www.company.com BusinessContactFirstName: firstname BusinessContactLastName: lastname BusinessContactEmail: email@company.com BusinessContactPhone: '+1231231234' UseCaseCategories: - TWO_FACTOR_AUTHENTICATION - MARKETING UseCaseSummary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop ProductionMessageSample: lorem ipsum OptInImageUrls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg OptInType: VERBAL MessageVolume: '10' AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy ThemeSetId: theme_set_id SkipMessagingUseCase: true /v1/CustomerProfiles: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name dependentProperties: customer_profiles_entity_assignments: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments customer_profiles_evaluations: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/Evaluations customer_profiles_channel_endpoint_assignment: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments className: customer_profiles pathType: list post: description: Create a new Customer-Profile. summary: Create a new Customer-Profile. tags: - TrusthubV1CustomerProfiles responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' examples: create: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfile requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCustomerProfileRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. PolicySid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ description: The unique string of a policy that is associated to the Customer-Profile resource. StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. required: - FriendlyName - Email - PolicySid examples: create: value: FriendlyName: friendly_name Email: email PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa StatusCallback: http://www.example.com get: description: Retrieve a list of all Customer-Profiles for an account. summary: Retrieve a list of all Customer-Profiles for an account. tags: - TrusthubV1CustomerProfiles parameters: - name: Status in: query description: The verification status of the Customer-Profile resource. schema: $ref: '#/components/schemas/customer_profile_enum_status' examples: readFull: value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string examples: readFull: value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Customer-Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ examples: readFull: value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.customer_profile' 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: ListCustomerProfileResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2020-07-31T01:00:00Z' date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: - code: 18601 meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfile /v1/CustomerProfiles/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name dependentProperties: customer_profiles_entity_assignments: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/EntityAssignments customer_profiles_evaluations: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/Evaluations customer_profiles_channel_endpoint_assignment: mapping: customer_profile_sid: sid resource_url: /v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments className: customer_profiles pathType: instance get: description: Fetch a specific Customer-Profile instance. summary: Fetch a specific Customer-Profile instance. tags: - TrusthubV1CustomerProfiles parameters: - name: Sid in: path description: The unique string that we created to identify the Customer-Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' examples: fetch: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft valid_until: null email: email status_callback: http://www.example.com date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: - code: 18601 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfile post: description: Updates a Customer-Profile in an account. summary: Updates a Customer-Profile in an account. tags: - TrusthubV1CustomerProfiles parameters: - name: Sid in: path description: The unique string that we created to identify the Customer-Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile' examples: update: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null updateToInReview: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: in-review email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: customer_profiles_entity_assignments: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments customer_profiles_evaluations: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations customer_profiles_channel_endpoint_assignment: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateCustomerProfile requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateCustomerProfileRequest properties: Status: $ref: '#/components/schemas/customer_profile_enum_status' StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Customer-Profile resource changes status. examples: update: value: Status: draft StatusCallback: http://www.example.com FriendlyName: friendly_name Email: email updateToInReview: value: Status: pending-review delete: description: Delete a specific Customer-Profile. summary: Delete a specific Customer-Profile. tags: - TrusthubV1CustomerProfiles parameters: - name: Sid in: path description: The unique string that we created to identify the Customer-Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCustomerProfile /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment pathType: list post: description: Create a new Assigned Item. summary: Create a new Assigned Item. tags: - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' examples: create: value: sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileChannelEndpointAssignment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCustomerProfileChannelEndpointAssignmentRequest properties: ChannelEndpointType: type: string description: 'The type of channel endpoint. eg: phone-number' ChannelEndpointSid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ description: The SID of an channel endpoint required: - ChannelEndpointType - ChannelEndpointSid examples: create: value: ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. summary: Retrieve a list of all Assigned Items for an account. tags: - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: ChannelEndpointSid in: query description: The SID of an channel endpoint schema: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ examples: readFull: value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListCustomerProfileChannelEndpointAssignmentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileChannelEndpointAssignment /v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_channel_endpoint_assignment pathType: instance get: description: Fetch specific Assigned Item Instance. summary: Fetch specific Assigned Item Instance. tags: - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment' examples: fetch: value: sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileChannelEndpointAssignment delete: description: Remove an Assignment Item Instance. summary: Remove an Assignment Item Instance. tags: - TrusthubV1CustomerProfilesChannelEndpointAssignment parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCustomerProfileChannelEndpointAssignment /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments pathType: list post: description: Create a new Assigned Item. summary: Create a new Assigned Item. tags: - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' examples: create: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEntityAssignment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCustomerProfileEntityAssignmentRequest properties: ObjectSid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ description: The SID of an object bag that holds information of the different items. required: - ObjectSid examples: create: value: ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. summary: Retrieve a list of all Assigned Items for an account. tags: - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: ObjectType in: query description: A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListCustomerProfileEntityAssignmentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEntityAssignment /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_entity_assignments className: customer_profiles_entity_assignments pathType: instance get: description: Fetch specific Assigned Item Instance. summary: Fetch specific Assigned Item Instance. tags: - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_entity_assignment' examples: fetch: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEntityAssignment delete: description: Remove an Assignment Item Instance. summary: Remove an Assignment Item Instance. tags: - TrusthubV1CustomerProfilesEntityAssignments parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCustomerProfileEntityAssignment /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations pathType: list post: description: Create a new Evaluation summary: Create a new Evaluation tags: - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' examples: create: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info createCompliantStarterCustomerProfile: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: compliant date_created: '2023-03-15T13:51:57Z' policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - valid: - object_field: first_name error_code: null friendly_name: First Name passed: true failure_reason: null - object_field: last_name error_code: null friendly_name: Last Name passed: true failure_reason: null - object_field: email error_code: null friendly_name: Email Address passed: true failure_reason: null - object_field: phone_number error_code: null friendly_name: Phone Number passed: true failure_reason: null invalid: [] object_type: starter_customer_profile_information friendly_name: Information failure_reason: null passed: true requirement_friendly_name: Starter Customer Profile Information error_code: null requirement_name: starter_customer_profile_information - valid: - object_field: address_sids error_code: null friendly_name: address sids passed: true failure_reason: null invalid: [] object_type: customer_profile_address friendly_name: Legal Company Address failure_reason: null passed: true requirement_friendly_name: Customer Profile Address error_code: null requirement_name: customer_profile_address - valid: - object_field: bundle_sid error_code: null friendly_name: Supporting Bundle Status passed: true failure_reason: null invalid: [] object_type: primary_customer_profile_type_business friendly_name: Primary Customer Profile Bundle failure_reason: null passed: true requirement_friendly_name: Primary Customer Profile error_code: null requirement_name: primary_customer_profile createCompliantSoleProprietorA2PProfile: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: compliant date_created: '2023-03-15T13:51:57Z' policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - valid: - object_field: brand_name error_code: null friendly_name: Brand Name passed: true failure_reason: null - object_field: mobile_phone_number error_code: null friendly_name: Mobile Phone Number passed: true failure_reason: null - object_field: vertical error_code: null friendly_name: Vertical passed: true failure_reason: null invalid: [] object_type: sole_proprietor_information friendly_name: Sole Proprietor Information failure_reason: null passed: true requirement_friendly_name: Sole Proprietor Information error_code: null requirement_name: sole_proprietor_information - valid: - object_field: bundle_status error_code: null friendly_name: Supporting Bundle Status passed: true failure_reason: null invalid: [] object_type: starter_customer_profile_type_business friendly_name: Starter Customer Profile(isv customers) Proof failure_reason: null passed: true requirement_friendly_name: Customer Profile error_code: null requirement_name: customer_profile headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCustomerProfileEvaluation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCustomerProfileEvaluationRequest properties: PolicySid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ description: The unique string of a policy that is associated to the customer_profile resource. required: - PolicySid examples: create: value: PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createCompliantStarterCustomerProfile: value: PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createCompliantSoleProprietorA2PProfile: value: PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the customer_profile resource. summary: Retrieve a list of Evaluations associated to the customer_profile resource. tags: - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListCustomerProfileEvaluationResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCustomerProfileEvaluation /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /CustomerProfiles/{Sid} mountName: customer_profiles_evaluations className: customer_profiles_evaluations pathType: instance get: description: Fetch specific Evaluation Instance. summary: Fetch specific Evaluation Instance. tags: - TrusthubV1CustomerProfilesEvaluations parameters: - name: CustomerProfileSid in: path description: The unique string that we created to identify the customer_profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that identifies the Evaluation resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.customer_profile.customer_profile_evaluation' examples: fetch: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCustomerProfileEvaluation /v1/EndUsers: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list post: description: Create a new End User. summary: Create a new End User. tags: - TrusthubV1EndUser responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' examples: create: value: date_updated: '2021-02-16T20:40:57Z' sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: auth_rep_1 account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-16T20:40:57Z' attributes: phone_number: '+11234567890' job_position: CEO first_name: rep1 last_name: test business_title: ceo email: foobar@test.com type: authorized_representative_1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateEndUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateEndUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Type: type: string description: The type of end user of the Bundle resource - can be `individual` or `business`. Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. required: - FriendlyName - Type examples: create: value: FriendlyName: auth_rep_1 Type: authorized_representative_1 Attributes: '{}' get: description: Retrieve a list of all End User for an account. summary: Retrieve a list of all End User for an account. tags: - TrusthubV1EndUser parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.end_user' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEndUserResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - date_updated: '2021-02-16T20:40:57Z' sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: auth_rep_1 account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-16T20:40:57Z' attributes: phone_number: '+11234567890' job_position: CEO first_name: rep1 last_name: test business_title: ceo email: foobar@test.com type: authorized_representative_1 meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEndUser /v1/EndUsers/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance get: description: Fetch specific End User Instance. summary: Fetch specific End User Instance. tags: - TrusthubV1EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' examples: fetch: value: date_updated: '2021-02-16T20:40:57Z' sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: auth_rep_1 account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-16T20:40:57Z' attributes: phone_number: '+11234567890' job_position: CEO first_name: rep1 last_name: test business_title: ceo email: foobar@test.com type: authorized_representative_1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEndUser post: description: Update an existing End User. summary: Update an existing End User. tags: - TrusthubV1EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user' examples: update: value: date_updated: '2021-02-16T20:40:57Z' sid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-16T20:40:57Z' attributes: phone_number: '+11234567890' job_position: CEO first_name: rep1 last_name: test business_title: ceo email: foobar@test.com type: authorized_representative_1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateEndUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateEndUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: description: The set of parameters that are the attributes of the End User resource which are derived End User Types. examples: update: value: FriendlyName: friendly_name Attributes: '{}' delete: description: Delete a specific End User. summary: Delete a specific End User. tags: - TrusthubV1EndUser parameters: - name: Sid in: path description: The unique string created by Twilio to identify the End User resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IT[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEndUser /v1/EndUserTypes: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list get: description: Retrieve a list of all End-User Types. summary: Retrieve a list of all End-User Types. tags: - TrusthubV1EndUserType parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: end_user_types: type: array items: $ref: '#/components/schemas/trusthub.v1.end_user_type' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEndUserTypeResponse examples: readEmpty: value: end_user_types: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 next_page_url: null key: end_user_types readFull: value: meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/EndUserTypes?PageSize=50&Page=0 next_page_url: null key: end_user_types end_user_types: - url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fields: - machine_name: last_name friendly_name: Last Name constraint: String - machine_name: email friendly_name: Email constraint: String - machine_name: first_name friendly_name: First Name constraint: String - machine_name: business_title friendly_name: Business Title constraint: String - machine_name: phone_number friendly_name: Phone Number constraint: String - machine_name: job_position friendly_name: Job Position constraint: String machine_name: authorized_representative_1 friendly_name: Authorized Representative one sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEndUserType /v1/EndUserTypes/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance get: description: Fetch a specific End-User Type Instance. summary: Fetch a specific End-User Type Instance. tags: - TrusthubV1EndUserType parameters: - name: Sid in: path description: The unique string that identifies the End-User Type resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.end_user_type' examples: fetch: value: url: https://trusthub.twilio.com/v1/EndUserTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fields: - machine_name: last_name friendly_name: Last Name constraint: String - machine_name: email friendly_name: Email constraint: String - machine_name: first_name friendly_name: First Name constraint: String - machine_name: business_title friendly_name: Business Title constraint: String - machine_name: phone_number friendly_name: Phone Number constraint: String - machine_name: job_position friendly_name: Job Position constraint: String machine_name: authorized_representative_1 friendly_name: Authorized Representative one sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEndUserType /v1/Policies: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name className: policies pathType: list get: description: Retrieve a list of all Policys. summary: Retrieve a list of all Policys. tags: - TrusthubV1Policies parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.policies' 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: ListPoliciesResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 next_page_url: null key: results readFull: value: meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0 next_page_url: null key: results results: - url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa requirements: end_user: - url: /EndUserTypes/customer_profile_business_information fields: - business_type - business_registration_number - business_name - business_registration_identifier - business_identity - business_industry - website_url - business_regions_of_operation - social_media_profile_urls type: customer_profile_business_information name: Business Information requirement_name: customer_profile_business_information - url: /EndUserTypes/authorized_representative_1 fields: - first_name - last_name - email - phone_number - business_title - job_position type: authorized_representative_1 name: Authorized Representative 1 requirement_name: authorized_representative_1 - url: /EndUserTypes/authorized_representative_2 fields: - first_name - last_name - email - phone_number - business_title - job_position type: authorized_representative_2 name: Authorized Representative 2 requirement_name: authorized_representative_2 supporting_trust_products: [] supporting_document: - - description: Customer Profile HQ Physical Address type: document name: Physical Business Address accepted_documents: - url: /SupportingDocumentTypes/customer_profile_address fields: - address_sids type: customer_profile_address name: Physical Business Address requirement_name: customer_profile_address supporting_customer_profiles: [] friendly_name: Primary Customer Profile of type Business sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPolicies /v1/Policies/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name className: policies pathType: instance get: description: Fetch specific Policy Instance. summary: Fetch specific Policy Instance. tags: - TrusthubV1Policies parameters: - name: Sid in: path description: The unique string that identifies the Policy resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.policies' examples: fetch: value: url: https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa requirements: end_user: - url: /EndUserTypes/customer_profile_business_information fields: - business_type - business_registration_number - business_name - business_registration_identifier - business_identity - business_industry - website_url - business_regions_of_operation - social_media_profile_urls type: customer_profile_business_information name: Business Information requirement_name: customer_profile_business_information - url: /EndUserTypes/authorized_representative_1 fields: - first_name - last_name - email - phone_number - business_title - job_position type: authorized_representative_1 name: Authorized Representative 1 requirement_name: authorized_representative_1 - url: /EndUserTypes/authorized_representative_2 fields: - first_name - last_name - email - phone_number - business_title - job_position type: authorized_representative_2 name: Authorized Representative 2 requirement_name: authorized_representative_2 supporting_trust_products: [] supporting_document: - - description: Customer Profile HQ Physical Address type: document name: Physical Business Address accepted_documents: - url: /SupportingDocumentTypes/customer_profile_address fields: - address_sids type: customer_profile_address name: Physical Business Address requirement_name: customer_profile_address supporting_customer_profiles: [] friendly_name: Primary Customer Profile of type Business sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetchStarterCustomerProfilePolicy: value: url: https://trusthub.twilio.com/v1/Policies/RN806dd6cd175f314e1f96a9727ee271f4 requirements: end_user: - url: /EndUserTypes/starter_customer_profile_information fields: - first_name - last_name - email - phone_number type: starter_customer_profile_information name: Information requirement_name: starter_customer_profile_information supporting_trust_products: [] supporting_document: - - description: Customer Profile Address type: document name: Customer Profile Address accepted_documents: - url: /SupportingDocumentTypes/customer_profile_address fields: - address_sids type: customer_profile_address name: Legal Company Address - url: /SupportingDocumentTypes/starter_customer_profile_address fields: - address_sids type: starter_customer_profile_address name: Legal Company Address requirement_name: customer_profile_address supporting_customer_profiles: - type: primary_customer_profile_type_business name: Primary Customer Profile Bundle requirement_name: primary_customer_profile friendly_name: Starter Customer Profile of type Business sid: RN806dd6cd175f314e1f96a9727ee271f4 fetchSoleProprietorTrustBundlePolicy: value: url: https://trusthub.twilio.com/v1/Policies/RN670d5d2e282a6130ae063b234b6019c8 requirements: end_user: - url: /EndUserTypes/sole_proprietor_information fields: - brand_name - mobile_phone_number - vertical type: sole_proprietor_information name: Sole Proprietor Information requirement_name: sole_proprietor_information supporting_trust_products: [] supporting_document: - [] supporting_customer_profiles: - type: starter_customer_profile_type_business name: Starter Customer Profile(isv customers) Proof requirement_name: customer_profile - type: starter_customer_profile_type_direct_long_tail name: Starter Customer Profile(direct customers) Proof requirement_name: customer_profile friendly_name: Sole Proprietor TrustProduct sid: RN670d5d2e282a6130ae063b234b6019c8 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPolicies /v1/SupportingDocuments: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list post: description: Create a new Supporting Document. summary: Create a new Supporting Document. tags: - TrusthubV1SupportingDocument responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' examples: create: value: status: DRAFT date_updated: '2021-02-11T17:23:00Z' friendly_name: Business-profile-physical-address account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-11T17:23:00Z' sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer_profile_address mime_type: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSupportingDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSupportingDocumentRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Type: type: string description: The type of the Supporting Document. Attributes: description: The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types. required: - FriendlyName - Type examples: create: value: FriendlyName: Business-profile-physical-address Type: customer_profile_address Attributes: '{}' get: description: Retrieve a list of all Supporting Document for an account. summary: Retrieve a list of all Supporting Document for an account. tags: - TrusthubV1SupportingDocument parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.supporting_document' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSupportingDocumentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - status: DRAFT date_updated: '2021-02-11T17:23:00Z' friendly_name: Business-profile-physical-address account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-11T17:23:00Z' sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer_profile_address mime_type: null meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocument /v1/SupportingDocuments/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance get: description: Fetch specific Supporting Document Instance. summary: Fetch specific Supporting Document Instance. tags: - TrusthubV1SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' examples: fetch: value: status: DRAFT date_updated: '2021-02-11T17:23:00Z' friendly_name: Business-profile-physical-address account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-11T17:23:00Z' sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer_profile_address mime_type: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocument post: description: Update an existing Supporting Document. summary: Update an existing Supporting Document. tags: - TrusthubV1SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document' examples: update: value: status: DRAFT date_updated: '2021-02-11T17:23:00Z' friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-11T17:23:00Z' sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: address_sids: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer_profile_address mime_type: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateSupportingDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateSupportingDocumentRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: description: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types. examples: update: value: FriendlyName: friendly_name Attributes: '{}' delete: description: Delete a specific Supporting Document. summary: Delete a specific Supporting Document. tags: - TrusthubV1SupportingDocument parameters: - name: Sid in: path description: The unique string created by Twilio to identify the Supporting Document resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RD[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSupportingDocument /v1/SupportingDocumentTypes: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list get: description: Retrieve a list of all Supporting Document Types. summary: Retrieve a list of all Supporting Document Types. tags: - TrusthubV1SupportingDocumentType parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: supporting_document_types: type: array items: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSupportingDocumentTypeResponse examples: readEmpty: value: supporting_document_types: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 next_page_url: null key: supporting_document_types readFull: value: supporting_document_types: - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fields: - machine_name: address_sids friendly_name: Address Sids constraint: List machine_name: customer_profile_address friendly_name: Customer profile address sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fields: - machine_name: first_name friendly_name: First Name constraint: String - machine_name: last_name friendly_name: Last Name constraint: String - machine_name: business_name friendly_name: Business Name constraint: String machine_name: government_issued_proof_of_authorized_representative friendly_name: Government Issued Identity certifying proof of being an authorized representative of a company sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0 next_page_url: null key: supporting_document_types headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSupportingDocumentType /v1/SupportingDocumentTypes/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance get: description: Fetch a specific Supporting Document Type Instance. summary: Fetch a specific Supporting Document Type Instance. tags: - TrusthubV1SupportingDocumentType parameters: - name: Sid in: path description: The unique string that identifies the Supporting Document Type resource. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.supporting_document_type' examples: fetch: value: url: https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fields: - machine_name: first_name friendly_name: First Name constraint: String - machine_name: last_name friendly_name: Last Name constraint: String - machine_name: business_name friendly_name: Business Name constraint: String machine_name: government_issued_proof_of_authorized_representative friendly_name: Government Issued Identity certifying proof of being an authorized representative of a company sid: OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSupportingDocumentType /v1/TrustProducts: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name dependentProperties: trust_products_entity_assignments: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/EntityAssignments trust_products_evaluations: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/Evaluations trust_products_channel_endpoint_assignment: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments className: trust_products pathType: list post: description: Create a new Trust Product. summary: Create a new Trust Product. tags: - TrusthubV1TrustProducts responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' examples: create: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateTrustProduct requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateTrustProductRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Trust Product resource changes status. PolicySid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ description: The unique string of a policy that is associated to the Trust Product resource. StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. required: - FriendlyName - Email - PolicySid examples: create: value: FriendlyName: friendly_name Email: email PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa StatusCallback: http://www.example.com get: description: Retrieve a list of all Trust Products for an account. summary: Retrieve a list of all Trust Products for an account. tags: - TrusthubV1TrustProducts parameters: - name: Status in: query description: The verification status of the Trust Product resource. schema: $ref: '#/components/schemas/trust_product_enum_status' examples: readFull: value: draft - name: FriendlyName in: query description: The string that you assigned to describe the resource. schema: type: string examples: readFull: value: friendly_name - name: PolicySid in: query description: The unique string of a policy that is associated to the Trust Product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ examples: readFull: value: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.trust_product' 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: ListTrustProductResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: twilio-approved email: email status_callback: http://www.example.com valid_until: '2020-07-31T01:00:00Z' date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListTrustProduct /v1/TrustProducts/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - policy_sid - friendly_name dependentProperties: trust_products_entity_assignments: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/EntityAssignments trust_products_evaluations: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/Evaluations trust_products_channel_endpoint_assignment: mapping: trust_product_sid: sid resource_url: /v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments className: trust_products pathType: instance get: description: Fetch a specific Trust Product instance. summary: Fetch a specific Trust Product instance. tags: - TrusthubV1TrustProducts parameters: - name: Sid in: path description: The unique string that we created to identify the Trust Product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' examples: fetch: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft valid_until: null email: email status_callback: http://www.example.com date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: - code: 18601 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchTrustProduct post: description: Updates a Trust Product in an account. summary: Updates a Trust Product in an account. tags: - TrusthubV1TrustProducts parameters: - name: Sid in: path description: The unique string that we created to identify the Trust Product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product' examples: update: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: draft email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null updateToInReview: value: sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name status: in-review email: email status_callback: http://www.example.com valid_until: null date_created: '2019-07-30T22:29:24Z' date_updated: '2019-07-31T01:09:00Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: trust_products_entity_assignments: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments trust_products_evaluations: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations trust_products_channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments errors: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateTrustProduct requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateTrustProductRequest properties: Status: $ref: '#/components/schemas/trust_product_enum_status' StatusCallback: type: string format: uri description: The URL we call to inform your application of status changes. FriendlyName: type: string description: The string that you assigned to describe the resource. Email: type: string description: The email address that will receive updates when the Trust Product resource changes status. examples: update: value: Status: draft StatusCallback: http://www.example.com FriendlyName: friendly_name Email: email updateToInReview: value: Status: pending-review delete: description: Delete a specific Trust Product. summary: Delete a specific Trust Product. tags: - TrusthubV1TrustProducts parameters: - name: Sid in: path description: The unique string that we created to identify the Trust Product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteTrustProduct /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment pathType: list post: description: Create a new Assigned Item. summary: Create a new Assigned Item. tags: - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' examples: create: value: sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductChannelEndpointAssignment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateTrustProductChannelEndpointAssignmentRequest properties: ChannelEndpointType: type: string description: 'The type of channel endpoint. eg: phone-number' ChannelEndpointSid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ description: The SID of an channel endpoint required: - ChannelEndpointType - ChannelEndpointSid examples: create: value: ChannelEndpointSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ChannelEndpointType: phone-number get: description: Retrieve a list of all Assigned Items for an account. summary: Retrieve a list of all Assigned Items for an account. tags: - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: ChannelEndpointSid in: query description: The SID of an channel endpoint schema: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ examples: readFull: value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: ChannelEndpointSids in: query description: comma separated list of channel endpoint sids schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListTrustProductChannelEndpointAssignmentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?ChannelEndpointSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListTrustProductChannelEndpointAssignment /v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_channel_endpoint_assignment pathType: instance get: description: Fetch specific Assigned Item Instance. summary: Fetch specific Assigned Item Instance. tags: - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_channel_endpoint_assignment' examples: fetch: value: sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_type: phone-number date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductChannelEndpointAssignment delete: description: Remove an Assignment Item Instance. summary: Remove an Assignment Item Instance. tags: - TrusthubV1TrustProductsChannelEndpointAssignment parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the CustomerProfile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteTrustProductChannelEndpointAssignment /v1/TrustProducts/{TrustProductSid}/EntityAssignments: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments pathType: list post: description: Create a new Assigned Item. summary: Create a new Assigned Item. tags: - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the TrustProduct resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' examples: create: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEntityAssignment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateTrustProductEntityAssignmentRequest properties: ObjectSid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ description: The SID of an object bag that holds information of the different items. required: - ObjectSid examples: create: value: ObjectSid: ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Assigned Items for an account. summary: Retrieve a list of all Assigned Items for an account. tags: - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the TrustProduct resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: ObjectType in: query description: A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListTrustProductEntityAssignmentResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEntityAssignment /v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_entity_assignments className: trust_products_entity_assignments pathType: instance get: description: Fetch specific Assigned Item Instance. summary: Fetch specific Assigned Item Instance. tags: - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the TrustProduct resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_entity_assignment' examples: fetch: value: sid: BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa object_sid: RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2019-07-31T02:34:41Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEntityAssignment delete: description: Remove an Assignment Item Instance. summary: Remove an Assignment Item Instance. tags: - TrusthubV1TrustProductsEntityAssignments parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the TrustProduct resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that we created to identify the Identity resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BV[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteTrustProductEntityAssignment /v1/TrustProducts/{TrustProductSid}/Evaluations: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations pathType: list post: description: Create a new Evaluation summary: Create a new Evaluation tags: - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the trust_product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' examples: create: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info createCompliantSoleProprietorA2PProfile: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: compliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - valid: - object_field: brand_name error_code: null friendly_name: Brand Name passed: true failure_reason: null - object_field: mobile_phone_number error_code: null friendly_name: Mobile Phone Number passed: true failure_reason: null - object_field: vertical error_code: null friendly_name: Vertical passed: true failure_reason: null invalid: [] object_type: sole_proprietor_information friendly_name: Sole Proprietor Information failure_reason: null passed: true requirement_friendly_name: Sole Proprietor Information error_code: null requirement_name: sole_proprietor_information - valid: - object_field: bundle_status error_code: null friendly_name: Supporting Bundle Status passed: true failure_reason: null invalid: [] object_type: starter_customer_profile_type_business friendly_name: Starter Customer Profile(isv customers) Proof failure_reason: null passed: true requirement_friendly_name: Customer Profile error_code: null requirement_name: customer_profile headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateTrustProductEvaluation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateTrustProductEvaluationRequest properties: PolicySid: type: string minLength: 34 maxLength: 34 pattern: ^RN[0-9a-fA-F]{32}$ description: The unique string of a policy that is associated to the customer_profile resource. required: - PolicySid examples: create: value: PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createCompliantSoleProprietorA2PProfile: value: PolicySid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Evaluations associated to the trust_product resource. summary: Retrieve a list of Evaluations associated to the trust_product resource. tags: - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the trust_product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListTrustProductEvaluationResponse examples: readEmpty: value: results: [] meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results readFull: value: results: - sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info meta: page: 0 page_size: 50 first_page_url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 previous_page_url: null url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0 next_page_url: null key: results headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListTrustProductEvaluation /v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}: servers: - url: https://trusthub.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /TrustProducts/{Sid} mountName: trust_products_evaluations className: trust_products_evaluations pathType: instance get: description: Fetch specific Evaluation Instance. summary: Fetch specific Evaluation Instance. tags: - TrusthubV1TrustProductsEvaluations parameters: - name: TrustProductSid in: path description: The unique string that we created to identify the trust_product resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string that identifies the Evaluation resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^EL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/trusthub.v1.trust_product.trust_product_evaluation' examples: fetch: value: sid: ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa policy_sid: RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: noncompliant date_created: '2020-04-28T18:14:01Z' url: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa results: - friendly_name: Business object_type: business passed: false failure_reason: A Business End-User is missing. Please add one to the regulatory bundle. error_code: 22214 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Please enter in a Business Name on the Business information. error_code: 22215 - friendly_name: Business Registration Number object_field: business_registration_number failure_reason: The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information. error_code: 22215 - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Please enter in a First Name on the Business information. error_code: 22215 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Please enter in a Last Name on the Business information. error_code: 22215 requirement_friendly_name: Business requirement_name: business_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Business Name object_field: business_name failure_reason: The Business Name is missing. Or, it does not match the Business Name you entered within Business information. Please enter in the Business Name shown on the Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative or make sure both Business Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Business Name requirement_name: business_name_info - friendly_name: Excerpt from the commercial register showing French address object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Address sid(s) object_field: address_sids failure_reason: The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address. error_code: 22219 requirement_friendly_name: Business Address (Proof of Address) requirement_name: business_address_proof_info - friendly_name: Excerpt from the commercial register (Extrait K-bis) object_type: commercial_registrar_excerpt passed: false failure_reason: An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: Document Number object_field: document_number failure_reason: The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis). error_code: 22217 requirement_friendly_name: Business Registration Number requirement_name: business_reg_no_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing. Or, it does not match the First Name you entered within Business information. Please enter in the First Name shown on the Government-issued ID or make sure both First Name fields use the same exact inputs. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing. Or, it does not match the Last Name you entered within Business information. Please enter in the Last Name shown on the Government-issued ID or make sure both Last Name fields use the same exact inputs. error_code: 22217 requirement_friendly_name: Name of Authorized Representative requirement_name: name_of_auth_rep_info - friendly_name: Executed Copy of Power of Attorney object_type: power_of_attorney passed: false failure_reason: An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: [] requirement_friendly_name: Power of Attorney requirement_name: power_of_attorney_info - friendly_name: Government-issued ID object_type: government_issued_document passed: false failure_reason: A Government-issued ID is missing. Please add one to the regulatory bundle. error_code: 22216 valid: [] invalid: - friendly_name: First Name object_field: first_name failure_reason: The First Name is missing on the Governnment-Issued ID. error_code: 22217 - friendly_name: Last Name object_field: last_name failure_reason: The Last Name is missing on the Government-issued ID error_code: 22217 requirement_friendly_name: Name of Person granted the Power of Attorney requirement_name: name_in_power_of_attorney_info headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchTrustProductEvaluation servers: - url: https://trusthub.twilio.com tags: - name: TrusthubV1BrandedCalling - name: TrusthubV1ComplianceInquiries - name: TrusthubV1ComplianceRegistrationInquiries - name: TrusthubV1ComplianceTollfreeInquiries - name: TrusthubV1CustomerProfiles - name: TrusthubV1CustomerProfilesChannelEndpointAssignment - name: TrusthubV1CustomerProfilesEntityAssignments - name: TrusthubV1CustomerProfilesEvaluations - name: TrusthubV1CustomerProfilesProvisionalCopy - name: TrusthubV1EndUser - name: TrusthubV1EndUserType - name: TrusthubV1Index - name: TrusthubV1Policies - name: TrusthubV1SupportingDocument - name: TrusthubV1SupportingDocumentType - name: TrusthubV1TrustProducts - name: TrusthubV1TrustProductsChannelEndpointAssignment - name: TrusthubV1TrustProductsEntityAssignments - name: TrusthubV1TrustProductsEvaluations - name: TrusthubV1TrustProductsProvisionalCopy - name: TrusthubV1Version security: - accountSid_authToken: []