Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
password

aid_customers_mfa_login_initiate_recovery_post

Initiate a Multi-Factor Authentication recovery login for a customer user that has forgotten/lost their secret. Specify the ident_type and the ident (email or phone_number) of the user. If the call is successful, the user will get an email with an one time recovery code that has to be submitted to the mfa_recovery endpoint. When a valid one time recovery has been posted the server response with a regular MFA challenge. Once authenticated the password or pin can be changed by updating the customer. scopes:

  • write:accounts:/auth/users
post/accounts/{aid}/customers/mfa_login_recovery

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

ident_type'phone_number' | 'email' required
identstring required

Email or phone_number, depending on the ident_type.

audiencestring required

The unique identifier of the target API you want to access. The audience must be a grant associated with the client used when calling this resource.

type'customer' | 'company' required

user type to login, required as users with different type can share email

Response

Recovery MFA challenge

binding_method'prompt'
oob_codestring required
mfa_tokenstring required
challenge_type'oob' required

MFA challenge types

  • oob (out of band) means that the user will get an out of band message containing a recovery_code that will have to be submitted along with the recovery_token when answering the MFA recovery challenge.

Example response

{
  "oob_code": "bkaiew...akas"
}