> ## 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.

# Get Transfer Status

> Poll the status of an asynchronously queued SFTP transfer, in either direction. Accepts the task_id returned by both the transfer-to-ftp and transfer-from-ftp endpoints.



## OpenAPI

````yaml https://vision.dev.pingintel.com/api/schema/?format=json get /api/v1/submission/{id}/transfer-status/{task_id}
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-status/{task_id}:
    get:
      tags:
        - Update Submission
      summary: Get Transfer Status
      description: >-
        Poll the status of an asynchronously queued SFTP transfer, in either
        direction. Accepts the task_id returned by both the transfer-to-ftp and
        transfer-from-ftp endpoints.
      operationId: api_v1_submission_transfer_status_retrieve
      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: path
          name: task_id
          schema:
            type: string
          description: Celery task id returned by either transfer endpoint.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferStatus'
          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:
    TransferStatus:
      type: object
      description: >-
        Status of any async SFTP transfer, in either direction.


        Which of the optional fields are present depends on the direction of the
        transfer the

        ``task_id`` belongs to, and they only appear once the transfer has
        succeeded: ``filename``

        for a transfer to FTP, ``submission_id`` and ``document`` for a transfer
        from FTP.
      properties:
        message:
          type: string
        status:
          type: string
        task_id:
          type: string
        document:
          type: string
        filename:
          type: string
        submission_id:
          type: string
      required:
        - message
        - status
        - task_id
    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
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````