Send PII

api reference adds originator/sender personally identifiable information to an incoming payment this endpoint is typically used when a payment requires originator/sender information before it can continue through compliance review and posting workflows { "name" "endpoint /v1/payments/{id}/pii", "method" "post", "url" "https //sandbox crbcos com/crypto/v1/payments/{id}/pii", "tab" "examples", "examples" { "languages" \[ { "id" "curl example", "language" "curl", "code" "curl x post https //sandbox crbcos com/crypto/v1/payments/05130f80 74b8 43f7 9221 341807e570ba/pii \\\\\\\\\n h \\"authorization bearer your access token\\" \\\\\\\\\n h \\"content type application/json\\" \\\\\\\\\n d '{\n \\"name\\" \\"john doe\\",\n \\"addressline1\\" \\"2115 linwood ave\\",\n \\"addressline2\\" \\"apt 4b\\",\n \\"city\\" \\"fort lee\\",\n \\"stateprovince\\" \\"nj\\",\n \\"countrycode\\" \\"us\\",\n \\"postalcode\\" \\"07024\\",\n \\"allowpiireuse\\" true\n}'" }, { "id" "nodejs example", "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' '/crypto/v1/payments/05130f80 74b8 43f7 9221 341807e570ba/pii //',\n 'headers' {\n 'content type' 'application/json'\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 \\\\\\"name\\\\\\" \\\\\\"john doe\\\\\\",\\\r\\\n \\\\\\"addressline1\\\\\\" \\\\\\"2115 linwood ave\\\\\\",\\\r\\\n \\\\\\"addressline2\\\\\\" \\\\\\"apt 4b\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"fort lee\\\\\\",\\\r\\\n \\\\\\"stateprovince\\\\\\" \\\\\\"nj\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"07024\\\\\\",\\\r\\\n \\\\\\"allowpiireuse\\\\\\" true\\\r\\\n}'\\";\n\nreq write(postdata);\n\nreq end();" }, { "id" "python example", "language" "python", "code" "import http client\nimport json\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = \\"{\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"john doe\\\\\\",\\\r\\\n \\\\\\"addressline1\\\\\\" \\\\\\"2115 linwood ave\\\\\\",\\\r\\\n \\\\\\"addressline2\\\\\\" \\\\\\"apt 4b\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"fort lee\\\\\\",\\\r\\\n \\\\\\"stateprovince\\\\\\" \\\\\\"nj\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"07024\\\\\\",\\\r\\\n \\\\\\"allowpiireuse\\\\\\" true\\\r\\\n}'\\"\nheaders = {\n 'content type' 'application/json'\n}\nconn request(\\"post\\", \\"/crypto/v1/payments/05130f80 74b8 43f7 9221 341807e570ba/pii //\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))" }, { "id" "ruby example", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/crypto/v1/payments/05130f80 74b8 43f7 9221 341807e570ba/pii //\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = \\"{\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"john doe\\\\\\",\\\r\\\n \\\\\\"addressline1\\\\\\" \\\\\\"2115 linwood ave\\\\\\",\\\r\\\n \\\\\\"addressline2\\\\\\" \\\\\\"apt 4b\\\\\\",\\\r\\\n \\\\\\"city\\\\\\" \\\\\\"fort lee\\\\\\",\\\r\\\n \\\\\\"stateprovince\\\\\\" \\\\\\"nj\\\\\\",\\\r\\\n \\\\\\"countrycode\\\\\\" \\\\\\"us\\\\\\",\\\r\\\n \\\\\\"postalcode\\\\\\" \\\\\\"07024\\\\\\",\\\r\\\n \\\\\\"allowpiireuse\\\\\\" true\\\r\\\n}'\\"\n\nresponse = https request(request)\nputs response read body\n" }, { "id" "go example", "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/crypto/v1/payments/05130f80 74b8 43f7 9221 341807e570ba/pii //\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"name\\" \\"john doe\\",`+\\"\n\\"+`\n \\"addressline1\\" \\"2115 linwood ave\\",`+\\"\n\\"+`\n \\"addressline2\\" \\"apt 4b\\",`+\\"\n\\"+`\n \\"city\\" \\"fort lee\\",`+\\"\n\\"+`\n \\"stateprovince\\" \\"nj\\",`+\\"\n\\"+`\n \\"countrycode\\" \\"us\\",`+\\"\n\\"+`\n \\"postalcode\\" \\"07024\\",`+\\"\n\\"+`\n \\"allowpiireuse\\" true`+\\"\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 req header add(\\"content type\\", \\"application/json\\")\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}" } ], "selectedlanguageid" "go example" }, "results" { "languages" \[ { "id" "200", "language" "200", "code" "{\n \\"id\\" \\"f87ee6d5 7775 46cd a6de b4570131ee00\\",\n \\"referenceid\\" \\"crp147bw063mn5\\",\n \\"partnerid\\" \\"aa554e0a 910c 435f 89ba b06c01305d57\\",\n \\"productid\\" \\"ac6686be 005f 4b05 bb4a b42f013bba12\\",\n \\"accountnumber\\" \\"123989446893\\",\n \\"direction\\" \\"inbound\\",\n \\"status\\" \\"hold\\",\n \\"blockchain\\" \\"solana\\",\n \\"currency\\" \\"usdc\\",\n \\"unit\\" \\"mwei\\",\n \\"amountnative\\" 1,\n \\"amount\\" 1000000,\n \\"netamountnative\\" 1,\n \\"netamount\\" 1000000,\n \\"feecurrency\\" \\"sol\\",\n \\"feeunit\\" \\"lamport\\",\n \\"feetype\\" \\"net\\",\n \\"feelevel\\" \\"low\\",\n \\"networkfeenative\\" 8e 05,\n \\"networkfee\\" 80000,\n \\"sourceaddress\\" \\"fvfzayzneljydghc3pwe3wumfgxgkdh6hwjrehgmzw84\\",\n \\"destinationaddress\\" \\"eulmgjikmjl7rvwy77udr16ji1zb69blqjoc6xmgf6rw\\",\n \\"source\\" \\"api\\",\n \\"createdat\\" \\"2026 05 27t18 33 51 559757z\\",\n \\"lastmodifiedat\\" \\"2026 05 27t18 33 51 575421z\\",\n \\"postingstatus\\" \\"pending\\",\n \\"transactionhash\\" \\"2k38gpiax9hfevnqxcqpmovqtyetxqqs3vrr9z2nwvwjry9p9f75p6crhdsb6g1zsyozzgmepvgcljmuaxd8lbyd\\",\n \\"paymenttype\\" \\"payment\\",\n \\"originator\\" {\n \\"fullname\\" \\"john doe\\",\n \\"addressline1\\" \\"2115 linwood\\",\n \\"addressline2\\" \\"ave\\",\n \\"city\\" \\"fort lee\\",\n \\"stateprovince\\" \\"nj\\",\n \\"postalcode\\" \\"07058\\",\n \\"countrycode\\" \\"us\\"\n },\n \\"beneficiary\\" {\n \\"entitytype\\" \\"business\\",\n \\"fullname\\" \\"abc corp\\",\n \\"addressline1\\" \\"2114 linwood ave\\",\n \\"city\\" \\"fort lee\\",\n \\"stateprovince\\" \\"nj\\",\n \\"postalcode\\" \\"07025\\",\n \\"countrycode\\" \\"us\\",\n \\"identificationtype\\" \\"incorporationnumber\\",\n \\"identificationvalue\\" \\"555599998\\"\n },\n \\"postings\\" \[]\n}\n" }, { "id" "uneh fxnnsaxua7vpbyic", "language" "204 class", "code" "{\n \\"error\\" {\n \\"code\\" 2043,\n \\"message\\" \\"the payment pii could not be added\\"\n }\n }" } ], "selectedlanguageid" "200" }, "request" { "pathparameters" \[ { "name" "id", "kind" "optional", "type" "string", "description" "unique identifier of the payment that requires originator pii this id is in uuid format ", "" "unique identifier of the payment that requires originator pii this id is in uuid format " } ], "queryparameters" \[], "headerparameters" \[], "formdataparameters" \[], "bodydataparameters" \[ { "name" "name", "kind" "required", "type" "string", "description" "full legal name of the originator maximum 200 characters ", "" "full legal name of the originator maximum 200 characters " }, { "name" "addressline1", "kind" "required", "type" "string", "description" "first line of the originator physical address maximum 80 characters ", "" "first line of the originator physical address maximum 80 characters " }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the originator physical address, if needed maximum 80 characters nullable ", "" "second line of the originator physical address, if needed maximum 80 characters nullable " }, { "name" "city", "kind" "required", "type" "string", "description" "full name of the city where the originator is located maximum 40 characters ", "" "full name of the city where the originator is located maximum 40 characters " }, { "name" "stateprovince", "kind" "required", "type" "string", "description" "state or province of the originator for us addresses, use the two letter state code " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "two letter iso country code for the originator country", "" "two letter iso country code for the originator country" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "postal or zip code of the originator maximum 20 characters ", "" "postal or zip code of the originator maximum 20 characters " }, { "name" "allowpiireuse", "kind" "optional", "type" "boolean", "description" "true if the provided pii may be reused for future applicable payments otherwise, false ", "" "true if the provided pii may be reused for future applicable payments otherwise, false " } ] }, "response" \[ { "name" "id", "kind" "returned", "type" "string", "description" "unique identifier of the incoming payment" }, { "name" "referenceid", "kind" "returned", "type" "string", "description" "unique cross river reference id for the payment the reference id always begins with a letter or letters indicating the rail for crypto the reference id starts with 'crp' " }, { "name" "partnerid", "kind" "returned", "type" "string", "description" "your unique id in the cross river system this id is in guid format " }, { "name" "productid", "kind" "returned", "type" "string", "description" "id in guid format of your specific product type on which the associated account is based provided by cross river " }, { "name" "accountnumber", "kind" "returned", "type" "string", "description" "account number associated with the payment" }, { "name" "direction", "kind" "returned", "type" "string", "description" "payment direction \n inbound\n outbound" }, { "name" "status", "kind" "returned", "type" "string", "description" "current payment status for this use case, hold indicates the inbound payment is awaiting further action \nvalues include \n created\n pending\n hold\n batched\n processing\n completed\n rejected\n canceled\n researchrequired\n transmitted\n blocked\n returned" }, { "name" "blockchain", "kind" "returned", "type" "string", "description" "blockchain network where payment was sent (for example, solana, ethereum)" }, { "name" "currency", "kind" "returned", "type" "string", "description" "asset sent (for example, usdc)" }, { "name" "unit", "kind" "returned", "type" "string", "description" "base unit used for the asset amount for example, mwei " }, { "name" "amountnative", "kind" "returned", "type" "number", "description" "amount in usd cents, if provided or computed (system converts to chain base units)" }, { "name" "amount", "kind" "returned", "type" "number", "description" "amount in blockchain base units for example, 0 01 usdc = 10,000 on 6 decimals " }, { "name" "netamountnative", "kind" "returned", "type" "number", "description" "net human readable amount of the payment, after applicable fees" }, { "name" "netamount", "kind" "returned", "type" "number", "description" "net amount in blockchain base units of the payment, after applicable fees" }, { "name" "feecurrency", "kind" "returned", "type" "string", "description" "asset used to pay the network fee " }, { "name" "feeunit", "kind" "returned", "type" "string", "description" "fee asset + unit for example, sol/lamport " }, { "name" "networkfeenative", "kind" "returned", "type" "number", "description" "human readable network fee amount" }, { "name" "networkfee", "kind" "returned", "type" "number", "description" "network fee in base units" }, { "name" "sourceaddress", "kind" "returned", "type" "string", "description" "blockchain address from which the payment originated" }, { "name" "destinationaddress", "kind" "returned", "type" "string", "description" "blockchain address that received the payment" }, { "name" "createdat", "kind" "returned", "type" "string", "description" "date and time the payment was created in the system in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lastmodifiedat", "kind" "returned", "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" "postingstatus", "kind" "returned", "type" "string", "description" "internal posting status \n pending\n posted\n failed\n canceled\n authorized\n notapplicable" }, { "name" "transactionhash", "kind" "returned", "type" "string", "description" "blockchain transaction hash" }, { "name" "originator", "kind" "returned", "type" "object", "description" "originator information added to the payment", "children" \[ { "name" "entitytype", "kind" "optional", "type" "string", "description" "type of entity \n person\n business" }, { "name" "fullname", "kind" "returned", "type" "string", "description" "full legal name of the originator (for person entities only)" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "first name of the originator (for person entities only)" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "last name of the originator (for person entities only)" }, { "name" "entityname", "kind" "optional", "type" "string", "description" "legal entity name (for business entities only)" }, { "name" "addressline1", "kind" "optional", "type" "string", "description" "first line of the originator physical address" }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the originator physical address" }, { "name" "city", "kind" "optional", "type" "string", "description" "city where the originator is located" }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "state or province of the originator" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal or zip code of the originator" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "two letter or three letter iso country code" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "date of birth for an originator who is a person, or date formed for a business originator" }, { "name" "identificationtype", "kind" "optional", "type" "string", "description" "type of identification document \n ein\n incorporationnumber" }, { "name" "identificationvalue", "kind" "optional", "type" "string", "description" "identification document number or value" } ] }, { "name" "beneficiary", "kind" "returned", "type" "object", "description" "beneficiary information associated with the payment ", "children" \[ { "name" "entitytype", "kind" "optional", "type" "string", "description" "type of entity \n person\n business" }, { "name" "fullname", "kind" "returned", "type" "string", "description" "full legal name of the beneficiary (for person entities only)" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "first name of the beneficiary (for person entities only)" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "last name of the beneficiary (for person entities only)" }, { "name" "entityname", "kind" "optional", "type" "string", "description" "legal entity name (for business entities only)" }, { "name" "addressline1", "kind" "optional", "type" "string", "description" "first line of the beneficiary physical address" }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the beneficiary physical address" }, { "name" "city", "kind" "optional", "type" "string", "description" "city where the beneficiary is located" }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "state or province of the beneficiary" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal or zip code of the beneficiary" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "two letter or three letter iso country code" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "date of birth for a beneficiary who is a person, or date formed for a business beneficiary" }, { "name" "identificationtype", "kind" "optional", "type" "string", "description" "type of identification document \n ein\n incorporationnumber" }, { "name" "identificationvalue", "kind" "optional", "type" "string", "description" "identification document number or value" } ] } ], "description" "", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "hastryitout" false, "autogeneratedanchorslug" "endpoint v1paymentsidpii", "legacyhash" "sxlhgpotwwyxd55igqwvs" }