HTTP Posting - Available Fields
Introduction
Every value you post into eKeeper needs to be posted into a particular field. The most common field names are listed below with a description and an example of how the code may look in your HTTP posting script.
Hint
All of the fields on this page should be added into the $fields array on your HTTP Posting document.
Important
There are some mandatory items that must be included in your HTTP posting script, these are listed below under Mandatory Fields Submissions.
Some items have validation against them and will be ignored if an invalid value is posted to this interface. Note that the case and product will still be created in the CRM, but the value will be missing. This is detailed in the xml response back to the originator of the post.
The following fields can be posted to via HTTP from an external process or can be used interactively by visiting a page in the eKeeper system (the ‘Quick Case Entry’ process). When posting the URL should be: https://SITENAME.ekeeperonline.co.uk/php/NewMortgageQuickDetails.php
Your eKeeper system will need configuring before this process will allow submission of information from an external source. You will need to supply us with the IP address that valid requests will come from in order for us to set this up for you.
Fields
Applicant Fields
Applicant 1
The following fields all relate to the first applicant on your case.
Note as of 06-07-2021 - Some fields are marked as legacy but still work if you use them instead of the actual field e.g. if only AddressText is passed instead of AddressText1 then the first applicants address will be updated with the AddressText1 as before.
Field | Legacy field (still supported) | Description | Validation | Example code |
|---|---|---|---|---|
Title1 |
| This will need to be the numeric key from the MortgageKeeper system corresponding to the title text. We can change the process to accept a textual string to match against the values in MortgageKeeper if desired but would need to requote for this addition |
| 'Title1' => urlencode($_POST['Title1']) |
Forename1 |
| The first name of the applicant |
| 'Forename1' => urlencode($_POST['Forename1']) |
MiddleName1 |
| The middle name of the applicant |
| 'MiddleName1' => urlencode($_POST['MiddleName1']) |
Surname1 |
| The last name of the applicant |
| 'Surname1' => urlencode($_POST['Surname1']) |
DOB1 | DOB | The date of birth for the first applicant | Date dd/mm/yyyy e.g. 03/06/1987 | 'DOB' => urlencode($_POST['DOB1']) |
DayPhone1 | DayPhone | The daytime telephone number of the applicant |
| 'DayPhone' => urlencode($_POST['DayPhone']) |
EveningPhone1 | EveningPhone | The evening phone number of the applicant |
| 'EveningPhone' => urlencode($_POST['EveningPhone']) |
MobilePhone1 | MobilePhone | The mobile phone number of the applicant |
| 'MobilePhone' => urlencode($_POST['MobilePhone']) |
Email1 | The email address of the applicant |
| 'Email' => urlencode($_POST['Email']) | |
AppNotes1 | AppNotes | Notes against the applicant (should not be confused with case notes) |
| 'AppNotes' => urlencode($_POST['AppNotes1']) |
AddressText1 | AddressText | The blobby address against the applicant | String (max 255 characters) | 'AddressText1' => urlencode($_POST['AddressText1']) |
Postcode1 | Postcode | The post code against the first applicant | String (max 10 characters) | 'Postcode1' => urlencode($_POST['AddressText1']) |
CountryISOCode1 | CountryISOCode | The pk number for the country against the first applicant | String (max 10 characters) | 'CountryISOCode' => urlencode($_POST['CountryISOCode1']) |
ResidentFromDate1 | ResidentFromDate | The date the first applicant moved into the address | Date dd/mm/yyyy e.g. 03/06/1987 | 'ResidentFromDate1' => urlencode($_POST['ResidentFromDate1']) |
The following GDPR consent fields can be added to the first applicant on your case.
The consent fields need to be surrounded by quotes e.g. 'true' otherwise they are defaulted to false
Field | Description | Example code |
|---|---|---|
EssentialConsentLevelGiven1 | Has the applicant provided any level of consent at all. Values accepted: 'true', 'false' |
|
EssentialConsentEmail1 | Has the applicant provided consent to contact via e-mail. Values accepted: 'true', 'false' |
|
EssentialConsentLetter1 | Has the applicant provided consent to contact via letter. Values accepted: 'true', 'false' |
|
EssentialConsentTelephone1 | Has the applicant provided consent to contact via telephone. Values accepted: 'true', 'false' |
|
EssentialConsentTextMessage1 | Has the applicant provided consent to contact via text-message. Values accepted: 'true', 'false' |
|
MarketingConsentLevelGiven1 | Has the applicant provided consent to be contacted for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentEmail1 | Has the applicant provided consent to contact via e-mail for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentLetter1 | Has the applicant provided consent to contact via letter for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentTelephone1 | Has the applicant provided consent to contact via telephone for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentTextMessage1 | Has the applicant provided consent to contact via text message for marketing purposes. Values accepted: 'true', 'false' |
|
ThirdPartyConsentLevelGiven1 | Has the applicant provided consent to contact by third parties. Values accepted: 'true', 'false' |
|
CreditAgencyConsentLevelGiven1 | Has the applicant provided consent for credit agency checks. Values accepted: 'true', 'false' |
|
ConsentProvidedByIndividual1 | Has the applicant provided consent themselves or via another entity. Values accepted: |
|
ConsentProvidedByOtherText1 | If the applicant did not provide the consent themselves, who did. Values accepted: [String] e.g. "John Smith" |
|
ConsentSuppliedMethod1 | By what method was the consent supplied. Values accepted: |
|
Applicant 2
The following fields all relate to the second Applicant on your case.
Note as of 06-07-2021 - some fields are marked as legacy but still work if you use them instead of the actual field e.g. if only AddressText is passed instead of AddressText2 then the second applicants address will be updated with the AddressText2 as it did before.
Field | Legacy field (still supported) | Description | Validation | Example code |
|---|---|---|---|---|
Title2 |
| This will need to be the numeric key from the MortgageKeeper system corresponding to the title text. We can change the process to accept a textual string to match against the values in MortgageKeeper if desired but would need to requote for this addition |
| 'Title2' => urlencode($_POST['Title2']) |
Forename2 |
| The first name of the applicant |
| 'Forename2' => urlencode($_POST['Forename2']) |
MiddleName2 |
| The middle name of the applicant |
| 'MiddleName2' => urlencode($_POST['MiddleName2']) |
Surname2 |
| The last name of the applicant |
| 'Surname2' => urlencode($_POST['Surname2']) |
DOB2 |
| The date of birth for the second applicant | Date (dd/mm/yyyy) e.g. 03/06/1987 | 'DOB2' => urlencode($_POST['DOB2']) |
AddressText2 | AddressText | The blobby address for the second applicant | String (max 255 characters) | 'AddressText2' => urlencode($_POST['AddressText2']) |
Postcode2 | Postcode | The post code for the second applicant | String (max 10 characters) | 'Postcode2' => urlencode($_POST['Postcode2']) |
DayPhone2 | DayPhone | The daytime telephone number of the applicant |
| 'DayPhone' => urlencode($_POST['DayPhone']) |
EveningPhone2 | EveningPhone | The evening phone number of the applicant |
| 'EveningPhone' => urlencode($_POST['EveningPhone']) |
MobilePhone2 | MobilePhone | The mobile phone number of the applicant |
| 'MobilePhone' => urlencode($_POST['MobilePhone']) |
Email2 | The email address of the applicant |
| 'Email' => urlencode($_POST['Email']) | |
AppNotes2 |
| Notes against the applicant (should not be confused with case notes) |
| 'AppNotes2' => urlencode($_POST['AppNotes2']) |
CountryISOCode2 | CountryISOCode | The country the second applicant is from | String (max 10 characters) | 'CountryISOCode2' => urlencode($_POST['CountryISOCode2']) |
ResidentFromDate2 | ResidentFromDate | The date the second applicant moved into the address | Date (dd/mm/yyyy) e.g. 03/06/1987 | ‘ResidentFromDate2' => urlencode($_POST['ResidentFromDate2’]) |
The following GDPR consent fields can be added to the second applicant on your case.
The consent fields need to be surrounded by quotes e.g. 'true' otherwise they are defaulted to false
Field | Description | Example code |
|---|---|---|
EssentialConsentLevelGiven2 | Has the applicant provided any level of consent at all. Values accepted: 'true', 'false' |
|
EssentialConsentEmail2 | Has the applicant provided consent to contact via e-mail. Values accepted: 'true', 'false' |
|
EssentialConsentLetter2 | Has the applicant provided consent to contact via letter. Values accepted: 'true', 'false' |
|
EssentialConsentTelephone2 | Has the applicant provided consent to contact via telephone. Values accepted: 'true', 'false' |
|
EssentialConsentTextMessage2 | Has the applicant provided consent to contact via text-message. Values accepted: 'true', 'false' |
|
MarketingConsentLevelGiven2 | Has the applicant provided consent to be contacted for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentEmail2 | Has the applicant provided consent to contact via e-mail for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentLetter2 | Has the applicant provided consent to contact via letter for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentTelephone2 | Has the applicant provided consent to contact via telephone for marketing purposes. Values accepted: 'true', 'false' |
|
MarketingConsentTextMessage2 | Has the applicant provided consent to contact via text message for marketing purposes. Values accepted: 'true', 'false' |
|
ThirdPartyConsentLevelGiven2 | Has the applicant provided consent to contact by third parties. Values accepted: 'true', 'false' |
|
CreditAgencyConsentLevelGiven2 | Has the applicant provided consent for credit agency checks. Values accepted: 'true', 'false' |
|
ConsentProvidedByIndividual2 | Has the applicant provided consent themselves or via another entity. Values accepted: |
|
ConsentProvidedByOtherText2 | If the applicant did not provide the consent themselves, who did. Values accepted: [String] e.g. "John Smith" |
|
ConsentSuppliedMethod2 | By what method was the consent supplied. Values accepted: |
|
Company fields
Note - there is currently no validation on Company fields
Fields | Description | Example Code |
|---|---|---|
CompanyName | The name of the company | 'CompanyName' => urlencode($_POST['CompanyName'] |
LegalStatus | The legal status of the company | 'LegalStatus' => urlencode($_POST['LegalStatus'] |
ComAddressLine1 | The address line 1 of the company | 'ComAddressLine1' => urlencode($_POST['ComAddressLine1']) |
ComAddressLine2 | The address line 2 of the company | 'ComAddressLine2' => urlencode($_POST['ComAddressLine2']) |
ComAddressLine3 | The address line 3 of the company | 'ComAddressLine3' => urlencode($_POST['ComAddressLine3']) |
ComAddressLine4 | The address line 4 of the company | 'ComAddressLine4' => urlencode($_POST['ComAddressLine4']) |
ComPostCode | The postcode of the company | 'ComPostCode' => urlencode($_POST['ComPostCode']) |
ComTelephone | The telephone number of the company | 'ComTelephone' => urlencode($_POST['ComTelephone']) |
ComFax | The e fax number of the company | 'ComFax' => urlencode($_POST['ComFax']) |
ComEmail | The email address of the company | 'ComEmail' => urlencode($_POST['ComEmail']) |
ComWebsite | The website associated with the company | 'ComWebsite' => urlencode($_POST['ComWebsite']) |
ComNotes | Notes against the company | 'ComNotes' => urlencode($_POST['ComNotes']) |
ComCompanyRegistrationNo | The registration number of the company | 'ComCompanyRegistrationNo' => urlencode($_POST['ComCompanyRegistrationNo']) |
ComIncorporationDate | The incorporation date of the company | 'ComIncorporationDate' => urlencode($_POST['ComIncorporationDate']) |
Note
CompanyName is the only mandatory field required if company details are being submitted
Mandatory Field submissions
The following fields must be submitted into:
Field | Comments/values |
|---|---|
StagePK | The reference number for the stage you wish to post into. Find this by heading to Maintenance > Stages > Edit ... and then noting the number that appears after "StagePK=" in the address bar |
AdvisorPK | The reference number for the advisor you wish to assign the lead to. Find this by heading to Maintenance → Users → Edit [the user you want] ... and then noting the number that appears after "UserPK=" in the address bar |
MortgageMode OR CommercialMode | This is the mode in which you want the case to present itself if a residential mortgage then submit:
If the product should be a commercial one then use:
|
submit | value must be 'submit' or 1 |
Important
You must submit a post value named ‘submit’ that contains the value ‘submit’ in order for this process to add the new case.
General Case Details
HINT
Some of the fields below need numeric values from your eKeeper system. We can’t detail what these are as they are determined by the way you set your eKeeper system. We can supply the necessary values at the time of go-live. If you change the configuration of your eKeeper system in the future then this may affect the values you need to use on your website.
Note - some items have validation against them. If the posted value fails validation then the product will still be created, but the invalid value will be ignored
Field | Possible Values | Validation |
|---|---|---|
CaseReference | 123ABDRD | Integer |
AddressText | This is the security address | String |
Postcode | This is the security postcode | String |
MortgageSourcePK | This will need to be the numeric key from the MortgageKeeper system corresponding to the Mortgage Source text. Note: If you are using this field in the system, the PK numbers can be obtained using the specific edit mortgage source URL |
|
AdvisorPK | This will need to be the numeric key from the MortgageKeeper system corresponding to the title text. We can change the process to accept a textual string to match against values in MortgageKeeper if desired but would need to requote for this addition. Note: The user PK numbers can be obtained using the specific edit user URL |
|
LenderPK | This will need to be the numeric key from the MortgageKeeper system corresponding to the title text. We can change the process to accept a textual string to match against values in MortgageKeeper if desired but would need to requote for this addition. Note: The Lender PK numbers can be obtained using the specific edit lender URL. |
|
NextStageDue | Next chase date format YYYY-MM-DD |
|
DateMade | This is the mortgage sign date, format YYY-MM-DD |
|
StagePK | This will need to be the numeric key from the MortgageKeeper system corresponding to the title text. We can change the process to accept a textual string to match against values in MortgageKeeper if desired but would need to requote for this addition. Note: The Stage PK numbers can be obtained using the specific edit Stage URL. |
|
PurposeOfLoan | This will need to be the numeric key from the MortgageKeeper system corresponding to the Purpose of Loan. We can change the process to accept a textual string to match against the values in MortgageKeeper if desired but would need to requote for this addition. NOTE: The values for this field are detailed in the table below. |
|
BranchPK | The PK number for the branch the application should be associated with | integer 11 |
LeadProvider | “abc leads” | String 250 |
LeadCreationDate | dd/mm/yyyy e.g. 03/06/1987 | Date |
DateAcknowledged | dd/mm/yyyy e.g. 03/06/1987 | Date |
DateAmended | (signup date) dd/mm/yyyy e.g. 03/06/1987 | Date |
DateComplete | dd/mm/yyyy e.g. 03/06/1987 | Date |
PurchasePrice | 150000.00 | Decimal (up to 12 digits before the decimal, and up to 2 digits after |
ActualPurchasePrice | 160000.20 | Decimal (up to 12 digits before the decimal, and up to 2 digits after |
MortgageAmount | 120000.20 | Decimal (up to 12 digits before the decimal, and up to 2 digits after |
BuyerType | PK number for Buyer type | Integer (max 11 digits) |
RepaymentMethod | PK number for the repayment Method | Integer (max 11 digits) |
Rate | e.g. 10.2 | Decimal (up to 10 digits before the decimal, and up to 2 digits after |
InterestRateTypePK | PK number for the interest rate type | Integer (max 11 digits) |
ProductDetails | “Vis te soleat accumsan consetetur, ne tempor noster mei, eu mei minimum hendrerit. Eu eos possit dolorem concludaturque, duo fugit errem fabellas te. Vel elitr primis interesset te, ius justo iudicabit ea. Vel ignota delenit philosophia id. An agam mazim duo, no est regione ponderum, solet appetere et eum” | String max 255 characters |