Start signing in from the phone app

GET/api/auth/veyra/mobile/start
No API key
Veyra Docs TeamUpdated Version 1 · History

Start signing in from the phone app.

The Veyra Intelligence phone app opens this address in a browser sheet (ASWebAuthenticationSession), on the console's public origin. It redirects to Veyra Connect's /authorize with app=mobile; after signing in there the sheet is sent to redirect_uri?code=<one-time code>&state=<state>. The code lives 60 seconds and is traded once at POST /api/auth/veyra/mobile/token with the PKCE verifier behind code_challenge. A redirect_uri that is not one of the app's addresses (VEYRA_MOBILE_REDIRECT_URIS, default veyra-intelligence://auth and veyra://auth, matched exactly) or a missing S256 challenge answers 400 and redirects nowhere. Without Veyra Intelligence accounts (local_trusted) it answers 404.

Authorization

No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. How keys work.

Query parameters

redirect_uristringRequired
code_challengestringRequired
code_challenge_methodstringOptionalone of: "S256"
devicestringOptionalat most 100 characters
app_versionstringOptionalat most 40 characters
statestringOptionalat most 200 characters

Responses

303Redirect to Veyra Connect's /authorize
400Bad requestThe request is malformed or failed validation. details names each field that failed.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Profile