Create a new Evaluation

POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations
Account sid auth token

Create a new Evaluation

Path parameters

  • CustomerProfileSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • PolicySid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RN[0-9a-fA-F]{32}$.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The unique string that identifies the Evaluation resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EL[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the customer_profile resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • policy_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RN[0-9a-fA-F]{32}$.

    • customer_profile_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

    • status string

      The compliance status of the Evaluation resource.

      Values are compliant or noncompliant.

    • results array | null

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

    • date_created string(date-time) | null
    • url string(uri) | null
POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations 
curl \
 --request POST 'https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
Request examples 
{"PolicySid"=>"RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{"PolicySid"=>"RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{"PolicySid"=>"RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
Response examples (201) 
{
  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "noncompliant",
  "results": [
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22215,
          "object_field": "business_name",
          "friendly_name": "Business Name",
          "failure_reason": "The Business Name is missing. Please enter in a Business Name on the Business information."
        },
        {
          "error_code": 22215,
          "object_field": "business_registration_number",
          "friendly_name": "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,
          "object_field": "first_name",
          "friendly_name": "First Name",
          "failure_reason": "The First Name is missing. Please enter in a First Name on the Business information."
        },
        {
          "error_code": 22215,
          "object_field": "last_name",
          "friendly_name": "Last Name",
          "failure_reason": "The Last Name is missing. Please enter in a Last Name on the Business information."
        }
      ],
      "error_code": 22214,
      "object_type": "business",
      "friendly_name": "Business",
      "failure_reason": "A Business End-User is missing. Please add one to the regulatory bundle.",
      "requirement_name": "business_info",
      "requirement_friendly_name": "Business"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22217,
          "object_field": "business_name",
          "friendly_name": "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": 22216,
      "object_type": "commercial_registrar_excerpt",
      "friendly_name": "Excerpt from the commercial register (Extrait K-bis) showing name of Authorized Representative",
      "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.",
      "requirement_name": "business_name_info",
      "requirement_friendly_name": "Business Name"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22219,
          "object_field": "address_sids",
          "friendly_name": "Address sid(s)",
          "failure_reason": "The Address is missing. Please enter in the address shown on the Excerpt from the commercial register showing French address."
        }
      ],
      "error_code": 22216,
      "object_type": "commercial_registrar_excerpt",
      "friendly_name": "Excerpt from the commercial register showing French address",
      "failure_reason": "An Excerpt from the commercial register showing French address is missing. Please add one to the regulatory bundle.",
      "requirement_name": "business_address_proof_info",
      "requirement_friendly_name": "Business Address (Proof of Address)"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22217,
          "object_field": "document_number",
          "friendly_name": "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": 22216,
      "object_type": "commercial_registrar_excerpt",
      "friendly_name": "Excerpt from the commercial register (Extrait K-bis)",
      "failure_reason": "An Excerpt from the commercial register (Extrait K-bis) is missing. Please add one to the regulatory bundle.",
      "requirement_name": "business_reg_no_info",
      "requirement_friendly_name": "Business Registration Number"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22217,
          "object_field": "first_name",
          "friendly_name": "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,
          "object_field": "last_name",
          "friendly_name": "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": 22216,
      "object_type": "government_issued_document",
      "friendly_name": "Government-issued ID",
      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
      "requirement_name": "name_of_auth_rep_info",
      "requirement_friendly_name": "Name of Authorized Representative"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [],
      "error_code": 22216,
      "object_type": "power_of_attorney",
      "friendly_name": "Executed Copy of Power of Attorney",
      "failure_reason": "An Executed Copy of Power of Attorney is missing. Please add one to the regulatory bundle.",
      "requirement_name": "power_of_attorney_info",
      "requirement_friendly_name": "Power of Attorney"
    },
    {
      "valid": [],
      "passed": false,
      "invalid": [
        {
          "error_code": 22217,
          "object_field": "first_name",
          "friendly_name": "First Name",
          "failure_reason": "The First Name is missing on the Governnment-Issued ID."
        },
        {
          "error_code": 22217,
          "object_field": "last_name",
          "friendly_name": "Last Name",
          "failure_reason": "The Last Name is missing on the Government-issued ID"
        }
      ],
      "error_code": 22216,
      "object_type": "government_issued_document",
      "friendly_name": "Government-issued ID",
      "failure_reason": "A Government-issued ID is missing. Please add one to the regulatory bundle.",
      "requirement_name": "name_in_power_of_attorney_info",
      "requirement_friendly_name": "Name of Person granted the Power of Attorney"
    }
  ],
  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2020-04-28T18:14:01Z",
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "compliant",
  "results": [
    {
      "valid": [
        {
          "passed": true,
          "error_code": null,
          "object_field": "first_name",
          "friendly_name": "First Name",
          "failure_reason": null
        },
        {
          "passed": true,
          "error_code": null,
          "object_field": "last_name",
          "friendly_name": "Last Name",
          "failure_reason": null
        },
        {
          "passed": true,
          "error_code": null,
          "object_field": "email",
          "friendly_name": "Email Address",
          "failure_reason": null
        },
        {
          "passed": true,
          "error_code": null,
          "object_field": "phone_number",
          "friendly_name": "Phone Number",
          "failure_reason": null
        }
      ],
      "passed": true,
      "invalid": [],
      "error_code": null,
      "object_type": "starter_customer_profile_information",
      "friendly_name": "Information",
      "failure_reason": null,
      "requirement_name": "starter_customer_profile_information",
      "requirement_friendly_name": "Starter Customer Profile Information"
    },
    {
      "valid": [
        {
          "passed": true,
          "error_code": null,
          "object_field": "address_sids",
          "friendly_name": "address sids",
          "failure_reason": null
        }
      ],
      "passed": true,
      "invalid": [],
      "error_code": null,
      "object_type": "customer_profile_address",
      "friendly_name": "Legal Company Address",
      "failure_reason": null,
      "requirement_name": "customer_profile_address",
      "requirement_friendly_name": "Customer Profile Address"
    },
    {
      "valid": [
        {
          "passed": true,
          "error_code": null,
          "object_field": "bundle_sid",
          "friendly_name": "Supporting Bundle Status",
          "failure_reason": null
        }
      ],
      "passed": true,
      "invalid": [],
      "error_code": null,
      "object_type": "primary_customer_profile_type_business",
      "friendly_name": "Primary Customer Profile Bundle",
      "failure_reason": null,
      "requirement_name": "primary_customer_profile",
      "requirement_friendly_name": "Primary Customer Profile"
    }
  ],
  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2023-03-15T13:51:57Z",
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "sid": "ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations/ELaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "compliant",
  "results": [
    {
      "valid": [
        {
          "passed": true,
          "error_code": null,
          "object_field": "brand_name",
          "friendly_name": "Brand Name",
          "failure_reason": null
        },
        {
          "passed": true,
          "error_code": null,
          "object_field": "mobile_phone_number",
          "friendly_name": "Mobile Phone Number",
          "failure_reason": null
        },
        {
          "passed": true,
          "error_code": null,
          "object_field": "vertical",
          "friendly_name": "Vertical",
          "failure_reason": null
        }
      ],
      "passed": true,
      "invalid": [],
      "error_code": null,
      "object_type": "sole_proprietor_information",
      "friendly_name": "Sole Proprietor Information",
      "failure_reason": null,
      "requirement_name": "sole_proprietor_information",
      "requirement_friendly_name": "Sole Proprietor Information"
    },
    {
      "valid": [
        {
          "passed": true,
          "error_code": null,
          "object_field": "bundle_status",
          "friendly_name": "Supporting Bundle Status",
          "failure_reason": null
        }
      ],
      "passed": true,
      "invalid": [],
      "error_code": null,
      "object_type": "starter_customer_profile_type_business",
      "friendly_name": "Starter Customer Profile(isv customers) Proof",
      "failure_reason": null,
      "requirement_name": "customer_profile",
      "requirement_friendly_name": "Customer Profile"
    }
  ],
  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2023-03-15T13:51:57Z",
  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}