Skip to main content
GET
Get Transfer Status

Authorizations

Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Path Parameters

id
string
required

The pingid of the submission.

task_id
string
required

Celery task id returned by either transfer endpoint.

Response

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.

message
string
required
status
string
required
task_id
string
required
document
string
filename
string
submission_id
string