API Docs / Operations / HMRC Credentials / Test HMRC Credentials

Test HMRC Credentials

POST /me/hmrc-credentials/{credentials}/test

Sends a dummy subcontractor verification through the gateway with the credentials, using the named tenant's HMRC references as the context (the caller must be a member; 400 otherwise), and reports whether HMRC accepted them.

Parameters

NameTypeDescription
credentials* path string (uuid)
{
  "tenant": "string"
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json