POST api/v1/login/{brand}?returnUrl={returnUrl}
whitelabelcustomerlogin
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| model |
Define this parameter in the request body. |
|
| brand | A brand value corresponding to an entry in Preferences.xml for a white label mobile app. |
Define this parameter in the request URI. |
| returnUrl |
Define this parameter in the request URI. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"UserName": "sample string 1",
"Password": "sample string 2",
"Brand": "sample string 3",
"RememberMe": true
}
application/xml, text/xml
Sample:
<LogOnModel> <UserName>sample string 1</UserName> <Password>sample string 2</Password> <Brand>sample string 3</Brand> <RememberMe>true</RememberMe> </LogOnModel>
Response Information
Response body formats
application/json, text/json
Sample:
{
"LastLogin": "2026-01-27T14:38:57.3424421Z",
"UserDetails": {
"ContactID": 1,
"AgentID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"JobTitle": "sample string 6",
"ContactNumber": "sample string 7",
"IsActivated": true,
"OperatedBy": 1,
"AddressBookID": 1,
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"ContactType": "sample string 9",
"UCTReferer": "sample string 10",
"UCTIsCaptcha": true,
"UATReferer": "sample string 12",
"UATIsCaptcha": true,
"Username": "sample string 14",
"GDPRflag": true
},
"AgentDetails": {
"AgentID": 1,
"AgentName": "sample string 2",
"AgentBranchName": "sample string 3",
"Services": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"Networks": [
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"RefNumber": "sample string 1"
}
],
"Permissions": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"UserPreferences": {
"AboutUs": "sample string 1",
"MOTDSubject": "sample string 2",
"MOTDMessage": "sample string 3",
"Language": "sample string 1",
"Currency": "sample string 2",
"UnitSystem": "sample string 3",
"TimeZone": {
"TheID": 1,
"KeyIdentifier": "sample string 2",
"KeyValue": "sample string 3",
"KeyDescription": "sample string 4",
"IsDefault": true
},
"DateFormat": "sample string 4",
"TimeFormat": "sample string 5",
"Controls": {
"MaxRFQ": 1
},
"Networks": [
{
"Code": "sample string 2",
"Name": "sample string 3",
"Preferred": true
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"Preferred": true
},
{
"Code": "sample string 2",
"Name": "sample string 3",
"Preferred": true
}
],
"ContactEmail": "sample string 6"
},
"Version": {
"APIVersion": "sample string 1",
"UIVersion": "sample string 2",
"MobileVersion": "sample string 3"
}
}
application/xml, text/xml
Sample:
<MobileAuthResponseDTO>
<LastLogin>2026-01-27T14:38:57.3424421+00:00</LastLogin>
<UserDetails>
<ContactID>1</ContactID>
<AgentID>2</AgentID>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Email>sample string 5</Email>
<JobTitle>sample string 6</JobTitle>
<ContactNumber>sample string 7</ContactNumber>
<IsActivated>true</IsActivated>
<OperatedBy>1</OperatedBy>
<AddressBookID>1</AddressBookID>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
<ContactType>sample string 9</ContactType>
<UCTReferer>sample string 10</UCTReferer>
<UCTIsCaptcha>true</UCTIsCaptcha>
<UATReferer>sample string 12</UATReferer>
<UATIsCaptcha>true</UATIsCaptcha>
<Username>sample string 14</Username>
<GDPRflag>true</GDPRflag>
</UserDetails>
<AgentDetails>
<AgentID>1</AgentID>
<AgentName>sample string 2</AgentName>
<AgentBranchName>sample string 3</AgentBranchName>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Services>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Services>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<RefNumber>sample string 1</RefNumber>
</Networks>
<Permissions>sample string 1</Permissions>
<Permissions>sample string 2</Permissions>
<Permissions>sample string 3</Permissions>
</AgentDetails>
<UserPreferences>
<AboutUs>sample string 1</AboutUs>
<MOTDSubject>sample string 2</MOTDSubject>
<MOTDMessage>sample string 3</MOTDMessage>
<Language>sample string 1</Language>
<Currency>sample string 2</Currency>
<UnitSystem>sample string 3</UnitSystem>
<TimeZone>
<TheID>1</TheID>
<KeyIdentifier>sample string 2</KeyIdentifier>
<KeyValue>sample string 3</KeyValue>
<KeyDescription>sample string 4</KeyDescription>
<IsDefault>true</IsDefault>
</TimeZone>
<DateFormat>sample string 4</DateFormat>
<TimeFormat>sample string 5</TimeFormat>
<Controls>
<MaxRFQ>1</MaxRFQ>
</Controls>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<Preferred>true</Preferred>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<Preferred>true</Preferred>
</Networks>
<Networks>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<Preferred>true</Preferred>
</Networks>
<ContactEmail>sample string 6</ContactEmail>
</UserPreferences>
<Version>
<APIVersion>sample string 1</APIVersion>
<UIVersion>sample string 2</UIVersion>
<MobileVersion>sample string 3</MobileVersion>
</Version>
</MobileAuthResponseDTO>