POST account/forgotpassword

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientId	string	Required
RedirectUrl	string	None.
BrokerList	Collection of Broker	None.
Email	string	Required
BrokerId	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "clientId": "sample string 1",
  "redirectUrl": "sample string 2",
  "brokerList": [
    {
      "id": "8f743f4c-bf45-4250-af09-51434cc1f355",
      "regulator": 0,
      "name": "sample string 2",
      "nameAlias": "sample string 3",
      "urlAddress": "sample string 4",
      "cssAddress": "sample string 5",
      "migrationBrokerId": "cc020d76-a8b6-46fa-ab71-d66fdb380050",
      "cHubPlantId": "sample string 6",
      "clientPermissions": {
        "depositFunds": true,
        "editProfile": true,
        "editSettings": true,
        "openAdditionalDemoAccounts": true,
        "openAdditionalLiveAccounts": true,
        "transferFunds": true,
        "withdrawFunds": true,
        "pendingDepositFunds": true,
        "showAnalysis": true
      },
      "cpUrl": "sample string 7",
      "depositBonusFirstLimitAmount": 8.0,
      "depositBonusFirstLimitPercentage": 9.0,
      "depositBonusSecondLimitAmount": 10.0,
      "depositBonusSecondLimitPercentage": 11.0,
      "smsBonusUSD": 12.0,
      "emailBonusUSD": 13.0,
      "kycBonusUSD": 14.0,
      "freeVPSCountries": "sample string 15",
      "maxDepositWithoutKyc": 16.0
    },
    {
      "id": "8f743f4c-bf45-4250-af09-51434cc1f355",
      "regulator": 0,
      "name": "sample string 2",
      "nameAlias": "sample string 3",
      "urlAddress": "sample string 4",
      "cssAddress": "sample string 5",
      "migrationBrokerId": "cc020d76-a8b6-46fa-ab71-d66fdb380050",
      "cHubPlantId": "sample string 6",
      "clientPermissions": {
        "depositFunds": true,
        "editProfile": true,
        "editSettings": true,
        "openAdditionalDemoAccounts": true,
        "openAdditionalLiveAccounts": true,
        "transferFunds": true,
        "withdrawFunds": true,
        "pendingDepositFunds": true,
        "showAnalysis": true
      },
      "cpUrl": "sample string 7",
      "depositBonusFirstLimitAmount": 8.0,
      "depositBonusFirstLimitPercentage": 9.0,
      "depositBonusSecondLimitAmount": 10.0,
      "depositBonusSecondLimitPercentage": 11.0,
      "smsBonusUSD": 12.0,
      "emailBonusUSD": 13.0,
      "kycBonusUSD": 14.0,
      "freeVPSCountries": "sample string 15",
      "maxDepositWithoutKyc": 16.0
    }
  ],
  "email": "sample string 3",
  "brokerId": "c33e182e-3b85-4bf3-bfe6-0488d2b57169"
}

application/xml, text/xml

Sample:

<ForgotPasswordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/App.Auth.Models">
  <BrokerId>c33e182e-3b85-4bf3-bfe6-0488d2b57169</BrokerId>
  <Email>sample string 3</Email>
  <BrokerList xmlns:d2p1="http://schemas.datacontract.org/2004/07/App.Framework.DTO.CRM">
    <d2p1:Broker>
      <d2p1:CPUrl>sample string 7</d2p1:CPUrl>
      <d2p1:ClientPermissions>
        <d2p1:DepositFunds>true</d2p1:DepositFunds>
        <d2p1:EditProfile>true</d2p1:EditProfile>
        <d2p1:EditSettings>true</d2p1:EditSettings>
        <d2p1:OpenAdditionalDemoAccounts>true</d2p1:OpenAdditionalDemoAccounts>
        <d2p1:OpenAdditionalLiveAccounts>true</d2p1:OpenAdditionalLiveAccounts>
        <d2p1:PendingDepositFunds>true</d2p1:PendingDepositFunds>
        <d2p1:ShowAnalysis>true</d2p1:ShowAnalysis>
        <d2p1:TransferFunds>true</d2p1:TransferFunds>
        <d2p1:WithdrawFunds>true</d2p1:WithdrawFunds>
      </d2p1:ClientPermissions>
      <d2p1:CssAddress>sample string 5</d2p1:CssAddress>
      <d2p1:DepositBonusFirstLimitAmount>8</d2p1:DepositBonusFirstLimitAmount>
      <d2p1:DepositBonusFirstLimitPercentage>9</d2p1:DepositBonusFirstLimitPercentage>
      <d2p1:DepositBonusSecondLimitAmount>10</d2p1:DepositBonusSecondLimitAmount>
      <d2p1:DepositBonusSecondLimitPercentage>11</d2p1:DepositBonusSecondLimitPercentage>
      <d2p1:EmailBonusUSD>13</d2p1:EmailBonusUSD>
      <d2p1:FreeVPSCountries>sample string 15</d2p1:FreeVPSCountries>
      <d2p1:Id>8f743f4c-bf45-4250-af09-51434cc1f355</d2p1:Id>
      <d2p1:KYCBonusUSD>14</d2p1:KYCBonusUSD>
      <d2p1:MaxDepositWithoutKyc>16</d2p1:MaxDepositWithoutKyc>
      <d2p1:MigrationBrokerId>cc020d76-a8b6-46fa-ab71-d66fdb380050</d2p1:MigrationBrokerId>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:NameAlias>sample string 3</d2p1:NameAlias>
      <d2p1:Regulator>FCA</d2p1:Regulator>
      <d2p1:SMSBonusUSD>12</d2p1:SMSBonusUSD>
      <d2p1:UrlAddress>sample string 4</d2p1:UrlAddress>
      <d2p1:cHubPlantId>sample string 6</d2p1:cHubPlantId>
    </d2p1:Broker>
    <d2p1:Broker>
      <d2p1:CPUrl>sample string 7</d2p1:CPUrl>
      <d2p1:ClientPermissions>
        <d2p1:DepositFunds>true</d2p1:DepositFunds>
        <d2p1:EditProfile>true</d2p1:EditProfile>
        <d2p1:EditSettings>true</d2p1:EditSettings>
        <d2p1:OpenAdditionalDemoAccounts>true</d2p1:OpenAdditionalDemoAccounts>
        <d2p1:OpenAdditionalLiveAccounts>true</d2p1:OpenAdditionalLiveAccounts>
        <d2p1:PendingDepositFunds>true</d2p1:PendingDepositFunds>
        <d2p1:ShowAnalysis>true</d2p1:ShowAnalysis>
        <d2p1:TransferFunds>true</d2p1:TransferFunds>
        <d2p1:WithdrawFunds>true</d2p1:WithdrawFunds>
      </d2p1:ClientPermissions>
      <d2p1:CssAddress>sample string 5</d2p1:CssAddress>
      <d2p1:DepositBonusFirstLimitAmount>8</d2p1:DepositBonusFirstLimitAmount>
      <d2p1:DepositBonusFirstLimitPercentage>9</d2p1:DepositBonusFirstLimitPercentage>
      <d2p1:DepositBonusSecondLimitAmount>10</d2p1:DepositBonusSecondLimitAmount>
      <d2p1:DepositBonusSecondLimitPercentage>11</d2p1:DepositBonusSecondLimitPercentage>
      <d2p1:EmailBonusUSD>13</d2p1:EmailBonusUSD>
      <d2p1:FreeVPSCountries>sample string 15</d2p1:FreeVPSCountries>
      <d2p1:Id>8f743f4c-bf45-4250-af09-51434cc1f355</d2p1:Id>
      <d2p1:KYCBonusUSD>14</d2p1:KYCBonusUSD>
      <d2p1:MaxDepositWithoutKyc>16</d2p1:MaxDepositWithoutKyc>
      <d2p1:MigrationBrokerId>cc020d76-a8b6-46fa-ab71-d66fdb380050</d2p1:MigrationBrokerId>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:NameAlias>sample string 3</d2p1:NameAlias>
      <d2p1:Regulator>FCA</d2p1:Regulator>
      <d2p1:SMSBonusUSD>12</d2p1:SMSBonusUSD>
      <d2p1:UrlAddress>sample string 4</d2p1:UrlAddress>
      <d2p1:cHubPlantId>sample string 6</d2p1:cHubPlantId>
    </d2p1:Broker>
  </BrokerList>
  <ClientId>sample string 1</ClientId>
  <RedirectUrl>sample string 2</RedirectUrl>
</ForgotPasswordModel>

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 'ForgotPasswordModel'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />