API Docs / Operations / HMRC Settings / Test HMRC Settings

Test HMRC Settings

POST /tenants/{tenant}/settings/hmrc/test

Sends a dummy subcontractor verification through the gateway with the stored settings and reports whether HMRC accepted the credentials. Slow: it waits for HMRC.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json