Skip to main content
GET
List end customers

Authorizations

X-Yara-API-Key
string
header
required

Your Yara API key. Send it in the X-Yara-API-Key header.

Query Parameters

external_reference
string

Exact merchant customer reference

type
enum<string>

Customer type

Available options:
INDIVIDUAL,
BUSINESS
status
string

Customer verification status

created_from
string

Created at or after this RFC3339 timestamp

created_to
string

Created at or before this RFC3339 timestamp

limit
integer

Number of results per page (default: 50, max: 200)

Required range: 1 <= x <= 200
page
integer

Page number (default: 1)

Required range: x >= 1

Response

OK

data
object
required
error
string
required
message
string
required
Example:

"resource retrieved"

status
enum<string>
required
Available options:
success
Example:

"success"