Skip to content
Documentation

Reference pages for the published route families.

Use these pages to check inputs, outputs, status codes, assumptions, and examples across validation, geo, finance, salary, time, documents, and legacy upstream endpoints.

Docs pages

14

Published routes

28

Response format

JSON

Start here

The pages below cover the shared rules first, then the request and response details for each route.

Routes

Each published route has a dedicated page with request examples and failure cases.

Shared behavior

These rules apply across the published endpoints and are the main things to account for in a shared client.

ConcernBehavior
Request bodyMost routes are query-driven GET endpoints. The document routes and `/api/translate` expect JSON bodies.
Response freshnessEach route sends Cache-Control: no-store. Some endpoints are deterministic, while others depend on live upstream services.
Error handlingCheck HTTP status and the returned code field or error.code value before deciding whether to retry.
Deployment profileHandlers run on Node.js and are marked dynamic.

Quickstart

Run one request per route before you wire the endpoints into application code.

GNU BashSmoke test sequence (cURL)
curl -s "https://utils.api.orb3x.com/api/v1/validate/bank-account?account=004000010123456789012"curl -s "https://utils.api.orb3x.com/api/v1/phone/validate?phone=%2B244923456789"curl -s "https://utils.api.orb3x.com/api/v1/finance/vat?amount=114000&inclusive=true"curl -s -X POST https://utils.api.orb3x.com/api/v1/documents/receipt \  -H "Content-Type: application/json" \  -d '{"receivedFrom":{"name":"Cliente Exemplo"},"amount":100000}'