onboarding

Start agent-initiated, human-authorized provisioning

PUBLIC: no credential required, because the caller has none yet.

Issues NO credential. It emails the named human, who must approve in a browser. Shaped after RFC 8628 (OAuth 2.0 Device Authorization Grant).

An agent cannot create an account, cannot choose a password, and cannot approve its own request.

post/api/agent-onboarding/request

Request

  • Base URL: https://www.spendline.ai
  • URL: https://www.spendline.ai/api/agent-onboarding/request
  • Auth: none required

Request body

human_emailstring email required

The human who owns this application. They receive the approval email.

agent_namestring

How to identify you to the human.

intended_usestring

Plain sentence shown to the human.

Response

Request created. Poll for the outcome.

request_idstring uuid
device_codestring

Your poll credential. Shown once.

user_codestring

What the human sees. Not a credential.

verification_uristring uri
verification_uri_completestring uri
intervalinteger

Seconds between polls.

expires_ininteger
statusstring
human_action_requiredstring

Example response

{
  "status": "pending_human_authorization"
}

Changes

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