API Docs / Operations / Verification / Request HMRC Verification For Many Contacts

Request HMRC Verification For Many Contacts

POST /tenants/{tenant}/hmrc-verification-requests

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 subcontractor, already verified, a request already pending, or CIS details too incomplete to send (the message is also stored on the contact). A delayed request is resumed. Requests are polled in the background; watch each contact's verification. HMRC settings that are incomplete or rejected are 422, before anything is sent.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

{
  "action": "Verify",
  "contacts": [
    "string"
  ]
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
422 Unprocessable Content
application/problem+json