# Login via biometrics

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.

Endpoint: POST /login_via_biometrics
Version: 3.63.5
Security: api-key

## Request fields (application/json):

  - `email` (string, required)
    E-mail Address of the user

  - `identity` (object)

  - `identity.type` (string, required)
    Indicates the identity type.
    Enum: "CONSUMER", "CORPORATE"

  - `identity.id` (string, required)
    The identifier for the identity.

## Response 200 fields (application/json):

  - `challengeId` (string)
    The unique identifier of a Biometric challenge.

## Response 400 fields (application/json):

  - `message` (string)
    When present helps to identify and fix the problem.

  - `syntaxErrors` (object)
    Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.

  - `syntaxErrors.invalidFields` (array)

  - `syntaxErrors.invalidFields.params` (array)

  - `syntaxErrors.invalidFields.fieldName` (string)

  - `syntaxErrors.invalidFields.error` (string)
    Enum: "REQUIRED", "HAS_TEXT", "REQUIRES", "SIZE", "RANGE", "IN", "NOT_IN", "REGEX", "EXACTLY", "AT_LEAST", "AT_MOST", "ALL_OR_NONE"

## Response 409 fields (application/json):

  - `errorCode` (string)
    Enum: "CHANNEL_NOT_REGISTERED", "CHANNEL_NOT_SUPPORTED"

## Response default fields (application/json):

  - `code` (string)

  - `message` (string)


## Response 401 fields

## Response 403 fields

## Response 423 fields

## Response 429 fields

## Response 500 fields

## Response 503 fields