v1

latestOpenAPI 3.0.32026-07-13833259.3 KB
organisations

Retrieve VAT customer information

Retrieves information about a VAT customer.

Test data

<p>Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.</p> <table> <thead> <tr> <th>Header Value (Gov-Test-Scenario)</th> <th>Scenario</th> </tr> </thead> <tbody> <tr> <td><p>DEFAULT</p></td> <td><p>The default scenario.</p></td> </tr> <tr> <td><p>CUSTOMER_INFO_NOT_FOUND</p></td> <td><p>The scenario where no customer information could be found.</p></td> </tr> <tr> <td><p>NO_EFFECTREGISTRATIONDATE</p></td> <td><p>The scenario where the customer has no effective registration date.</p></td> </tr> <tr> <td><p>NO_FLATRATESCHEME</p></td> <td><p>The scenario where the customer has not entered the VAT Flat Rate Scheme.</p></td> </tr> <tr> <td><p>NO_EFFECTREGISTRATIONDATE_NO_FRS</p></td> <td><p>The scenario where the customer has no effective registration date and has not entered the VAT Flat Rate Scheme.</p></td> </tr> </tbody> </table>
get/organisations/vat/{vrn}/information

Path parameters

vrnstring required
Example:123456789

VAT registration number. <br> A nine-digit number.

Headers

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Example response

{
  "customerDetails": {
    "effectiveRegistrationDate": "2025-12-31"
  },
  "flatRateScheme": {
    "frsCategory": "001",
    "startDate": "2025-12-31"
  }
}