Consumer API Reference

Explore the details of the Stytch API. Our authentication API is organized around REST principles and has resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All API resources are scoped to the Project of the API keys you provide.

To connect to the Stytch API, you need to authenticate your requests using your project_id and secret from the API Keys section in your Project's Dashboard.

• For direct API calls, you'll need to pass these credentials into the Authorization request header using basic authentication.

• For our backend SDKs, you'll need to provide these credentials when initializing the Stytch SDK client.

const stytch = require('stytch');

const client = new stytch.Client({
  project_id: "PROJECT_ID",
  secret: "SECRET",
});

from stytch import Client

client = Client(
  project_id="PROJECT_ID",
  secret="SECRET",
)

require 'stytch'

client = Stytch::Client.new(
  project_id: "PROJECT_ID",
  secret: "SECRET"
)

import (
    "context"

    "github.com/stytchauth/stytch-go/v12/stytch"
    "github.com/stytchauth/stytch-go/v12/stytch/consumer/stytchapi"
    "github.com/stytchauth/stytch-go/v12/stytch/consumer/users"
)

stytchClient, err := stytchapi.NewClient(
    "PROJECT_ID",
    "SECRET",
)

import com.stytch.java.consumer.StytchClient;
StytchClient.configure(
    "PROJECT_ID",
    "SECRET"
);

curl --request POST \
  --url https://test.stytch.com/v1/users \
  -u 'PROJECT_ID:{$secret}' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "adalovelace@stytch.com",
    "name": {"first_name": "Ada", "last_name": "Lovelace"}
  }'

For every Stytch project, there are two environments, TEST and LIVE, and each have their own API root URLs, test.stytch.com and api.stytch.com respectively.

All resources and data objects are tied to the environment they were created in. Also, the ids include their respective environment. For example, user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6 indicates a User was created in the TEST environment.