Preview an external identity-link intent

GET/api/chat-identity-links/preview
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Preview an external identity-link intent.

Returns the organization and provider identity that a valid, unexpired confirmation token would link. Admin-created links require organization access. Private links issued to a signed Slack sender allow a signed-in recipient to preview that identity and request organization access.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Query parameters

tokenstringRequired32–4096 characters

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Chat channels