Skip to main content
GET
Begin Universal Login and redirect to the login page

Headers

X-Correlation-Id
string

An optional id you send to tie this request to your own logs. Send one and it is echoed back unchanged; omit it and one is assigned for you. Either way the id is returned in the X-Correlation-Id response header on every response, including errors, so you can match a response to the request that produced it.

Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Query Parameters

brand
string
required

the brand (brd_...) this login is scoped to

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$
connection
enum<string>

optional connection hint (never a password connection)

Available options:
email,
google-oauth2,
apple
returnTo
string

post-login return URL; brand allowlist only (open redirect barred, fail-closed)

Response

redirect to the hosted Universal Login page; sets the transaction cookie