Tracking Users

Send user registration and profile update events to Atlas for player analytics and compliance.

Event Types

User events are sent to POST /api/v1/user. The Kafka topic is fixed: atlas.events.raw.user.

Event	Description
register	Player creates a new account
update	Player updates their profile

Track a Registration

Send this event when a player creates a new account on your platform.

cURL

curl -X POST https://events.atlas.io/api/v1/user \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": "org_abc123",
    "brand_id": "brand_xyz",
    "event": "register",
    "user_id": "user_12345",
    "email": "[e-mail]",
    "full_name": "João Silva",
    "document": "***.***.***-**",
    "birthdate": "1990-05-15",
    "country": "BR",
    "state": "SP",
    "city": "São Paulo",
    "phone": "+55 11 9****-****",
    "kyc_status": "pending",
    "registered_at": "2026-03-11T14:30:00Z"
  }'

Track a Profile Update

Send this event when a player updates their profile data, KYC status changes, or address is verified. Only include the fields that changed.

cURL

curl -X POST https://events.atlas.io/api/v1/user \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": "org_abc123",
    "brand_id": "brand_xyz",
    "event": "update",
    "user_id": "user_12345",
    "kyc_status": "approved",
    "updated_at": "2026-03-11T15:00:00Z"
  }'

Request Fields

Envelope Fields (all events)

org_id · string · required

Your organization ID. Found in Dashboard -> Settings -> Organization.

brand_id · string · required

Brand identifier where this user belongs.

event · string · required

Event type: register or update.

ip · string

Player IP address at event time (IPv4 or IPv6).

geolocation_lat · number

Player latitude at event time.

geolocation_long · number

Player longitude at event time.

User Profile Fields

user_id · string · required

Your internal user identifier. Must be stable across all events for the same player.

full_name · string

Player full name.

email · string

Player email. Must be a valid email format when provided.

phone · string

Player phone number.

document · string

Player document (CPF or equivalent). Send masked or hashed values whenever possible.

birthdate · string

Birth date as string (for example 1990-05-15).

gender · integer

Gender code from your platform model.

country · string

Country code (for example BR).

post_code · string

Postal code / ZIP code.

city · string

City name.

state · string

State / region code.

registered_at · string

Registration timestamp in ISO 8601.

updated_at · string

Profile update timestamp in ISO 8601.

registration_platform · string

Allowed values: DESKTOP, MOBILE, APP.

status · string

Allowed values: ACTIVE, BLOCKED, SUSPENDED, BANNED, SELF_EXCLUDED, DEACTIVATED, PENDING.

is_test_account · boolean

Indicates whether this user is a test account.

kyc_status · string

KYC verification status from your platform workflow.

Batch Registration

For bulk imports (e.g., migrating players from a legacy system):

curl -X POST https://events.atlas.io/api/v1/user/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "org_id": "org_abc123",
        "brand_id": "brand_xyz",
        "event": "register",
        "user_id": "user_001",
        "email": "[e-mail]",
        "registered_at": "2025-01-01T00:00:00Z"
      },
      {
        "org_id": "org_abc123",
        "brand_id": "brand_xyz",
        "event": "register",
        "user_id": "user_002",
        "email": "[e-mail]",
        "registered_at": "2025-01-02T00:00:00Z"
      }
    ]
  }'

For historical data migrations, include the original registered_at timestamp. Atlas will backfill the analytics using the actual registration dates.

Privacy & PII

User events may contain PII (Personally Identifiable Information). Atlas handles all data in compliance with LGPD (Lei Geral de Proteção de Dados) and GDPR.

Best practice: Never send raw CPF or document numbers — always hash or mask them before sending to Atlas unless your Data Processing Agreement explicitly allows it.