Skip to main content
POST
Create a verification link
Needs a live key (sk_live_...): the identity check is real. A test key gets 403 live_key_required.
You send the link; only your client can complete the identity check. url is null when they are already verified. Another app of your own company has no identity check of its own: 409 identity_from_company.
Webhook: none. account.updated fires when your client completes the identity check and AgentaOS reads the result. See Which action fires which event.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

id
string<uuid>
required

The business UUID.

Response

The link, or null when already verified.

url
string | null
required

The identity check link to send your client, or null when already verified.

status
string
required

Where the identity check stands. These are the check's own states, not a business status: Not Started, In Progress, Awaiting User, In Review, Approved, Declined, Resubmitted, Expired, Kyc Expired or Abandoned. Approved means the check is done.