Customer record
What is a customer record
Most of the time, if you want to offer a feature or service your customers through Cross River, you must first create a customer record, sometimes called onboarding the customer. A customer record is just that, a record of details of an individual or business. This record includes customer communication details, tax information and other data. The customer record is a primary source of information for creating a bank account, for example. You can associate a customer with more than one bank account.
Cross River also uses the customer record for the Know Your Customer () and Know your Business () activities.
Create/onboard a customer either by API or using COS Explorer.
IMPORTANT Some customer endpoints include a dueDiligence resource that may or may not be required when onboarding customers. Your assigned compliance liaison communicates requirements for any Due Diligence fields during your onboarding process. Due diligence fields also appear when you create a customer using COS Explorer.
API Examples
The example below shows how to onboard a customer for a personal customer.
POST /core/v1/cm/customers
{
"partnerId": "7cc038be-fde9-4455-b27b-1497cf667362",
"name": {
"prefix": "Mr.",
"firstName": "John",
"middleName": "Robert",
"lastName": "Smith",
"suffix": "Jr.",
"preferredName": "Jim"
},
"classification": "Personal",
"profile": {
"regO": false,
"citizenshipCountryCode": "US",
"politicallyExposedPerson": false,
"enableBackupWithholding": false,
"backupWithholdingPercent": 0,
"taxIdType": "Ssn",
"taxId": "123456789",
"birthDate": "1965-09-15",
"riskRating": "Low",
"privacyOptOut": true
}
}Onboard a business customer such as corporation or LLC using the same endpoint with slightly different attributes.
POST /core/v1/cm/customers
{
"partnerId": "a24cba49-2bb6-431d-a867-1de81d6e4127",
"name": {
"entityName": "ACME CO",
},
"classification": "Business",
"profile": {
"citizenshipCountryCode": "US",
"enableBackupWithholding": false,
"backupWithholdingPercent": 0,
"taxIdType": "Ein",
"taxId": "123456789",
"dateFormed": "2019-09-10",
"entityType": "Corporation",
"riskRating": "Low",
"ownershipType": "LegalEntity",
"primaryOwnerCustomerId": "f9321f7f-3712-46e1-b965-2b79ead64dc9",
}
}Regardless of whether you are onboarding a personal or business customer, the primaryOwnerCustomerId attribute must contain a customer ID referencing a customer record of type Personal. So to onboard a business, you must first create a personal customer record for the primary owner of that business.
Beneficial owners
A beneficial owner is a person who owns 25% or more of a business. For regulatory reasons, you need to create a beneficial owner resource in a Business customer record for each beneficial owner of that business. The ownerCustomerId attribute references the Personal customer record for each beneficial owner. You usually add beneficial owner resources to the business customer record immediately after onboarding a business.
POST /core/v1/cm/customers/{customerId}/beneficial-owners
{
"ownerCustomerId": "c1210a2d-932e-43ca-be29-f358a4382385",
"ownerTitle": "President"
}Address
The physical addresses associated with customer can be updated.
POST /core/v1/cm/customers/{customerId}/addresses
{
"isPrimary": true,
"status": "Active",
"classification": "Residential",
"addressType": "Home",
"street1": "123 Maple Street",
"street2": "Apt. 12",
"street3": "",
"city": "New York",
"state": "NY",
"postalCode": "10025",
"countryCode": "US",
}Email addresses
Add email contact information for customer.
POST /core/v1/cm/customers/{customerId}/emails
{
"isPrimary": true,
"emailType": "Personal",
"emailAddress": "[email protected]"
}Phones
Add phone contact information for customer.
POST /core/v1/cm/customers/{customerId}/phones
{
"phoneType": "Home",
"isPrimary": true,
"phoneNumber": "2015551234"
}Identifications
Identifications are used to track metadata for customer-identifying documents such as driver's licenses and passports. Add identification can be used to add new ID details.
POST /core/v1/cm/customers/{customerId}/identifications
{
"isPrimary": true,
"idNumber": "DL123456789",
"idType": "DriversLicense",
"issuedDate": "2018-08-30",
"expDate": "2018-08-30",
"verifiedDate": "2018-08-30",
"issuingAuthority": "NJ DMV",
"issuingStateOrProvince": "NJ",
"issuingCountryCode": "US",
}