API Reference

Player enrichment

post
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.

Body Params
string
required

Player document (CPF), digits only. Sent in the body so it does not end up in access logs, proxies or browser history.

string
enum
required

Declared reason for the query. Required. Recorded for traceability and auditing: it does not change any score, cluster or dimension.

  • ONBOARDING — player sign-up
  • TRANSACTIONAL_ANALYSIS — analysis tied to transactional activity
  • PROFILE_UPDATE — profile refresh or re-assessment
  • COMMERCIAL_SEGMENTATION — segmentation, CRM, campaigns or offers
  • ACCOUNT_REVIEW — player account review
Allowed:
string

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

Responses

Updated about 1 month 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 about 1 month ago

Did this page help you?