Onboard a customer
Before you use banking services offered at Cross River, you need to create a customer record for each of your customers. The customer onboarding process includes creating a customer record and adding relevant customer information.
All customers are automatically scanned for regulatory compliance purposes, so you need to register for relevant webhooks events to receive customer record status updates.
In this tutorial, you'll learn how to:
✅ Register the relevant webhooks
✅ Create a new customer
✅ Add relevant customer details, including customer address and phone number
✅ Retrieve information about a customer
If you are new to customer management, we recommend you read our Customer Management documentation.
The tutorial assumes you have a knowledge of APIs and how they work. Refer to the API overview page for more details.
The tutorial uses these API endpoints.
API | Description |
---|---|
POST /core/v1/cm/customers | Create a new customer record |
GET core/v1/cm/customers/{id} | Retrieve customer information |
POST /core/v1/cm/customers/{customerId}/addresses | Add or edit the customer address |
POST /core/v1/cm/customers/{customerId}/phones | Add or edit the customer phone number |
The tutorial uses these webhooks.
Webhook | Description |
---|---|
Core.Customer.Onboarded | Notifies you that the customer record has been created |
Core.Customer.Ofac.Changed | Notifies you that a customer's OFAC status has been updated |
Core.Customer.PepScan.Changed | Notifies you that a customer's PEP status has been updated |
Make sure you have:
- Partner ID
To receive the webhook events for this tutorial you need to register each specific webhook event type. Once you are registered, the event objects are sent to the registered URLs.
The event object contains a list of resource identifiers used to download details on each event.
After the request to onboard a customer is submitted, you need to stay informed of the result of the compliance scan and that the customer record is created.
The customer record contains customer information. The customer record supports both classifications of types Personal or Business. Once registered, a customer can be associated with one or more accounts.
In this tutorial, we'll onboard Peter Griffin. First, let's create a customer record. We are registering Peter as a Personal customer.
To onboard a business customer, first create a personal customer record for the primary owner of that business.
Call POST /core/v1/cm/customers. For this call these attributes are required.
partnerId | Your unique partner ID |
---|---|
classification | The customer classification. Either:
|
name | The object containing the customer name details |
profile | The customer banking profile. This includes:
|
IMPORTANT We highly recommend you include an idempotency key in your request header to provide duplicate protection in the event of a failure.
The customer record is created.
The unique customer ID is the first line of the response body.
The Core.Customer.Onboarded webhook event is triggered when the customer record is created.
CR scans a new customer record for OFAC and PEP compliance.
Sometimes the results of the scan require a review by the our Anti-Money Laundering (AML) team.
On scan completion, Core.Customer.Ofac.Changed and Core.Customer.PepScan.Changed webhook events return with a status. Customers with no compliance issues show a Clear status.
To retrieve the results of the OFAC and PEP scans, call GET core/v1/cm/customers/{id}, where id is the customer ID in the resources attribute of both events.
In this example, the customer ID is 9052b6a5-3f09-41d1-b526-ade80104eb79
Next, you need to add the customer address and phone number. You can also add the customer email and identification information. Once you add this initial information, if needed you add more information, such as a mailing address. This tutorial will cover adding the address and phone number only. These details are considered primary information. If you add a second address, this is secondary.
Use the customer ID returned when you create the customer record to call POST /core/v1/cm/customers/{id}/addresses to add the customer address. The first address you add is the primary address.
Call POST /core/v1/cm/customers/{id}/phones to add the customer phone number. The first phone number you add is the primary phone number.
The onboarding process is considered complete when the address and phone records have been added.