Onboard a customer

/core/v1/cm/customers

Creates a new customer record.

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.

Important

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.

Request attributes

partnerId

string

Your ID in the CR system. This ID is in GUID format.

Required

name

object

Account holder name in detail

entityName

string

Name of the business if opening a business account

Optional

prefix

string

Prefix for name

Optional

firstName

string

Account holder first name. 100 characters maximum.

Required

middleName

string

Account holder middle name. 50 characters maximum.

Optional

lastName

string

Account holder last name. 100 characters maximum.

Required

suffix

string

Suffix for name

Optional

preferredName

string

Customer preferred name

Optional

fullName

string

Customer's entire name including middle intial

Optional

classification

string

The classification type of the account being created:

Personal (an individual)
Business (a legal entity)

Required

profile

object

The following attributes are included in the profile object:

regO

boolean

Pertains to loans issued to executive officers, directors, and principal shareholders of member banks

Required

citizenshipCountryCode

string

Country of citizenship (2 characters)

Optional

politicallyExposedPerson

boolean

Politically exposed person (PEP). True if PEP, otherwise false

Required

enableBackupWithholding

boolean

Enable to allow withholding taxes on interest earned. True when enabled, otherwise false.

Optional

backupWithholdingPercent

integer

If Backup Withholding is enabled, the percentage to withhold taxes on interest earned

Optional

taxIdType

string

Tax ID type for the entity: Ssn, Ein, Itin, Vat, Foreign

Required

taxId

string

Tax ID number

Required

birthDate

string

Date of birth in the format "yyy-mm-dd"

Optional

dateFormed

string

Date when legal entity was formed. In the format "yyyy-mm-dd".

Optional

entityType

string

Business entity legal classification. Also called Customer entity type.

Optional

riskRating

string

Customer risk rating: Low, Medium, High

Required

ownershipType

string

Exempt
Excluded
NonProfit
LegalEntity

Optional

primaryOwnerCustomerId

string

Customer ID of the primary owner of a business account

Optional

parentEntityId

string

The business customer related to the customer being created. Used when a customer is a sole proprietorship or doing DBA.

Optional

dateOfDeath

string

Indicates the date of a customer's passing, should that occur

Optional

privacyOptOut

boolean

Customer opts out of information sharing. True when the customer opts out, otherwise false.

Optional

dueDiligence

object

Details for due diligence compliance. To be used when required.

employmentStatus

string

How and if the customer is employed:

Employed
SelfEmployed
Retired
Unemployed
Student

occupation

string

Possible occupation types:

Executive
Sales
Consulting
Government
Healthcare
FinanceAccounting
Technology
ScienceEngineering
FoodServices
LegalServices
Manufacturing
Other

occupationDescription

string

Further details about the customer occupation. Up to 255 characters..

industry

string

Possible industries:

Agriculture
Mining
Utilities
Construction
Manufacturing
ChemicalManufacturing
MerchantWholesale
Automotive
RetailFurnishing
RetailElectronics
RetailHome
RetailFood
HealthStores
Gasoline
RetailClothing
RetailSporting
RetailNonStore
Transportation
Publishing
Finance
RealEstate
RentalServices
ProfessionalNonLegal
Accounting
Travel
EducationalMedical
PerformingArts
RecreationGambling
FoodService
Maintenance
Laundry
ReligiousCharity
PublicAdministration

incomeSource

string

Possible income sources:

Salary
SelfEmployed
Inheritance
Investments
Retirement
RentalIncome
GovernmentBenefits
FamilySupport

incomeState

string

State where customer earns income

incomeCountryCode

string

2-letter code of the country where the customer earns income

employer

string

Name of the customer employer

employerState

string

State where customer employer is based

employerCountryCode

string

2-letter code of the country where the customer's employer is based

sourceOfFunds

string

Customer funds the account from one of these sources:

SelfEmployed
GeneralEmployee
SeniorExecutive
Retired
Homemaker
InheritanceGift
Investment
Salary
BusinessOwner
Alimony
Retirement
Lottery
Annuity
TrustIncome
RealEstate
GovernmentBenefits
LegalSettlement

wealthSource

string

Source of customer wealth:

Salary
SelfEmployed
Inheritance
FamilySupport
Investments
Retirement
RentalIncome
GovernmentBenefits
BusinessSale
Other

wealthSourceDescription

string

Further details about the customer's source of wealth. Up to 255 characters.

annualIncome

integer

Customer annual income

Copy

Sample request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
curl -X POST 
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--header 'Authorization: Bearer <token>'
-d '{ \
{
  "partnerId": "ad475a30-5c89-406d-9a3e-103aa38c3ba0",
  "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
  }
}' 'https://sandbox.crbcos.com/Core/v1/cm/customers'

Response attributes

string

The unique customer ID for the onboarded customer. This ID is in GUID format.

cifNumber

string

The Customer Identification File Number

classification

string

Classification type of the account being created:

Personal (an individual)
Business (a legal entity)

status

string

Status of the customer record:

Inactive
Active

ofac

string

Status of customer on OFAC list check:

Pending
Clear
Failed
Positive
Reviewing

pepScan

string

Status of customer on PEP list check:

Pending
Clear
Failed
Positive
Reviewing

internalList

string

Status of customer on internal CR list check:

Pending
Clear
Failed
Positive
Reviewing

name

object

The following attributes are included in the name object:

entityName

string

Name of the business if opening a business account

prefix

string

Prefix for name

firstName

string

Account holder first name. 100 characters maximum.

middleName

string

Account holder middle name. 50 characters maximum.

lastName

string

Account holder last name. 100 characters maximum.

suffix

string

Suffix for name

preferredName

string

Customer preferred name

fullName

string

Customer's entire name including middle intial

profile

object

The following attributes are included in the profile object

regO

boolean

Pertains to loans issued to executive officers, directors, and principal shareholders of member banks

citizenshipCountryCode

string

Country of citizenship (2 characters)

politicallyExposedPerson

boolean

Politically exposed person (PEP). True if PEP, otherwise false.

enableBackupWithholding

boolean

Enable to allow withholding taxes on interest earned. True when enabled, otherwise false.

backupWithholdingPercent

integer

If Backup Withholding is enabled, the percentage to withhold taxes on interest earned

taxIdType

string

Tax ID type for the entity: Ssn, Ein, Itin, Vat, Foreign

taxId

string

Tax ID number

birthDate

string

Date of birth

dateFormed

string

Date when legal entity was formed

entityType

string

Business entity legal classification. Also called Customer entity type.

riskRating

string

Customer risk rating: Low, Medium, High

ownershipType

string

Exempt
Excluded
NonProfit
LegalEntity

primaryOwnerCustomerId

string

Customer ID of the primary owner of a business account

parentEntityId

string

The business customer related to the customer being created. Used when a customer is a sole proprietorship or doing DBA.

dateOfDeath

string

Indicates the date of a customer's passing, should that occur

privacyOptOut

boolean

Customer opts out of information sharing. True when the customer opts out, otherwise false.

createdAt

date/time

Time the customer was created

lastModifiedAt

date/time

Internal CR value. Date and time the database entry was last modified.

partnerId

string

Your ID in the CR system. This ID is in GUID format.

dueDiligence

object

When required, details for due diligence compliance

employmentStatus

string

Choose from:

Employed
SelfEmployed
Retired
Unemployed
Student

occupation

string

Possible occupation types:

Executive
Sales
Consulting
Government
Healthcare
FinanceAccounting
Technology
ScienceEngineering
FoodServices
LegalServices
Manufacturing
Other

occupationDescription

string

Further details about the customer occupation. Up to 255 characters..

industry

string

Possible industries:

Agriculture
Mining
Utilities
Construction
Manufacturing
ChemicalManufacturing
MerchantWholesale
Automotive
RetailFurnishing
RetailElectronics
RetailHome
RetailFood
HealthStores
Gasoline
RetailClothing
RetailSporting
RetailNonStore
Transportation
Publishing
Finance
RealEstate
RentalServices
ProfessionalNonLegal
Accounting
Travel
EducationalMedical
PerformingArts
RecreationGambling
FoodService
Maintenance
Laundry
ReligiousCharity
PublicAdministration

incomeSource

string

Possible sources of income:

Salary
SelfEmployed
Inheritance
Investments
Retirement
RentalIncome
GovernmentBenefits
FamilySupport

incomeState

string

State where customer earns income

incomeCountryCode

string

2-letter code of the country where the customer earns income

employer

string

Name of the customer employer

employerState

string

State where customer employer is based

employerCountryCode

string

2-letter code of the country where the customer's employer is based

sourceOfFunds

string

Customer is funding the account from one of these sources:

SelfEmployed
GeneralEmployee
SeniorExecutive
Retired
Homemaker
InheritanceGift
Investment
Salary
BusinessOwner
Alimony
Retirement
Lottery
Annuity
TrustIncome
RealEstate
GovernmentBenefits
LegalSettlement

wealthSource

string

Source of customer wealth:

Salary
SelfEmployed
Inheritance
FamilySupport
Investments
Retirement
RentalIncome
GovernmentBenefits
BusinessSale
Other

wealthSourceDescription

string

Further details about the customer's source of wealth. Up to 255 characters.

annualIncome

integer

Customer annual income

Copy

Sample response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "49160e7c-6c94-4898-a7cc-5457b80a3307",
  "cifNumber": "136274839562",
  "classification": "Personal",
  "status": "Active",
  "name": {
    "prefix": "Mr.",
    "firstName": "John",
    "middleName": "Robert",
    "lastName": "Smith",
    "suffix": "Jr.",
    "preferredName": "Jim"
  },
  "profile": {
    "regO": false,
    "politicallyExposedPerson": false,
    "enableBackupWithholding": false,
    "taxIdType": "Ssn",
    "taxId": "123456789",
    "birthDate": "1965-09-15",
    "riskRating": "Low",
  },
  "createdAt": "2018-08-30T14:24:42.394Z",
  "lastModifiedAt": "2018-08-30T14:24:42.394Z",
  "partnerId": "ad475a30-5c89-406d-9a3e-103aa38c3ba0"
}