Skip to main content
POST
/
api
/
v1
/
submission
/
{id}
/
transfer-from-ftp
Transfer Document from FTP to Submission
curl --request POST \
  --url https://vision.pingintel.com/api/v1/submission/{id}/transfer-from-ftp \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-FTP-Password: <x-ftp-password>' \
  --data '
{
  "ftp": {
    "host": "<string>",
    "username": "<string>",
    "port": 22
  },
  "remote_path": "<string>"
}
'
{
  "message": "<string>",
  "document": "<string>",
  "submission_id": "<string>"
}

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

Remote path to the target file relative to the remote root directory of the FTP server including the filename.

Response

​
message
string
required
​
document
string
​
submission_id
string