Client integration documentation

Request parameters

Application fields accepted by the API.

Supported production fields

The production gateway allowlists the fields below. Required/recommended semantics are based on the supplied Monevo UK Loan API specification.

Filter parameters

Parameter	Requirement	Description
`affiliate_app_id`	Recommended	The lead or application ID from the affiliate. Up to 100 alphanumeric characters. Used to allow us to report conversion on an application level.
`loan_amount`	Required	The amount of the requested loan in whole pounds of the loan requested in integer format.
`loan_purpose`	Required	The reason the customer is requesting the loan. Valid values are: 2. Car Lease 3. Car Purchase 4. Car Other 5. Motorbike 6. Vehicle Other 7. Debt Consolidation 8. Holiday 9. Home Improvement’s 10. Medical Bill 18. Other 19. Short term loan 21. One-off purchase
`loan_term`	Required	The number of months the loan is required for by the customer.
`title`	Recommended. If title is not collected you must collect the customer's gender	The customers' title. Valid values are: 1. Mr 2. Mrs 3. Miss 4. Ms 5. Dr 6. Other Allowing customers to select 6. Other is not Recommended as it will reduce the panel of lenders available to that customer.
`first_name`	Required	The customer’s first name. 2-50 alphanumeric characters.
`last_name`	Required	The customer’s last name. Up to 100 alphanumeric characters.
`gender`	Optional. If title is not collected then gender is required.	The customer’s gender. Valid values are: F Female M Male
`dob`	Required	The customer's date of birth in YYYY-MM-DD format. Applicants must be between 18 and 77 years old.
`marital_status`	Required	The marital status of the customer. Valid values list below: 1. Married 2. Partner 3. Single 4. Co-habiting 5. Separated 6. Divorced 7. Civil Union 8. Widowed
`financial_dependent_cost`	Optional (Depends on Provider - speak to Partner manager to see if required by Providers on panel)	The monthly cost of financial dependents (i.e. children, relatives, and other dependents. Send as an integer i.e. 1000
`expected_monthly_expenditure_increase`	Optional (Depends on Provider - speak to Partner manager to see if required by Providers on panel)	The monthly known and expected increase in expenditure in the near future i.e. expected increase in mortgage, loan or credit card payments or future expected childcare costs Send as an integer i.e. 1000
`dependent_number`	Optional (Speak to Partner Manager to see if Providers on panel require this	The number of dependents the applicant has: 0 1 2 3 4 5
`email`	Required	The customer’s email address. Up to 100 alphanumeric characters.
`mobile_phone`	Recommended (mobile_phone required if home_phone not supplied)	The customer’s mobile phone number. 11 digits starting 07.
`home_phone`	Optional (home_phone required if mobile_phone not supplied)	The customer’s home phone number. 11 digits starting 01, 02, 03, 07, 08
`residence_type`	Required	The type of the customer’s residence. Valid values are: 1. Home Owner - With Mortgage 2. Rent 3. Living With Family 4. Other 5. Joint owner 6. Living with Parents 7. Tenant-Furnished 8. Tenant-Unfurnished 9. Council Tenant 10. Home Owner - No Mortgage
`postcode`	Required	The customer’s address postcode. Up to 7 alphanumeric characters.
`building_name`	Optional. Either building_name, building_number or address1 must be provided.	2-50 alphanumeric characters
`building_number`	Optional. Either building_name, building_number or address1 must be provided.	2-50 alphanumeric characters
`street_name`	Optional. Either street_name or address2 must be provided.	2-50 alphanumeric characters
`sub_building`	Optional	2-50 alphanumeric characters
`address1`	Optional. Either building_name, building_number or address1 must be provided.	The customer’s house name or house number. Up to 50 alphanumeric characters. Allowed Characters A-Z a-z 0-9 , . - ' / \ (space) No symbols e.g , ' - ?
`address2`	Optional. Either street_name or address2 must be provided.	The customer’s address street name. Alphanumeric. Up to 50 alphanumeric characters. Allowed Characters A-Z a-z 0-9 , . - ' / \ (space) No symbols e.g , ' - ?
`city`	Required	The customer’s address town. Up to 50 alphanumeric characters.
`county`	Required	The customer’s address county.Minimum 3 characters.
`months_at_address`	Required	The number of months since the customer has moved in to his/her address. Months at address must be = > 1
`prev_residence_type`	Optional	The type of the customer’s previous residence. Valid values are: 1. Home Owner - With Mortgage 2. Rent 3. Living With Family 4. Other 5. Joint owner 6. Living with Parents 7. Tenant-Furnished 8. Tenant-Unfurnished 9. Council Tenant 10. Home Owner - No Mortgage
`prev_postcode`	Optional	The customer’s previous address postcode. Up to 7 alphanumeric characters.
`prev_building_name`	Optional. Either building_name, building_number or address1 must be provided for a valid previous address.	2-50 alphanumeric characters
`prev_building_number`	Optional. Either building_name, building_number or address1 must be provided for a valid previous address.	2-50 alphanumeric characters
`prev_street_name`	Optional. Either street_name or address2 must be provided for a valid previous address.	2-50 alphanumeric characters
`prev_sub_building`	Optional	2-50 alphanumeric characters
`prev_address1`	Optional. Either prev_building_name, prev_building_number or prev_address1 must be provided for a valid previous address.	The first line of the customer’s previous street address. Up to 80 alphanumeric characters.
`prev_address2`	Optional. Either prev_street_name or prev_address2 must be provided for a valid previous address.	The second line of the customer’s previous street address. Up to 50 alphanumeric characters. Pass in a space if this field is empty.
`prev_city`	Optional	The customer’s previous address city. Up to 50 alphanumeric characters.
`prev_county`	Optional	Previous county part of the customer address. Lookup value.
`prev_months_at_address`	Recommended. Many lenders need a minimum of address history to consider a customer (up to 3 years). If they have lived at the current address for less than 3 years a previous address should be supplied.	The number of months since the customer has moved in to his/her previous address.
`home_value`	Optional	The customer’s home value. Numeric value greater than zero, no decimal.
`remaining_mortgage`	Optional	The value of the customer’s remaining mortgage. Numeric value greater than zero, no decimal.
`mortgage_age`	Optional	Number of years the customer has held their mortgage. Numeric value greater than zero, no decimal.
`income_source`	Required	The source of the customer’s income. Valid values are: 1. Full Time Employed 2. Part Time Employed 3. Self Employed 4. Temporarily Employed 5. Student 6. Pension 7. Disability 8. Unemployed 9. Homemaker
`employer_name`	Optional	The name of the customer’s employer. Up to 50 alphanumeric characters.
`job_title`	Optional	The occupation of the customer. Between 2-50 alphanumeric characters.(Preferred - The description of the ABI Job Title taken from the ABI code 55 list.)
`work_phone`	Optional	The customer’s work phone number. 10 to 11 digits starting 01, 02, 07 or 08.
`months_at_employer`	Recommended. Not providing this will reduce the chance of approval with some lenders.	The number of months the customer has been with his/her current employer.
`gross_annual_income`	Recommended. Either the customers gross_annual_income or monthly_income needs to be supplied.	The customer’s gross annual income (Headline, before tax yearly salarly). Numeric value greater than zero, no decimal.
`monthly_income`	Optional. Either the customers gross_annual_income or monthly_income needs to be supplied.	The customer’s net monthly income (The amount they recieve into their account after tax each month). Numeric value greater than zero, no decimal.
`employment_industry`	Optional	Industry of the employer. Valid values: 1. Accountancy 2. Advertising/Media 3. Business Consultancy 4. Call Centre Operations 5. Cleaning Services 6. Computer Services 7. Building/Construction 8. Education/Teaching 9. Electricity/Gas/Water 10. Finance 11. Health 12. Hotels/Restaurants 13. Insurance 14. Legal Services 15. Leisure/Culture 16. Manufacturing 17. Military 18. Mining/Quarrying 19. Public Administration 20. Publishing 21. Real Estate/Property 22. Research/Development 23. Retail 24. Telecoms/Internet 25. Transportation/Distribution/Delivery 26. Other 35. Emergency Services 36. Charity/Voluntary 37. Sports 38. Pharmaceutical 39. Aerospace 40. Farming/Agriculture 41. Clerical/Administration 42. Repair/Maintenence 43. Import/Export 44. Storage 45. Waste Management/Disposal 46. Child/Adult/Social Care Services
`abi_industry`	Optional	The description of the ABI industry taken from the ABI code 11 list. (please contact your partner manager for further information.)
`income_pay_frequency`	Optional	The frequency with which the customer receives income. Valid values are: 1. Weekly 2. Every 2 weeks 3. Twice a month 4. Monthly
`income_payment_type`	Optional	The method by which the customer receives his/her paycheck. Valid values are: 1. Electronic Deposit (BACs/CHAPs/Other) 2. Other
`next_pay_date`	Optional	The date of the customer’s next paycheck in YYYY-MM-DD format. Accepted values must be in the future (tomorrow onwards)
`has_other_household_income`	Optional	Valid values: 1. (Yes, the customer has other household income); 0. (No, the customer hasn’t other household income).
`benefits`	Optional	The customer’s benefits income. Value can be zero or greater than zero, no decimal.
`rental_income`	Optional	The customer’s rental income. Value can be zero or greater than zero, no decimal.
`pension_income`	Optional	The customer’s pension income. Value can be zero or greater than zero, no decimal.
`additional_job_income`	Optional	The customer’s additional job income. Value can be zero or greater than zero, no decimal.
`other_income`	Optional	The customer’s other income. Value can be zero or greater than zero, no decimal.
`rental_mortgage_payments`	Required	The amount of the rental/mortgage payments in whole pounds and in integer format.
`existing_loan_payments`	Optional	The amount of the existing loan payments in whole pounds and in integer format.
`other_expenses`	Optional	The amount of the other expenses in whole pounds and in integer format.
`bills`	Optional	The amount of bills expenses, integer value.
`transport`	Optional	The amount of transport expenses, integer value.
`food`	Optional	The amount of the food expenses, integer value.
`bank_account_number`	Recommended. Not providing this will reduce the number of available lenders.	The customer’s bank account number. Length 8 numeric digits, no dash or space.
`bank_sort_code`	Recommended. Not providing this will reduce the number of available lenders.	The customer’s bank routing number. Length 6 numeric digits, no dash or space.
`name_of_bank`	Recommended if not supplying sort code	The customer’s primary bank. Valid values are: 1 Bank of Scotland 2 Barclays 3 Clydesdale bank 4 Halifax 5 HSBC 6 Lloyds Bank > 7 Metro Bank 8 Monzo Bank 9 National Westminster Bank 10 Nationwide Building Society 11 Prepay Technologies Ltd 12 Santander 13 Starling Bank 14 The Co-Operative Bank 15 The Royal Bank Of Scotland 16 Think Money Limited 17 TSB Bank 18 Ulster Bank 19 Other
`time_at_bank`	Optional. (Required for full lender panel)	Number of years the customer has been with their bank. Numeric value greater than zero, no decimal.
`terms_consent`	Required	Indicates whether the customer has accepted the applicable terms and conditions. Valid values: 1 (Yes) and 0 (No).
`site_url`	Required	The URL of the site on which the user applied for the loan.
`site_ip`	Required	The IP address of the site/server submitting the application, in IPv4 format.
`client_ip`	Required	The IP address of the browser of the customer requesting the loan in XXX.XXX.XXX.XXX format.
`client_agent`	Optional	The user agent string of the browser of the customer requesting the loan.
`ref`	Optional	Additional variables that affiliate can pass to our system. Up to 200 alphanumeric characters.
`gclid`	Optional	Google Click ID that may be passed as an affiliate tracking value. Up to 200 alphanumeric characters.
`keyword_gclid`	Optional	Additional affiliate tracking value associated with Google click/keyword attribution. Up to 200 alphanumeric characters.
`keyword`	Optional	Additional variables that affiliate can pass to our system. Up to 200 alphanumeric characters.
`match_type`	Optional	Additional variables that affiliate can pass to our system. Up to 10 alphanumeric characters.
`network`	Optional	Additional variables that affiliate can pass to our system. Up to 200 alphanumeric characters.
`device`	Optional	Additional variables that affiliate can pass to our system. Up to 100 alphanumeric characters.
`v1`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Alphanumeric.
`v2`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Alphanumeric.
`v3`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Alphanumeric.
`v4`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Alphanumeric.
`v5`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Alphanumeric.
`i1`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Integer.
`i2`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Integer.
`i3`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Integer.
`i4`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Integer.
`i5`	Optional	Additional tracking variable that affiliate can pass to our system. Can also be used to pass additional parameters for pixel tracking. Integer.
`opt_sms`	Optional	Indicates whether the customer has opted in for SMS. Valid values: “1” (Yes, the customer has opted in to SMS); “0” (No, the customer has not opted in to SMS)
`opt_email`	Optional	Description: Indicates whether the customer has opted in for Email. Valid values: “1” (Yes, the customer has opted in to Email); “0” (No, the customer has not opted in to Email).
`opt_phone`	Optional	Description: Indicates whether the customer has opted in for Phone. Valid values: “1” (Yes, the customer has opted in to Phone); “0” (No, the customer has not opted in to Phone).
`opt_post`	Optional	Description: Indicates whether the customer has opted in for Post. Valid values: “1” (Yes, the customer has opted in to Post); “0” (No, the customer has not opted in to Post).
`opt_cookie`	Optional	Indicates whether the customer has opted in to cookie storage for the relevant journey. Valid values: 1 (Yes) and 0 (No).
`whatsapp_consent`	Optional	Description: Indicates whether the customer has agreed to be contacted via WhatsApp. Valid values: “1” (Yes, the customer has opted in); “0” (No, the customer has not opted in).

Include site_ip unless Authorised Compliance has explicitly confirmed otherwise for your integration.

Important value rules

Consent values

Use 1 for yes and 0 for no for consent and opt-in fields.

Dates and numeric values

Dates such as dob and next_pay_date use YYYY-MM-DD. Monetary and count fields documented as integers should be sent without currency symbols or thousands separators.