v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Two Factor Authentication

Code Generator Information

This endpoint allows you to retrieve the information of a certain code generator previously configured.

get/v1/2fa/{id}

Path parameters

idinteger required

Provide the unique ID of the code generator

Response

Succeed, 2FA Information Retrieved

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "id": 1,
    "codeLength": 5,
    "expirationMinutes": 10,
    "channels": [
      {
        "subject": "Your verification code",
        "shortcode": "1234",
        "from": "noreply@example.com",
        "text": "Verification code: {0}",
        "placeholder": "code",
        "address": "1234",
        "templateName": "2fa_template",
        "templateId": "2fa_template",
        "templateLanguage": "en",
        "type": "SMS"
      }
    ]
  }
}