Running a Search query

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Search API allows you to find and screen companies at scale by running a query, a tree of filters, against Veridion's company universe. A single module parameter sets what question that query answers: find a specific company, verify one you already hold, segment a market, or discover suppliers.

Run in Postman



When to use it

Reach for this endpoint once you know which module fits your job and which filters express your criteria:

Request body

The body is a module plus a query (the filter tree):

{
    "module": "company_verification",
    "query": {...}
}

Where module is one of company_lookup, company_verification, segmentation, or supplier_discovery.

For how to compose query, see How to build a search query; for each module's required anchor and allowed filters, see Choosing a module.

Results pagination

Results are paginated using the same cursor based mechanism as other Veridion APIs. See the Pagination section for the parameters and tokens.

Successful responses

A successful call returns 200 OK with a JSON envelope. Each company in result carries its evidence first (if evidence is required), then its company fields.

{
  "search_module": "supplier_discovery",
  "result_count": 1240,
  "result": [
    { "evidence": { }, "veridion_id": "…", "company_name": "…" }
  ],
  "has_more": true,
  "next_cursor": "eyJ0IjoicyIs…"
}
FieldDescription
search_moduleThe module you called.
result_countThe total number of matches for the query. It ignores max_results , returns true count of result set.
resultThe companies on this page. How much of each company you get back depends on the module: a full profile for most, or a confirmation stub for company_verification.
has_moreWhether another page remains.
next_cursorThe cursor to pass as cursor on the next request, or null when no records remain.

For the company fields inside each result, see Response fields and types; for more details on the evidence object, see Explainability (evidence).

Error responses

  • 400 Bad Request, where the body breaks a module's input contract, or the query is malformed. When a filter isn't allowed in the module you called, the message names the module you should use instead, so a caller can correct and retry. See Choosing a module.
  • other standard HTTP error responses, detailed in the Response codes section.

Any error response follows a specific structure. Please see the Error response format section for more details.

Query Params
integer
Defaults to 25

Number of results to be returned per page. Default value: 25, Maximum value: 200.

string

Cursor returned by a previous call as next_cursor. Bound to the query that produced it. Opaque string (<=1024)

integer

Optional cap on the total number of records returned across the pagination session. Integer value (1 - 10000).

Headers
string
required

Your individual OAuth Bearer token (e.g. Authorization: Bearer <your_access_token>).

Response

Language
LoadingLoading…
Response
Choose an example:
application/json