3.7. Read a Partner Identifier

Method	URL
GET	oauth2/ctid/referral

Retrieves the unique partner identifier of a specific partner entity.

Parameters

Parameter	Parameter Type	Required?	Data Type	Description
`userId`	query	No (if the partner entity is an account)	integer	The unique ID of a specific user.
`ctidTraderAccountId`	query	No (if the partner entity is a user)	integer	The unique ID of the linkage between a specific user and one of their trading accounts.
`brokerCrmName`	query	Yes	string	Please, see Section 2.3.

Note that the request body can include either a userId or a ctidTraderAccountId depending on the entity to which the partner identifier is assigned. To elaborate, userId is a mandatory parameter if the identifier is assigned to a user; alternatively, ctidTraderAccountId is a mandatory parameter if the identifier is assigned to an account.

Output

Key	Data Type	Description
`ctidTraderAccountId`	integer	The unique ID of the linkage between a specific user and one of their trading accounts.
`userId`	integer	The unique ID of a specific user.
`partnerId`	string	The string assigned as a partner identifier to a specific user or an account.

Request Example

curl -X GET "https://HOST:PORT/cid/oauth2/ctid/referral?token=token=04d95575-c9af-42fba72e-2f0ce93f01d4?ctidTraderAccountId=9017800&brokerCrmName=BESTBROKERCRM" -H "Accept: application/json"

Expected Response Status Code

200

Response Example

{
    "userId": 10345533,
    "ctidTraderAccountId": 9017800,
    "partnerId":"somePartnerId"
}

Last update: February 6, 2023