API Docs / Operations / Client - Business Details / Verify Client VAT Number

Verify Client VAT Number

POST /tenants/{tenant}/clients/{client}/businessdetails/vat-number/verify

Checks the client's VAT number against HMRC's Check a UK VAT Number service and records the outcome on their business details. When the practice's own VAT number is set on Practice Details the check is a verified one and HMRC's consultation number (proof of the check) is stored. A "not registered" answer is returned as registered=false, and clears any earlier verification. Editing the VAT number clears the verification automatically.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

client* path string

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found