Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

This REST API can be called directly with an HTTP client in your server-side language, or by using an Authsignal Server SDK.

Download the Server API OpenAPI Specification

​
Endpoint selection

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

​
Authentication

The Authsignal Server API uses your secret key to authenticate requests using basic authentication.
You should only ever call the Authsignal Server API from your server where your secret key can be stored securely. Your secret key should never be exposed to any public client.
You can find your secret key in the API Keys section of the Authsignal Portal settings.

​
Example usage

curl -u "YOUR_SECRET_KEY:" https://api.authsignal.com/v1/users/{userId}/actions/{action}/{idempotencyKey}
# The colon prevents curl from asking for a password.
Following the basic authentication protocol, the Server API expects requests to include an Authorization header containing the word Basic followed by a space and a base64-encoded username:password string. The username value should be your Server API secret key and the password value should be empty.

​
Next steps