Whichdeal Ltd API Help Page

Introduction

Listed below are the methods required to manage all resources within the Whichdeal Ltd systems.

AppUtils

Exposes general utilities assisting with application processing.

API	Description
POST api/utils/autoassign	Reassigns stale leads according to the parameters supplied.

PortalAuth

Provides user authentication for the portal.

API	Description
POST api/portalauth	Provides a token to customer users so that secured services may be subsequently accessed.
POST api/portalauth/internal	Provides a token to internal users so that secured services may be subsequently accessed.

VehicleShowroom

Services related to the vehicle showroom.

API	Description
POST api/showroom/search	Searches the showroom vehicles based on the supplied criteria.
POST api/showroom/all-vehicles	No documentation available.
POST api/showroom/all-vehicles-file	No documentation available.
POST api/showroom/updateFilter	Gets filter options according to the available data based on the search terms provided.
GET api/showroom/build-vehicles-list	Build Vevicle List to File
GET api/showroom/carbyregistration?reg={reg}	Get nominated best selling vehicles
GET api/showroom/standing-data	Get nominated best selling vehicles

Onfido

API	Description
POST api/onfido/retrieve-references	Retrieves onfido references, including onfido applicant reference and attached check references
POST api/onfido/create-applicant	Starts a new onfido session
POST api/onfido/hook	Receives onfido webhook requests
GET api/onfido/get-document-download?documentId={documentId}&applicationId={applicationId}&licenceCount={licenceCount}	No documentation available.
POST api/onfido/check-other-proofs	No documentation available.
POST api/onfido/get-sdk-token	Gets onfido sdk token ready for adding documents to applicant
POST api/onfido/create-check	No documentation available.

Quote

Provides services relating to quotes.

API	Description
POST api/quotes/getquote	Gets a provisional quote from a loan quotation that includes a finance request.
POST api/quotes/getFinanceBreakdown	Gets a quotation from quoteAPI
POST api/quotes/calculator	Gets a calculation from quoteAPI
POST api/quotes/saveQuotesToNotes	Save the quote selected by the user into the notes
POST api/quotes/commissionbreakdown	Gets a commission breakdown. Tiers may be left blank to obtain full suite. If values are supplied but none are valid, a representative calculation will be used.
POST api/quotes/commissiontotal	Gets a lender commission summary for the full cut. Tiers may be left blank to obtain full suite. If values are supplied but none are valid, a representative calculation will be used.
POST api/quotes/commissiondealer	Gets a lender commission summary for the full cut. Tiers may be left blank to obtain full suite. If values are supplied but none are valid, a representative calculation will be used.
POST api/quotes/submitproposal	Sends off loan proposals to various lenders according to the credit status of the applicant.
POST api/quotes/updatelendingcriteria	Updates the Lender Configurator on Crm, seen in eqf_fulldecision table.
POST api/quotes/verifyLenderRequirements	Checks what lenders require in order to make the extra page dynamic.
POST api/quotes/getpassedcriterialenders	Updates the Lender Configurator on Crm, seen in eqf_fulldecision table.
POST api/quotes/getDynamicLenderOffersPCP	Return a boolean which determines weather passed lenders offer PCP or not
POST api/quotes/getDealerCommission	get the customer's offers and uses lender's ids to get dealer comission

LookUp

Controller for lookups.

API	Description
GET api/lookUp/jobindustry	Looks up job industries.
GET api/lookUp/employedstatus	Looks up employed status.
POST api/lookUp/proposalstatusupdate	Gets the proposal status per contact.
GET api/lookUp/customerNotes?contactId={contactId}	Looks up notes for each customer.

Vehicle

Represents a vehicle resource

API	Description
POST crm/vehicle	Method to submit new vehicle.

VehicleSearch

Functionality for vehicle vrm lookup and valuation

API	Description
GET api/vehicleLookup/detailsOnly?registration={registration}	Returns vehicle details, sans valuation data.
GET api/vehicleLookup?registration={registration}&currentMileage={currentMileage}&applicationId={applicationId}&isSuggested={isSuggested}	Returns vehicle details
GET api/vehicleLookup/getFutureValuation?registerationDate={registerationDate}&endofTermMileage={endofTermMileage}&capId={capId}&term={term}	Returns vehicle future value

AddressSearch

Functionality for address lookup

API	Description
GET api/address?postcode={postcode}&id={id}	Searches for general address data based on a postal code.
GET api/address/Retrieve?id={id}	returns address full details after passing the id.

CustomerApplication

Functionality for get/save operations with a customer's current (open) application

API	Description
GET api/customer/application/get-employment-address?companyName={companyName}	Finds the address for a company by company name
GET api/customer/application/onboarding-details?userId={userId}&userEmail={userEmail}	No documentation available.
POST api/customer/application/search	Searches for applications
GET api/customer/application?id={id}	Returns customer with a collection of related applications by customer id of the logged in user
POST api/customer/application	Sends an email via the Whichdeal Messaging API
GET api/customer/application/vehicle?id={id}	Gets display vehicle.
POST api/customer/application/save	No documentation available.
GET api/customer/application/docsStatus?customerId={customerId}&sourceUrl={sourceUrl}	Gets docusign status.
POST api/customer/application/create-note	No documentation available.
POST api/customer/application/apply	No documentation available.
POST api/customer/application/loan-confirmed?customerId={customerId}&firstName={firstName}&lastName={lastName}&salesPerson={salesPerson}&isDemo={isDemo}	No documentation available.
POST api/customer/application/portal-link?customerId={customerId}&customerEmail={customerEmail}&isDemo={isDemo}	No documentation available.
POST api/customer/application/create-forgot-password-link?customerEmail={customerEmail}&isDemo={isDemo}	No documentation available.
POST api/customer/application/verify-forgot-password-link?verifyCode={verifyCode}	No documentation available.
POST api/customer/application/vehicle-needs?id={id}&vehicleNeeded={vehicleNeeded}	No documentation available.

Application

Represents an application resource

API	Description
GET crm/application/{src}/{id}	Returns application by id
POST crm/application	Method to submit new application

Applicant

Represents an applicant resource

API	Description
GET crm/applicant/{id}	Returns applicant by id
GET crm/applicant?lastname={lastname}&postcode={postcode}&email={email}&telephone={telephone}&page={page}&pagesize={pagesize}	Returns applicant by last name, postcode, email and telephone
POST crm/applicant	Method to submit new applicant
PUT api/Applicant	Method to update applicant

UserAccount

Provides user account administration.

API	Description
POST api/useraccount/create	Adds a new user with the username provided. The user will be non- activated and have a generated password applied. The Register service should be used to complete the on-boarding process.
POST api/useraccount/registerDpCustomer	Creates and registers a new dealerplus customer in a single step. The user is activated immediately and assumes the password supplied. The user does not need any further registration activities.
POST api/useraccount/register	Changes the status of the matching user to activated and configures their password according to the value supplied.
POST api/useraccount/createandregister	Creates and registers a new customer in a single step. The user is activated immediately and assumes the password supplied. The user does not need any further registration activities.
POST api/useraccount/registertemp	Provides a temporary token so that secured services may be subsequently accessed.
PUT api/useraccount/changepassword	Changes the password for the current user. A fresh authentication token is returned for convenience.
PUT api/useraccount/resetforgottenpassword	Resets the password for a user who has forgotten theirs.
PUT api/useraccount/resetpassword	Changes the password for the (customer) user specified. This is for users who appear in the PortalUser table only; i.e. it cannot be used on an account that resides anywhere else.

Timer

API	Description
GET api/timers/vehicle-search-new-user-check?customerId={customerId}	Checks to see if user accessing search page is new to the portal
GET api/timers/vehicle-search	When fired by windows task scheduler, checks for idle users in search page
GET api/timers/vehicle-search-removal-check?customerId={customerId}	No documentation available.

TFCCallback

Controller for handling callback from the TFC lender.

API	Description
POST api/callbacks/tfc/submit	Handles the submit proposal response.

CustomerDocuments

Functionality to upload/save customer docs (loan agreements, customer pack) and proofs

API	Description
POST api/docs	Method for uploading customer documents
GET api/docs	Method for Getting the file names of all the documents/proofs uploaded by the customer.
GET api/docs/download?fileName={fileName}&applicationId={applicationId}	A method to download the customer proof file that was previously uploaded by a customer
POST api/docs/delete?applicationId={applicationId}	A method to delete the uploaded previously customer document by providing the name of the file