Skip to content
Authrim

Complete an anonymous-user upgrade.

POST
/api/auth/upgrade/complete
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/upgrade/complete \
  --header 'Content-Type: application/json' \
  --data '{ "upgrade_token": "upgrade_123", "method": "email", "preserve_sub": true }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
upgrade_token
required
string
method
required
string
preserve_sub
boolean
Example 
{
  "upgrade_token": "upgrade_123",
  "method": "email",
  "preserve_sub": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
user_id
required
string
previous_user_id
string
preserve_sub
required
boolean
method
required
string
upgraded_at
required
integer
profile_completion_required
required
boolean
missing_required_custom_claims
required
Array<object>
object
field_key
string
label
string
field_type
string
account_lifecycle_state
required
string
Example 
{
  "success": true,
  "user_id": "user_123",
  "preserve_sub": true,
  "method": "email",
  "upgraded_at": 1770000000000,
  "profile_completion_required": false,
  "missing_required_custom_claims": [],
  "account_lifecycle_state": "active"
}