Developer news
Ireland: Addition of subType to productName
Posted 2025-07-02
Summary
To improve clarity and usability in the Irish document product listings, we have introduced a change to how subType values are handled in the productName field. This enhancement was rolled out 2nd of July 2025’s release ensures that compound documents are more easily distinguishable in KYC API interface.
Background
Previously, in version 1 of the API, Irish document products included both
type and subType fields. However, in version 2, the subType was omitted, leading to ambiguity when multiple documents shared the same type.
Change Description
We now concatenate the
subType to the productName in parentheses, unless the type and subType are identical. This change applies to the productSearch endpoint.
Before (on v1 structure):
{
"date": "2022-10-03",
"docId": "124023406",
"subType": "AMENDED CONSTITUTION",
"type": "Form G1Q: Special Resolution to Change the Company Name"
}Response now (as-is)
{
"date": "2022-10-03",
"productName": "Form G1Q: Special Resolution to Change the Company Name (AMENDED CONSTITUTION)",
"productOptionId": "124023405"
}This approach ensures that users can distinguish between different document subtypes at a glance.
Notes
type=subType, the subType will not be appended.