Create a verification link
The identity check link for your client. You send it; only your client can complete it. Needs a live key: a test key gets 403 live_key_required. While a check is open, calling again returns the same check. url is null when the client is already verified. For another app of your own company it returns 409 identity_from_company: its identity check is your company’s.
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.account.updated fires when your client completes the identity check and AgentaOS reads the result. See Which action fires which event.Authorizations
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
The business UUID.
Response
The link, or null when already verified.
The identity check link to send your client, or null when already verified.
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.