Skip to main content
POST

Headers

​
x-signature
string

HMAC-SHA256 signature: HMAC-SHA256(secretKey, timestamp + METHOD + path + body). Required for API-key authenticated requests (JWT/OAuth session auth is exempt).

​
x-timestamp
string

Request timestamp in epoch milliseconds. Required with x-signature for API-key auth. Rejected if drift exceeds 5 minutes.

Body

application/json

OpenAPI schema McpRequestAuthLookupBodyDto. Mirrors GraphQL RequestAuthLookupInput.

​
email
string
required

The user's email address to which the lookup code will be sent.

Example:

"alice@example.com"

​
recaptcha
string
required

reCAPTCHA token. Verification is skipped automatically in non-production environments.

Example:

"recaptcha_token_here"

​
fingerprint
string
required

Device fingerprint / visitor id generated by the client for session binding.

Example:

"fp_browser_abc123"

​
username
string

Desired username (only used when registering a new user).

Minimum string length: 5
Example:

"alice_bob"

​
receiveMarketingOffers
boolean

Opt-in to marketing offers / communications (new users only).

​
agreedToTerms
boolean

Indicates the user has accepted the platform's terms and conditions (new users only).

​
promoCode
string

Promotional code (new users only).

Example:

"WELCOME2025"

​
referralCode
string

Referral code from an invitation link (new users only).

Example:

"REF-ABC-123"

​
referrerUsername
string

Username of the referring user (new users only).

Example:

"referrer_user"

​
referrerUserId
string

User id of the referring user (new users only).

Example:

"507f1f77bcf86cd799439011"

Response

Lookup request accepted; email dispatched when applicable.

​
success
boolean
required
Example:

true

​
data
object
required

Endpoint-specific payload