API Docs / Schemas / VatNumberVerificationDto

VatNumberVerificationDto

The outcome of verifying a client's VAT number against HMRC's Check a UK VAT Number service.
When the number is registered, HMRC's registered name and address are returned so the user can
compare them with the client record — a mismatch is information, not an error.

Properties

Name Type Description
registeredboolean

Whether HMRC recognises the number as a current VAT registration.

Whether HMRC recognises the number as a current VAT registration.

vatNumberstring

The VAT number that was checked, as normalised by HMRC (no GB prefix, no spaces).

The VAT number that was checked, as normalised by HMRC (no GB prefix, no spaces).

hmrcNamestring

The name HMRC holds the registration under. Null when not registered.

The name HMRC holds the registration under. Null when not registered.

hmrcAddressLine1string

First line of the registered address. Null when not registered.

First line of the registered address. Null when not registered.

hmrcPostcodestring

Postcode of the registered address. Null when not registered or held abroad.

Postcode of the registered address. Null when not registered or held abroad.

hmrcCountryCodestring

ISO country code of the registered address. Null when not registered.

ISO country code of the registered address. Null when not registered.

consultationNumberstring

HMRC's consultation number — proof the check was made, for the AML file. Present only when
the practice's own VAT number is on record (which upgrades the check to a verified one).

HMRC's consultation number — proof the check was made, for the AML file. Present only when
the practice's own VAT number is on record (which upgrades the check to a verified one).

verifiedDatestring

When the verification was recorded. Null when the number was not registered.

When the verification was recorded. Null when the number was not registered.

JSON Example

{
  "registered": false,
  "vatNumber": "string",
  "hmrcName": "string",
  "hmrcAddressLine1": "string",
  "hmrcPostcode": "string"
}

Used By Operations