API Reference

Common Errors

From previous experience these seem to be the most common fields causing issues

Request validation

There are different levels of validation that are applied to request payloads and returned as two different statuses in the response from the API.

  1. INCOMPLETE_DATA - this is when not enough information exists in the request for the API to be able to create an application and proceed to getting offers. An example of this might be where the Years Lived at an address is not supplied.
  2. INVALID_DATA - this is when invalid information that fails to meet the constraints imposed by the API have not been met. An example of this might be where a request exceeding the Maximum Loan Amount has been asked for.

Common errors

🛑

The following seem to be those errors that occur more frequently than others (listed in no particular order):

  1. API constraints
    • Many of the API fields have Min/Max constraints or Regular expressions - please ensure that if you are building your own EC form that you also apply these to your UI so that data items are correct when passed to the API (note that in the API document you can click into each field to see a popup that shows any constraints).
  2. Other incomes
    • Incomes are not specified if the customer is retired or unemployed (typically, adding a pension or other means of income such as benefits).
    • Incomes are added but with a zero amount (typically this occurs when partners have built their own EC form. and allow a customer to add, then remove an income which ultimately gets passed to the API)
  3. Employer name
    • Failing to ensure that the name passed matches the regular expression that is applied to this field.
    • Exceeding the length allowed.
  4. Address data
    • This is covered in the Current and Previous Address section but is worth specifically mentioning again here as this is quite an important data component.
    • If the current address matches the previous address then the API will return an EC resume link, so if you are building your own EC form it would be best to also validate this constraint before our API is invoked.
    • The validation of Address Data can be a little complex, in that at least one of Flat, House number or House name is required so please be sure that all the constraints on the address data is met.
  5. Phone Numbers
    • Phone numbers must be between 11 and 24 characters in length - typically we see errors because the customer has dropped the leading zero on a mobile phone number meaning the length drops to 10 characters.