Counterparty Schema

Field	Type	Optional	Description
l3CounterpartyId	String	No	The unique identifier for the counterparty. UUID format.
l3CounterpartyName	String	Yes	Name of the counterparty.
parentId	String	Yes	The unique identifier of the parent counterparty (where applicable). 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	Name of the parent counterparty (where applicable).
fullCompanyName	String	Yes	Company name. Can be the extended name or registered name of the counterparty.
logoUrl	String	Yes	Logo URL of counterparty. Suitable for displaying in a consumer-facing app.
website	String	Yes	Website URL of counterparty.
registeredLocation	String	Yes	Registered address of company.
l3CounterpartyCategory	String	Yes	Category used to group similar counterparties. The level 3 category, industry, assigned to the counterparty.
l2CategoryName	String	Yes	Most appropriate transaction category name for transactions to this counterparty. The predominant level 2 category assigned to the counterparty, e.g. a petrol station, will be "gasoline".
l4LoanType	String	Yes	The level 4 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".