Social login

Authenticate a customer via a social identity provider and receive an authentication token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Authenticate a customer through a social identity provider — Facebook, Google, or Auth0. The provider token is verified server-side; an existing linked customer is returned, or a new customer is created and linked on first sign-in. On success you receive the customer and a JWT.

Example: A visitor taps “Continue with Google.” Send idp_name, the provider’s idp_token, and the customer’s email; on success you receive their profile and a token to use for their session.

📘

First sign-in creates the customer

If no customer is linked to the provider identity and none matches the email, a new customer is created with email_confirm set to true and linked to the provider.


Conditional Requirements

ConditionRequired Fields
Alwaysidp_name (facebook, google, or auth0), idp_token, email
Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required
length ≤ 255

The email identifying the customer.

string
enum
required
Defaults to facebook

The identity provider name.

Allowed:
string
required

The identity provider token.

string
length ≤ 2
Defaults to en

The customer’s language as a two-letter code, defined by ISO 639-1 standard.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json