API Docs / Schemas / HmrcVerificationRequestDto

HmrcVerificationRequestDto

A subcontractor's latest HMRC verification request. Requests are asynchronous: the API submits them to the HMRC
gateway and polls for the outcome, which lands on the verification.

Properties

Name Type Description
status*enum

Request status

Pending Delayed Completed Failed

Request status

Pending Delayed Completed Failed

submittedDate*string

When the request was submitted to HMRC

When the request was submitted to HMRC

lastPolledDatestring

When HMRC was last polled for the outcome

When HMRC was last polled for the outcome

requestXmlstring

The GovTalk request sent to HMRC; only for callers with the HmrcXmlViewer role

The GovTalk request sent to HMRC; only for callers with the HmrcXmlViewer role

responseXmlstring

HMRC's GovTalk response; only for callers with the HmrcXmlViewer role

HMRC's GovTalk response; only for callers with the HmrcXmlViewer role

JSON Example

{
  "status": "Pending",
  "submittedDate": "2024-01-01T00:00:00Z",
  "lastPolledDate": "2024-01-01T00:00:00Z",
  "requestXml": "string",
  "responseXml": "string"
}

Contained in Schemas