Skip to content

Sign in via biometrics

Request

Trigger a push notification and subsequent biometric authentication of a user, by providing the email that was used in the enrolment process of biometrics.

This endpoint can be used in conjunction with your application to authenticate a user and receive a stepped-up token in a single action, for use in-session for any endpoints or UI components that require step-up authentication.

Given that the user credentials are correct, a push notification is sent to the user requesting them to complete biometric authentication. On successful completion of authentication, a token will be shared that can be used for endpoints or UI components that require a stepped-up token.

Security
api-key
Bodyapplication/jsonrequired
emailstring, (email)(Email)required

E-mail Address of the user

identityobject(IdentityId)
curl -i -X POST \
  https://sandbox.weavr.io/multi/login_via_biometrics \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "identity": {
      "type": "CONSUMER",
      "id": "string"
    }
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
challengeIdstring

The unique identifier of a Biometric challenge.

Response
{ "challengeId": "string" }