POST v1/Authentication/userLogin

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
username	string	None.
password	string	None.
deviceID	string	None.
deviceSignature	string	None.
biometric	boolean	None.
companyCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2",
  "deviceID": "sample string 3",
  "deviceSignature": "sample string 4",
  "biometric": true,
  "companyCode": "sample string 6"
}

application/xml, text/xml

Sample:

<userLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.Authentication.userLogin">
  <biometric>true</biometric>
  <companyCode>sample string 6</companyCode>
  <deviceID>sample string 3</deviceID>
  <deviceSignature>sample string 4</deviceSignature>
  <password>sample string 2</password>
  <username>sample string 1</username>
</userLoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:

{"username":"sample string 1","password":"sample string 2","deviceID":"sample string 3","deviceSignature":"sample string 4","biometric":true,"companyCode":"sample string 6"}

Response Information

Resource Description

userLoginResult

Name	Type	Additional information
success	boolean	None.
message	string	None.
errorMsg	string	None.
emailAddress	string	None.
fullName	string	None.
mobileNo	string	None.
user_id	integer	None.
accessToken	string	None.
picture_url	string	None.
companyCode	string	None.
dob_MM_dd_yyyy	string	None.
gender	string	None.
dob	string	None.
niin_avaliable	boolean	None.
adProducts	Collection of advertProduct	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "emailAddress": "sample string 4",
  "fullName": "sample string 5",
  "mobileNo": "sample string 6",
  "user_id": 7,
  "accessToken": "sample string 8",
  "picture_url": "sample string 9",
  "companyCode": "sample string 10",
  "dob_MM_dd_yyyy": "sample string 11",
  "gender": "sample string 12",
  "dob": "sample string 13",
  "niin_avaliable": true,
  "adProducts": [
    {
      "productName": "sample string 1",
      "benefit": "sample string 2",
      "premium": 3.0,
      "paymentUrl": "sample string 4",
      "paymentReference": "sample string 5",
      "businessTypeCode": "sample string 6",
      "duration": "sample string 7"
    },
    {
      "productName": "sample string 1",
      "benefit": "sample string 2",
      "premium": 3.0,
      "paymentUrl": "sample string 4",
      "paymentReference": "sample string 5",
      "businessTypeCode": "sample string 6",
      "duration": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<userLoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.Authentication.userLogin">
  <accessToken>sample string 8</accessToken>
  <adProducts xmlns:d2p1="http://schemas.datacontract.org/2004/07/unifiedApp.Models.Authentication.authenticateGrouplife">
    <d2p1:authenticateGrouplifeResult.advertProduct>
      <d2p1:benefit>sample string 2</d2p1:benefit>
      <d2p1:businessTypeCode>sample string 6</d2p1:businessTypeCode>
      <d2p1:duration>sample string 7</d2p1:duration>
      <d2p1:paymentReference>sample string 5</d2p1:paymentReference>
      <d2p1:paymentUrl>sample string 4</d2p1:paymentUrl>
      <d2p1:premium>3</d2p1:premium>
      <d2p1:productName>sample string 1</d2p1:productName>
    </d2p1:authenticateGrouplifeResult.advertProduct>
    <d2p1:authenticateGrouplifeResult.advertProduct>
      <d2p1:benefit>sample string 2</d2p1:benefit>
      <d2p1:businessTypeCode>sample string 6</d2p1:businessTypeCode>
      <d2p1:duration>sample string 7</d2p1:duration>
      <d2p1:paymentReference>sample string 5</d2p1:paymentReference>
      <d2p1:paymentUrl>sample string 4</d2p1:paymentUrl>
      <d2p1:premium>3</d2p1:premium>
      <d2p1:productName>sample string 1</d2p1:productName>
    </d2p1:authenticateGrouplifeResult.advertProduct>
  </adProducts>
  <companyCode>sample string 10</companyCode>
  <dob>sample string 13</dob>
  <dob_MM_dd_yyyy>sample string 11</dob_MM_dd_yyyy>
  <emailAddress>sample string 4</emailAddress>
  <errorMsg>sample string 3</errorMsg>
  <fullName>sample string 5</fullName>
  <gender>sample string 12</gender>
  <message>sample string 2</message>
  <mobileNo>sample string 6</mobileNo>
  <niin_avaliable>true</niin_avaliable>
  <picture_url>sample string 9</picture_url>
  <success>true</success>
  <user_id>7</user_id>
</userLoginResult>

text/html

Sample:

{"success":true,"message":"sample string 2","errorMsg":"sample string 3","emailAddress":"sample string 4","fullName":"sample string 5","mobileNo":"sample string 6","user_id":7,"accessToken":"sample string 8","picture_url":"sample string 9","companyCode":"sample string 10","dob_MM_dd_yyyy":"sample string 11","gender":"sample string 12","dob":"sample string 13","niin_avaliable":true,"adProducts":[{"productName":"sample string 1","benefit":"sample string 2","premium":3.0,"paymentUrl":"sample string 4","paymentReference":"sample string 5","businessTypeCode":"sample string 6","duration":"sample string 7"},{"productName":"sample string 1","benefit":"sample string 2","premium":3.0,"paymentUrl":"sample string 4","paymentReference":"sample string 5","businessTypeCode":"sample string 6","duration":"sample string 7"}]}