> ## Documentation Index
> Fetch the complete documentation index at: https://developers.circle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upload a payout RFI file

> Uploads a file in response to an active RFI file requirement for the specified fiat payout.

The `fileKey` in `fileMetadata` must match one of the `fileKey` values from the
`fileRequirements` array returned by `GET /v1/payouts/{id}/rfi`.

**Encryption** — required for BFI-generated RFIs, optional for internally-generated RFIs:

Check whether `GET /v1/payouts/{id}/rfi` returns a non-null `certificate` field:

- **`certificate` present** (BFI-generated RFI): encrypt the file client-side before upload.
  1. Extract `certificate.jwk` — an EC public key in JWK format.
  2. Generate a random AES-128 key and encrypt the file bytes using **AES-128-GCM**. Retain the IV.
  3. Wrap the AES-128 key using **ECDH-ES + AES-128 Key Wrap** (`ECDH-ES+A128KW` / `A128GCM`)
     against the EC public key from step 1. This produces a **Compact JWE string**
     (`header.encryptedKey.iv.ciphertext.tag`).
  4. Submit with all three multipart fields (`fileMetadata`, `encryption`, `encryptedFile`).

- **`certificate` absent** (internally-generated RFI): omit `encryption` and `encryptedFile`.
  Submit only `fileMetadata` and the raw `file` field. The file is stored with standard
  encryption-at-rest; no client-side encryption step is needed.




## OpenAPI

````yaml openapi/payouts.yaml post /v1/payouts/{id}/rfi/files
openapi: 3.0.2
info:
  version: ${version}
  title: Crypto Payouts API
  description: >-
    The Circle Payouts API allows you to programmatically make fast, global
    payouts to your customers, vendors, and suppliers. Make payouts on supported
    blockchains.
servers:
  - url: https://api-sandbox.circle.com
  - url: https://api.circle.com
security: []
tags:
  - name: Payouts
    description: Create and get information on address book payouts.
  - name: Crypto Address Book
    description: Manage blockchain addresses with metadata.
paths:
  /v1/payouts/{id}/rfi/files:
    post:
      tags:
        - Payouts
      summary: Upload a payout RFI file
      description: >
        Uploads a file in response to an active RFI file requirement for the
        specified fiat payout.


        The `fileKey` in `fileMetadata` must match one of the `fileKey` values
        from the

        `fileRequirements` array returned by `GET /v1/payouts/{id}/rfi`.


        **Encryption** — required for BFI-generated RFIs, optional for
        internally-generated RFIs:


        Check whether `GET /v1/payouts/{id}/rfi` returns a non-null
        `certificate` field:


        - **`certificate` present** (BFI-generated RFI): encrypt the file
        client-side before upload.
          1. Extract `certificate.jwk` — an EC public key in JWK format.
          2. Generate a random AES-128 key and encrypt the file bytes using **AES-128-GCM**. Retain the IV.
          3. Wrap the AES-128 key using **ECDH-ES + AES-128 Key Wrap** (`ECDH-ES+A128KW` / `A128GCM`)
             against the EC public key from step 1. This produces a **Compact JWE string**
             (`header.encryptedKey.iv.ciphertext.tag`).
          4. Submit with all three multipart fields (`fileMetadata`, `encryption`, `encryptedFile`).

        - **`certificate` absent** (internally-generated RFI): omit `encryption`
        and `encryptedFile`.
          Submit only `fileMetadata` and the raw `file` field. The file is stored with standard
          encryption-at-rest; no client-side encryption step is needed.
      operationId: uploadPayoutRfiFiles
      parameters:
        - $ref: '#/components/parameters/IdPath'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - fileMetadata
              properties:
                fileMetadata:
                  type: object
                  required:
                    - fileName
                    - fileType
                    - fileKey
                  properties:
                    fileName:
                      type: string
                      description: Original file name including extension.
                      example: invoice.pdf
                    fileType:
                      type: string
                      description: MIME type of the file.
                      example: application/pdf
                    fileKey:
                      type: string
                      description: >
                        Key identifying which file requirement this upload
                        satisfies.

                        Must match a `fileKey` value from `GET
                        /v1/payouts/{id}/rfi` → `fileRequirements`.
                      example: proofOfFunds
                encryption:
                  type: object
                  description: >
                    JWE encryption envelope. Required when `certificate` is
                    present in the RFI response

                    (BFI-generated RFI). Omit for internally-generated RFIs.
                  required:
                    - encryptedAesKey
                    - iv
                  properties:
                    encryptedAesKey:
                      type: string
                      description: >
                        Compact JWE string wrapping the AES-128 file-encryption
                        key.

                        Algorithm: `ECDH-ES+A128KW` (key agreement) with
                        `A128GCM` (content encryption).

                        The recipient EC public key is obtained from
                        `certificate.jwk` in the RFI response.
                      example: >-
                        eyJhbGciOiJFQ0RILUVTIn0..GawgguFyGrWKav7AX4VKUg.p0oLHRPhFBZqYYQxouP9gw.0HFmhOzsQ98HboVlPPyQ0A
                    iv:
                      type: string
                      description: >-
                        Base64-encoded AES-128-GCM initialization vector (96-bit
                        / 12 bytes).
                      example: YWJjZGVmZ2hpamts
                encryptedFile:
                  type: string
                  format: binary
                  description: >
                    AES-128-GCM encrypted file contents. Required when
                    `encryption` is present

                    (BFI-generated RFI). Omit for internally-generated RFIs.
                file:
                  type: string
                  format: binary
                  description: >
                    Raw (unencrypted) file contents. Required for
                    internally-generated RFIs

                    (when `certificate` is absent in the RFI response). Omit for
                    BFI-generated RFIs.
      responses:
        '204':
          description: File uploaded successfully.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - bearerAuth: []
components:
  parameters:
    IdPath:
      name: id
      description: Universally unique identifier (UUID v4) of a resource.
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: b3d9d2d5-4c12-4946-a09d-953e82fae2b0
  headers:
    XRequestId:
      description: >-
        Universally unique identifier (UUID v4) for the request. Helpful for
        identifying a request when communicating with Circle support.
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  responses:
    BadRequest:
      description: The request cannot be processed due to a client error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: BadRequest
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 400
              message: Bad request.
          examples:
            response:
              value:
                code: 400
                message: Bad request.
    NotAuthorized:
      description: >-
        The request has not been applied because it lacks valid authentication
        credentials.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: NotAuthorized
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 401
              message: Malformed authorization.
          examples:
            response:
              value:
                code: 401
                message: Malformed authorization.
    NotFound:
      description: The specified resource was not found.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            type: object
            title: NotFound
            required:
              - code
              - message
            properties:
              code:
                type: integer
                example: 400
              message:
                type: string
                example: Something went wrong.
            example:
              code: 404
              message: Not found.
          examples:
            response:
              value:
                code: 404
                message: Not found.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````