Redeem Invitation Code

Redeem a single-use invitation code for SDK tokens.

Public endpoint (no authentication required). Exchanges a valid, non-expired, single-use invitation code for access_token, refresh_token, and user_id. The returned token is write-only to the /sdk/* endpoints.

This backs the standalone onboarding flow used by the Open Wearables app and the SDK example apps. It is not the standard integration path - if your app has its own backend, mint and forward a token with POST /api/v1/users/{user_id}/token instead of redeeming codes on the client.

POST /api/v1/invitation-code/redeem

Redeem Invitation Code

cURL

curl --request POST \
  --url https://api.example.com/api/v1/invitation-code/redeem \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'

200

{
  "access_token": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token_type": "bearer",
  "refresh_token": "<string>",
  "expires_in": 123
}

Body

application/json

API input for redeeming an invitation code.

code · string · required

Required string length: 8

Pattern: ^[A-Z2-9]{8}$

Response

200

application/json

Successful Response

Redeem response with user_id included.

access_token · string · required

user_id · string<uuid> · required

token_type · string · default: bearer

refresh_token · string | null

expires_in · integer | null