Skip to main content
The Authsignal Client API can be used to perform challenges using different authentication methods and verify users. This API is designed to be used if you’re not using Authsignal’s pre-built UI and are building your own web or native app UI.

Download the Client API OpenAPI Specification

​
Endpoint selection

Select the API endpoint which correlates with your tenant’s region selection. 
https://api.authsignal.com/v1/client

​
Authentication

The Authsignal Client API uses bearer authentication with a short-lived token obtained from the Server API or via a Server SDK.

​
1. Track an action

You should first track an action that represents what the user is doing (e.g. “signIn”) and get a token which is valid for 10 minutes. 
const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
  action: "signIn",
};

const response = await authsignal.track(request);

const token = response.token;
When tracking an action to enroll an authenticator, the scope add:authenticators must be explicitly specified if the user is already enrolled with at least one authentication method. Learn more about scopes for authenticator binding.

​
2. Use bearer auth

This token can then be used to authenticate to the Client API using bearer auth. 
curl https://api.authsignal.com/v1/client/user-authenticators \
  -H "Accept: application/json" \
  -H "Authorization: Bearer TOKEN_RETURNED_FROM_SERVER_API"
The authentication model is designed so you can call the Authsignal Client API directly from your web browser or mobile app (though you can also communicate via your backend where convenient).