Platform
Launch state, what is available per country, and the agreements people accept.
/v1/platform/statusLaunch state of the platform and any per-country overrides
Response (200)
| Field | Type | Required |
|---|---|---|
| launchState | PRELAUNCH | LIVE | — |
| launchedAt | string,null (date-time) | — |
| countryOverrides | object | — |
/v1/platform/countries/{country}What TBBN offers in a country right now — identity verification, business verification, merchant accounts, Space hosting, payments, payouts, marketplace listings — plus the per-country form configuration (labels and required fields) every onboarding form reads.
Parameters
| country | path | required |
Response (200)
| Field | Type | Required |
|---|---|---|
| country | string | — |
| identityVerification | boolean | — |
| businessVerification | boolean | — |
| merchantOnboarding | boolean | — |
| spaceHosting | boolean | — |
| acceptPayments | boolean | — |
| payouts | boolean | — |
| marketplaceListings | boolean | — |
| formConfig | object | — |
/v1/agreements/{kind}/currentThe current version of an agreement (business-profile, merchant, space-host, trade-terms)
Parameters
| kind | path | required |
Response (200)
| Field | Type | Required |
|---|---|---|
| id | string (uuid) | — |
| kind | BUSINESS_PROFILE | MERCHANT | SPACE_HOST | TRADE_TERMS | — |
| version | integer | — |
| title | string | — |
| summary | stringnull | — |
| body | string | — |
| effectiveAt | string (date-time) | — |
/v1/agreements/statusWhich agreements the signed-in person has accepted at their current version
Response (200)
/v1/agreements/{kind}/acceptAccept the current version of an agreement. Idempotent per person and version.
Parameters
| kind | path | required |
Request body
| Field | Type | Required |
|---|---|---|
| businessId | string (uuid) | — |
| merchantId | string (uuid) | — |
Response (201)
| Field | Type | Required |
|---|---|---|
| accepted | boolean | — |
| version | integer | — |
| acceptedAt | string (date-time) | — |
/v1/identity/statusThe signed-in person's identity verification status — unverified, pending, verified or needs attention — whether verification is offered in their country, and their latest attempt. A pending attempt is refreshed from the provider on read.
Response (200)
| Field | Type | Required |
|---|---|---|
| status | UNVERIFIED | PENDING | VERIFIED | NEEDS_ATTENTION | — |
| verifiedAt | string,null (date-time) | — |
| country | stringnull | — |
| verificationAvailable | boolean | — |
| configured | boolean | — |
| latest | objectnull | — |
/v1/identity/sessionsStart an identity check (government ID + selfie). Returns the hosted page to send the person to; they come back to the return URL when done and the status endpoint reflects the outcome. Only where the country access matrix offers identity verification.
Request body
| Field | Type | Required |
|---|---|---|
| returnUrl | string (uri) | — |
| country | string | — |
Response (201)
| Field | Type | Required |
|---|---|---|
| verificationId | string (uuid) | — |
| url | string (uri) | — |