Skip to main content
POST
Initialize customer

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

productId
string
required

The productId

Body

application/json
brokerageFirmId
string

Brokerage firm id to associate with the customer (used in anonymous funnels)

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Response

type
string
required

Type of the customer

id
string
required

Unique identifier for the customer

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
initializedWith
object
required

Policy and branch id created with the customer