POST api/v1/user/recoverypassword/request?isWhatsapp={isWhatsapp}

Request Password Recovery Validation Code (SMS notification)

Request Information

URI Parameters

Name	Description	Type	Additional information
isWhatsapp		boolean	Default value is False

Requires Authorization!

Roles:

Body Parameters

UserPasswordRecoveryRequestDto

Name	Type	Additional information
DeviceUID	string	None.
CompanyId	string	None.
Document	string	None.
Birthday	date	None.

Request Formats

application/json, text/json

Sample:

{
  "DeviceUID": "sample string 1",
  "CompanyId": "sample string 2",
  "Document": "sample string 3",
  "Birthday": "2025-04-29T11:48:02.1625946-03:00"
}

application/xml, text/xml

Sample:

<UserPasswordRecoveryRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs">
  <Birthday>2025-04-29T11:48:02.1625946-03:00</Birthday>
  <CompanyId>sample string 2</CompanyId>
  <DeviceUID>sample string 1</DeviceUID>
  <Document>sample string 3</Document>
</UserPasswordRecoveryRequestDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserPasswordRecoveryRequestDto'.

Response Information

Resource Description

ResultOfString

Name	Description	Type	Additional information
Data		string	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": "sample string 1",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.Entities.Ep">
  <Data>sample string 1</Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ResultOfstring>