API Reference

Create Account Recoveries (bulk)

post
https://api-sandbox.koin.com.br/v1/accounts/recoveries

Creates a recovery for each account in the list, with the same fields as the individual creation plus user_id. There is no bulk PATCH: completing a two-step recovery is done account by account.

Up to 1,000 entries per request; more returns 400 for the whole request. Otherwise it always returns 200, with one result per entry in the same order as the request: an invalid entry does not fail the others. If the same user_id appears twice, the entries are processed in order; the second changes nothing and gets the same result.

Safe to retry: if the account is already in that state, the entry gets the same result and the existing id (the same id), without side effects or a new history entry. A retry with different data (for example, another client_flow) does not change the account or the recorded reason.

Body Params
accounts
array of objects
required
length between 1 and 1000

Up to 1,000 accounts, each with its own fields.

accounts*
string
required

The account's user_id: the same details.user_id you send on evaluations.

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

Updated 20 days ago

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

Updated 20 days ago