Verification

A CIS subcontractor's verification with HMRC, as a child of the contact (contractor module only). The verification is the outcome: not verified, entered manually (PUT), obtained from HMRC, or failed with HMRC's errors. Asking HMRC is a separate child, hmrc-request: POST submits a verify or match request, which is polled in the background, and the outcome lands on the verification; POST again while it is delayed to resume polling, DELETE to cancel it. Webhooks report each outcome (subcontractor.verified, subcontractor.verification_failed, subcontractor.verification_removed).

GET Get Verification
Returns the subcontractor's verification: its status (not verified, manual, from HMRC, or failed with HMRC's errors), number, date and deduction rate,...
/tenants/{tenant}/contacts/{code}/verification
PUT Update Verification
Records a verification obtained from HMRC outside the API (number, date and deduction rate), replacing any manual verification already recorded. A ver...
/tenants/{tenant}/contacts/{code}/verification
DELETE Delete Verification
Removes the subcontractor's verification, manual or from HMRC. Payments are deducted at the higher rate until it is verified again. 404 when there is ...
/tenants/{tenant}/contacts/{code}/verification
POST Request HMRC Verification
Asks HMRC to verify (or match) the subcontractor. The request is submitted to the HMRC gateway and polled in the background; the outcome lands on the ...
/tenants/{tenant}/contacts/{code}/verification/hmrc-request
DELETE Cancel HMRC Verification Request
Cancels the subcontractor's pending or delayed HMRC verification request, so a new one can be submitted. 404 when there is none (a completed or failed...
/tenants/{tenant}/contacts/{code}/verification/hmrc-request
POST Request HMRC Verification For Many Contacts
Submits an HMRC verification (or match) request for each listed contact that can take one, and reports the rest with a reason: unknown, not a subcontr...
/tenants/{tenant}/hmrc-verification-requests