SynqDocs
Account APILink codes

Start linking an account your app verifies

A link code for the person at one of the brand's “your app verifies it” providers (409 `sign_in_method_unavailable` for any other, or one turned off): put it in your service's deep link (`t.me/acmeguildbot?start=<code>`), and your server redeems it once it knows who opened that. The identity then waits, pending (`GET /v1/pending-identities`), until this same session of the app confirms it (`POST /v1/identities/{identity}/confirm`) or turns it down. The code works once, for 10 minutes, for this person, provider and session alone; a newer one drops their oldest waiting there past three. Where the provider makes sign-in links, the account becomes a way to sign in: then it wants a sign-in Synq proved within the brand's `link_reauth_window`, or the last 5 minutes when that is shorter (403 `fresh_sign_in_required`), and an account whose email address nobody proved yet takes none (403 `email_unverified`). A session a sign-in link made links nothing (403 `fresh_sign_in_required`). One person has at most 20 ways to sign in and linked accounts (409 `identity_limit_reached`). The answer is shown once, never replayed for an Idempotency-Key. Needs `me:write`.

POST/v1/link-codes

A link code for the person at one of the brand's “your app verifies it” providers (409 sign_in_method_unavailable for any other, or one turned off): put it in your service's deep link (t.me/acmeguildbot?start=<code>), and your server redeems it once it knows who opened that. The identity then waits, pending (GET /v1/pending-identities), until this same session of the app confirms it (POST /v1/identities/{identity}/confirm) or turns it down. The code works once, for 10 minutes, for this person, provider and session alone; a newer one drops their oldest waiting there past three. Where the provider makes sign-in links, the account becomes a way to sign in: then it wants a sign-in Synq proved within the brand's link_reauth_window, or the last 5 minutes when that is shorter (403 fresh_sign_in_required), and an account whose email address nobody proved yet takes none (403 email_unverified). A session a sign-in link made links nothing (403 fresh_sign_in_required). One person has at most 20 ways to sign in and linked accounts (409 identity_limit_reached). The answer is shown once, never replayed for an Idempotency-Key. Needs me:write.

Authorization

bearer
AuthorizationBearer <token>

An access token from this issuer for its account API (resource=<issuer>/me).

In: header

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

curl -X POST "https://example.auth.synq.build/me/v1/link-codes" \  -H "Authorization: Bearer $ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "provider": "custom-acme-telegram"  }'
{  "code": "q2V0ZXJzLWV4YW1wbGUtY29kZS1vbmx5LTAxMjM0NTY",  "identity": "idn_01h455vb4pex5vsknk084sn02q",  "provider": "custom-acme-telegram",  "expires_at": "2026-10-21T12:00:00.000Z"}