SynqDocs
Management APIBrands

Make a sign-in link

A link that signs in the person who confirmed an account at one of the brand's “your app verifies it” providers, where it makes sign-in links (`sign_in_tickets`; 409 `sign_in_method_unavailable` otherwise, or while it is off): your bot's “Open the event” button, say. It is for one of the brand's own apps (`client_id`) and one of its redirect URIs exactly as registered (`return_to`), works once and for 2 minutes, and only through that app: opening it shows the app's page whose button signs them in, its server pushing the ticket to Synq (`synq_ticket` in a pushed authorization request with `prompt=login`), so a link preview or a scanner that only fetches it spends nothing. The sign-in is `amr: ["ticket"]` and never a fresh one: it can't add or remove ways to sign in, delete the account or make API keys. It shows in the person's sign-ins. An account nobody confirmed there is 404 `not_found`. The answer is shown once, never replayed for an Idempotency-Key, and never cached. Only an org API key, from a server: a person's access token, the dashboard's included, or a request with an `Origin` or `Sec-Fetch-Site` header (a browser's) is 403 `server_only`. Limited per org (`sign_in_tickets.org`). Needs `org.users.signInTickets.create`. Recorded as `user.sign_in_ticket_created`, and its use as `user.sign_in_ticket_used`.

POST/v1/orgs/{org}/brands/{brand}/sign-in-tickets

A link that signs in the person who confirmed an account at one of the brand's “your app verifies it” providers, where it makes sign-in links (sign_in_tickets; 409 sign_in_method_unavailable otherwise, or while it is off): your bot's “Open the event” button, say. It is for one of the brand's own apps (client_id) and one of its redirect URIs exactly as registered (return_to), works once and for 2 minutes, and only through that app: opening it shows the app's page whose button signs them in, its server pushing the ticket to Synq (synq_ticket in a pushed authorization request with prompt=login), so a link preview or a scanner that only fetches it spends nothing. The sign-in is amr: ["ticket"] and never a fresh one: it can't add or remove ways to sign in, delete the account or make API keys. It shows in the person's sign-ins. An account nobody confirmed there is 404 not_found. The answer is shown once, never replayed for an Idempotency-Key, and never cached. Only an org API key, from a server: a person's access token, the dashboard's included, or a request with an Origin or Sec-Fetch-Site header (a browser's) is 403 server_only. Limited per org (sign_in_tickets.org). Needs org.users.signInTickets.create. Recorded as user.sign_in_ticket_created, and its use as user.sign_in_ticket_used.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/sign-in-tickets" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "provider": "custom-acme-telegram",    "subject": "987654321",    "client_id": "app_01h455vb4pex5vsknk084sn02q",    "return_to": "https://app.acme-guild.example/auth/callback"  }'
{  "url": "https://app.acme-guild.example/auth/callback?synq_ticket=Oyewzb7tB0AL3anJsAjr7DTSO3Ojr34HOqKwZ611DYM",  "expires_at": "2026-10-21T12:00:00.000Z"}