Client integration documentation

Responses

XML is used for application and results responses.

Initial application result codes

Result	Meaning
`10`	Application accepted; a results URL is available for polling.
`11`	Upstream authentication or configuration failure.
`12`	Invalid application parameters.
`13`	Rejected by business rules.
`21` / `22`	No offer / no eligible lender outcome.

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <result>10</result>
  <reference>123456789</reference>
  <message><![CDATA[Submitted]]></message>
  <error><code></code><desc><![CDATA[]]></desc></error>
  <results_url><![CDATA[https://api.authorisedcompliance.com/Monevo/results?t=OPAQUE_TOKEN]]></results_url>
</response>

Initial response fields

Field	Description
`result`	A code indicating the application outcome. Common values include 10 accepted, 11 upstream authentication/configuration failure, 12 invalid parameters, 13 business-rule rejection, and 21/22 no-offer outcomes.
`reference`	The unique reference code to identify the transaction.
`message`	A text description of the result code.
`error`	Returned when an error occurs when submitting the request.
`code`	Code indicating the error. Valid values are: 0* Internal error before ping, includes parameters invalid error and system internal error. 1* For resubmit, original application was rejected by this tier. 2* Application was filtered out by required minimum commission setting. Re-attempt this application at the lower tier. 3* Error happened during lender 'ping' process. 4* Application filtered out by the tier setting.
`desc`	A text description of the error returned.
`results_url`	The results URL where customer offers can be retrieved from.
`redirect_url`	When a decline* A URL to forward customer when no offers have been found.
`Please note`	In the event of a system/power outage then the response from the API will be 522: Connection timed out 99**: Error receiving applications

Polling result codes

Result	Meaning
`10`	Application accepted; results pending.
`20`	At least one offer was found.
`21`	All lenders rejected the customer.
`22`	No qualified lender was found.

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <result>20</result>
  <offer_results>
    <accepted>1</accepted>
    <rejected>1</rejected>
    <awaiting_response>2</awaiting_response>
  </offer_results>
  <reference>123456789</reference>
  <message><![CDATA[Accepted]]></message>
  <offers>...</offers>
  <error><code></code><desc><![CDATA[]]></desc></error>
</response>

Polling and offer fields

Field	Description
`response/result`	The result code of the response Valid values: 10 = The application has been accepted, results pending 20 = A minimum of one offer was found 21 = All lenders have rejected the customer 22 = No qualified lender has been found
`response/reference`	Unique application reference.
`offer_results/accepted`	The number of lender offers
`offer_results/rejected`	The number of lenders that have declined the customer
`offer_results/awaiting_response`	The number of lenders that have not yet responded
`offers/offer/id`	The sequential offer number that is returned by Monevo API
`offers/offer/product_id`	The individual ID of the Product
`offers/offer/offer_number`	The offer number/reference the lender provides if it exists
`offers/offer/redirect_url`	The specific offer redirect URL the customer should follow to take up the lender’s offer
`offers/offer/loan/loan_amount`	The loan amount being offered by the lender
`offers/offer/loan/apr`	The APR of the offer
`offers/offer/loan/rep_apr`	The Representative APR of the offer
`offers/offer/loan/rapr`	The Representative example of the offer
`offers/offer/loan/term`	The term in months of the offer
`offers/offer/loan/fees`	The fees of the offer
`offers/offer/loan/cost_of_credit`	The total cost of credit of the offer
`offers/offer/loan/monthly_repayment`	The monthly repayment of the offer
`offers/offer/loan/total_repayment`	The total repayment of the offer
`offers/offer/loan/type`	The product type of offer Valid values are: personal_loan = A personal loan offer by a lender guarantor_loan= A guarantor loan offer by a lender alternative= Offer is a non lender offer for example a broker short_term= A short term loan offer by a lender secured_loan= A secured loan offer by a lender car_finance=A car finance offer credit_card= A credit card offer
`offers/offer/loan/other_information`	Additional information relating to the offer
`offers/offer/loan/features/feature`	Key features of the offer
`offers/offer/loan/terms`	Term and conditions of the offer
`offers/offer/loan/preapproved`	Indicates whether the offer is pre-approved or not. Valid Values are: True= Offer is pre-approved offer False= Offer is non-pre approved offer
`offers/offer/loan/secured`	Indicates whether the offer the lender has returned is a Secured loan offer (or asset based) or not. Valid values are: True= Secured offer False= Not a secured offer
`offers/offer/loan/decision`	The decision that has come back from the lender. Valid Values: Approved = Loan is provisionally approved Declined = Loan is declined
`offers/offer/loan/likelihood`	The percentage likelihood of approval from 0-100 Valid Values: 10 = 10% likelihood of approval 20 = 20% likelihood of approval 30 = 30% likelihood of approval 40 = 40% likelihood of approval 50 = 50% likelihood of approval 60 = 60% likelihood of approval 70 = 70% likelihood of approval 80 = 80% likelihood of approval 90 = 90% likelihood of approval 95 = 95% likelihood of approval 100 = 100% likelihood of approval Also described as eligibility
`offers/offer/loan/offer_expires`	Indicates when the offer expires, returned on yyyy-mm-dd format
`offers/offer/loan/caveat/description`	The caveat or special conditions of the offer returned to be displayed to the customer within the offer tile For example: *Subject to final lender checks
`offers/offer/loan/caveat/tooltip`	Further information regarding the caveat or special conditions of the offer returned which can be displayed to the customer
`offers/offer/lender/id`	The lender id
`offers/offer/lender/rate_type`	Indicates whether an offers APR is Confirmed/Guaranteed, Representative or APRC. Valid Values are: Confirmed_APR = offer APR is Confirmed/Guaranteed. Rep_APR = offer APR is Representative. APRC = offer APR is APRC (Secured Loans)
`offers/offer/lender/funding_speed`	Indicates the funding speed of the lender. Valid values are Fast Funding or Same day
`lender/name`	Name of the lender
`lender/description`	The description of the lender
`lender/URL`	URL of the lender's homepage
`lender/phone_number`	A phone number for the applicant to contact the lender on if available
`lender/logo_url`	A URL with a hosted logo of the lender to be used when presenting the offer
`lender/review/service`	The name of the review service that holds the reviews for the lender Valid values are: TRUSTPILOT FEEFO
`lender/review/id`	The lender's id with the review service. this is used to display lender review ratings

Offer presentation

A result may include lender redirect URLs, pricing, representative examples, terms, features, approval indicators and lender information. Display the relevant information provided for each offer.