Users

End users related endpoints

Get info for the given casino player

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/casino/players

Returns information for the casino player with the given id.

If a player does not exist for the given id an appropriate error is returned.

Example

In this example we get the country of the user with id 123.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/players?id=123,fields=country'

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstringRequired

The player id to get information for.

Default: 0

fieldsstring · enumOptional

Optional selection of the object fields to retrieve. It expects a comma separated list of strings, as described in the field selection section, e.g. brand,city.

Default: brand,city,country,language,statePossible values:

operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/casino/players

HTTPcURLJavaScriptPython

GET /api/casino/players?id=0 HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": {
    "brand": null,
    "city": "ldn",
    "country": "uk",
    "language": "en",
    "state": null
  },
  "status": "success"
}