Autional Autional
API Reference GitHub autional.com →

POST /auth/recovery/request

Initiate the account recovery flow via email or phone number, generate a recovery token and send a verification code to the trusted contact, supporting sending the recovery code to a backup email or phone. References: NIST SP 800-63B §5.1.1.2, OWASP ASVS V2.3.

Authentication None application/json

Request Body

Schema: dto.RequestAccountRecoveryRequest

FieldTypeRequiredExampleConstraintsDescription
identity string Yes john@example.com Known identity identifier
method string Yes enum: `backup_email`, `security_qa`, `trusted_device`, `sms` Recovery method

Responses

StatusDescriptionSchema
200Recovery flow initiated, recovery token and masked contact information returneddto.RequestAccountRecoveryResponseWrapper
400Invalid request parametersgitee_com_linmes_authms_base_dto.SimpleResponse
500Internal server errorgitee_com_linmes_authms_base_dto.SimpleResponse

Referenced Schemas

dto.RequestAccountRecoveryResponseWrapper

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No
Try this API in Scalar → Download OpenAPI spec (JSON) ↓