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

# Transfer Document to FTP



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json post /api/v1/submission/{id}/transfer-to-ftp
openapi: 3.0.3
info:
  title: Ping.Vision API
  version: v1.0
  description: >
    ### Ping.Vision API


    This API provides convenient, efficient access to Ping Intel's data and
    services. It is designed to be used by developers and data scientists to
    integrate Ping Intel's capabilities into their applications.


    Once SSO is set up with your organization, you can create an Organization or
    Personal API key at https://auth.pingintel.com/org.


    Please see the Python client library
    [pingintel-api](https://pypi.org/project/pingintel-api/) for commandline
    tools and programmatic access, and you

    can refer to the following documentation for details on interacting with the
    system via the HTTP API.
  contact:
    email: support@pingintel.com
    name: Ping Intel
    url: https://www.pingintel.com
servers:
  - url: https://vision.pingintel.com
    description: Ping.Vision API
  - url: https://vision.staging.pingintel.com
    description: Ping.Vision API (staging)
security: []
tags:
  - name: Create Submission
    description: The Create Submission API allows you to add new data into the system.
  - name: Update Submission
    description: >-
      The Update Submission API provides various endpoints to update, modify, or
      act upon existing submissions.
  - name: Get Submission Data
    description: ''
  - name: User Memberships
    description: >-
      The User Memberships API allows you to add, remove, and change the role of
      users in different teams, divisions, or companies.
  - name: Miscellaneous
    description: ''
paths:
  /api/v1/submission/{id}/transfer-to-ftp:
    post:
      tags:
        - Update Submission
      summary: Transfer Document to FTP
      operationId: api_v1_submission_transfer_to_ftp_create
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: The pingid of the submission.
          required: true
          examples:
            Example:
              value: p-lo-ping-abc123
              description: Example ping ID.
        - in: header
          name: X-FTP-Password
          schema:
            type: string
          description: FTP password.
          required: true
        - in: header
          name: X-FTP-Private-Key
          schema:
            type: string
          description: Private key content for key-based authentication.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferDocumentToFTP'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TransferDocumentToFTP'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TransferDocumentToFTP'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferDocumentToFTPResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferToFTPErrResponse'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse403'
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    TransferDocumentToFTP:
      type: object
      properties:
        ftp:
          $ref: '#/components/schemas/FTPConnection'
        remote_path:
          type: string
          description: >-
            Desired remote FTP path that Ping will write the document to. Should
            include the destination filename. If filename and file_uri are not
            included then the destination filename in this path must match the
            requested SubmissionDocument filename.
        file_uri:
          type: string
          description: >-
            Full download URI of the document (e.g.,
            '/api/v1/submission/{pingid}/document/document.pdf' or
            'https://domain.com/api/v1/submission/{pingid}/document/document.pdf').
            Cannot be used together with filename.
        filename:
          type: string
          description: >-
            Name of the document in the submission to transfer (e.g.,
            'document.pdf'). Cannot be used together with file_uri.
      required:
        - ftp
        - remote_path
    TransferDocumentToFTPResponse:
      type: object
      properties:
        message:
          type: string
        filename:
          type: string
      required:
        - message
    TransferToFTPErrResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    ErrorResponse401:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Request ID
        message:
          type: string
          description: Authorization error message.
      required:
        - id
        - message
    ErrorResponse403:
      type: object
      properties:
        detail:
          type: string
          description: Error message.
      required:
        - detail
    FTPConnection:
      type: object
      properties:
        host:
          type: string
          description: SFTP server hostname or IP address.
        username:
          type: string
          description: SFTP username.
        port:
          type: integer
          default: 22
      required:
        - host
        - username
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````