Set up Cross River
Customer Management

Onboard a customer API

3min

Use Cross River (CR) APIs to manage your customer information (called a customer record). You need a customer record, for example, to open a deposit account or create a debit card. Customer management APIs are found in the core module of our COS sandbox.

Get started with Cross River APIs.

Action

API Call

Description

Onboard a customer

POST /core/v1/cm/customers

Creates a new customer record

Onboard a customer

The customer record is the primary resource that contains customer information and supports the classification of Personal or Business. Once onboarded, a customer can be associated with one or more accounts

Some customer endpoints include a dueDiligence resource that may or may not be required when onboarding personal customers. Your assigned compliance liaison communicates requirements for any Due Diligence fields during your onboarding process.

Creates a new customer record.
POST
Request
Response
Body Parameters
partnerID
String
required
Your ID in the CR system. This ID is in GUID format.
name
Object
required
Account holder name in detail
classification
String
required
The classification type of the account being created: Personal (an individual) Business (a legal entity)
profile
Object
required
Customer banking-relevant information
dueDiligence
Object
optional
Details for due diligence compliance for an individual customer. To be used when required.
businessDueDiligence
Object
optional
Details for due diligence compliance for a business entity. To be used when required.
clientIdentifier
String
optional
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes. 50 characters maximum
primaryAddress
Object
optional
Main address for the customer
primaryPhone
Object
optional
Main phone number for the customer
primaryEmail
Object
optional
Main email address for the customer
primaryIdentification
Object
optional
Identification metadata of customer-identifying documents, such as a driver's license or passport


Associated webhook events

Event Name

Description

Core.Customer.Onboarded

New customer was onboarded

Core.Customer.Profile.Changed

Customer profile was changed

Core.Customer.Name.Changed

Customer name changed

Core.Customer.CifNumber.Changed



Core.Customer.Address.Added

Customer address was added

Core.Customer.Address.Changed

Customer address was changed

Core.Customer.Address.Removed

Customer address was removed

Core.Customer.Phone.Added

Customer phone number was added

Core.Customer.Phone.Changed

Customer phone number was changed

Core.Customer.Phone.Removed

Customer phone number was removed

Core.Customer.Identification.Added

Customer identification was added

Core.Customer.Identification.Changed

Customer identification changed

Core.Customer.Identification.Removed

Customer identification was removed

Core.Customer.Email.Added

Customer email was added

Core.Customer.Email.Changed

Customer email was changed

Core.Customer.Email.Removed

Customer email was removed

Core.Customer.Ofac.Changed

Customer OFAC scan resulted in a status change

Core.Customer.PepScan.Changed

Customer PEP Scan resulted in a status change



Updated 17 Feb 2025
Did this page help you?
PREVIOUS
Onboard a customer
NEXT
Add a beneficial owner
Docs powered by Archbee