Customer management
APIs
Add beneficial owner
1 min
{ "name" "endpoint /core/v1/cm/customers/{customerid}/beneficial owners", "method" "post", "url" "https //sandbox crbcos com/core/v1/cm/customers/{customerid}/beneficial owners", "description" "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 each beneficial owner will have a personal customer record that includes a unique customer id the ownercustomerid attribute in the call described here references the personal customer id for each beneficial owner you usually add beneficial owner resources to the business customer record immediately after onboarding a business ", "tab" "examples", "examples" { "languages" \[ { "id" "b2qwb9wn1dtrmagdjzkxc", "language" "curl", "code" "curl location globoff 'https //sandbox crbcos com/core/v1/cm/customers/{customerid}/beneficial owners?customerid=' \\\\\n data '{\n \\"ownercustomerid\\" \\"\\",\n \\"ownertitle\\" \\"ceo\\",\n \\"ownershippercentage\\" \\"26\\"\n}'", "customlabel" "" }, { "id" "zpbcocvucgz5kitvrnnzr", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'post',\n 'hostname' 'sandbox crbcos com',\n 'path' '/core/v1/cm/customers/{customerid}/beneficial owners?customerid=',\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\nvar postdata = \\"{\\\r\\\n \\\\\\"ownercustomerid\\\\\\" \\\\\\"\\\\\\",\\\r\\\n \\\\\\"ownertitle\\\\\\" \\\\\\"ceo\\\\\\",\\\r\\\n \\\\\\"ownershippercentage\\\\\\" \\\\\\"26\\\\\\"\\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "va41mtjbvqpgptiiles c", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/core/v1/cm/customers/{customerid}/beneficial owners?customerid=\\"\n\npayload = \\"{\\\r\\\n \\\\\\"ownercustomerid\\\\\\" \\\\\\"\\\\\\",\\\r\\\n \\\\\\"ownertitle\\\\\\" \\\\\\"ceo\\\\\\",\\\r\\\n \\\\\\"ownershippercentage\\\\\\" \\\\\\"26\\\\\\"\\\r\\\n}\\"\nheaders = {}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "gmvw0uwnlhlk2cwjdclm8", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/cm/customers/{customerid}/beneficial owners?customerid=\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest body = \\"{\\\r\\\n \\\\\\"ownercustomerid\\\\\\" \\\\\\"\\\\\\",\\\r\\\n \\\\\\"ownertitle\\\\\\" \\\\\\"ceo\\\\\\",\\\r\\\n \\\\\\"ownershippercentage\\\\\\" \\\\\\"26\\\\\\"\\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "hav1d17eyu xo6d7k3v0h", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/core/v1/cm/customers/{customerid}/beneficial owners?customerid=\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"ownercustomerid\\" \\"\\",`+\\"\n\\"+`\n \\"ownertitle\\" \\"ceo\\",`+\\"\n\\"+`\n \\"ownershippercentage\\" \\"26\\"`+\\"\n\\"+`\n}`)\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, payload)\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" "b2qwb9wn1dtrmagdjzkxc" }, "results" { "languages" \[ { "id" "atm1q1y7kg6k2 cq0iwb6", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"bf3fe246 626e 4960 8e2b b300008b44e1\\",\n \\"customerid\\" \\"554fa0db ee28 4671 8d02 b300008abb4a\\",\n \\"ownercustomerid\\" \\"bbe09f0a f38b 4daa a0a2 b2ff00f4e887\\",\n \\"status\\" \\"active\\",\n \\"ownertitle\\" \\"ceo\\",\n \\"partnerid\\" \\"1101a33d fbd9 4b9e b169 b29500f12407\\",\n \\"createdat\\" \\"2025 06 18t04 27 03 7887551 04 00\\",\n \\"lastmodifiedat\\" \\"2025 06 18t04 27 03 7887551 04 00\\",\n \\"ownershippercentage\\" 26\n}" }, { "id" "hhcnoqpxig0pateobvm 6", "language" "400", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 2214,\n \\"message\\" \\"entity customer must be a business\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "atm1q1y7kg6k2 cq0iwb6" }, "request" { "pathparameters" \[ { "name" "customerid", "kind" "required", "type" "string", "description" "the customerid of the customer record being updated", "" "the customerid of the customer record being updated" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "ownercustomerid", "kind" "required", "type" "string", "description" "beneficial owner cross river customer id (provided when the beneficial owner was onboarded to cos)", "" "beneficial owner cross river customer id (provided when the beneficial owner was onboarded to cos)" }, { "name" "ownertitle", "kind" "required", "type" "string", "description" "title or role of the beneficial owner", "" "required" }, { "name" "ownershippercentage", "kind" "optional", "type" "number", "description" "percentage of the business this beneficial owner controls enter the percentage in real numbers for example, if you enter 0 20 it means 0 20% if you enter 20, it means 20% ", "" "percentage of the business this beneficial owner controls enter the percentage in real numbers for example, if you enter 0 20 it means 0 20% if you enter 20, it means 20% " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "cos id for the record, in guid format" }, { "name" "customerid", "kind" "optional", "type" "string", "description" "the customerid of the customer record being updated", "children" \[] }, { "name" "ownercustomerid", "kind" "optional", "type" "string", "description" "beneficial owner cross river customer id (provided when the beneficial owner was onboarded to cos)", "children" \[] }, { "name" "status", "kind" "optional", "type" "boolean", "description" "status of the customer record can be 'inactive' or 'active'", "children" \[] }, { "name" "ownertitle", "kind" "optional", "type" "string", "description" "title or role of the beneficial owner", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your partner id in the cross river system", "children" \[] }, { "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 ", "children" \[] }, { "name" "ownershippercentage", "kind" "optional", "type" "number", "description" "percentage of the business this beneficial owner controls enter the percentage in real numbers for example, if you enter 0 20 it means 0 20% if you enter 20, it means 20% ", "children" \[] } ] }