Customer by ID

api reference retrieves a specific customer record by customer id { "name" "endpoint /core/v1/cm/customers/{id}", "method" "get", "url" "https //sandbox crbcos com/core/v1/cm/customers/{id}", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "mlk ypcj mebm3hc o1v9", "language" "curl", "code" "curl l 'https //sandbox crbcos com/core/v1/cm/customers/bbgfe09f0a f38b 4daa a0a2 b2ff00f4e887' ^\n h 'authorization bearer token'", "customlabel" "" }, { "id" "9fcocakxvj6nlnmhwoqjh", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'get',\n 'hostname' 'sandbox crbcos com',\n 'path' '/core/v1/cm/customers/bbgfe09f0a f38b 4daa a0a2 b2ff00f4e887',\n 'headers' {\n 'authorization' 'bearer token'\n },\n 'maxredirects' 20\n};\n\nvar req = https request(options, function (res) {\n var chunks = \[];\n\n res on(\\"data\\", function (chunk) {\n chunks push(chunk);\n });\n\n res on(\\"end\\", function (chunk) {\n var body = buffer concat(chunks);\n console log(body tostring());\n });\n\n res on(\\"error\\", function (error) {\n console error(error);\n });\n});\n\nreq end();", "customlabel" "" }, { "id" "fqlyzkhnp7mzoa8rsn6ot", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/core/v1/cm/customers/bbgfe09f0a f38b 4daa a0a2 b2ff00f4e887\\"\n\npayload = {}\nheaders = {\n 'authorization' 'bearer token'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "nivnc7zwbgr9uejupdwmi", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/cm/customers/bbgfe09f0a f38b 4daa a0a2 b2ff00f4e887\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"authorization\\"] = \\"bearer token\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "1o1fdes6spqxwjtgrqwyz", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/core/v1/cm/customers/bbgfe09f0a f38b 4daa a0a2 b2ff00f4e887\\"\n method = \\"get\\"\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, nil)\n\n if err != nil {\n fmt println(err)\n return\n }\n req header add(\\"authorization\\", \\"bearer token\\")\n\n res, err = client do(req)\n if err != nil {\n fmt println(err)\n return\n }\n defer res body close()\n\n body, err = io readall(res body)\n if err != nil {\n fmt println(err)\n return\n }\n fmt println(string(body))\n}", "customlabel" "" } ], "selectedlanguageid" "mlk ypcj mebm3hc o1v9" }, "results" { "languages" \[ { "id" "zuoamzsuzjovanqserbuz", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"bbe09f0a f38b 4daa a0a2 b2ff00f4e887\\",\n \\"cifnumber\\" \\"863128282889\\",\n \\"classification\\" \\"personal\\",\n \\"status\\" \\"active\\",\n \\"ofac\\" \\"clear\\",\n \\"pepscan\\" \\"clear\\",\n \\"internallist\\" \\"clear\\",\n \\"name\\" {\n \\"firstname\\" \\"bob\\",\n \\"middlename\\" \\"f\\",\n \\"lastname\\" \\"fergusson\\",\n \\"fullname\\" \\"bob f fergusson\\"\n },\n \\"profile\\" {\n \\"rego\\" false,\n \\"citizenshipcountrycode\\" \\"us\\",\n \\"politicallyexposedperson\\" false,\n \\"enablebackupwithholding\\" false,\n \\"backupwithholdingpercent\\" 0,\n \\"taxidtype\\" \\"ssn\\",\n \\"taxid\\" \\"553571593\\",\n \\"birthdate\\" \\"1980 03 06\\",\n \\"riskrating\\" \\"low\\",\n \\"privacyoptout\\" true\n },\n \\"createdat\\" \\"2025 06 17t10 51 41 033 04 00\\",\n \\"lastmodifiedat\\" \\"2025 06 18t05 03 31 9381844 04 00\\",\n \\"partnerid\\" \\"1101a33d fbd9 4b9e b169 b29500f12407\\",\n \\"duediligence\\" {\n \\"employmentstatus\\" \\"employed\\",\n \\"occupation\\" \\"technology\\",\n \\"occupationdescription\\" \\"support\\",\n \\"industry\\" \\"finance\\",\n \\"incomesource\\" \\"salary\\",\n \\"incomestate\\" \\"nj\\",\n \\"incomecountrycode\\" \\"us\\",\n \\"employer\\" \\"cross river\\",\n \\"employerstate\\" \\"nj\\",\n \\"employercountrycode\\" \\"us\\",\n \\"sourceoffunds\\" \\"salary\\",\n \\"wealthsource\\" \\"salary\\",\n \\"wealthsourcedescription\\" \\"salary\\",\n \\"annualincome\\" 4500000\n }\n}" } ], "selectedlanguageid" "zuoamzsuzjovanqserbuz" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "the customer id of the customer record to update", "" "the customer id of the customer record to update" } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the customerid of the customer record being updated" }, { "name" "cifnumber", "kind" "optional", "type" "string", "description" "the customer identification file (cif) number is internal to cross river, used to identify customers uniquely for compliance purposes", "children" \[] }, { "name" "classification", "kind" "optional", "type" "string", "description" "the classification type of the customer \npersonal (an individual)\nbusiness (a legal entity)", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" " inactive\n active", "children" \[] }, { "name" "ofac", "kind" "optional", "type" "string", "description" " pending\n clear\n failed\n positive\n reviewing\n notscanned", "children" \[] }, { "name" "pepscan", "kind" "optional", "type" "string", "description" " pending\n clear\n failed\n positive\n reviewing\n notscanned", "children" \[] }, { "name" "internallist", "kind" "optional", "type" "string", "description" " pending\n clear\n failed\n positive\n reviewing\n notscanned", "children" \[] }, { "name" "name", "kind" "optional", "type" "object", "description" "customer name in detail", "children" \[ { "name" "entityname", "kind" "optional", "type" "string", "description" "name of the business if opening a business account 255 character maximum " }, { "name" "prefix", "kind" "optional", "type" "string", "description" "prefix for name" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "customer first name 100 characters maximum" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "customer middle name 50 characters maximum" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "customer last name 100 characters maximum" }, { "name" "suffix", "kind" "optional", "type" "string", "description" "suffix for name" }, { "name" "preferredname", "kind" "optional", "type" "string", "description" "customer preferred name 255 character maximum" }, { "name" "fullname", "kind" "optional", "type" "string", "description" "customer's entire name including middle initial 255 characters maximum" } ] }, { "name" "profile", "kind" "required", "type" "object", "description" "customer banking relevant information", "" "customer banking relevant information", "children" \[ { "name" "taxidtype", "kind" "required", "type" "string", "description" "tax id type for the entity \n ssn\n ein\n itin\n vat\n foreign" }, { "name" "taxid", "kind" "required", "type" "string", "description" "tax id number" }, { "name" "riskrating", "kind" "required", "type" "string", "description" "customer risk rating \nlow, medium, high" }, { "name" "rego", "kind" "optional", "type" "boolean", "description" "pertains to loans issued to executive officers, directors, and principal shareholders of member banks true if the customer is one of them otherwise false \nthis attribute is not relevant for a business entity, but is required for an individual " }, { "name" "citizenshipcountrycode", "kind" "optional", "type" "string", "description" "country of citizenship (2 character iso code)" }, { "name" "politicallyexposedperson", "kind" "optional", "type" "boolean", "description" "politically exposed person (pep) true if pep, otherwise false \nthis attribute is not relevant for a business entity, but is required for an individual " }, { "name" "enablebackupwithholding", "kind" "optional", "type" "boolean", "description" "enable to allow withholding taxes on interest earned true when enabled, otherwise false " }, { "name" "backupwithholdingpercent", "kind" "optional", "type" "number", "description" "if backup withholding is enabled, the percentage to withhold taxes on interest earned" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "date of birth in the format \\"yyyy mm dd\\" \nthis attribute is not relevant for a business entity " }, { "name" "dateformed", "kind" "optional", "type" "string", "description" "date when legal entity was formed in the format \\"yyyy mm dd\\" \nnot relevant for an individual " }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "business entity legal classification also called customer entity type " }, { "name" "ownershiptype", "kind" "optional", "type" "string", "description" "exempt, excluded, nonprofit, legalentity" }, { "name" "primaryownercustomerid", "kind" "optional", "type" "string", "description" "customer id of the primary owner of a business account \nthis id is in guid format " }, { "name" "parententityid", "kind" "optional", "type" "string", "description" "the business customer related to the customer being created used when a customer is a sole proprietorship or doing dba \nthis id is in guid format " }, { "name" "dateofdeath", "kind" "optional", "type" "string", "description" "indicates the date of a customer's passing, should that occur in the format \\"yyyy mm dd\\" " }, { "name" "privacyoptout", "kind" "optional", "type" "boolean", "description" "customer opts out of information sharing true when the customer opts out, otherwise false " } ], "schema" \[ { "name" "taxidtype", "kind" "required", "type" "string", "description" "tax id type for the entity \nssn, ein, itin, vat, foreign" }, { "name" "taxid", "kind" "required", "type" "string", "description" "tax id number 9 character minimum 20 character maximum " }, { "name" "riskrating", "kind" "required", "type" "string", "description" "customer risk rating \nlow, medium, high" }, { "name" "rego", "kind" "optional", "type" "boolean", "description" "pertains to loans issued to executive officers, directors, and principal shareholders of member banks true if the customer is one of them otherwise false \nthis attribute is not relevant for a business entity" }, { "name" "citizenshipcountrycode", "kind" "optional", "type" "string", "description" "country of citizenship (2 characters)" }, { "name" "politicallyexposedperson", "kind" "optional", "type" "boolean", "description" "politically exposed person (pep) true if pep, otherwise false \nthis attribute is not relevant for a business entity" }, { "name" "enablebackupwithholding", "kind" "optional", "type" "boolean", "description" "enable to allow withholding taxes on interest earned true when enabled, otherwise false" }, { "name" "backupwithholdingpercent", "kind" "optional", "type" "integer", "description" "if backup withholding is enabled, the percentage to withhold taxes on interest earned" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "date of birth in the format \\"yyyy mm dd\\" \nthis attribute is not relevant for a business entity" }, { "name" "dateformed", "kind" "optional", "type" "string", "description" "date when legal entity was formed in the format \\"yyyy mm dd\\" \nnot relevant for an individual" }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "business entity legal classification also called customer entity type" }, { "name" "customer entity type", "kind" "optional", "type" "string", "description" "exempt, excluded, nonprofit, legalentity" }, { "name" "primaryownercustomerid", "kind" "optional", "type" "string", "description" "customer id of the primary owner of a business account \nthis id is in guid format" }, { "name" "parententityid", "kind" "optional", "type" "string", "description" "the business customer related to the customer being created used when a customer is a sole proprietorship or doing dba \nthis id is in guid format" }, { "name" "dateofdeath", "kind" "optional", "type" "string", "description" "indicates the date of a customer's passing, should that occur in the format \\"yyyy mm dd\\" " }, { "name" "privacyoptout", "kind" "optional", "type" "boolean", "description" "customer opts out of information sharing true when the customer opts out, otherwise false " } ] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the record was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format ", "children" \[] }, { "name" "duediligence", "kind" "optional", "type" "object", "description" "details for due diligence compliance for an individual customer to be used when required ", "" "details for due diligence compliance for an individual customer to be used when required", "children" \[ { "name" "employmentstatus", "kind" "optional", "type" "string", "description" "how and if the customer is employed \n employed\n selfemployed\n retired\n unemployed\n student" }, { "name" "occupation", "kind" "optional", "type" "string", "description" "possible occupation types \n executive\n sales\n consulting\n government\n healthcare\n financeaccounting\n technology\n scienceengineering\n foodservices\n legalservices\n manufacturing\n other" }, { "name" "occupationdescription", "kind" "optional", "type" "string", "description" "any further details needed about the customer's occupation" }, { "name" "industry", "kind" "optional", "type" "string", "description" "possible industries \n agriculture\n mining\n utilities\n construction\n manufacturing\n chemicalmanufacturing\n merchantwholesale\n automotive\n retailfurnishing\n retailelectronics\n retailhome\n retailfood\n healthstores\n gasoline\n retailclothing\n retailsporting\n retailnonstore\n transportation\n publishing\n finance\n realestate\n rentalservices\n professionalnonlegal\n accounting\n travel\n educationalmedical\n performingarts\n recreationgambling\n foodservice\n maintenance\n laundry\n religiouscharity\n publicadministration" }, { "name" "incomesource", "kind" "optional", "type" "string", "description" "possible income sources \n salary\n selfemployed\n inheritance\n investments\n retirement\n rentalincome\n governmentbenefits\n familysupport" }, { "name" "incomestate", "kind" "optional", "type" "string", "description" "state where customer earns income" }, { "name" "incomecountrycode", "kind" "optional", "type" "string", "description" "2 letter iso code of the country where the customer earns income" }, { "name" "employer", "kind" "optional", "type" "string", "description" "name of customer's employer" }, { "name" "employerstate", "kind" "optional", "type" "string", "description" "state where customer employer is based" }, { "name" "employercountrycode", "kind" "optional", "type" "string", "description" "2 letter iso code of the country where the customer's employer is based" }, { "name" "sourceoffunds", "kind" "optional", "type" "string", "description" "customer funds the account from one of these sources \n selfemployed\n generalemployee\n seniorexecutive\n retired\n homemaker\n inheritancegift\n investment\n salary\n businessowner\n alimony\n retirement\n lottery\n annuity\n trustincome\n realestate\n governmentbenefits\n legalsettlement" }, { "name" "wealthsource", "kind" "optional", "type" "string", "description" "source of customer wealth \n salary\n selfemployed\n inheritance\n familysupport\n investments\n retirement\n rentalincome\n governmentbenefits\n businesssale\n other" }, { "name" "wealthsourcedescription", "kind" "optional", "type" "string", "description" "further details about the customer's source of wealth" }, { "name" "annualincome", "kind" "optional", "type" "integer", "description" "customer annual income" } ], "schema" \[ { "name" "employmentstatus", "kind" "optional", "type" "string", "description" "how and if the customer is employed \n\\"employed\\"\n\\"selfemployed\\"\n\\"retired\\"\n\\"unemployed\\"\n\\"student\\"" }, { "name" "occupation", "kind" "optional", "type" "string", "description" "possible occupation types \n\\"executive\\"\n\\"sales\\"\n\\"consulting\\"\n\\"government\\"\n\\"healthcare\\"\n\\"financeaccounting\\"\n\\"technology\\"\n\\"scienceengineering\\"\n\\"foodservices\\"\n\\"legalservices\\"\n\\"manufacturing\\"\n\\"other\\"" }, { "name" "occupationdescription", "kind" "optional", "type" "string", "description" "any further details needed about the customer's occupation up to 255 characters" }, { "name" "industry", "kind" "optional", "type" "string", "description" "possible industries \nagriculture\nmining\nutilities\nconstruction\nmanufacturing\nchemicalmanufacturing\nmerchantwholesale\nautomotive\nretailfurnishing\nretailelectronics\nretailhome\nretailfood\nhealthstores\ngasoline\nretailclothing\nretailsporting\nretailnonstore\ntransportation\npublishing\nfinance\nrealestate\nrentalservices\nprofessionalnonlegal\naccounting\ntravel\neducationalmedical\nperformingarts\nrecreationgambling\nfoodservice\nmaintenance\nlaundry\nreligiouscharity\npublicadministration" }, { "name" "incomesource", "kind" "optional", "type" "string", "description" "possible income sources \nsalary\nselfemployed\ninheritance\ninvestments\nretirement\nrentalincome\ngovernmentbenefits\nfamilysupport" }, { "name" "incomestate", "kind" "optional", "type" "string", "description" "state where customer earns income" }, { "name" "incomecountrycode", "kind" "optional", "type" "string", "description" "2 letter code of the country where the customer earns income" }, { "name" "employer", "kind" "optional", "type" "string", "description" "name of customer's employer" }, { "name" "employerstate", "kind" "optional", "type" "string", "description" "state where customer employer is based" }, { "name" "employercountrycode", "kind" "optional", "type" "string", "description" "2 letter code of the country where the customer's employer is based" }, { "name" "sourceoffunds", "kind" "optional", "type" "string", "description" "customer funds the account from one of these sources \nselfemployed\ngeneralemployee\nseniorexecutive\nretired\nhomemaker\ninheritancegift\ninvestment\nsalary\nbusinessowner\nalimony\nretirement\nlottery\nannuity\ntrustincome\nrealestate\ngovernmentbenefits\nlegalsettlement" }, { "name" "wealthsource", "kind" "optional", "type" "string", "description" "source of customer wealth \nsalary\nselfemployed\ninheritance\nfamilysupport\ninvestments\nretirement\nrentalincome\ngovernmentbenefits\nbusinesssale\nother" }, { "name" "wealthsourcedescription", "kind" "optional", "type" "string", "description" "further details about the customer's source of wealth 255 characters maximum" }, { "name" "annualincome", "kind" "optional", "type" "integer", "description" "customer annual income" } ] }, { "name" "businessduediligence", "kind" "optional", "type" "object", "description" "details for due diligence compliance for a business entity to be used when required", "" "details for due diligence compliance for a business entity to be used when required", "children" \[ { "name" "natureofbusiness", "kind" "optional", "type" "string", "description" "nature of the business" }, { "name" "naics", "kind" "optional", "type" "string", "description" "business's north american industry classification system code" }, { "name" "merchantcategorycode", "kind" "optional", "type" "string", "description" "iso defined 4 digit number that classifies a business by the goods they sell or the services they provide nn characters maximum" }, { "name" "businessurl", "kind" "optional", "type" "string", "description" "url of the business" }, { "name" "relationshipformationdate", "kind" "optional", "type" "string", "description" "the date the relationship was formed" } ], "schema" \[ { "name" "natureofbusiness", "kind" "optional", "type" "string", "description" "255 characters maximum" }, { "name" "naics", "kind" "optional", "type" "string", "description" "business's north american industry classification system code" }, { "name" "merchantcategorycode", "kind" "optional", "type" "string", "description" "iso defined 4 digit number that classifies a business by the goods they sell or the services they provide nn characters maximum" }, { "name" "businessurl", "kind" "optional", "type" "string", "description" "" }, { "name" "relationshipformationdate", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes \n50 characters maximum", "" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes \n50 characters maximum" }, { "name" "primaryaddress", "kind" "optional", "type" "object", "description" "main address for the customer", "" "object", "children" \[ { "name" "addresstype", "kind" "optional", "type" "string", "description" "what this is the address of \n home\n work\n other" }, { "name" "classification", "kind" "optional", "type" "string", "description" "what kind of address this is \n residential\n business\n pobox\n rural\n military\n other" }, { "name" "isprimary", "kind" "optional", "type" "boolean", "description" "true if this is the primary address record for this customer otherwise, false" }, { "name" "street1", "kind" "optional", "type" "string", "description" "primary location details of customer, for instance, street name, house/building number, po box" }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "street3", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "city", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "state", "kind" "optional", "type" "string", "description" "state name" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code, also known as zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "id", "kind" "optional", "type" "string", "description" "database id of the primary address record for this customer id" }, { "name" "customerid", "kind" "optional", "type" "string", "description" "the unique id for the customer this address is primary for" }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the record was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format " }, { "name" "status", "kind" "optional", "type" "string", "description" "either active or inactive" } ], "schema" \[ { "name" "addresstype", "kind" "optional", "type" "string", "description" "what this is the address of \nhome\nwork\nother" }, { "name" "classification", "kind" "optional", "type" "string", "description" "what kind of address this is \nresidential\nbusiness\npobox\nrural\nmilitary\nother" }, { "name" "isprimary", "kind" "optional", "type" "boolean", "description" "true if this is the primary address record for this customer otherwise, false" }, { "name" "street1", "kind" "optional", "type" "string", "description" "primary location details of account holder, for instance, street name, house/building number, po box" }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "street3", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "city", "kind" "optional", "type" "string", "description" "city full name 50 character maximum" }, { "name" "state", "kind" "optional", "type" "string", "description" "state name 10 character maximum" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code, also known as zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "primaryemail", "kind" "optional", "type" "object", "description" "main email address for the customer", "" "main email address for the customer", "children" \[ { "name" "isprimary", "kind" "required", "type" "boolean", "description" "true if this is the primary email address record for this customer otherwise, false" }, { "name" "emailtype", "kind" "required", "type" "string", "description" "email address is \n personal\n work\n other" }, { "name" "emailaddress", "kind" "required", "type" "string", "description" "customer's primary email address" }, { "name" "id", "kind" "optional", "type" "string", "description" "unique id assigned to a customer when the customer record is created you need this id to take action for a specific customer for example, when opening an account or adding an address to a customer record " }, { "name" "customerid", "kind" "optional", "type" "string", "description" "the unique id for the customer this email address is primary for" }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the record was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format " }, { "name" "status", "kind" "optional", "type" "string", "description" "either active or inactive" } ], "schema" \[ { "name" "isprimary", "kind" "required", "type" "boolean", "description" "true if this is the primary email address record for this customer otherwise, false" }, { "name" "emailtype", "kind" "required", "type" "string", "description" "email address is \npersonal\nwork\nother" }, { "name" "emailaddress", "kind" "required", "type" "string", "description" "customer's primary email address this must be a minimum of 6 characters" } ] }, { "name" "primaryidentification", "kind" "optional", "type" "object", "description" "identification metadata of customer identifying documents, such as a driver's license or passport", "" "identification metadata of customer identifying documents, such as a driver's license or passport", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "cos id for the identification record, in guid format" }, { "name" "customerid", "kind" "optional", "type" "string", "description" "unique id assigned to a customer when the customer record is created you need this id to take action for a specific customer for example, when opening an account or adding an address to a customer record " }, { "name" "isprimary", "kind" "optional", "type" "boolean", "description" "true if this is the primary identification record for this customer otherwise, false" }, { "name" "idnumber", "kind" "optional", "type" "string", "description" "the identification number being added" }, { "name" "idtype", "kind" "optional", "type" "string", "description" "the kind of id \n driverslicense\n passport\n idcard\n socialsecurity\n other" }, { "name" "issueddate", "kind" "optional", "type" "string", "description" "date the id was issued" }, { "name" "expdate", "kind" "optional", "type" "string", "description" "date the id expires" }, { "name" "verifieddate", "kind" "optional", "type" "string", "description" "date the id was last verified" }, { "name" "issuingauthority", "kind" "optional", "type" "string", "description" "the official authority that issued the id for example, the department of motor vehicles" }, { "name" "issuingstateorprovince", "kind" "optional", "type" "string", "description" "state or province where the id was issued" }, { "name" "issuingcountrycode", "kind" "optional", "type" "string", "description" "country where the id was issued expressed as a 2 character code" }, { "name" "status", "kind" "optional", "type" "string", "description" "either active or inactive" }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the record was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format " } ], "schema" \[ { "name" "isprimary", "kind" "optional", "type" "boolean", "description" "true if this is the primary identification record for this customer otherwise, false" }, { "name" "idnumber", "kind" "optional", "type" "string", "description" "the identification number being added" }, { "name" "idtype", "kind" "optional", "type" "string", "description" "the kind of id \ndriverslicense\npassport\nidcard\nsocialsecurity\nother" }, { "name" "issueddate", "kind" "optional", "type" "string", "description" "date the id was issues" }, { "name" "expdate", "kind" "optional", "type" "string", "description" "date the id expires" }, { "name" "verifieddate", "kind" "optional", "type" "string", "description" "date the id was verified" }, { "name" "issuingauthority", "kind" "optional", "type" "string", "description" "the official authority that issued the id for example, the department of motor vehicles" }, { "name" "issuingstateorprovince", "kind" "optional", "type" "string", "description" "state or province where the id was issued" }, { "name" "issuingcountrycode", "kind" "optional", "type" "string", "description" "country where the id was issued expressed as a 2 character code" } ] }, { "name" "primaryphone", "kind" "optional", "type" "object", "description" "main phone number for the customer", "" "main phone number for the customer", "children" \[ { "name" "isprimary", "kind" "required", "type" "boolean", "description" "true if this is the primary phone number record for this customer otherwise, false" }, { "name" "phonetype", "kind" "required", "type" "string", "description" "the phone number calls a \n home\n mobile\n work\n fax" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "phone number with no spaces or other characters minimum 10, maximum 20" }, { "name" "extension", "kind" "optional", "type" "string", "description" "if the phone rings a switchboard, the entity's direct extension" }, { "name" "notes", "kind" "optional", "type" "string", "description" "additional phone information 255 character maximum" }, { "name" "status", "kind" "optional", "type" "string", "description" "either inactive or active" }, { "name" "id", "kind" "optional", "type" "string", "description" "cos id for the phone number record, in guid format" }, { "name" "customerid", "kind" "optional", "type" "string", "description" "unique id assigned to a customer when the customer record is created you need this id to take action for a specific customer for example, when opening an account or adding an address to a customer record " }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the record was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id in the cross river system this id is in guid format " } ], "schema" \[ { "name" "isprimary", "kind" "required", "type" "boolean", "description" "true if this is the primary phone number record for this customer otherwise, false" }, { "name" "phonetype", "kind" "required", "type" "string", "description" "the phone number calls a \nhome\nmobile\nwork\nfax" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "phone number with no spaces or other characters minimum 10, maximum 20" }, { "name" "extension", "kind" "optional", "type" "string", "description" "if the phone rings a switchboard, the entity's direct extension" }, { "name" "notes", "kind" "optional", "type" "string", "description" "additional phone information 255 character maximum" } ] } ], "hastryitout" false, "autogeneratedanchorslug" "endpoint corev1cmcustomersid", "legacyhash" "ep 4fp7yde669ic4karxe" }