Customer Management

Overview

The first step to opening a deposit account is establishing a customer record. One or more customers can then be assigned to an account through customer relationships.

For more technical information, view the API reference.

Customer Onboarding

The Customer record is the primary resource containing customer information. The customer record supports either classifications of type Personal or Business . Once onboarded, a customer can be associated with one or more accounts.

POST /core/v1/cm/customers
{
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "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
  }
}

A business customer such as corporation or LLC can be onboarded using a slightly different request.

POST /core/v1/cm/customers
{
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "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": "00000000-0000-0000-0000-000000000000",
  }
}

The primaryOwnerCustomerId is expecting a customer ID referencing a customer record of type Personal. So in order to onboard a business, the first step is to create a personal customer record for the primary owner of that business.

Beneficial Owners

The Beneficial Owner resource is required for each person owning 25% or more of the business. The ownerCustomerId field references a Personal customer record for the business owner. These resources will typically be added immediately after the business has been onboarded.

POST /core/v1/cm/customers/{businessCustomerId}/beneficial-owners
{
  "ownerCustomerId": "00000000-0000-0000-0000-000000000000",
  "ownerTitle": "President"
}

Customer Name

The Name resource contains all the naming information for both persons and organizations.

PUT /core/v1/cm/customers/{id}/name
{
  "firstName": "Jane",
  "middleName": "Carol",
  "lastName": "Roberts"
}

PUT /core/v1/cm/customers/{id}/name
{
  "entityName": "Acme Co"
}

Customer Profile

The Profile resource collects various banking-relevant information for the customer.

PUT /core/v1/cm/customers/{id}/profile
{
    "regO": false,
    "citizenshipCountryCode": "US",
    "politicallyExposedPerson": false,
    "enableBackupWithholding": false,
    "backupWithholdingPercent": 0,
    "taxIdType": "Ssn",
    "taxId": "123456789",
    "birthDate": "1965-09-15",
    "riskRating": "Low",
    "privacyOptOut": true
}

PUT /core/v1/cm/customers/{id}/profile
{
    "citizenshipCountryCode": "US",    
    "enableBackupWithholding": false,
    "backupWithholdingPercent": 0,    
    "taxIdType": "Ein",
    "taxId": "123456789",
    "dateFormed": "2019-09-10",
    "entityType": "Corporation",
    "riskRating": "Low",
    "ownershipType": "LegalEntity",
    "primaryOwnerCustomerId": "00000000-0000-0000-0000-000000000000",
}

Address

Physical addresses associated with customer.

POST /core/v1/cm/customers/{id}/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

Email contact information for customer.

POST /core/v1/cm/customers/{id}/emails
{
  "isPrimary": true,
  "emailType": "Personal",
  "emailAddress": "[email protected]"
}

Phones

Phone contact information for customer.

POST /core/v1/cm/customers/{id}/phones
{
  "phoneType": "Home",
  "isPrimary": true,
  "phoneNumber": "2015551234"
}

Identifications

Identifications are used to track meta data for customer identifying documents such as driver's licenses and passports.

POST /core/v1/cm/customers/{id}/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",
}