POST api/Profile/PreAuth

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:

<PreAuthParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CorporateAPI.RequestObjs">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</PreAuthParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PreAuthResponsedata

Name	Type	Additional information
Responsecode	string	None.
ResponseDescription	string	None.
UserpasswordChanged	integer	None.
CustomerIdentity	string	None.
DefaultAccountNumber	string	None.
DefaultAccountName	string	None.
DefaultAccountBalance	string	None.
LastLoginDate	string	None.
Phone	string	None.
BVN	string	None.
access_token	string	None.
token_type	string	None.
expires_in	string	None.
SecurityQuestion	string	None.
AccountList	Collection of MyAccounts	None.
TransactionHistory	Collection of dystementofacct	None.
CorporateID	string	None.
IndemnitySigned	integer	None.
Role	string	None.
CompanyName	string	None.
RegStage	integer	None.
PayrollRole	string	None.
UserName	string	None.
ProfileList	Collection of CorporatePrfl	None.
IsSoleUser	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Responsecode": "sample string 1",
  "ResponseDescription": "sample string 2",
  "UserpasswordChanged": 3,
  "CustomerIdentity": "sample string 4",
  "DefaultAccountNumber": "sample string 5",
  "DefaultAccountName": "sample string 6",
  "DefaultAccountBalance": "sample string 7",
  "LastLoginDate": "sample string 8",
  "Phone": "sample string 9",
  "BVN": "sample string 10",
  "access_token": "sample string 11",
  "token_type": "sample string 12",
  "expires_in": "sample string 13",
  "SecurityQuestion": "sample string 14",
  "AccountList": [
    {
      "accountName": "sample string 1",
      "accountType": "sample string 2",
      "bookBalance": "sample string 3",
      "currency": "sample string 4",
      "accountNumber": "sample string 5",
      "customerNo": "sample string 6",
      "availableBalance": "sample string 7",
      "productCode": "sample string 8"
    },
    {
      "accountName": "sample string 1",
      "accountType": "sample string 2",
      "bookBalance": "sample string 3",
      "currency": "sample string 4",
      "accountNumber": "sample string 5",
      "customerNo": "sample string 6",
      "availableBalance": "sample string 7",
      "productCode": "sample string 8"
    }
  ],
  "TransactionHistory": [
    {
      "date": "sample string 1",
      "amount": "sample string 2",
      "narration": "sample string 3",
      "debitOrCredit": "sample string 4",
      "closingBalance": "sample string 5",
      "valueDate": "sample string 6",
      "transactionId": "sample string 7"
    },
    {
      "date": "sample string 1",
      "amount": "sample string 2",
      "narration": "sample string 3",
      "debitOrCredit": "sample string 4",
      "closingBalance": "sample string 5",
      "valueDate": "sample string 6",
      "transactionId": "sample string 7"
    }
  ],
  "CorporateID": "sample string 15",
  "IndemnitySigned": 16,
  "Role": "sample string 17",
  "CompanyName": "sample string 18",
  "RegStage": 1,
  "PayrollRole": "sample string 19",
  "UserName": "sample string 20",
  "ProfileList": [
    {
      "CompanyName": "sample string 1",
      "CorporateID": "sample string 2"
    },
    {
      "CompanyName": "sample string 1",
      "CorporateID": "sample string 2"
    }
  ],
  "IsSoleUser": true
}

application/xml, text/xml

Sample:

<PreAuthResponsedata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CorporateAPI.ResponseObjs">
  <AccountList>
    <MyAccounts>
      <accountName>sample string 1</accountName>
      <accountNumber>sample string 5</accountNumber>
      <accountType>sample string 2</accountType>
      <availableBalance>sample string 7</availableBalance>
      <bookBalance>sample string 3</bookBalance>
      <currency>sample string 4</currency>
      <customerNo>sample string 6</customerNo>
      <productCode>sample string 8</productCode>
    </MyAccounts>
    <MyAccounts>
      <accountName>sample string 1</accountName>
      <accountNumber>sample string 5</accountNumber>
      <accountType>sample string 2</accountType>
      <availableBalance>sample string 7</availableBalance>
      <bookBalance>sample string 3</bookBalance>
      <currency>sample string 4</currency>
      <customerNo>sample string 6</customerNo>
      <productCode>sample string 8</productCode>
    </MyAccounts>
  </AccountList>
  <BVN>sample string 10</BVN>
  <CompanyName>sample string 18</CompanyName>
  <CorporateID>sample string 15</CorporateID>
  <CustomerIdentity>sample string 4</CustomerIdentity>
  <DefaultAccountBalance>sample string 7</DefaultAccountBalance>
  <DefaultAccountName>sample string 6</DefaultAccountName>
  <DefaultAccountNumber>sample string 5</DefaultAccountNumber>
  <IndemnitySigned>16</IndemnitySigned>
  <IsSoleUser>true</IsSoleUser>
  <LastLoginDate>sample string 8</LastLoginDate>
  <PayrollRole>sample string 19</PayrollRole>
  <Phone>sample string 9</Phone>
  <ProfileList>
    <CorporatePrfl>
      <CompanyName>sample string 1</CompanyName>
      <CorporateID>sample string 2</CorporateID>
    </CorporatePrfl>
    <CorporatePrfl>
      <CompanyName>sample string 1</CompanyName>
      <CorporateID>sample string 2</CorporateID>
    </CorporatePrfl>
  </ProfileList>
  <RegStage>1</RegStage>
  <ResponseDescription>sample string 2</ResponseDescription>
  <Responsecode>sample string 1</Responsecode>
  <Role>sample string 17</Role>
  <SecurityQuestion>sample string 14</SecurityQuestion>
  <TransactionHistory>
    <dystementofacct>
      <amount>sample string 2</amount>
      <closingBalance>sample string 5</closingBalance>
      <date>sample string 1</date>
      <debitOrCredit>sample string 4</debitOrCredit>
      <narration>sample string 3</narration>
      <transactionId>sample string 7</transactionId>
      <valueDate>sample string 6</valueDate>
    </dystementofacct>
    <dystementofacct>
      <amount>sample string 2</amount>
      <closingBalance>sample string 5</closingBalance>
      <date>sample string 1</date>
      <debitOrCredit>sample string 4</debitOrCredit>
      <narration>sample string 3</narration>
      <transactionId>sample string 7</transactionId>
      <valueDate>sample string 6</valueDate>
    </dystementofacct>
  </TransactionHistory>
  <UserName>sample string 20</UserName>
  <UserpasswordChanged>3</UserpasswordChanged>
  <access_token>sample string 11</access_token>
  <expires_in>sample string 13</expires_in>
  <token_type>sample string 12</token_type>
</PreAuthResponsedata>