Skip to content
Start free in Cloud

Preview social completion REST API

POST
/api/auth/social/preview
curl --request POST \
--url http://127.0.0.1:25737/api/auth/social/preview \
--header 'Content-Type: application/json' \
--data '{ "completion_token": "example", "email": "hello@example.com" }'

Returns safe provider and observed-email metadata for a still-valid completion token. Provider subjects are never returned.

Media typeapplication/json
object
completion_token
required
string
email

HitKeep target email required for a first unauthenticated Microsoft link.

string format: email
Examplegenerated
{
"completion_token": "example",
"email": "hello@example.com"
}

Social completion preview

Media typeapplication/json
object
display_name
required
string
email_confirmation_required
required

Whether this completion requires the user to confirm a HitKeep email before continuing.

boolean
email_verified
required
boolean
flow
required
string
Allowed values: login signup invite
observed_email
string format: email
provider
required
string
Allowed values: google github microsoft
Example
{
"flow": "login",
"provider": "google"
}

Completion token invalid, expired, or already consumed

Media typeapplication/json
object
message
string
Examplegenerated
{
"message": "example"
}