Create Account Recovery

Starts a recovery, or records one that already finished. Allowed from BLOCKED and QUARANTINED.

  • completed: false (default), self-service in two steps: the account becomes RECOVERING until expires_at. The events of your recovery flow (for example, the CHANGE_PASSWORD of the reset) pass with strong verification instead of being denied. When you are sure the user recovered the account, complete it with PATCH /v1/accounts/USER_ID/recoveries/{recovery_id}. If expires_at passes first, the recovery is abandoned and the account gets a new restriction of the same kind it had before.
  • completed: true, call center in one step: the account stayed BLOCKED during your review and becomes NORMAL.

Reaching NORMAL updates last_recovered_at and recovery_count. If a block was a mistake, recover the account with client_flow: FALSE_POSITIVE.

Special cases:

  • completed: false on an account that is already RECOVERING returns 200 with the same recovery in progress (the same recovery_id) and renews expires_at, with the value you sent or the default period.
  • completed: true on an account that is RECOVERING returns 409: complete the recovery in progress with the PATCH.
  • On a NORMAL account it returns 409 if the user never went through a recovery, because there is nothing to recover. If they did (for example, you retry after a timeout), it returns 200 with that recovery.
Path Params
string
required

The account's user_id: the same details.user_id you send on evaluations. URL-encode it if it contains reserved characters.

Body Params

client_flow and reported_by are set when the recovery is created and do not change.

boolean
Defaults to false

false (default): the account becomes RECOVERING until you complete it or expires_at passes. true: the recovery already happened and the account becomes NORMAL.

string
enum
required

Your recovery flow (Koin does not own these flows). Use FALSE_POSITIVE to undo a block that was a mistake.

Allowed:
string
enum
required

Who intends to recover the account.

Allowed:
date-time

Only with completed: false. A future ISO-8601 date and time until which the account can stay RECOVERING. If you omit it, Koin applies a default period. With completed: true it returns 400.

boolean

You revoked the sessions and tokens of the account. Koin records it; it does not verify it.

string

Free text.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json