Create a new customer

Create a new customer with details such as name, contact information, and identification. Customers can be individuals or businesses and are created in ACTIVE status by default.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Customer details including name, contact information, and identification.

string

Reference id assigned by the program manager.

string
enum

The customer type.

Allowed:
individual
object

Details of the individual customer.

business
object

Details of the business customer.

owners
object

The details of the customer with type JOINT_TENANCY.

string
enum

Preferred mode of communication for the customer.

Allowed:
boolean

Indication of customer’s consent to receive all communication via email.

linkedDocument
array of objects

Identification documents for the customer.

linkedDocument
programAffiliate
object

Program affiliate under whom the customer is onboarded.

Headers
string
enum
required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses

201

The entity has been created successfully.

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with Promise Mode as ALWAYS.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json