PCI Vault Logo
SFTP

These endpoints allow for interacting with bulk data sent through SFTP. Please e-mail [email protected] to have an SFTP account set up.

Once the SFTP account has been set up, these endpoints can be used to tokenize the data in the files.

GET /sftp/files List Files
PCI DSS Scope: SAQ-A/D

List all the files in your SFTP folder.

GET
https://api.pcivault.io/v1/sftp/files
# No Body
Response Code: 200 (example)
POST /sftp/store Parse And Store File Data
PCI DSS Scope: SAQ-A/D

Read a PGP encrypted CSV file, and store the items in the vault.

(query)

The identifier for the key used to originally encrypt the data.

(query)

The passphrase for the key used to originally encrypt the data.

(query)

A reference to assist with lookups in the vault. This reference will be applied to all parsed items.

(query)

Setting this to true will include all fields in the stored data, even the ones that are not on the field map in the body.

(query)

The tokenization algorithm to use. See the tokenization guide for more information.

(query)

A comma seperated list of rule ids to apply to the data after being mapped. The rules will be applied before it is stored.

(body)

The path of the file to parse. This must be the same as the path returned by the List Files endpoint.

A map of fields. The keys in this map is the fields as they are in the CSV file, the values are the fields as they must be in the stored JSON.

(body)

A webhook to send the capture result to.

(body -> webhook)

The URL for the webhook. This must be an https URL.

(body -> webhook)

A secret that will be returned in the webhook call's X-PCIVault-Webhook-Secret header.

(body -> webhook)

A value between 1 and 8 for the maximum amount of times the webhook should be called per token update. Calls to the webhook will stop on a 200 HTTP response, or when max_attempts are reached.

(body -> webhook)

Some metadata which will be merged into the webhook response. This is useful for uniquely identifying webhook responses to requests.

POST
https://api.pcivault.io/v1/sftp/store
Response Code: 200 (example)