Skip to main content
POST
/
v1beta1
/
get_who_am_i
Get Who Am I
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/get_who_am_i \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "audience": "<string>",
  "firm": "<string>",
  "firm_display_name": "<string>",
  "firm_type": "FIRM_TYPE_UNDEFINED",
  "user": "<string>",
  "user_display_name": "<string>"
}

Body

application/json

Request to get the user information of the caller.

Response

A successful response.

​
audience
string

The claim string for the user to verify whether the user is entitled to perform audience specific requests.

​
firm
string

Fully qualified resource name for the firm associated with the user (ie: "firms/[firmid]").

​
firm_display_name
string

Display name for the firm associated with the user.

​
firm_type
enum<string>
default:FIRM_TYPE_UNDEFINED

FirmType of the exchange firm.

Available options:
FIRM_TYPE_UNDEFINED,
FIRM_TYPE_PARTICIPANT,
FIRM_TYPE_SUPERVISOR,
FIRM_TYPE_CLEARING_MEMBER,
FIRM_TYPE_CLEARING_HOUSE,
FIRM_TYPE_AGENT
​
user
string

Fully qualified resource name for the user (ie: "firms/[firmid]/users/[userid]").

​
user_display_name
string

Display name for the user.