SynqDocs
Management APIIdentities

Add an account your app verifies to a user

For a person your server already knows: links their account at one of the brand's “your app verifies it” providers, confirmed at once, with no code. Their account page shows it as added by your brand, and they can remove it. One person has at most 20 ways to sign in and linked accounts (409 `identity_limit_reached`); an account someone has linked already is 409 `identity_in_use`. Needs `org.users.identities.edit`. Recorded as `user.identity_linked` with `by: server`.

POST/v1/orgs/{org}/brands/{brand}/users/{user}/identities

For a person your server already knows: links their account at one of the brand's “your app verifies it” providers, confirmed at once, with no code. Their account page shows it as added by your brand, and they can remove it. One person has at most 20 ways to sign in and linked accounts (409 identity_limit_reached); an account someone has linked already is 409 identity_in_use. Needs org.users.identities.edit. Recorded as user.identity_linked with by: server.

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}$
user*string

The user's id

Match^usr_[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/users/usr_01h455vb4pex5vsknk084sn02q/identities" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "provider": "custom-acme-telegram",    "subject": "987654321",    "handle": "ada",    "name": "Ada Lovelace",    "picture": "string"  }'
{  "id": "idn_01h455vb4pex5vsknk084sn02q",  "provider": "string",  "subject": "string",  "handle": "string",  "details": {    "account_type": "User",    "created_at": "2011-01-25T18:44:36.000Z",    "public_repos": 0,    "followers": 0,    "email_verified": true,    "workspace_domain": "acme.example",    "telegram_user_id": "987654321",    "phone_number": "+15555550123",    "phone_number_verified": true,    "name": "Ada Lovelace",    "test": true  },  "details_read_at": "2026-10-21T12:00:00.000Z",  "scopes": [    "phone"  ],  "unconfirmed_scopes": [    "telegram:bot_access"  ],  "last_used_at": "2026-10-21T12:00:00.000Z",  "created_at": "2026-10-21T12:00:00.000Z",  "added_by": "person",  "claims": {    "locale": "en-US"  },  "provider_tokens": {    "scope": "tweet.read users.read offline.access",    "expires_at": "2026-10-21T12:00:00.000Z",    "refreshable": true,    "kept_at": "2026-10-21T12:00:00.000Z"  },  "linked_at": "2026-10-21T12:00:00.000Z"}