Set up Cross River
Customer Management
12min
manage your customer information in the cross river operating system (cos) using either apis or cos explorer this information includes basic details needed to open a bank account or use a credit card, as well as more specific data about the customer, as needed we call this a customer record before you can open a deposit account or create a debit card you must establish the customer record, sometimes called onboarding you can then assign one or more customers to an account through customer relationships customer onboarding the customer record is the primary resource containing customer information therefore, before creating an account for a customer, you must onboard that customer the customer record supports classifications of type personal or business once onboarded, you can associate a customer with one or more accounts the example below shows an onboarding request for a personal customer onboard person request 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 i mportant 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 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 resourcesto the business customer record immediately after onboarding a business post /core/v1/cm/customers/{businesscustomerid}/beneficial owners { "ownercustomerid" "c1210a2d 932e 43ca be29 f358a4382385", "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" "be22a7da f15c 4678 8524 2b2650f929d9", } 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" "john smith\@crossriver com" } 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 metadata 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", } error codes see reference codes , along with lots of other reference information, on the cos reference codes page