Create a new Customer

post https://sandbox.newline53.com/api/v1/customers

This endpoint is used to initialize a new Customer. All request body data is optional unless otherwise specified. For customer types other than primary, customer_type must be specified .

The customer_type cannot be changed after the customer is created. Customer details accepted by Adjust Customer Data can be sent in this request if desired. See Adjust Customer Data for an example with all customer details provided.

Body Params

customer_type

string

The type of Customer. Defaults to primary.

primary_customer_uid

string | null

The UID of the Primary Customer with whom this Secondary Customer will be affiliated. Required for and only applicable to requests with customer_type secondary. Cannot be updated later from the initial value.

client_verified

boolean | null

Indicates whether the client has already performed identity verification of the Customer. The client's Program must be configured to accept this value. All Customers in a Program configured for this value must submit true in this field to complete onboarding. This value defaults to false.

external_uid

string | null

An optional Customer identifier supplied by the Partner. If supplied, must be unique among the collection of all Partner's Customers.

string | null

Email of the Customer

details

object

An object containing the supplied identifying information for the Customer

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Response

Response body

object

uid

string

Newline-generated unique id resource specific to the current endpoint

external_uid

string

length between 1 and 255

A unique identifier the Client supplies. It must be unique within the resource type. If the same value is given, no new resource will be created.

activated_at

date-time

The date and time at which this Customer was activated.

created_at

date-time

customer_type

string

The type of Customer

primary secondary sole_proprietor sub_ledger

string

Email of the Customer

client_verified

boolean

Indicates whether or not the client is responsible for identity verification of this Customer. If true, the kyc_status will be "pre_verified".

kyc_status

string | null

A value indicating the state of KYC/AML evaluation.

manual_review approved denied pending_id_documents pending_poa_documents pending_idandpoa_documents documents_provided documents_rejected retake_images pre_verified

kyc_status_reasons

array of strings | null

A list of reasons for the current kyc_status.

kyc_status_reasons

lock_reason

string | null

The lock reason provided by the Client, an admin User, or the system at the time the Customer was locked. This field will be null if and only if the locked_at is null.

locked_at

date-time | null

The date and time when the Customer was locked. This field will be null if and only if the lock_reason is null.

pii_confirmed_at

date-time

The date and time when the Customer's PII was last confirmed to be accurate

pool_uids

array of strings

A list of uids referring to Pools belonging to this Customer.

pool_uids

primary_customer_uid

string | null

The UID of the primary Customer. Null unless the customer type is secondary.

profile_responses

array of objects

A list of Profile Responses submitted by the Customer

profile_responses

object

profile_requirement

string

A statement that requires a response in order to onboard a Customer for a Product

profile_response

string

The Customer's response to the Profile Requirement as a single string value.

profile_requirement_uid

string

A UID referring to the Profile Requirement

program_uid

string

A UID referring to the program this customer belongs to

secondary_customer_uids

array of strings | null

The UIDs of secondary Customers. Null unless the customer type is primary.

secondary_customer_uids

status

string

A value indicating the overall state of this Customer.

initiated queued identity_verified active manual_review rejected pending_archival archived under_review

total_balance

string

Total asset owned by the customer in US dollars

archived_at

date-time | null

If the Customer's status is archived this will have the time at which they were archived.

details

object

An object containing the supplied identifying information for the Customer

first_name

string | null

1-40 characters

middle_name

string | null

1-40 characters

last_name

string | null

1-40 characters

suffix

string | null

1-30 characters

phone

string | null

Exactly 10 digits long (no hyphens, parentheses, or spaces)

business_name

string | null

Required for customers of type sole_proprietor and discarded otherwise. 1-256 alphanumeric characters.

ssn_last_four

string | null

dob

date | null

Follows pattern 'YYYY-MM-DD'

address

object

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.newline53.com/api/v1/customers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

201A newly created Customer is returned