Skip to main content
POST
Transfer Document to FTP

Authorizations

Authorization
string
header
required

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

Headers

X-FTP-Password
string
required

FTP password.

X-FTP-Private-Key
string

Private key content for key-based authentication.

Path Parameters

id
string
required

The pingid of the submission.

Body

ftp
object
required
remote_path
string
required

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
string

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
string

Name of the document in the submission to transfer (e.g., 'document.pdf'). Cannot be used together with file_uri.

Response

message
string
required
filename
string