INinfobip
platform
2fa
pin-sending-and-verification
verify-pin

Verify a PIN

Verify OTP to confirm successful phone number verification. pinId is received in the response after sending the OTP message.

post/2fa/2/pin/{pinId}/verify

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

pinIdstring required

ID of the pin code that has to be verified.

Request body

pinstring required

The PIN code to verify.

Response

successful response

attemptsRemaininginteger

Number of remaining PIN attempts.

msisdnstring

Phone number (MSISDN) to which the 2FA message was sent.

pinError'TTL_EXPIRED' | 'WRONG_PIN' | 'NO_MORE_PIN_ATTEMPTS'
pinIdstring

Sent PIN code ID.

verifiedboolean

Indicates whether the phone number (MSISDN) was successfully verified.

Changes

No recorded changes to this operation across all 1 revision of this API.