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 verification, so poll GET (the Location header) until hmrcRequest.status leaves Pending. While a request is pending, another is 409. While the last request is Delayed (HMRC slow to answer), POST resumes polling that request, as HMRC asks. A contact whose CIS details are not complete enough to send is 400, with the reason also stored as its verification error; HMRC settings that are incomplete or rejected are 422.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The tenant code (the organisation's URL stub) |
The tenant code (the organisation's URL stub) |
||
| code* | path string | |
Request Body*
{
"action": "Verify"
}Responses
202 Accepted
401 Unauthorized – Invalid or missing API key