> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get somewhere to put a member's opt-out notice > Returns a short-lived URL to PUT the notice to, so the document goes straight to storage rather than through the service. The employer must keep the original or a copy of every opt-out notice for four years (TPR detailed guidance 7, paragraph 72), and it stays readable after the membership is deleted. Each notice gets its own id, so re-submitting one keeps the original as well. ## OpenAPI ````yaml /api-reference/specs/pension-v2.json post /employee-pension/{employeeId}/opt-out-notices openapi: 3.0.4 info: title: FlowPayroll Pension API version: v2 servers: - url: https://api.sandbox.flowpayroll.ai/v2/pension security: [] tags: - name: Pension providers description: >- Look up the pension providers available to your organisation. Providers are set up in the product, so the API exposes them read-only. - name: Pension schemes description: >- Your organisation's arrangements with providers. Scheme endpoints use the /pension-schema path. - name: Pension groups description: >- Contribution rule sets within a scheme: pension type, contribution basis, and employee and employer factors. - name: Employee enrolment description: >- Associate employees with pension groups, remove associations, and send enrolment letters. - name: Pension information description: >- An employee's full pension picture in one call: composition, latest assessment, and postponement. - name: Auto-enrolment description: >- Assessment results per pay run, employees with outstanding or no auto-enrolment, and a stateless assessment preview. - name: Postponement description: Defer auto-enrolment per employee, overriding the organisation defaults. - name: Organisation defaults description: >- The organisation's default pension group, postponement definitions, and auto-enrolment mode. - name: Pension calculations description: >- Per-period contribution amounts, the contributions CSV, and provider export files. - name: Provider submissions description: >- Send a completed pay run to its connected pension provider, approve the payment, and read back what the provider reported: opt-outs, stopped contributions, refunds and schedules. paths: /employee-pension/{employeeId}/opt-out-notices: post: tags: - Employee enrolment summary: Get somewhere to put a member's opt-out notice description: >- Returns a short-lived URL to PUT the notice to, so the document goes straight to storage rather than through the service. The employer must keep the original or a copy of every opt-out notice for four years (TPR detailed guidance 7, paragraph 72), and it stays readable after the membership is deleted. Each notice gets its own id, so re-submitting one keeps the original as well. operationId: CreateOptOutNoticeUpload parameters: - name: employeeId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOptOutNoticeUploadRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OptOutNoticeUploadModelResponseBody' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' components: schemas: CreateOptOutNoticeUploadRequest: required: - fileName - membershipEndDate type: object properties: membershipEndDate: type: string description: The ending this notice belongs to. The four years run from it. format: date fileName: type: string nullable: true contentType: type: string nullable: true additionalProperties: false description: Ask for somewhere to put a member's opt-out notice. OptOutNoticeUploadModelResponseBody: required: - message type: object properties: message: $ref: '#/components/schemas/MessageWithTokenResponse' content: $ref: '#/components/schemas/OptOutNoticeUploadModelContentResponse' validationIssues: type: array items: $ref: '#/components/schemas/ValidationIssue' nullable: true errors: type: array items: $ref: '#/components/schemas/Error' description: >- Deprecated: the same issues as `validationIssues` (`reasonText` is `reason`, `reasonId` is `reasonToken`, `reasonParameters` is `reasonTokenArguments`). Read `validationIssues`; this will be removed. nullable: true readOnly: true deprecated: true metadata: allOf: - $ref: '#/components/schemas/ContentMetadataResponse' description: >- Deprecated: the same values as `content.metadata`. Read that; this will be removed. deprecated: true additionalProperties: false description: >- The response envelope every FlowPayroll API answers with: a `message`, the `content`, and any `validationIssues`. `errors` and the top-level `metadata` are deprecated copies of `validationIssues` and `content.metadata`, and will be removed. ObjectResponseBody: required: - message type: object properties: message: $ref: '#/components/schemas/MessageWithTokenResponse' content: $ref: '#/components/schemas/ObjectContentResponse' validationIssues: type: array items: $ref: '#/components/schemas/ValidationIssue' nullable: true errors: type: array items: $ref: '#/components/schemas/Error' description: >- Deprecated: the same issues as `validationIssues` (`reasonText` is `reason`, `reasonId` is `reasonToken`, `reasonParameters` is `reasonTokenArguments`). Read `validationIssues`; this will be removed. nullable: true readOnly: true deprecated: true metadata: allOf: - $ref: '#/components/schemas/ContentMetadataResponse' description: >- Deprecated: the same values as `content.metadata`. Read that; this will be removed. deprecated: true additionalProperties: false description: >- The response envelope every FlowPayroll API answers with: a `message`, the `content`, and any `validationIssues`. `errors` and the top-level `metadata` are deprecated copies of `validationIssues` and `content.metadata`, and will be removed. MessageWithTokenResponse: required: - token type: object properties: text: type: string nullable: true token: type: string description: >- Stable snake_case key for the message, for clients that translate it. nullable: true tokenArguments: type: array items: $ref: '#/components/schemas/ValidationIssueArgument' nullable: true textId: type: string description: >- Deprecated: the same value as `token`. Read that; this will be removed. nullable: true readOnly: true deprecated: true textParameters: type: array items: $ref: '#/components/schemas/Pair' description: >- Deprecated: the same values as `tokenArguments`. Read that; this will be removed. nullable: true readOnly: true deprecated: true additionalProperties: false description: >- What happened, as English `text` and a stable `token` to translate from. `textId` and `textParameters` are deprecated copies of `token` and `tokenArguments`. OptOutNoticeUploadModelContentResponse: type: object properties: data: $ref: '#/components/schemas/OptOutNoticeUploadModel' metadata: $ref: '#/components/schemas/ContentMetadataResponse' additionalProperties: false ValidationIssue: type: object properties: field: type: string nullable: true reason: type: string nullable: true reasonToken: type: string nullable: true reasonTokenArguments: type: array items: $ref: '#/components/schemas/ValidationIssueArgument' nullable: true additionalProperties: false Error: type: object properties: field: type: string nullable: true reasonText: type: string nullable: true reasonId: type: string nullable: true reasonParameters: type: array items: $ref: '#/components/schemas/Pair' nullable: true additionalProperties: false description: >- Deprecated: an entry of the old `errors` list. Read `validationIssues` instead. deprecated: true ContentMetadataResponse: type: object properties: dateFormat: type: string nullable: true dateTimeFormat: type: string nullable: true paginationToken: type: string nullable: true additionalProperties: false ObjectContentResponse: type: object properties: data: nullable: true metadata: $ref: '#/components/schemas/ContentMetadataResponse' additionalProperties: false ValidationIssueArgument: type: object properties: name: type: string nullable: true value: nullable: true additionalProperties: false Pair: type: object properties: key: type: string nullable: true value: type: string nullable: true additionalProperties: false description: >- Deprecated: a key and value of the old `textParameters` and `reasonParameters`. deprecated: true OptOutNoticeUploadModel: required: - contentType - noticeId - retainUntil - uploadUrl type: object properties: noticeId: type: string nullable: true uploadUrl: type: string nullable: true contentType: type: string description: >- Must be sent as the Content-Type of the PUT, or the URL will not accept it. nullable: true retainUntil: type: string description: 'The last day this notice must be kept (TPR DG7 para 72: four years).' format: date additionalProperties: false description: |- Where to PUT the notice. Short-lived, and the document goes straight to storage rather than through the service. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.