Категории

​Проверка статуса аутентификации

Используется для получения информации о текущем статусе аутентификации, указав ее идентификатор.

Чтобы проверить статус аутентификации, отправьте запрос по этому URL: 
GET https://one-api.notificore.ru/api/2fa/authentications/{id}


Request parameters

Parameter Requires Type Default Description
id Yes string No Authentication ID received in response to https://one-api.notificore.ru/api/2fa/authentications/otp. The maximum length is 36 characters.


Response parameters

Parameter Type Description
id string Authentication ID created at the request of the user.
recipient string OTP message recipient number (specified by the user in the authentication request)
status string Authentication status. Possible values: pending – authentication has been created and is in the pending state; verified – authentication successful (code successfully verified); expired – authentication has expired; failed – authentication failed; canceled – authentication has been canceled.
channel string Authentication channel. Possible values: SMS, Viber.
sender string The name of the sender (specified by the user in the authentication request).
sender_alt string Alternative sender name for sending SMS (specified by the user in the authentication request).
code_lifetime integer OTP expiration date (specified by the user in the authentication request).
code_max_tries integer Number of OTP verification attempts (specified by the user in the authentication request).
code_digits integer The number of digits in the OTP (specified by the user in the authentication request).
price string Authentication cost (excluding the cost of sent messages). The amount must be displayed with 7 decimal places.
currency string The three-letter code of the currency in which the value is indicated.
country_code string Receiver’s country code according to ISO 3166-1 alpha-2.
expired_at string The expiration date of the authentication session.
created_at string The date and time of the authentication were created in ISO 8601 format.
finished_at string Date and time when authentication was closed in ISO 8601 format.
messages array Array of message objects:
messages[]id string The unique ID of the message.
messages[]recipient string The recipient’s phone number.
messages[]status string Message status. Possible values: delivered – the message was sent; accepted – message accepted for sending; undelivered – the message was not delivered.
messages[]channel string The channel for sending the message. Possible values: SMS or Viber.
messages[]sender string The name of the sender of the message.
messages[]text string Message text.
messages[]price float Message cost.
messages[]currency string The three-letter code of the currency in which the value is indicated.
messages[]sent_at string The date and time of the message were sent in ISO 8601 format.
messages[]created_at string The date and time the message was created in ISO 8601 format.


Response example

Ответ в случае успешного запроса: 

{
  "data": {
    "id": "ea5db413-e368-4952-b745-cc2030210c49",
    "recipient": "792501403813",
    "status": "verified",
    "channel": "sms",
    "sender": "testsms",
    "sender_alt": "string",
    "message_text": "Your Notificore 2FA confirmation code is {code}. Do not share this with anyone else.",
    "code_lifetime": 30,
    "code_max_tries": 5,
    "code_digits": 6,
    "price": 50.25,
    "currency": "EUR",
    "country_code": "RU",
    "expired_at": "2022-04-28 14:21:16",
    "created_at": "2022-04-28 14:21:16",
    "updated_at": "2022-04-28 14:21:16",
    "finished_at": "2022-04-28 14:21:16",
    "messages": [
      {
        "id": "1ed32701-5d4f-6cfa-ba06-9db3aa8bab68",
        "recipient": "61401629754",
        "status": "accepted",
        "channel": "sms",
        "sender": "SENDER",
        "price": 0.0642918,
        "currency": "EUR",
        "sent_at": "2022-04-18 11:00:30",
        "created_at": "2022-04-18 10:55:35"
      }
    ]
  }
}


Possible errors

Code Error Description
404 Authentication not found This error can occur when the authentication identifier is specified incorrectly or the specified authentication is not present in the system. Please ensure that you are using the correct authentication identifier and try again.