check if client with given email is affiliated with the agent

check if client with given email is affiliated with the agent

POST /api/v1/referral-agents/affiliation

check if client with given email is affiliated with the agent

cURL

curl --request POST \
  --url https://my.exnessaffiliates.com/api/v1/referral-agents/affiliation/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_email": "<string>",
  "max_accounts": 123
}
'

200

{
  "is_affiliated": "bool",
  "link_code": "string",
  "accounts": [
    "string"
  ]
}

Body

application/json

client_email · string · required

Agent's email

max_accounts · integer

Max amount of client accounts to return

Response

200

*/*

OK

is_affiliated · boolean · required

True if client is affiliated with the referral agent's partner

Example:

"bool"

link_code · string · required

Partner link code

Example:

"string"

accounts · string[] · required

Client account numbers

Example:

["string"]