Reference Data

The following are reference datasets that we will reference throughout the solution. They are the same for the API GET response as they are for the de-normalised schema.

Field	Type	Optional	Description
l3CounterpartyId	String	No	Unique identifier for the counterparty. Type 4 or type 5 UUID for “core” engine counterparties and a type 3 UUID for counterparties derived from geotag data.
l3CounterpartyName	String	No	The name of the counterparty: L3 brand.
parentId	String	Yes	For counterparties that provide multiple services, such as Tesco, there may be numerous child counterparties for each service, e.g., Tesco Mobile, which link back to a more generic parent, i.e., Tesco.
parentName	String	Yes	The name of the more generic parent counterparty.
fullCompanyName	String	Yes	Can be the extended name or registered name of the counterparty.
logoUrl	String	Yes	URL of Moneyhub-hosted version of the counterparty logo. Suitable for displaying in a consumer-facing app.
website	String	Yes	Counterparty website.
registeredLocation	String	Yes	Address of the counterparty.
l2CategoryName	String	Yes	The predominant level 2 category assigned to the counterparty, e.g. a petrol station, will be “gasoline”.
l3CounterpartyCategory	String	Yes	The level 3 category, industry, assigned to the counterparty.
l4LoanType	String	Yes	The L4 loan type. Only present for loan provider counterparties. One of “Unsecured”, “Secured”, “Buy Now Pay Later”, “High Cost Short Term Credit”, “Debt Collection Agency/Debt Management Plan”.