auth
oauth

Start a device-authorization login

Begin a device-authorization login: creates a pending request and returns a browser confirmation URL plus a token to poll for the result.

post/auth/oauth/device/start

Request

  • Base URL: https://api.namefi.io/v-next
  • URL: https://api.namefi.io/v-next/auth/oauth/device/start
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Headers

x-namefi-eip7702-accountstring

Optional delegated account address to authenticate as when the signer is an approved signer. Preferred header name.

x-namefi-eip1271-accountstring

Legacy alias for x-namefi-erc1271-account. When multiple delegated account headers are present, x-namefi-eip7702-account takes precedence, then x-namefi-erc1271-account.

x-namefi-erc1271-accountstring

Optional delegated account address to authenticate as when the signer is an approved signer. Preferred ERC-1271 header name.

Request body

clientIdstring

Identifier of the requesting client. Known ids render as a verified client on the confirm page; unknown ids are allowed but shown as unverified.

variant'headless'

Device-authorization variant. Reserved for future flows (e.g. a typed user_code); currently only the headless capability-URL variant is supported.

codeChallengestring required

PKCE S256 code challenge: BASE64URL(SHA256(codeVerifier)).

codeChallengeMethod'S256' required

PKCE challenge method; only S256 is supported.

Response

OK

authReqTokenstring uuid required

Opaque handle for this login request; used to poll status.

confirmUrlstring uri required

Browser URL where the user approves or cancels the request.

expiresAtstring date-time required

ISO timestamp after which the request can no longer be used.

pollIntervalMsinteger required

Suggested delay between consecutive status calls.

Changes

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