Response format
Every endpoint returns the same JSON envelope, so you can write one parser for the whole API.
The envelope#
successβ boolean;trueon a 2xx response.dataβ the payload (object, array or null).errorβ a human-readable message, ornullon success.timestampβ ISO 8601 server time.metaβ optional object for pagination/usage metadata, ornull.
{
"success": true,
"data": {
"enterpriseNumber": "0403.170.701",
"status": "AC",
"denomination": "Anheuser-Busch InBev"
},
"error": null,
"timestamp": "2026-06-05T09:00:00.000Z",
"meta": null
}On error#
success is false, data is null and error describes the problem. The HTTP status code carries the category.
{
"success": false,
"data": null,
"error": "Enterprise not found",
"timestamp": "2026-06-05T09:00:00.000Z",
"meta": null
}βΉοΈ
Always branch on the HTTP status first, then read error for the message. See Errors.