Accounts
Account mgmt APIs
Tax document list
2 min
{ "name" "endpoint /core/v1/dda/accounts/{accountnumber}/tax documents/", "method" "get", "url" " https //sandbox crbcos com/core/v1/dda/accounts/{accountnumber}/tax documents/", "description" "when the account is over a year old, returns a list of the tax documents associated with the specified account based on query criteria the list includes each document's unique guid, which you need to pull a specific document the response values below are repeated for each document in the list \n\nonce you have the document id use get /core/v1/dda/accounts/{accountnumber}/tax documents/{id} to pull an individual document ", "tab" "examples", "examples" { "languages" \[ { "id" "h7b5xnrx rlojzazypt5j", "language" "curl", "code" "curl location 'https //sandbox crbcos com/core/v1/dda/accounts/2203250853/tax documents' \\\\\n header 'authorization bearer \<token>'", "customlabel" "" }, { "id" "4rmypdripkuflkl9bjfgy", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' '/core/v1/dda/accounts/2203250853/tax documents?accountnumber=string\&status=string\&documenttype=string\&year=integer',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "7l 7exagtnyamwe0wq2uk", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/core/v1/dda/accounts/2203250853/tax documents?accountnumber=string\&status=string\&documenttype=string\&year=integer\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "22p0mytyozs5ayyprc xk", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/core/v1/dda/accounts/2203250853/tax documents?accountnumber=string\&status=string\&documenttype=string\&year=integer\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" }, { "id" "pxd ftns7ovee1mk3xssm", "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/dda/accounts/2203250853/tax documents\\"\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" "h7b5xnrx rlojzazypt5j" }, "results" { "languages" \[ { "id" "inq22wdzxrqff2cdgnja6", "language" "200", "customlabel" "", "code" "{ \\"results\\" \n \[\n\n\n\n ],\n \\"pagenumber\\" 1,\n \\"pagesize\\" 0,\n \\"haspreviouspage\\" false,\n \\"hasnextpage\\" false\n}" } ], "selectedlanguageid" "inq22wdzxrqff2cdgnja6" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "number of the customer's account that earns tax reportable income", "" "number of the customer's account that earns tax reportable income" } ], "queryparameters" \[ { "name" "status", "kind" "optional", "type" "string", "description" "status of the document in the cross river system \n importing\n active\n recalled", "" "status" }, { "name" "documenttype", "kind" "optional", "type" "string", "description" "document type the query returns information about \n form1099int\n unknown", "" "document type the query returns information about \n form1099int\n unknown" }, { "name" "year", "kind" "optional", "type" "integer", "description" "year the document covers, in the format yyyy", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "cross river system id of the specific document, in guid format use this id to get the document in pdf format " }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "the account number used in your request", "children" \[] }, { "name" "customerid", "kind" "optional", "type" "string", "description" "the 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 \n\nthe id is in guid format ", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "document status in the system \n importing\n active\n recalled", "children" \[] }, { "name" "documenttype", "kind" "optional", "type" "string", "description" "document type the query returns information about \n form1099int\n unknown", "children" \[] }, { "name" "year", "kind" "optional", "type" "string", "description" "year the document covers, in the format yyyy", "children" \[] }, { "name" "iscorrection", "kind" "optional", "type" "boolean", "description" "true if the document is a correction to a previously generated document otherwise, false ", "children" \[] }, { "name" "productid", "kind" "optional", "type" "string", "description" "id in guid format of your specific product type on which the account is based provided by cross river ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cross river system this id is in guid format ", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "when the document was created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "recalledat", "kind" "optional", "type" "string", "description" "when the document was recalled, for example for a correction 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" \[] } ] } important only pull documents as needed if you want to pull a large number of documents, speak to your relationship manager the irs requires cross river to provide account holders with an irs form 1099 for earnings equal to or greater than $10 00, per taxpayer identification number (tin) should the customer have more than one account, the system generates a 1099 for each account if the earnings of all accounts total $10 00 or more