Businesses

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.

post/gateway/businesses/{id}/verification-link

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/businesses/{id}/verification-link
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

The business UUID.

Response

The link, or null when already verified.

urlstring nullable required

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

statusstring 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.

Changes

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