Skip to main content

​
Users API

The Users API provides user management capabilities for partners. Users represent individual retail traders on your platform.
Automatic User CreationUsers are created automatically when their KYC verification is approved. You do not need to call a user creation endpoint manually. See KYC Verification Flow for details.

​
Endpoints

MethodEndpointDescription
GET/v1/usersList users for trading
GET/v1/whoamiGet current authenticated identity

​
User Lifecycle

When a user completes KYC verification and is approved:
  1. The system automatically provisions an EP3 participant
  2. A trading account is created for the user
  3. The user can immediately proceed to funding and trading

​
List Users

Returns the users that the caller may trade on behalf of.

​
Request

GET /v1/users

​
Response

{
  "users": [
    "firms/ISV-Participant-Acme/users/user-123",
    "firms/ISV-Participant-Acme/users/user-456"
  ],
  "displayNames": [
    "John Doe",
    "Jane Smith"
  ],
  "firms": [
    "ISV-Participant-Acme",
    "ISV-Participant-Acme"
  ],
  "firmsDisplayNames": [
    "Acme Trading",
    "Acme Trading"
  ]
}

​
Response Fields

FieldTypeDescription
usersarrayEP3 participant IDs for each user
displayNamesarrayHuman-readable names (parallel array)
firmsarrayFirm IDs the users belong to
firmsDisplayNamesarrayHuman-readable firm names

​
Get Who Am I

Returns identity information for the authenticated caller.

​
Request

GET /v1/whoami

​
Response

{
  "user": "firms/ISV-Participant-Acme/users/admin",
  "userDisplayName": "ISV Admin",
  "firm": "ISV-Participant-Acme",
  "firmDisplayName": "Acme Trading Platform",
  "audience": "https://api.preprod.polymarketexchange.com",
  "firmType": "FIRM_TYPE_PARTICIPANT"
}

​
Response Fields

FieldTypeDescription
userstringFull EP3 participant ID
userDisplayNamestringHuman-readable user name
firmstringFirm identifier
firmDisplayNamestringHuman-readable firm name
audiencestringAPI audience from token
firmTypeenumType of firm (see below)

​
Firm Types

TypeDescription
FIRM_TYPE_PARTICIPANTStandard trading participant
FIRM_TYPE_SUPERVISORSupervisory role
FIRM_TYPE_CLEARING_MEMBERClearing member
FIRM_TYPE_CLEARING_HOUSEClearing house
FIRM_TYPE_AGENTAgent firm

​
User vs Account

EntityDescription
UserA person with identity (KYC verified). Has an EP3 participant ID.
AccountA trading account with balances and positions. Belongs to a user.
A user can have multiple accounts for different purposes (e.g., separate trading strategies).