POST WrmClient/Authenticate

Request Information

URI Parameters

None.

Body Parameters

AuthenticateRequest
NameDescriptionTypeAdditional information
UserName

string

Required

Password

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Password": "sample string 2",
  "UserName": "sample string 1"
}

application/xml, text/xml

Sample:
<AuthenticateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
</AuthenticateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticateResponse
NameDescriptionTypeAdditional information
MembershipKey

integer

None.

AltUsername

string

None.

OldPortfolioNo

string

None.

EmailAddress

string

None.

FirstName

string

None.

LastName

string

None.

FullName

string

None.

LastLoggedIn

date

None.

SecurityQuestion

string

None.

SecurityAnswer

string

None.

IsActive

boolean

None.

IsSysGenerated

boolean

None.

IsTcAgreed

boolean

None.

IsIndemnityAgreed

boolean

None.

IsOnlineRedemptionActive

boolean

None.

ResponseCode

integer

None.

ResponseMessage

string

None.

Token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsOnlineRedemptionActive": true,
  "IsIndemnityAgreed": true,
  "IsTcAgreed": true,
  "IsSysGenerated": true,
  "IsActive": true,
  "ResponseCode": 15,
  "MembershipKey": 1,
  "LastLoggedIn": "2025-04-28T11:30:14.553082Z",
  "Token": "sample string 17",
  "ResponseMessage": "sample string 16",
  "SecurityAnswer": "sample string 9",
  "SecurityQuestion": "sample string 8",
  "FullName": "sample string 7",
  "LastName": "sample string 6",
  "FirstName": "sample string 5",
  "EmailAddress": "sample string 4",
  "OldPortfolioNo": "sample string 3",
  "AltUsername": "sample string 2"
}

application/xml, text/xml

Sample:
<AuthenticateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MembershipKey>1</MembershipKey>
  <AltUsername>sample string 2</AltUsername>
  <OldPortfolioNo>sample string 3</OldPortfolioNo>
  <EmailAddress>sample string 4</EmailAddress>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 6</LastName>
  <FullName>sample string 7</FullName>
  <LastLoggedIn>2025-04-28T12:30:14.553082+01:00</LastLoggedIn>
  <SecurityQuestion>sample string 8</SecurityQuestion>
  <SecurityAnswer>sample string 9</SecurityAnswer>
  <IsActive>true</IsActive>
  <IsSysGenerated>true</IsSysGenerated>
  <IsTcAgreed>true</IsTcAgreed>
  <IsIndemnityAgreed>true</IsIndemnityAgreed>
  <IsOnlineRedemptionActive>true</IsOnlineRedemptionActive>
  <ResponseCode>15</ResponseCode>
  <ResponseMessage>sample string 16</ResponseMessage>
  <Token>sample string 17</Token>
</AuthenticateResponse>