---
title: "Retrieves a service request form by its ID"
url: "https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625/operations/downloadSRFDocument"
---

> Full API specification: https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625.md

# Retrieves a service request form by its ID

`GET` `/document/v3/service-request-form/{documentId}/download`

Operation ID: `downloadSRFDocument`

Retrieves the service request form based on the provided ID. If a document key is available, the form is returned as binary data; otherwise, a public URL to access the form is provided.

## Path parameters

- `documentId` (string, required)

## Query parameters

- `documentClassification` (string, optional)
- `parentCarrierCode` (string, optional)

## Header parameters

- `x-correlation-id` (string, optional)

## Responses

- `200` - service request form downloaded successfully
- `400` - service request form download failed
- `403` - Forbidden
- `500` - Internal server error

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Enterprise Documents API
  version: 3.1.0
servers:
  - url: https://dev.api.zinnia.io
    description: Dev Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
paths:
  /document/v3/service-request-form/{documentId}/download:
    get:
      security:
        - Auth0: []
      tags:
        - ServiceRequestForms V3
      summary: Retrieves a service request form by its ID
      description: Retrieves the service request form based on the provided ID. If a
        document key is available, the form is returned as binary data;
        otherwise, a public URL to access the form is provided.
      operationId: downloadSRFDocument
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
        - name: x-correlation-id
          in: header
          required: false
          schema:
            type: string
        - name: documentClassification
          in: query
          required: false
          schema:
            type: string
            enum:
              - INBOUND
              - OUTBOUND
        - name: parentCarrierCode
          in: query
          required: false
          schema:
            type: string
      responses:
        "200":
          description: service request form downloaded successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceRequestFormDownloadResponse"
        "400":
          description: service request form download failed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              examples:
                InvalidRequest:
                  summary: Invalid input
                  description: InvalidRequest
                  value:
                    correlationId: 123e4567-e89b-12d3-a456-426614174000
                    success: false
                    message: Invalid request format
                    statusCode: 400
                MissingField:
                  summary: Missing required field
                  description: MissingField
                  value:
                    correlationId: 123e4567-e89b-12d3-a456-426614174000
                    success: false
                    message: documentType is required
                    statusCode: 400
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              examples:
                AccessDenied:
                  summary: Access denied
                  description: AccessDenied
                  value:
                    correlationId: 123e4567-e89b-12d3-a456-426614174000
                    success: false
                    message: User not authorized to perform this action
                    statusCode: 403
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              examples:
                UnexpectedError:
                  summary: Unexpected server error
                  description: UnexpectedError
                  value:
                    correlationId: 123e4567-e89b-12d3-a456-426614174000
                    success: false
                    message: An unexpected error occurred
                    responseCode: 500
security:
  - Auth0: []
components:
  schemas:
    ServiceRequestFormDownloadResponse:
      type: object
      properties:
        fileExtension:
          type: string
          description: File extension of the document
          example: pdf
        formName:
          type: string
          description: Name of the document
          example: NB Application
        binaryData:
          type: string
          description: Binary data of the document
          example: wdvb2ekllkk189w0enjansle..
        correlationId:
          type: string
          description: Unique ID for correlating requests
          example: 123e4567-e89b-12d3-a456-426614174000
    ErrorResponse:
      type: object
      properties:
        correlationId:
          type: string
          description: Unique ID for correlating requests
          example: 123e4567-e89b-12d3-a456-426614174000
        message:
          type: string
          description: Response message
          example: No document types found/Invalid request/Access denied for document
            metadata fetch
        statusCode:
          type: integer
          description: status code
          format: int32
        success:
          type: boolean
        errorCode:
          type: string
          description: Machine-readable error code, present on timeouts and unhandled
            errors.
          enum:
            - GATEWAY_TIMEOUT
            - DB_TIMEOUT
            - INTERNAL_ERROR
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://api.zinnia.io
          client_id:
            - bGOIRPRq2ZnjCujDXC7ikwR5ez7VH5GZ
          auth_methods:
            - bearer
          scopes: []
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```