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

# Download a report

> Download a ready report. Redirects (`303`) to a signed link to the file that
expires after one minute, so follow the redirect straight away (`curl -L`)
and call this endpoint again for a fresh link rather than storing it.

Supports `Nxos-On-Behalf-Of` on the same terms as listing.



## OpenAPI

````yaml GET /v1/reports/{reportId}/download
openapi: 3.0.0
info:
  title: nxos API
  version: 1.0.0
  contact:
    name: nxos
    url: https://nxos.io
  description: |-
    The nxos platform API provides programmatic access to accounts, balances,
    quotes, and trades. All endpoints require API key authentication.
servers:
  - url: https://api.nxos.io
    description: Production
    variables: {}
  - url: https://api.sandbox.nxos.io
    description: Sandbox
    variables: {}
security: []
tags:
  - name: Accounts
  - name: Quotes
  - name: Beneficiaries
  - name: Fiat Payouts
  - name: Crypto Payouts
  - name: Sandbox Faucet
  - name: Nxosnet
  - name: Fees
  - name: Sub-Org Tiers
  - name: Assets
  - name: Funding Methods
  - name: Transactions
  - name: Organizations
  - name: Authorizations
  - name: Referral invites
  - name: Referral links
  - name: Reports
  - name: Webhooks
    description: >-
      Register an HTTPS endpoint to receive events (organization verification,

      transaction status changes, and finished reports) instead of polling.
      Deliveries are signed; verify

      the `svix-signature` header before acting on an event.


      See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for
      the

      delivery format, signature verification, retries, and broker behavior.
      Payload

      shapes are documented in the `…Event` models below.
paths:
  /v1/reports/{reportId}/download:
    get:
      tags:
        - Reports
      description: >-
        Download a ready report. Redirects (`303`) to a signed link to the file
        that

        expires after one minute, so follow the redirect straight away (`curl
        -L`)

        and call this endpoint again for a fresh link rather than storing it.


        Supports `Nxos-On-Behalf-Of` on the same terms as listing.
      operationId: Reports_download
      parameters:
        - $ref: '#/components/parameters/ApiKeyAuth'
        - name: reportId
          in: path
          required: true
          description: Report identifier.
          schema:
            type: string
      responses:
        '303':
          description: Redirection
          headers:
            Location:
              required: true
              description: Signed link to the file, valid for one minute.
              schema:
                type: string
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Access is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
              examples:
                verification_required:
                  summary: verification_required
                  value:
                    error:
                      code: verification_required
                      message: Complete identity verification before using the API.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                acting_org_not_found:
                  summary: acting_org_not_found
                  value:
                    error:
                      code: acting_org_not_found
                      message: >-
                        Nxos-On-Behalf-Of points to an organization that does
                        not exist.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                authorization_required:
                  summary: authorization_required
                  value:
                    error:
                      code: authorization_required
                      message: No authorization for the requested organization.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
              examples:
                report_not_found:
                  summary: report_not_found
                  value:
                    error:
                      code: report_not_found
                      message: Report not found.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        '409':
          description: The request conflicts with the current state of the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
              examples:
                report_not_ready:
                  summary: report_not_ready
                  value:
                    error:
                      code: report_not_ready
                      message: The report is not ready to download.
                      requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        '429':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  parameters:
    ApiKeyAuth:
      name: Authorization
      in: header
      required: true
      description: 'Bearer token. Format: `Bearer <api_key>`'
      schema:
        type: string
  schemas:
    Error401:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: missing_api_key
          message: 'Missing or invalid Authorization header. Expected: Bearer <api_key>'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error403:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
    Error404:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
    Error409:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
    Error429:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: rate_limited
          message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error500:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: internal_error
          message: An unexpected error occurred.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    ErrorBody:
      type: object
      required:
        - code
        - message
        - requestId
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCode'
          description: Machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Unique identifier for this request, useful for debugging.
    ErrorCode:
      type: string
      enum:
        - missing_api_key
        - authentication_failed
        - invalid_api_key
        - forbidden
        - acting_org_not_found
        - authorization_required
        - swap_direction_not_allowed
        - sub_org_tier_not_available
        - service_not_enabled
        - not_found
        - organization_not_found
        - account_not_found
        - quote_not_found
        - beneficiary_not_found
        - transaction_not_found
        - funding_method_not_found
        - authorization_not_found
        - nxosnet_handle_not_found
        - sub_org_tier_not_found
        - report_not_found
        - quote_expired
        - quote_already_used
        - beneficiary_already_archived
        - beneficiary_not_archived
        - beneficiary_blocked
        - transaction_blocked
        - transaction_not_held
        - fee_schedule_drifted
        - nxosnet_not_enabled
        - nxosnet_handle_taken
        - chain_send_failed
        - swift_copy_not_found
        - swift_copy_not_ready
        - bank_unavailable
        - idempotency_key_in_use
        - idempotency_request_in_flight
        - referral_invite_already_accepted
        - report_not_ready
        - too_many_pending_reports
        - invalid_request
        - insufficient_funds
        - trade_size_out_of_bounds
        - validation_error
        - invalid_document
        - too_many_documents
        - document_too_large
        - document_not_found
        - document_not_uploaded
        - share_token_invalid
        - verification_import_unsupported
        - verification_required
        - rate_limited
        - webhooks_unavailable
        - internal_error
      description: All possible error codes returned by the API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.