POST Account/LoginClient

Login for the client using either the client's CellPhone or Email or AccountNumber or Identity Number

Request Information

URI Parameters

None.

Body Parameters

ApiClientLoginRequest
NameDescriptionTypeAdditional information
clientAccountNumber

Gets or sets the client account number.

 string

None.
clientPin

Gets or sets the client pin.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "clientAccountNumber": "sample string 1",
  "clientPin": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiClientLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <clientAccountNumber>sample string 1</clientAccountNumber>
  <clientPin>sample string 2</clientPin>
</ApiClientLoginRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApiClientLoginRequest'.

Response Information

Resource Description

LogonResponseLite.

ApiClientLoginResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

 ApiClient

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseObject": {
    "ClientID": 1,
    "ClientGuid": "6b434e33-2f0a-4ed9-ab04-8321bdc51bb8",
    "FK_ClientTitleID": 3,
    "FirstName": "sample string 4",
    "ClientPassword": "sample string 5",
    "ClientPin": "sample string 6",
    "LastName": "sample string 7",
    "Initials": "sample string 8",
    "DateOfBirth": "2025-12-27T08:56:02.1225757+02:00",
    "CellPhone": "sample string 10",
    "Email": "sample string 11",
    "FK_CountryID": 1,
    "PassportNumber": "sample string 12",
    "FK_IdentityTypeID": 13,
    "IdentityTypeValue": "sample string 14",
    "CreditLimit": 1.0,
    "CurrentStake": 15.0,
    "BalanceAvailable": 16.0,
    "BalancePending": 17.0,
    "FK_ClientTypeID": 18,
    "FK_AccountTypeID": 64,
    "ClientFICACompliant": true,
    "FK_CompanyID": 21,
    "ChangePasswordAtNextLogin": true,
    "FailedLogins": 1,
    "FK_ClientStatusID": 22,
    "FK_BranchID": 1,
    "FK_CountryOfOrigin": 1,
    "NotifyOnBetStrike": true,
    "MaximumLiabilitySingleBets": 1.0,
    "MaximumLiabilityMultipleBets": 1.0,
    "MaximumLiability": 23.0,
    "Gender": "sample string 24",
    "DepositLimit": 1.0,
    "PreferredContactID": 1,
    "CurrencyRate": 1.0,
    "DepositLimitPerDay": 1,
    "StakeLimitPerDay": 1,
    "SelfExclusionDate": "2025-12-27T08:56:02.1225757+02:00",
    "ClientTitleName": "sample string 25",
    "AccountTypeName": "sample string 26",
    "ClientTypeName": "sample string 27",
    "SourceOfIncome": "sample string 28"
  },
  "ResponseType": 1,
  "ResponseMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiClientLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseType>1</ResponseType>
  <ResponseObject>
    <AccountTypeName>sample string 26</AccountTypeName>
    <BalanceAvailable>16</BalanceAvailable>
    <BalancePending>17</BalancePending>
    <CellPhone>sample string 10</CellPhone>
    <ChangePasswordAtNextLogin>true</ChangePasswordAtNextLogin>
    <ClientFICACompliant>true</ClientFICACompliant>
    <ClientGuid>6b434e33-2f0a-4ed9-ab04-8321bdc51bb8</ClientGuid>
    <ClientID>1</ClientID>
    <ClientPassword>sample string 5</ClientPassword>
    <ClientPin>sample string 6</ClientPin>
    <ClientTitleName>sample string 25</ClientTitleName>
    <ClientTypeName>sample string 27</ClientTypeName>
    <CreditLimit>1</CreditLimit>
    <CurrencyRate>1</CurrencyRate>
    <CurrentStake>15</CurrentStake>
    <DateOfBirth>2025-12-27T08:56:02.1225757+02:00</DateOfBirth>
    <DepositLimit>1</DepositLimit>
    <DepositLimitPerDay>1</DepositLimitPerDay>
    <Email>sample string 11</Email>
    <FK_AccountTypeID>64</FK_AccountTypeID>
    <FK_BranchID>1</FK_BranchID>
    <FK_ClientStatusID>22</FK_ClientStatusID>
    <FK_ClientTitleID>3</FK_ClientTitleID>
    <FK_ClientTypeID>18</FK_ClientTypeID>
    <FK_CompanyID>21</FK_CompanyID>
    <FK_CountryID>1</FK_CountryID>
    <FK_CountryOfOrigin>1</FK_CountryOfOrigin>
    <FK_IdentityTypeID>13</FK_IdentityTypeID>
    <FailedLogins>1</FailedLogins>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 24</Gender>
    <IdentityTypeValue>sample string 14</IdentityTypeValue>
    <Initials>sample string 8</Initials>
    <LastName>sample string 7</LastName>
    <MaximumLiability>23</MaximumLiability>
    <MaximumLiabilityMultipleBets>1</MaximumLiabilityMultipleBets>
    <MaximumLiabilitySingleBets>1</MaximumLiabilitySingleBets>
    <NotifyOnBetStrike>true</NotifyOnBetStrike>
    <PassportNumber>sample string 12</PassportNumber>
    <PreferredContactID>1</PreferredContactID>
    <SelfExclusionDate>2025-12-27T08:56:02.1225757+02:00</SelfExclusionDate>
    <SourceOfIncome>sample string 28</SourceOfIncome>
    <StakeLimitPerDay>1</StakeLimitPerDay>
  </ResponseObject>
</ApiClientLoginResponse>