Search Accounts

Finds the accounts of your program that match the filters, with their personal data and risk state. Use it to get the user_id that blocks, quarantines, and recoveries need.

Send at least one filter: user_id, document, email, phone, device, or risk_state. If you send several, all of them must match; risk_state works on its own. Inside device, send exactly one of merchant_device or koin_device_id. A body without filters returns 400. It is a POST so that documents and emails never travel in the URL.

Returns a list, because an email, document, phone, or device can belong to more than one account. For accounts in RECOVERING, the summary also includes recovery_id and expires_at. You only see accounts of your own program, with data you sent to Koin, and only active emails and phones. No matches is a 200 with an empty accounts.

Query Params
integer
≥ 1
Defaults to 1

The page to return, from 1.

integer
1 to 100
Defaults to 50

Accounts per page: 50 by default, 100 at most.

Body Params

At least one filter. If you send several, all of them must match. A body without filters returns 400.

string

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

document
object

Document is required for Payment Antifraud Data if payment method is Redirection and email is blank.

string

An email of the account.

phone
object
device
object

Exactly one of merchant_device or koin_device_id.

risk_state
array of objects

A list of risk states. It works on its own, for example to list every blocked account.

risk_state
Allowed:
Responses

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