POST api/bfg/v1/persons/username-recovery/request

Start username recovery after identity lookup (WI 59111). Session state is owned by the caller; supply <see cref="F:TPP.B2B.Webservices2.Utilities.CorrelationHeaderResult.HeaderName" /> on the request.

Request Information

URI Parameters

None.

Body Parameters

UsernameRecoveryRequest

Name	Type	Additional information
brandId	integer	Required
lastName	string	Required String length: inclusive between 0 and 50
dateOfBirth	date	Required
mobileNumber	string	Required String length: inclusive between 0 and 30

Request Formats

application/json, text/json

Sample:

{
  "brandId": 1,
  "lastName": "sample string 2",
  "dateOfBirth": "2026-10-14T15:23:27.3544228+11:00",
  "mobileNumber": "sample string 4"
}

application/xml, text/xml

Sample:

<UsernameRecoveryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.UsernameRecovery">
  <brandId>1</brandId>
  <dateOfBirth>2026-10-14T15:23:27.3544228+11:00</dateOfBirth>
  <lastName>sample string 2</lastName>
  <mobileNumber>sample string 4</mobileNumber>
</UsernameRecoveryRequest>

Response Information

Resource Description

UsernameRecoveryResponse

Name	Type	Additional information
isSuccess	boolean	None.
usernameRecoveryId	globally unique identifier	None.
emailVerification	UsernameRecoveryEmailVerificationIssueResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "usernameRecoveryId": "0e1b7c78-19a5-49c7-ad23-fe1b22d5025b",
  "emailVerification": {
    "sentToEmail": "sample string 1",
    "expiresAtUtc": "2026-10-14T15:23:27.3544228+11:00",
    "issueCount": 3,
    "issuesRemaining": 4,
    "attemptCount": 5,
    "attemptsRemaining": 6
  }
}

application/xml, text/xml

Sample:

<UsernameRecoveryResponse 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>
    <expiresAtUtc>2026-10-14T15:23:27.3544228+11:00</expiresAtUtc>
    <issueCount>3</issueCount>
    <issuesRemaining>4</issuesRemaining>
    <sentToEmail>sample string 1</sentToEmail>
  </emailVerification>
  <isSuccess>true</isSuccess>
  <usernameRecoveryId>0e1b7c78-19a5-49c7-ad23-fe1b22d5025b</usernameRecoveryId>
</UsernameRecoveryResponse>