POST api/bfg/v1/persons/username-recovery/{usernameRecoveryUid}/email/verify

Checks the encrypted email-link code, moves the session to the OTP step, and sends the first SMS one-time password. An invalid or expired link returns 400. The attempt limit and a locked session return 403 SESSION_LOCKED.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
usernameRecoveryUid

string

Required

Body Parameters

UsernameRecoveryEmailVerifyRequest
NameDescriptionTypeAdditional information
code

string

None.

Request Formats

application/json, text/json

Sample:
{
  "code": "sample string 1"
}

application/xml, text/xml

Sample:
<UsernameRecoveryEmailVerifyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.UsernameRecovery">
  <code>sample string 1</code>
</UsernameRecoveryEmailVerifyRequest>

Response Information

Resource Description

UsernameRecoveryEmailVerifyResponse
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

emailVerification

UsernameRecoveryVerificationIssueResponse

None.

otpVerification

UsernameRecoveryOTPVerificationIssueResponse

None.

errorCode

string

None.

errorMessage

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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