Working with Customer Types
Customer Types allow for unique customer behaviors, data requirements, and validation to be applied while building against a standardized set of API endpoints. The Customer Type must be chosen when the initial POST /customers request is submitted and cannot be updated. If no Customer Type is submitted, then the default type of primary is used.
Each Customer Type has a different set of identifying information that is necessary in order to successfully onboard the customer. Therefore, the fields required to be submitted with the Customer resource as well as the fields that can be edited after first time activation of a Customer are determined by the Customer Type.
Data validations for all non-active Customers are run during the first attempt to onboard a Customer to a Product using the POST /customer_products endpoint. Once a Customer has been fully activated for the first time, subsequent attempts to update the Customers data will result in immediate validations being run as part of the PUT /customers/uid request.
Some Products within a program are only available to a subset of Customer Types. The list of allowed Customer Types for a Product is retrievable from the Products endpoint. Customer Types and Product requirements are configurable and unique to each program. Please work with your client support representative for proper setup.
Customer Type List
Primary
Primary Customer's represent the most typical banking customer experience on the Newline Platform. For this reason, they are the default Customer Type value that is used when no Customer Type is provided. Primary Customers are considered full account owners and have complete authority to take any actions associated with their accounts and associated resources. Primary Customers require the completion of at least one Compliance Plan, as well as an approved KYC evaluation.
Primary Customer Required Fields
| Field Name | Required |
|---|---|
external_uid | optional |
email | required |
first_name | required |
middle_name | optional |
last_name | required |
suffix | optional |
phone | required |
business_name | ignored |
ssn | required |
dob | required |
address | required |
primary_customer_uid | ignored |