API Docs / Schemas / SubcontractorVerificationDto

SubcontractorVerificationDto

The subcontractor's current CIS verification. On a contact it is read-only: it changes through the contact's
verification resource (manual entry, or an HMRC verification request), not through the contacts resource.

Properties

Name Type Description
status*enum

Verification status

NotVerified Manual HmrcVerified HmrcFailed

Verification status

NotVerified Manual HmrcVerified HmrcFailed

numberstring

Verification number (V followed by 10 digits and up to 2 letters). Present for Manual and HmrcVerified.

Verification number (V followed by 10 digits and up to 2 letters). Present for Manual and HmrcVerified.

datestring

Date of the verification. Present for Manual and HmrcVerified.

Date of the verification. Present for Manual and HmrcVerified.

taxStatus*enum

The deduction rate that applies to the subcontractor's payments

NetOfHigherDeduction NetOfStandardDeduction Gross

The deduction rate that applies to the subcontractor's payments

NetOfHigherDeduction NetOfStandardDeduction Gross

recordedDatestring

When the verification was recorded: entered by a user, or received from HMRC. Present for Manual and HmrcVerified.

When the verification was recorded: entered by a user, or received from HMRC. Present for Manual and HmrcVerified.

errorsarray of HmrcError

HMRC's errors from the last verification request, or the reason the contact could not be sent to HMRC.
Present for HmrcFailed.

HMRC's errors from the last verification request, or the reason the contact could not be sent to HMRC.
Present for HmrcFailed.

hmrcRequestHmrcVerificationRequestDto

The contact's latest HMRC verification request. Reported by the verification resource only; null on a contact.

The contact's latest HMRC verification request. Reported by the verification resource only; null on a contact.

JSON Example

{
  "status": "NotVerified",
  "number": "string",
  "date": "2024-01-01T00:00:00Z",
  "taxStatus": "NetOfHigherDeduction",
  "recordedDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas