{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e31aa056-d21a-43f1-9b35-7c503cf6b6c3","name":"Compliance Catalyst - REST Documentation - Bureau van Dijk - A Moody's Analytics Company","description":"# Announcement\n\nIn anticipation of our migration to cloud infrastructure, we are moving to a single domain for all our products. In-line with the migration we have made a new url [https://api.bvdinfo.com/v1/compliancecatalyst4/](https://desktop.postman.com/?desktopVersion=9.31.0&userId=22131433&teamId=465273) available for this end point.We encourage all users to use this url irrespective of your account being on cloud infrastructure or not. The system will redirect the users to relevant resources based on entitlement.\n\nAll current users can continue to use the old url pending migration to cloud infrastructure, however are requested to change to the new url at the earliest.\n\nFor any issues please contact customer support.\n\n# Authentication\n\nAll API requests must include your token number in the **ApiToken** property. If you require a token, please contact customer support.\n\n**Note:** This REST API adopts TLS1.2, please make sure that your environments are compliant with this specification.\n\n# Rate limitation\n\nYour account dictates the number of simultaneous calls allowed at any one time. Exceeding this count will result in a **`429`** **Too Many Requests** error. E.g. if an account is allowed to have three concurrent users, then three queries can be sent in parallel, but if a fourth query is sent before any of the three earlier queries have finished you will receive the 429 error.\n\nContact your Relationship Management Team if you require an increase in the number of parallel connections.\n\n# Pagination and limits\n\nA request can be executed against the API without the need to retrieve data points. The response contains the number of records by the searches in your request.  \nThis information is available through the property **TotalRecordsFound** in the block **SearchSummary**.\n\n## Pagination\n\nTo paginate through the results you must use the **Offset** property of the parameter [<b>Range</b>](#d6d7eff2-153e-4705-a0aa-5714fd2bf6b0) in your **Query**.\n\n## Limits\n\nSome searches can return more than _300 million results in Orbis_, which exceeds allowed limits per request. A **dynamic limitation** based on the request format and amount of data points is in place to maintain performance and enforce an absolute threshold of 4,000 records to each request.\n\n> The maximum number of records per response is always equal or less than 4,000 \n  \n\n## URL character limit for GET requests\n\nRequests using the HTTP method GET is limited to 2,000 characters due to natural URL limitations. Reaching the limit will warrant a **`401`** **\\- File or directory not found error message**. Requests exceeding this limit should be using the HTTP methhod POST instead as it doesn't have any character limitations.\n\n# General syntax\n\n## Query\n\nThis is the main placeholder for all parameters that compose your request. Both requests and responses are formatted in **JSON**.\n\n#### GLOBALS: Application settings\n\nDetermine the settings that can have a global impact on the request. For instance, you can specify the [<b>Language</b>](#101f721f-299a-4cbc-bc57-41e92f37997a) as well as your statements [<b>Preferences</b>](#73516a2f-b85a-4903-ae8b-b5439295bd86).\n\n#### SELECT: Data points\n\nDetermine the data points that will be retrieved from the database. This object takes an array of field codes associated to their (optional) [<b>Additional properties</b>](#3077235d-908a-4a52-9bf3-6bf5b3614ccc).\n\n#### RANGE: Pagination and threshold\n\nThis parameter allows you to limit the number of retrieved and paginated records. By default, if the [<b>Range</b>](#d6d7eff2-153e-4705-a0aa-5714fd2bf6b0) is omitted, the response will contain (up to) the first **100** records matching your search criteria.\n\n#### ORDERBY: Sorting\n\nSort the results according to a chosen data point (if possible). Results can either ascend or descend.\n\n#### WHERE: Searches\n\nWHERE is used to identify records in the database. Most searches are constructed by the association of a criteria and an expected result. Consult our list of available [<b>Searches</b>](#bee3a22a-97c5-43ed-b8cf-3b2f28ddc7b6) or jump straight to our [<b>Quick start requests</b>](#519bb5e5-7378-4aac-925d-ae527c16c918).\n\n# Error codes\n\n## 400 - Bad request\n\nOften linked to requests that entails a JSON formatted body, the 400 responses contain a self-descriptive message to identify the issue.\n\n**Response body example:** the query failed because **Id** is not a property available in the search by Naics2017.\n\n```\n{\n  \"At\": \"WHERE[0].Naics2017\",\n  \"Expect\": {\n    \"type:\": \"Property\",\n    \"choices:\": [\n      \"Ids\",\n      \"Text\"\n    ]\n  },\n  \"Found\": [\n    \"Id\"\n  ]\n}\n\n ```\n\n## 401 - Unauthorized\n\nThis is a common error that often occurs because of one of the scenarios below:\n\n\\* The property **ApiToken** is not specified in the header  \n\\* You are not entitled to use a specific endpoint\n\n## 402 - Payment Required\n\nThis error indicates an insufficient amount of credits to process the given request. please contact customer support or email [ClientServices@moodys.com](https://mailto:ClientServices@moodys.com) for adding credits to an account.\n\n## 404 - Not found\n\nThe resource could not be identified. Ensure you are using one of the available [<b>Endpoints</b>](#introduction).\n\n## Variances in 'Example Responses'\n\nEvery example request in this documentation features corresponding example responses. These responses are subjected to change as the Bureau van Dijk database is updated weekly. Please note that there can be instances where your result can vary from the one in the example response.\n\n## Identity Delegation by OnBehalfUserName\n\nCompliance Catalyst utilizes role definitions as a collection of permissions which also applies to the API to propagate the delegated user identity and permissions through the request chain. _OnBehalfUserName_ should therefore be included in this request with user name attached as the value. Responses of requests will be from the main-account of the sub-account connected to the API Token defined in the environment variable if _OnBehalfUserName_ isn't included in the header.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8532867","team":465273,"collectionId":"e31aa056-d21a-43f1-9b35-7c503cf6b6c3","publishedId":"SWLh4mG7","public":true,"publicUrl":"https://documenter-api.postman.tech/view/8532867/SWLh4mG7","privateUrl":"https://go.postman.co/documentation/8532867-e31aa056-d21a-43f1-9b35-7c503cf6b6c3","customColor":{"top-bar":"FFFFFF","right-sidebar":"010B47","highlight":"001489"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-01T12:50:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"> PublishingEnvironment","id":"c23abd15-d730-4d9f-85ec-6cbe71386a5c","owner":"18770795","values":[{"key":"ApiToken","value":"XXXXXXXX","enabled":true,"type":"secret"},{"key":"Domain","value":"https://api.bvdinfo.com/","enabled":true,"type":"default"},{"key":"domain","value":"https://api.bvdinfo.com/","enabled":true,"type":"default"},{"key":"username","value":"Username","enabled":true,"type":"default"},{"key":"CF_RA_ID","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a15db298f8648c979ec7e245e7c50ab8a60e4a1a601522f9715e3811687e6ac1","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"> PublishingEnvironment","value":"18770795-c23abd15-d730-4d9f-85ec-6cbe71386a5c"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWLh4mG7"}