DocumentationAPI Reference
General reference · eKYB Reference / eKYB Prefill Coverage

Ireland

eKYB Prefill in Ireland leverages Ireland's source of truth to automatically retrieve and populate business information based on a company's CRO number or VAT number, including the business name, entity type, registration status, registration date, credit rating, and other corporate details, without requiring manual input from the user.

Source

Country Source Description
Ireland IE_KYB_PREFILL Returns matching Irish business details from Ireland's source of truth for pre-fill.

Direct API approach

For general integration notes and shared response semantics, see the eKYB Prefill API Reference.

All module configurations and user data can be forwarded directly in the request for performing a Prefill lookup. This overrides existing configuration and data collected about the user.

Endpoint

POST /omni/externalVerification/ekyb-prefill

Request parameters

Parameter Required Description
plugins Mandatory String array. Must be ["ekyb-prefill"]. Specifies the Prefill flow.
source Mandatory String. Must be IE_KYB_PREFILL. Identifies the Prefill source.
country Mandatory String. Two-letter Alpha-2 country code. Must be IE.
taxId Mandatory String. CRO number or VAT number. See Tax ID formats for details.
businessName Optional String. Registered business name, used to verify the match against the source of truth.
address Optional String. Business address, used to verify the match against the source of truth.

Tax ID formats

Ireland supports two business identifier formats as search input. Requests with an invalid format return a 400 error.

Entity Type Format
CRO number (Company Registration Number) Purely numeric, typically 5–9 digits (e.g. 301274). May or may not appear with an IE prefix in the response — do not assume either way.
VAT number IE + 7 digits + 1–2 check letters (e.g. IE6321274H)

Disambiguation logic: if taxId is purely numeric, it is treated as a CRO number. If it contains letters, it is treated as a VAT number.

Sample request

{
    "plugins": ["ekyb-prefill"],
    "source": "IE_KYB_PREFILL",
    "country": "IE",
    "taxId": "301274",
    "businessName": "",
    "address": ""
}

Sample response

{
    "kyb-prefill": [
        {
            "tin": "IE301274",
            "vatNo": "IE6321274H",
            "name": "SAMPLE CHEMICAL & DAIRY ENGINEERING LIMITED",
            "nameMatch": "Verified",
            "address": "SAMPLE ROAD, EXAMPLETOWN CORK Ireland",
            "entityType": "LTD - PRIVATE COMPANY LIMITED BY SHARES",
            "registrationStatus": "Active",
            "registrationDate": "1999-02-15T00:00:00Z",
            "creditRating": "A",
            "creditRatingDescription": "Very Low Risk",
            "industryDesc": "Manufacture of metal structures and parts of structures",
            "activityDesc": "The manufacture of process systems and stainless steel products including the design, procurement and manufacture of modular process skid units.",
            "turnover": { "currency": "EUR", "value": 53090461 },
            "employeeCount": "211",
            "shareholders": [
                { "name": "SAMPLE CHEMICAL & DAIRY ENGINEERING (HOLDINGS) LIMITED", "percentSharesHeld": 100 }
            ],
            "directors": [
                { "name": "SAMPLE DIRECTOR NAME", "positionName": "Director" },
                { "name": "SAMPLE DIRECTOR NAME", "positionName": "Company Secretary" },
                { "name": "ANOTHER SAMPLE NAME", "positionName": "Director" },
                { "name": "THIRD SAMPLE NAME", "positionName": "Director" }
            ],
            "ultimateParent": { "name": "SAMPLE HOLDING GROUP", "country": "FR" },
            "immediateParent": { "name": "SAMPLE HOLDING GROUP", "country": "FR" }
        }
    ]
}

Example 2 — sole trader (NonLtd)

{
    "kyb-prefill": [
        {
            "tin": "240907",
            "name": "SAMPLE SALON",
            "nameMatch": "Verified",
            "address": "2 SAMPLE COURT, SAMPLE ROAD, EXAMPLE AREA, DUBLIN 18, D18TW10",
            "city": "DUBLIN",
            "postalCode": "D18TW10",
            "entityType": "INDIVIDUAL",
            "registrationStatus": "Active",
            "registrationDate": "2003-09-10T00:00:00Z",
            "activityDesc": "Website",
            "directors": [
                { "name": "SAMPLE OWNER NAME", "positionName": "Registered Business Owner" }
            ]
        }
    ]
}

Info

Field availability differs significantly by entity type. vatNo, creditRating, turnover, employeeCount, and shareholders may all be absent for sole traders. ultimateParent/immediateParent are absent for entities that sit at the top of their own group. city, postalCode, and websites are not consistently present across entities.

Response fields

Key Value Description
tin CRO number Company Registration Number. May or may not include an IE prefix, depending on the entity — do not assume either way.
vatNo VAT number Includes the IE prefix as stored in the source of truth (not stripped). Absent for sole traders and pure holding companies with no VAT registration.
name Business name The registered legal name of the business as returned from the source of truth.
nameMatch Verified, Approximate Match, Unverified Match result comparing the submitted businessName against the registered name. Only returned when businessName is submitted.
address Address The registered business address as returned from the source of truth.
addressMatch Verified, Approximate Match, Unverified Match result comparing the submitted address against the registered address. Only returned when address is submitted.
city City The city associated with the registered business address, when available. May not be present even when available at the initial search step.
postalCode Postal code Eircode format (3+4 characters), when available.
entityType Entity type The legal entity type of the business (e.g. LTD - PRIVATE COMPANY LIMITED BY SHARES, INDIVIDUAL). Defaults to "Unknown" when not available.
registrationStatus Active, Expired, Unknown, Not Found Current registration status of the business. Defaults to "Unknown" when not available.
registrationDate Date The date the business was registered. May not be available for all entities.
creditRating Rating value (e.g. A, C) The business's credit rating, as returned from the source of truth. Defaults to "Unknown" when not available.
creditRatingDescription Description (e.g. Very Low Risk) Human-readable description of the credit rating. Defaults to "Unknown" when not available.
industryDesc Industry description Description of the business's main activity.
activityDesc Activity description Description of the business's principal activity. May be a short label or a long free-text description depending on the company — this varies within Ireland itself.
turnover {currency, value} object The business's latest reported turnover figure. May not be present (e.g. for sole traders).
employeeCount Number (as string) Latest reported number of employees, if available.
websites Array of strings Websites associated with the business, if available.
shareholders Array of {name, percentSharesHeld} Shareholder information. Entirely absent for sole traders and other non-limited entities — not just empty.
directors Array of {name, positionName} Directors associated with the business. The same person may appear multiple times with different positionName values — all entries are listed, without deduplication. For sole traders, the owner appears here with positionName: "Registered Business Owner".
ultimateParent {name, country} The business's ultimate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group.
immediateParent {name, country} The business's immediate parent company, if the business is a subsidiary. Absent when the entity sits at the top of its own group.

Error responses

For standard HTTP response codes, see the API Error Response page. Ireland Prefill returns the following country-specific 400 errors.

taxId is not a valid CRO number (numeric) or VAT number (IE + 7 digits + 1–2 letters):

{
    "status": 400,
    "error": "Bad Request",
    "message": "taxId must be a valid CRO number or Irish VAT number",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Any mandatory field (plugins, source, country, or taxId) is missing:

{
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}

No business match is found for the submitted taxId:

{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Single Session Dashboard results

Prefill results are available on the Business tab in single Session view.

Was this page helpful?