Verification

Verify one or many T-numbers (batch)

post/v1/verify

Request

  • Base URL: https://jp-verify.obolpay.xyz
  • URL: https://jp-verify.obolpay.xyz/v1/verify
  • Auth: one of:
    • none
    • API key in header X-API-Key

Headers

X-API-Keystring

Request body

numbersstring[] required

T-numbers to verify (a comma-joined string is also accepted); up to the caller's tier batch ceiling — see the service description

signboolean nullable

return an Ed25519-signed record (Growth/Reseller keys only; otherwise the response says so and signs nothing)

includestring[] nullable

add-ons to embed in each result (1.5.0; a comma-separated string is also accepted). shareholders replaces the free compact major_shareholders object with the full block (holders[] and filings[]) and costs +1 unit per corporate result that actually carries rows; a status-only answer costs nothing extra. Unknown members are ignored.

Response

One record per well-formed input number (a not_registered or invalid record carries every documented key, null where the register has nothing to say — never an absent key); malformed inputs are listed under invalid[], unmetered. The example is the real response of this code on a sample register.

unknown required

Changes

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