POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/otp/send

Resends the SMS one-time password for a session on the OTP step. Issue cooldown and the issue limit return 400. A locked session returns 403 SESSION_LOCKED.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
usernameRecoveryUid

string

Required

Body Parameters

None.

Response Information

Resource Description

UsernameRecoveryOtpSendResponse
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

otpVerification

UsernameRecoveryOTPVerificationIssueResponse

None.

errorCode

string

None.

errorMessage

string

None.

nextRetryAtUtc

date

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "otpVerification": {
    "sentToMobile": "sample string 1",
    "expiresAtUtc": "2026-11-17T11:17:49.6990402+11:00",
    "issueCount": 3,
    "issuesRemaining": 4,
    "attemptCount": 5,
    "attemptsRemaining": 6,
    "cooldownSeconds": 7
  },
  "errorCode": "sample string 2",
  "errorMessage": "sample string 3",
  "nextRetryAtUtc": "2026-11-17T11:17:49.6990402+11:00"
}

application/xml, text/xml

Sample:
<UsernameRecoveryOtpSendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.UsernameRecovery">
  <errorCode>sample string 2</errorCode>
  <errorMessage>sample string 3</errorMessage>
  <isSuccess>true</isSuccess>
  <nextRetryAtUtc>2026-11-17T11:17:49.6990402+11:00</nextRetryAtUtc>
  <otpVerification>
    <attemptCount>5</attemptCount>
    <attemptsRemaining>6</attemptsRemaining>
    <cooldownSeconds>7</cooldownSeconds>
    <expiresAtUtc>2026-11-17T11:17:49.6990402+11:00</expiresAtUtc>
    <issueCount>3</issueCount>
    <issuesRemaining>4</issuesRemaining>
    <sentToMobile>sample string 1</sentToMobile>
  </otpVerification>
</UsernameRecoveryOtpSendResponse>