Skip to main content

API Documentation

Identity Service

MethodEndpointPurpose
POST/api/v1/admin/distributorsProvision a distributor account
POST/api/v1/auth/registerRegister a user
POST/api/v1/auth/loginAuthenticate and issue tokens
GET/api/v1/users/meReturn the current user profile

Customer Service

MethodEndpointPurpose
POST/api/v1/invitesCreate a distributor invite
POST/api/v1/invites/{token}/redeemRedeem an invite
GET/api/v1/relationships/{customer_id}Retrieve an authorized relationship view
GET/api/v1/entitlements/chat/{first_user_id}/{second_user_id}Confirm chat entitlement

Game Service

MethodEndpointPurpose
POST/api/v1/games/invitesCreate a game invite
POST/api/v1/games/invites/{invite_id}/acceptAccept a game invite
POST/api/v1/games/invites/{invite_id}/declineDecline a game invite
POST/api/v1/games/{game_id}/playSubmit a card play
GET/api/v1/games/{game_id}/reconnect-tokenRetrieve reconnect capability
GET/api/v1/games/{game_id}/scoreboardRetrieve game scores
WS/api/v1/games/{game_id}/wsStream live game events

Chat Service

MethodEndpointPurpose
POST/api/v1/conversationsCreate an entitled conversation
GET/api/v1/conversations/{conversation_id}/messagesList visible participant messages
POST/api/v1/conversations/{conversation_id}/messagesSend a message
POST/api/v1/messages/{message_id}/deliveredRecord delivery
POST/api/v1/messages/{message_id}/readRecord read state
WS/api/v1/conversations/{conversation_id}/wsStream live chat events
GET/api/v1/admin/moderation/conversations/{conversation_id}Review retained conversation content
POST/api/v1/admin/moderation/conversations/{conversation_id}/legal-holdApply legal hold
DELETE/api/v1/admin/moderation/conversations/{conversation_id}/legal-holdRelease legal hold
POST/api/v1/admin/archive-expiry/runTrigger archive expiry

Contract Rules

  • Public and internal APIs should remain domain-specific and typed.
  • Moderator/admin surfaces must stay distinct from participant-facing routes.
  • Service-to-service routes should require trusted credentials instead of user-supplied actor IDs.