API Reference

Onboard3 API

Verify any OB3 record, submit registrations, and manage records programmatically. Free public verification. Module-scoped API keys for partners.

Quick Start -- No API Key Needed

curl https://onboard3.io/api/v1/verify/OB3-TRADE-88IP

Base URL

https://onboard3.io/api/v1

Authentication

x-api-key: your_key

CORS

Access-Control-Allow-Origin: *

Endpoints

Get API Key

GET/api/v1/verify/{code}

Verify any OB3 record. Works for all 7 modules. Auto-detects module from code prefix.

Auth: Optional API key

Rate limit: 100/hr anonymous, unlimited with key

Parameters

codepathAny OB3 code (OB3-PET-XXXX, OB3-BIZ-XXXX, etc.)

x-api-keyheaderOptional API key for higher rate limits

Response

{
  "verified": true,
  "ob3_code": "OB3-PET-DEYG",
  "module": "pets",
  "status": "active",
  "anchored": true,
  "blockchain": {
    "network": "polygon",
    "tx_hash": "0x7f2a..."
  },
  "record": {
    "pet_name": "Pandora",
    "species": "dog",
    "owner_name": "Demo User"
  },
  "response_ms": 124
}

Code Examples

JavaScript

const response = await fetch(
  'https://onboard3.io/api/v1/verify/OB3-PET-DEYG',
  { headers: { 'x-api-key': 'your_api_key' } }
)
const data = await response.json()
console.log(data.verified) // true

cURL

curl https://onboard3.io/api/v1/verify/OB3-TRADE-88IP \
  -H "x-api-key: your_api_key"