// API Reference

Verify Entity

POST /api/enterprise/verify — the core KYB endpoint.

Endpoint

endpoint
POST https://app.osapher.com/api/enterprise/verify

Request body

FieldTypeRequiredDescription
queryValuestringYesABN (11 digits) or NZBN (13 digits)
jurisdictionstringYesAU or NZ

Response fields

FieldTypeDescription
legalNamestringLegal entity name from the government registry
abnstringAustralian Business Number (AU only)
nzbnstringNew Zealand Business Number (NZ only)
entityTypestringEntity classification e.g. Australian Private Company
abnStatusstringActive, Cancelled, or other registry status
gstRegisteredstringGST registration status from the registry
registeredStatestringState or territory of registration (AU)
registeredDatestringDate of registration (ISO 8601)
fractureScorenumberRisk score 0–100. Lower is better.
fractureRiskstringlow, medium, high, or critical
fractureSignalsarrayRisk signals that contributed to the score
statusstringverified, not_found, or error

HTTP status codes

CodeMeaning
200Verification completed successfully
400Invalid request — missing or malformed fields
401Unauthorised — missing or invalid API key
422Invalid ABN or NZBN format
429Rate limit exceeded
500Server error — registry may be unavailable

Examples

Verify an Australian ABN

shell
curl -X POST https://app.osapher.com/api/enterprise/verify \
  -H "Authorization: Bearer vnt_ent_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "queryValue": "22222222222",
    "jurisdiction": "AU"
  }'

Verify a New Zealand NZBN

shell
curl -X POST https://app.osapher.com/api/enterprise/verify \
  -H "Authorization: Bearer vnt_ent_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "queryValue": "YOUR_NZBN_HERE",
    "jurisdiction": "NZ"
  }'

Example response

response
{
  "result": {
    "legalName": "Acme Corp Pty Ltd",
    "abn": "22222222222",
    "nzbn": null,
    "entityType": "Australian Private Company",
    "abnStatus": "Active",
    "gstRegistered": "Registered",
    "registeredState": "NSW",
    "registeredDate": "2010-03-15",
    "fractureScore": 0,
    "fractureRisk": "low",
    "fractureSignals": [],
    "status": "verified"
  }
}
AuthenticationWebhooks