v1
latestOpenAPI 3.1.02026-07-268342124.0 KBInitiate challenge
Initiate a challenge by sending a verification code to an email address or phone number.
Request body
The verification method to use for the challenge.
The action code used to identify the challenge in the Authsignal Portal.
The idempotency key for the action. An idempotency key can be used to initiate multiple challenges for the same action.
The phone number in E.164 format. Required if the verification method is 'SMS'.
The email address. Required if the verification method is 'EMAIL_OTP'.
The primary ID of the user in your system. Required when initiating a challenge to enroll or update an authenticator for an existing user.
Providing scopes will authorize enrolling or updating an authenticator for an existing user. Must only be provided when initiating a challenge from an already authenticated state.
The locale of the user in BCP 47 format. Used to localize the pre-built UI, email, and SMS messages.
The user's IP address. Can be provided to use rules based on location or other IP-derived features.
The user agent identifying a browser or app. Can be provided to use rules based on device.
An ID which identifies the user's device. Can be provided to use rules based on device.
A JSON object which can include any key/value pairs. Can be provided to use rules based on your own data points.
Example request
{
"locale": "es"
}Response
OK
The ID of the challenge.
The idempotency key for the action. An idempotency key can be used to initiate multiple challenges for the same action.
The challenge expiry as a Unix timestamp in seconds.