Skip to main content
GET
Returns all customers associated with your account, with support for filtering and pagination.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Query Parameters

per_page
integer
default:20

Number of records per page (default: 20).

email
string

Filter by email (partial match).

country
string

Filter by ISO 3166-1 alpha-3 country code (e.g. "USA", "BRA").

kyc_status
string

Filter by KYC status.

is_kyc_approved
boolean

Filter by KYC approval status. Pass "true" or "false".

Response

Paginated customer list

status
string
data
object[]
pagination
object