On this page

CustomerProfileEvaluation Resource

Evaluation Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<EL>

Optional

Not PII

The unique string that identifies the Evaluation resource.

Pattern: ^EL[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

Optional

Not PII

The SID of the Account that created the customer_profile resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

policy_sidSID<RN>

Optional

Not PII

The unique string of a policy that is associated to the customer_profile resource.

Pattern: ^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34

customer_profile_sidSID<BU>

Optional

Not PII

The unique string that we created to identify the customer_profile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

statusenum<string>

Optional

Not PII

The compliance status of the Evaluation resource.

Possible values:

compliantnoncompliant

resultsarray

Optional

Not PII

The results of the Evaluation which includes the valid and invalid attributes.

date_createdstring<date-time>

Optional

Not PII

urlstring<uri>

Optional

Not PII

Create a new Evaluation

POST https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

PolicySidSID<RN>required

Not PII

The unique string of a policy that is associated to the customer_profile resource.

Pattern: ^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34

Create an Evaluation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createCustomerProfileEvaluation() {
11  const customerProfilesEvaluation = await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .customerProfilesEvaluations.create({
14      policySid: "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15    });
16
17  console.log(customerProfilesEvaluation.sid);
18}
19
20createCustomerProfileEvaluation();

Output

1{
2  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "status": "noncompliant",
7  "date_created": "2020-04-28T18:14:01Z",
8  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9  "results": [
10    {
11      "friendly_name": "Business",
12      "object_type": "business",
13      "passed": false,
14      "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.",
15      "error_code": 22214,
16      "valid": [],
17      "invalid": [
18        {
19          "friendly_name": "Business Name",
20          "object_field": "business_name",
21          "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.",
22          "error_code": 22215
23        },
24        {
25          "friendly_name": "Business Registration Number",
26          "object_field": "business_registration_number",
27          "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.",
28          "error_code": 22215
29        },
30        {
31          "friendly_name": "First Name",
32          "object_field": "first_name",
33          "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.",
34          "error_code": 22215
35        },
36        {
37          "friendly_name": "Last Name",
38          "object_field": "last_name",
39          "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.",
40          "error_code": 22215
41        }
42      ],
43      "requirement_friendly_name": "Business",
44      "requirement_name": "business_info"
45    },
46    {
47      "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative",
48      "object_type": "commercial_registrar_excerpt",
49      "passed": false,
50      "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.",
51      "error_code": 22216,
52      "valid": [],
53      "invalid": [
54        {
55          "friendly_name": "Business Name",
56          "object_field": "business_name",
57          "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.",
58          "error_code": 22217
59        }
60      ],
61      "requirement_friendly_name": "Business Name",
62      "requirement_name": "business_name_info"
63    },
64    {
65      "friendly_name": "Excerpt from the commercial register showing French address",
66      "object_type": "commercial_registrar_excerpt",
67      "passed": false,
68      "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.",
69      "error_code": 22216,
70      "valid": [],
71      "invalid": [
72        {
73          "friendly_name": "Address sid(s)",
74          "object_field": "address_sids",
75          "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.",
76          "error_code": 22219
77        }
78      ],
79      "requirement_friendly_name": "Business Address (Proof of Address)",
80      "requirement_name": "business_address_proof_info"
81    },
82    {
83      "friendly_name": "Excerpt from the commercial register (Extrait K-bis)",
84      "object_type": "commercial_registrar_excerpt",
85      "passed": false,
86      "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.",
87      "error_code": 22216,
88      "valid": [],
89      "invalid": [
90        {
91          "friendly_name": "Document Number",
92          "object_field": "document_number",
93          "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).",
94          "error_code": 22217
95        }
96      ],
97      "requirement_friendly_name": "Business Registration Number",
98      "requirement_name": "business_reg_no_info"
99    },
100    {
101      "friendly_name": "Government-issued ID",
102      "object_type": "government_issued_document",
103      "passed": false,
104      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
105      "error_code": 22216,
106      "valid": [],
107      "invalid": [
108        {
109          "friendly_name": "First Name",
110          "object_field": "first_name",
111          "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.",
112          "error_code": 22217
113        },
114        {
115          "friendly_name": "Last Name",
116          "object_field": "last_name",
117          "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.",
118          "error_code": 22217
119        }
120      ],
121      "requirement_friendly_name": "Name of Authorized Representative",
122      "requirement_name": "name_of_auth_rep_info"
123    },
124    {
125      "friendly_name": "Executed Copy of Power of Attorney",
126      "object_type": "power_of_attorney",
127      "passed": false,
128      "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.",
129      "error_code": 22216,
130      "valid": [],
131      "invalid": [],
132      "requirement_friendly_name": "Power of Attorney",
133      "requirement_name": "power_of_attorney_info"
134    },
135    {
136      "friendly_name": "Government-issued ID",
137      "object_type": "government_issued_document",
138      "passed": false,
139      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
140      "error_code": 22216,
141      "valid": [],
142      "invalid": [
143        {
144          "friendly_name": "First Name",
145          "object_field": "first_name",
146          "failure_reason": "The First Name is missing on the Governnment-Issued ID.",
147          "error_code": 22217
148        },
149        {
150          "friendly_name": "Last Name",
151          "object_field": "last_name",
152          "failure_reason": "The Last Name is missing on the Government-issued ID",
153          "error_code": 22217
154        }
155      ],
156      "requirement_friendly_name": "Name of Person granted the Power of Attorney",
157      "requirement_name": "name_in_power_of_attorney_info"
158    }
159  ]
160}

Fetch specific Evaluation Instance.

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the customer_profile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<EL>required

Not PII

The unique string that identifies the Evaluation resource.

Pattern: ^EL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch an Evaluation

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchCustomerProfileEvaluation() {
11  const customerProfilesEvaluation = await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .customerProfilesEvaluations("ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(customerProfilesEvaluation.sid);
17}
18
19fetchCustomerProfileEvaluation();

Output

1{
2  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "status": "noncompliant",
7  "date_created": "2020-04-28T18:14:01Z",
8  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9  "results": [
10    {
11      "friendly_name": "Business",
12      "object_type": "business",
13      "passed": false,
14      "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.",
15      "error_code": 22214,
16      "valid": [],
17      "invalid": [
18        {
19          "friendly_name": "Business Name",
20          "object_field": "business_name",
21          "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information.",
22          "error_code": 22215
23        },
24        {
25          "friendly_name": "Business Registration Number",
26          "object_field": "business_registration_number",
27          "failure_reason": "The Business Registration Number is missing. Please enter in a Business Registration Number on the Business information.",
28          "error_code": 22215
29        },
30        {
31          "friendly_name": "First Name",
32          "object_field": "first_name",
33          "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information.",
34          "error_code": 22215
35        },
36        {
37          "friendly_name": "Last Name",
38          "object_field": "last_name",
39          "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information.",
40          "error_code": 22215
41        }
42      ],
43      "requirement_friendly_name": "Business",
44      "requirement_name": "business_info"
45    },
46    {
47      "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative",
48      "object_type": "commercial_registrar_excerpt",
49      "passed": false,
50      "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.",
51      "error_code": 22216,
52      "valid": [],
53      "invalid": [
54        {
55          "friendly_name": "Business Name",
56          "object_field": "business_name",
57          "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.",
58          "error_code": 22217
59        }
60      ],
61      "requirement_friendly_name": "Business Name",
62      "requirement_name": "business_name_info"
63    },
64    {
65      "friendly_name": "Excerpt from the commercial register showing French address",
66      "object_type": "commercial_registrar_excerpt",
67      "passed": false,
68      "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.",
69      "error_code": 22216,
70      "valid": [],
71      "invalid": [
72        {
73          "friendly_name": "Address sid(s)",
74          "object_field": "address_sids",
75          "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address.",
76          "error_code": 22219
77        }
78      ],
79      "requirement_friendly_name": "Business Address (Proof of Address)",
80      "requirement_name": "business_address_proof_info"
81    },
82    {
83      "friendly_name": "Excerpt from the commercial register (Extrait K-bis)",
84      "object_type": "commercial_registrar_excerpt",
85      "passed": false,
86      "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.",
87      "error_code": 22216,
88      "valid": [],
89      "invalid": [
90        {
91          "friendly_name": "Document Number",
92          "object_field": "document_number",
93          "failure_reason": "The Document Number is missing. Please enter in the Document Number shown on the Excerpt from the commercial register (Extrait K-bis).",
94          "error_code": 22217
95        }
96      ],
97      "requirement_friendly_name": "Business Registration Number",
98      "requirement_name": "business_reg_no_info"
99    },
100    {
101      "friendly_name": "Government-issued ID",
102      "object_type": "government_issued_document",
103      "passed": false,
104      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
105      "error_code": 22216,
106      "valid": [],
107      "invalid": [
108        {
109          "friendly_name": "First Name",
110          "object_field": "first_name",
111          "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.",
112          "error_code": 22217
113        },
114        {
115          "friendly_name": "Last Name",
116          "object_field": "last_name",
117          "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.",
118          "error_code": 22217
119        }
120      ],
121      "requirement_friendly_name": "Name of Authorized Representative",
122      "requirement_name": "name_of_auth_rep_info"
123    },
124    {
125      "friendly_name": "Executed Copy of Power of Attorney",
126      "object_type": "power_of_attorney",
127      "passed": false,
128      "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.",
129      "error_code": 22216,
130      "valid": [],
131      "invalid": [],
132      "requirement_friendly_name": "Power of Attorney",
133      "requirement_name": "power_of_attorney_info"
134    },
135    {
136      "friendly_name": "Government-issued ID",
137      "object_type": "government_issued_document",
138      "passed": false,
139      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
140      "error_code": 22216,
141      "valid": [],
142      "invalid": [
143        {
144          "friendly_name": "First Name",
145          "object_field": "first_name",
146          "failure_reason": "The First Name is missing on the Governnment-Issued ID.",
147          "error_code": 22217
148        },
149        {
150          "friendly_name": "Last Name",
151          "object_field": "last_name",
152          "failure_reason": "The Last Name is missing on the Government-issued ID",
153          "error_code": 22217
154        }
155      ],
156      "requirement_friendly_name": "Name of Person granted the Power of Attorney",
157      "requirement_name": "name_in_power_of_attorney_info"
158    }
159  ]
160}

Retrieve a list of Evaluations associated to the customer_profile resource.

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeinteger

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple Evaluations

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listCustomerProfileEvaluation() {
11  const customerProfilesEvaluations = await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .customerProfilesEvaluations.list({ limit: 20 });
14
15  customerProfilesEvaluations.forEach((c) => console.log(c.sid));
16}
17
18listCustomerProfileEvaluation();

Output

1{
2  "results": [],
3  "meta": {
4    "page": 0,
5    "page_size": 50,
6    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0",
7    "previous_page_url": null,
8    "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations?PageSize=50&Page=0",
9    "next_page_url": null,
10    "key": "results"
11  }
12}