Docs

The Login Link object

Login Links are single-use URLs that take an Express account directly to the login page for their Zoneless dashboard. A Login Link differs from an Account Link in that it takes the user directly to their Express dashboard rather than through an onboarding flow.

You can only create login links for Express accounts that are connected to your platform. The connected account must have already completed onboarding and have access to the Express Dashboard.

Attributes

object string

String representing the object's type. Objects of the same type share the same value. Always login_link.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

url string

The URL for the login link. Redirect the connected account holder to this URL to take them directly to the Express Dashboard.

THE LOGIN LINK OBJECT
{
  "object": "login_link",
  "created": 1704067200,
  "url": "https://dashboard.yourdomain.com/login?token=ll_z_abc123..."
}

Create a login link

Creates a login link for a connected account to access the Express Dashboard.

ENDPOINTS
POST /v1/accounts/:id/login_links

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

Parameters

No parameters.

Returns

Returns a LoginLink object if the call succeeds.

POST/v1/accounts/:id/login_links
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.zoneless.com');

const loginLink = await zoneless.accounts.createLoginLink(
  'acct_z_1Nv0FGQ9RKHgCVdK'
);
RESPONSE
{
  "object": "login_link",
  "created": 1704067200,
  "url": "https://dashboard.yourdomain.com/login?token=ll_z_abc123..."
}