Push verification

Check out our end-to-end guide on how to implement push verification using Authsignal.

Start a push challenge

Start a push challenge by sending a notification to the user’s mobile device.

const response = await authsignal.push.challenge({ action: "login" });

To target a specific enrolled push authenticator when the user has more than one, pass its userAuthenticatorId. The challenge is then sent only to that authenticator and can only be approved from that device.

const response = await authsignal.push.challenge({
  action: "login",
  userAuthenticatorId: "9b89d063-72c8-4a3b-9c2b-1e2f3a4b5c6d",
});

Parameters

string

required

The action being performed.

string

The ID of a specific enrolled push authenticator to target. When omitted, the challenge is sent to all of the user’s eligible push authenticators.

Response

AuthsignalResponse<PushChallengeResponse>

Show properties

PushChallengeResponse

Show properties

string

The ID of the Authsignal challenge. Use this ID to poll for the challenge result.

string

See the Error handling section for more details.

string

Check push challenge verification status

const response = await authsignal.push.verify({
  challengeId: "3a991a14-690c-492b-a5e5-02b9056a4b7d",
});

Parameters

string

The ID of the Authsignal challenge returned when starting the push challenge.

Response

AuthsignalResponse<PushVerifyResponse>

Show properties

PushVerifyResponse

Show properties

boolean

required

True if the challenge has been either approved or denied by a user.

boolean

required

True if the challenge has been approved by a user.

string

A token which can be used for server-side validation. Only present if the challenge succeeded.

string

See the Error handling section for more details.

string

Server

Client

Call Connect

Start a push challenge

Parameters

Response

Check push challenge verification status

Parameters

Response

​Start a push challenge

​Parameters

​Response

​Check push challenge verification status

​Parameters

​Response

Start a push challenge

Parameters

Response

Check push challenge verification status

Parameters

Response