Learn about Veridion's APIs.
It is important to keep your organization up-to-date with the latest data to avoid missing out on opportunities, losing money, or putting your company at risk. Veridion is here to assist you with fresh and accurate data.
Our APIs provide access to over 400 datapoints that are updated weekly, covering over 180 million companies worldwide, public and private.
Conventions
The base URL for all API requests is https://data.veridion.com and HTTPS is required for all requests.
Veridion's APIs follow RESTful conventions, with all operations performed via POST or GET requests. Request and response bodies are JSON encoded.
JSON Conventions
- Property names are in
snake_case - Empty fields always return as
null(includingstringandarraytypes) - Date time fields are formatted as ISO 8601 date time strings
Headers
The following headers are required to ensure that your requests are processed correctly:
Content-Type:application/json- specifies that the data being sent is in JSON format.x-api-key:<your_api_key>- your personal key that grants access to Veridion's APIs. For more information on how to authenticate requests, please refer to the Authentication section.
Versioning
The API version is reflected in the request URL for each of Veridion's APIs.
Veridion uses semantic versioning to track API changes. We update the major version number when making backwards-incompatible changes to the API, while the minor version number is incremented for improvements and fixes.
Pagination
Endpoints that return more than one record are paginated with a cursor. The mechanism is the same across the Veridion APIs, so a client written once works everywhere.
Please refer to the Pagination section for more information.
Error response format
All error responses have the same object structure. The fields returned in an error response are listed below.
| Field | Type | Description |
|---|---|---|
path | string | API Request path |
status | integer | HTTP status code |
error | string | A code tied to the status code. At present, the value defaults to the generic string indicative of the status code. |
message | string | Additional information on the error |
Error example:
{
"path": "/match/v6/companies",
"status": 400,
"error": "Bad Request",
"message": "At least one of the 'legal_names' or 'commercial_names' non-empty text array fields is required."
}