Deactivate customer

api reference deactivates a specific customer record using the customer id the customer record is not deleted if the customer to be deactivated has a relationship with an account, you cannot deactivate the customer record { "name" "endpoint /core/v1/cm/customers/{id}", "method" "delete", "url" "https //sandbox crbcos com/core/v1/cm/customers/{id}", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "mlk ypcj mebm3hc o1v9", "language" "curl", "code" "curl location request delete 'https //sandbox crbcos com/core/v1/cm/customers/68f217df f9f4 4bd6 8568 b39900888a57'", "customlabel" "" }, { "id" "9fcocakxvj6nlnmhwoqjh", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'delete',\n 'hostname' 'sandbox crbcos com',\n 'path' '/core/v1/cm/customers/68f217df f9f4 4bd6 8568 b39900888a57',\n 'headers' {\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 http client\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = ''\nheaders = {}\nconn request(\\"delete\\", \\"/core/v1/cm/customers/68f217df f9f4 4bd6 8568 b39900888a57\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "customlabel" "" }, { "id" "nivnc7zwbgr9uejupdwmi", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/cm/customers/68f217df f9f4 4bd6 8568 b39900888a57\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http delete new(url)\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/68f217df f9f4 4bd6 8568 b39900888a57\\"\n method = \\"delete\\"\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 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", "code" "{\n \\"id\\" \\"68f217df f9f4 4bd6 8568 b39900888a57\\",\n \\"cifnumber\\" \\"591180301965\\",\n \\"classification\\" \\"personal\\",\n \\"status\\" \\"inactive\\",\n \\"ofac\\" \\"clear\\",\n \\"pepscan\\" \\"clear\\",\n \\"internallist\\" \\"clear\\",\n \\"name\\" {\n \\"firstname\\" \\"frank\\",\n \\"lastname\\" \\"thompson\\",\n \\"fullname\\" \\"frank thompson\\"\n },\n \\"profile\\" {\n \\"rego\\" false,\n \\"citizenshipcountrycode\\" \\"us\\",\n \\"politicallyexposedperson\\" false,\n \\"enablebackupwithholding\\" false,\n \\"backupwithholdingpercent\\" 0,\n \\"taxidtype\\" \\"ssn\\",\n \\"taxid\\" \\"555663232\\",\n \\"birthdate\\" \\"1972 03 08\\",\n \\"riskrating\\" \\"low\\",\n \\"privacyoptout\\" true\n },\n \\"createdat\\" \\"2025 11 18t03 17 07 703 05 00\\",\n \\"lastmodifiedat\\" \\"2026 07 01t06 16 12 387589 04 00\\",\n \\"partnerid\\" \\"cd9c12f4 7691 424a b38b af5b0134c611\\",\n \\"duediligence\\" {\n \\"employmentstatus\\" \\"employed\\",\n \\"occupation\\" \\"technology\\",\n \\"occupationdescription\\" \\"support\\",\n \\"industry\\" \\"finance\\",\n \\"incomesource\\" \\"salary\\",\n \\"incomestate\\" \\"ny\\",\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 \\"clientidentifier\\" \\"35ba6120 f860 4caa 9479 b5aaebeca49d\\"\n}", "customlabel" "" } ], "selectedlanguageid" "zuoamzsuzjovanqserbuz" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "the unique id assigned to the customer when the customer record is created the id is in guid format ", "" "the unique id assigned to the customer when the customer record is created the id is in guid format " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the customerid of the customer record" }, { "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 \n personal (an individual)\n business (a legal entity)", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of the customer record\n 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 business customers return only the entityname and fullname personal customers return all other fields if they have values ", "children" \[ { "name" "entityname", "kind" "optional", "type" "string", "description" "for a business customer, the legal name of the business" }, { "name" "prefix", "kind" "optional", "type" "string", "description" "prefix for name" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "customer first name" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "customer middle name" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "customer last name" }, { "name" "suffix", "kind" "optional", "type" "string", "description" "suffix for the name" }, { "name" "preferredname", "kind" "optional", "type" "string", "description" "customer preferred name" }, { "name" "fullname", "kind" "optional", "type" "string", "description" "customer's entire name including middle initial for a business customer this will be identical to the entityname " } ] }, { "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 customer \n ssn (social security number)\n ein (employer identification number)\n itin (individual tax id number)\n vat (international vat number)\n foreign (non us domestic)" }, { "name" "taxid", "kind" "required", "type" "string", "description" "tax id number" }, { "name" "riskrating", "kind" "required", "type" "string", "description" "customer risk rating \n low\n medium\n 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" "relevant only for business entities \n exempt\n excluded\n nonprofit\n legalentity" }, { "name" "primaryownercustomerid", "kind" "optional", "type" "string", "description" "customer id of the primary owner of a business account" }, { "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" } ], "hastryitout" false, "autogeneratedanchorslug" "endpoint corev1cmcustomersid", "legacyhash" "jjv8jxzfi5g3t3o6wswgb" }