API Reference

Quarantine Accounts (bulk)

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

Quarantines a list of accounts, each with its own reason, comment, and external_reference. An account that is BLOCKED or RECOVERING gets REJECTED.

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 reason) 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.

string
enum
required

Why you restrict the account. ATO_SUSPECTED and ATO_CONFIRMED tell Koin you suspect or confirm an account takeover; NOT_ME records that the member said it was not them; FRAUD_CONFIRMED records a confirmed fraud; INTERNAL_POLICY and OTHER are for reasons of your own program.

Allowed:
string

Free text.

string

The case id in your own system.

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