Create an admin login link

Creates a one-time sign-in link for a company admin, for a "Go to Payroll" button in your product. Open the returned url in a new browser tab. It takes the admin past the password step, straight to Everee's multi-factor challenge, and never past it: the admin still enters the code from their authenticator app. The link expires 60 seconds after it is returned, works once, and only the newest link for an admin works. Treat the url as a sign-in credential: don't log it or store it, and create it only when the admin clicks the button.

Call this with a company API token from a Production instance. Sandbox tokens and partner API keys are refused. The token needs the integration:admin-login-links:write scope. The feature must be switched on for the company, and the admin must have given your integration their secret. See the guide.

Create a one-time link that signs a company admin in to Everee, up to but never past the multi-factor challenge. Use it for a "Go to Payroll" button in your product. Open the returned url in a new browser tab when the admin clicks the button; it expires 60 seconds after it is returned.

Each admin gives your integration their own secret, and the feature must be enabled for the company. See Sign admins in from your product for setup, the full flow and security guidance.

Body Params
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json