OZozav
Businesses

Look up a company in the public registry

Returns the public registry record of a company, read at request time (a copy up to 30 days old may answer instead). Brazil only today: send country: BR and the CNPJ.

Three answers, and never a guess:

  • result: found with the record. stale: true means the registry could not be read and a copy older than 30 days answered.
  • result: not_found: every registry source said the number does not exist. It is a real answer and is charged.
  • 503 REGISTRY_UNAVAILABLE: the registry could not be read. The charge is refunded; retry.

A check-digit error is 400 INVALID_REGISTRATION_NUMBER and another country is 422 FEATURE_NOT_AVAILABLE; the charge for either is refunded. Nothing about the lookup is stored.

Send an Idempotency-Key to retry safely: the same key and body return the same answer and are not charged again.

Requires the businesses:read scope. API keys created before this scope existed do not gain it: create a new key with the scopes you need.

post/businesses/lookup

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency key (16-256 characters of [A-Za-z0-9_-]); same semantics as on money-moving operations.

Request body

countrystring required

ISO 3166-1 alpha-2. BR only today.

registration_numberstring required

The CNPJ, with or without punctuation. Check digits are verified.

Response

The registry answer.

object'business_registry_lookup' required
countrystring required
registration_numberstring required

The CNPJ

result'found' | 'not_found' required
staleboolean

Present when result is found. true = the registry could not be read and a copy older than 30 days answered.

checked_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.