Verification Status Update Webhook

After you have created the messaging templates and are ready to send them using the API, you can create a webhook to receive status updates automatically. To create a webhook, go to Managing Webhooks. When creating the webhook, select the Verification Status Update event.

Webhook response

Refer to the following as example of the webhook response:

{
  "mfaStatus": "VERIFIED",
  "apiVersion": "v1",
  "clientId": "12345678912345",
  "verificationAttempts": "1",
  "id": "1a345b78-c90d-1e2f-g345-6h7i8j901k23",
  "eventType": "MFA.StatusUpdate",
  "sendAttempts": "1",
  "mfaId": "1759f113-edf8-4b3e-85cc-0cadba226fc4"
}

Webhook statuses

The webhook can return different statuses in the API response:

/*
  UNKNOWN: 
    The status is unknown. This is the default value.
  INVALID:
    The verification session was invalidated due to an error.
  VERIFIED:
    The verification process succeeded.
  TERMINATED:
    The verification session expired or reached the maximum number of verification or resend attempts.
  MESSAGE_SENT:
    The verification message has been sent and is awaiting action from the user.
  FAILED_AUTHORIZATION:
    The verification process has failed due to an authorization issue.
  VERIFICATION_ATTEMPT_FAILED:
    The verification attempt failed, but the session remains active for retry.
*/

Resend Multi-Factor Authentication (MFA)

To resend the MFA, send the mfa.ID from the /login endpoint response or verififcation.ID from the /newaccountopening endpoint response as sessionId in the /resend endpoint.