API Reference

Get player by CPF

get
https://kyg-api.paag.io/api/v1/players/

Main endpoint for looking up a single player. Returns every KYG dimension available for the given CPF.

Path Params
string
required

Player CPF (digits only, 11 characters)

Query Params
string

Dimensions to return (comma-separated). Accepted values: value, engagement, behavior, clustering.

boolean
Defaults to false
deprecated

Accepted for compatibility and has no effect: the API returns no history. Kept so integrations that already send it do not break.

string
enum
Defaults to json

Response format. Only json is supported; any other value returns 400 UNSUPPORTED_FORMAT.

Allowed:
Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?