Sign in

v1

latestOpenAPI 3.0.32026-07-131211345.4 KB
Coding Out Status

Opt Out of Coding Out

This endpoint enables a specified customer (identified by a National Insurance number) and tax year to opt out of coding out. Opt-out status can be changed up to and including 30 December following the end of the specified tax year. Opt-out status cannot be changed after the customer has made a final declaration for the specified tax year.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulates a successful response with latest values.
BUSINESS_PARTNER_NOT_EXISTSimulates a scenario where the NINO is valid but is not registered with ITSD as a business partner.
ITSA_CONTRACT_OBJECT_NOT_EXISTSimulates a scenario where the NINO is valid and is registered with ITSD as a business partner, but the ITSA contract object does not exist for the NINO.
ALREADY_OPTED_OUTSimulates a scenario where the customer cannot be opted out because they are already opted out.
STATEFULPerforms a stateful Opt Out of Coding Out.
post/accounts/self-assessment/{nino}/{taxYear}/collection/tax-code/coding-out/opt-out

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A.

taxYearstring required
Example:2021-22

The tax year the data applies to, for example, 2021-22. The start year and end year must not span two tax years. No gaps are allowed, for example, 2020-22 is not valid.

Headers

Accept'application/vnd.hmrc.4.0+json' required

Specifies the response format and the version of the API to be used.

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the read:self-assessment scope.

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Success(No Content)