PCI Vault Logo
Capture

PCI Vault lets you capture data without having the data touch your own server at all.

To do this without compromising your passphrase or your authorization details, you can create a shareable unique endpoint. This endpoint can only be used for storing data in the vault, nothing else.

POST /capture/ Create a Capturing Endpoint

Create a temporary endpoint that you can share with others without compromising your passphrase. This endpoint will capture data that can later be decrypted with the same key that was used to create the endpoint.

We have a PCD web form that is ready made to use this endpoint, you can get instructions here on how to use the Capture PCD form.

This endpoint can also auto-generate the form html for you. To do this, set the Accept header in your request to text/html. The generated form html will work out of the box and can be injected directly into your HTML.

Important: We store an encrypted version of the provided key in our database. This endpoint generates a secret necessary to decrypt the key and securely store the captured data. Anybody with the secret can use the generated endpoint to post data on your behalf. We do not store this secret. We recommend that you delete the endpoint after use.

(query)

The identifier for the key that will be used to encrypt submitted data.

(query)

The passphrase for the key that will be used to encrypt submitted data.

(query)

A unique name for the endpoint. The uniqueness is enforced across the entire vault, you can't use a unique id that is currently being used by someone else.

(query)

The duration for which the endpoint will be active. This can be specified in the form of 24h60m60s for specifying hours, minutes, and seconds. The default is 24h(24 hours). To make the endpoint permanent, use 0s(0 seconds).

(query)

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

(query)

PCI Vault can try to parse credit card numbers, cvv numbers, and expiry dates in a smart way. To enable smart parsing for data sent to this endpoint, set this flag to true. If the parsing was successful, the parsed item will contain a JSON object with the parsed data, otherwise the request will be rejected with error 400.

(header)

Set the Accept header text/html to receive the endpoint data in ready-made HTML code.

POST
https://api.pcivault.io/v1/capture/
Accept
application/json
# No Body
Response Code: 200 (example)
GET /capture/ List Capture Endpoints

List available capture endpoints, this list may include expired endpoints. Expired endpoints can't be used and will be deleted.

(query)

Optional key identifier for filtering endpoints.

GET
https://api.pcivault.io/v1/capture/
# No Body
Response Code: (example)
POST /capture/{unique_id} Use a Capturing Endpoint to Capture Data

Encrypt, tokenize , and store data securely in the vault without having access to a key.

The data object is limited to 256KB per request. It does not need to comply with the example value, but it must be a valid JSON object.

Please specify a number in the data with one of these keys: card_number, account_number, n, or number. Alternatively, specify a number in the query string.

(path)

The unique id of the endpoint to use.

(query)

This number is used for generating a token. It is only required if not specified in the body, and will not be stored.

(query)

A reference to assist with lookups and grouping of data.

(header)

The unique id of the endpoint to use.

Any valid JSON object
POST
https://api.pcivault.io/v1/capture/{unique_id}
Response Code: 200 (example)
DELETE /capture/{unique_id} Delete a Capturing Endpoint

Delete a capturing endpoint. Please note that this endpoint can also be used to delete retrieval endpoints by specifying a unique id belonging to a retrieval endpoint.

(path)

The unique id of the endpoint to delete.

DELETE
https://api.pcivault.io/v1/capture/{unique_id}
# No Body
Response Code: 200 (example)