External Authorization

Start passwordless grant issuance for an external identity and installation.

Use this when a person on your platform already has a Mind Upload account. Store the returned device code only for the short authorization window. Show the user code and verification link to the person; they review the application, requested scopes, and selected AI consciousnesses on Mind Upload.

post/v1/create_external_authorization_request

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/create_external_authorization_request
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

idempotency_keystring required

A stable opaque event key that makes exact retries return the same outcome.

installation_idstring required

Your stable opaque identifier for this app installation.

external_subjectstring required

Your stable opaque identifier for the person authorizing this installation.

installation_labelstring nullable

Optional user-readable name for the installation shown during consent.

external_identity_labelstring nullable

Optional user-readable external identity shown during consent.

requested_scopesstring[] required

Capabilities the owner is being asked to delegate.

Example request

{
  "idempotency_key": "unique-request-id-from-your-system",
  "installation_id": "your-installation-id",
  "external_subject": "your-external-user-id",
  "installation_label": "Work laptop",
  "external_identity_label": "External account",
  "requested_scopes": [
    "clone:invoke"
  ]
}

Response

Result envelope — check the success field.

successboolean required

Whether the call succeeded.

error_messagestring nullable required

Human-readable reason when success is false.

error_codestring
device_codestring nullable required

Short-lived high-entropy secret used only to poll and exchange this request.

user_codestring nullable required

Short-lived human-entered code shown to the owner.

verification_uristring nullable required

Mind Upload location where the owner reviews the request.

verification_uri_completestring nullable required

Verification location with the human code prefilled.

expires_ininteger nullable required

Seconds until the device authorization request expires.

poll_intervalinteger nullable required

Minimum seconds to wait between exchange polls.

grant_duration_secondsinteger nullable required

Grant lifetime shown to the owner before consent.

Changes

No recorded changes to this operation across all 2 revisions of this API.