v1

latestOpenAPI 3.0.02026-07-132812.0 KB
marriage-allowance-test-support

Create Marriage Allowance eligibility test data

Lets you create Marriage Allowance eligibility test data.

Supports the Check Marriage Allowance eligibility resource method on the Marriage Allowance API.

post/marriage-allowance-test-support/nino/{nino}/eligibility/{taxYear}

Path parameters

ninostring required
Example:AA000003D

Partner’s (potential recipient’s) National Insurance number. This must match the National Insurance number of an individual created using the Create Test User API.

taxYearstring required
Example:2016-17

The tax year for which the Marriage Allowance eligibility is being created.

Request body

eligibleboolean required

Whether the taxpayer's partner is eligible to become a recipient of Marriage Allowance

Response

eligibleboolean required

Whether the taxpayer's partner is eligible to become a recipient of Marriage Allowance