WAwavix
2FA

List 2FA verification events

Changed on

Returns the lifecycle events of the 2FA verification identified by session_id, such as number lookup and code delivery.

get/v1/two-fa/session/{session_id}/events

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/two-fa/session/{session_id}/events
  • Auth
    HTTP bearer

Path parameters

session_idstring required
Example:8753d4308f2e11ecb75fcdafd6d2d690

The unique ID of the 2FA verification session.

Response

Returns the list of 2FA verification events.

created_atstring date-time required

Date and time of the event

eventstring required

Human-readable event description. One of the following values:

  • Number lookup — the Wavix platform checked whether the destination phone number is valid. Returned only when number validation is enabled for the 2FA Service.
  • Code sent via SMS — a code was sent via SMS.
  • Code sent via voice — a code was sent via a voice call.
  • Verification — a code verification attempt.
statusstring required

Status of an action associated with the event. Can be either success, failed, or pending.

chargestring required

Cost of an operation associated with the event, in USD

errorstring nullable required

Error description, if any

Example response

[
  {
    "created_at": "2022-02-16T13:41:38.000Z",
    "event": "Number lookup",
    "status": "success",
    "charge": "0.005",
    "error": null
  },
  {
    "created_at": "2022-02-16T13:41:38.000Z",
    "event": "Code sent via SMS",
    "status": "success",
    "charge": "0.005",
    "error": null
  }
]

Changes

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 76b9bb35619fRevision changes
    • warning

      removed the optional property from the response with the status