toc

API reference

A full reference of the Evervault API.

Authentication

The Evervault API is authenticated using an API key. You can find your key in the Settings page for your team. Each key is scoped per team.

To authenticate requests, append an API-Key header to your request with the value set to the API key copied from the previous step.

Run a Cage

Run a Cage by POSTing a payload to run.evervault.com. Server-side, the API-Key header must be included as explained above. Client-side, a run token can be used instead.

  • Server-side
  • Client-side
http
POST https://run.evervault.com/:cageName
API-Key: <YOUR_API_KEY>
Content-Type: application/json
{
  "ssn": "ev:debug:UJJn8/4KRA8f+G47:A1Sq3fd2OBst4zsZNBbZex9XSEItenNkt99M1EBVehgy:BNOnINL4WcCLr5b70CRbAs0VrH6K4wO6Tw==:$",
  "creditCard": {
    "number": "ev:debug:fHs4yviecz4ui23O:A3MRMElymESwgydJE5z3B7cPUyC0K6TT5THYkylAEb0E:9TTGYz0CDTwqfBXrEGNw0dLCBLuh29wlQ0P+tyBlbkNYGSY=:$",
    "cvv": "ev:debug:ZA7b52W/h0PVBbhx:A1Sq3fd2OBst4zsZNBbZex9XSEItenNkt99M1EBVehgy:yMTM47CmzqefKVedyokvKfPXZA==:$",
    "expiry": "ev:debug:OZxh1MEomn+X7M0X:A3MRMElymESwgydJE5z3B7cPUyC0K6TT5THYkylAEb0E:m8e0b4AUiadzmOuvUcmXBJZH7qLr:$"
  }
}

Here’s how to run a Cage with cURL:

  • Server-side
  • Client-side
bash
curl --request POST \
     --url https://run.evervault.com/:cageName \
     --header 'API-Key: <YOUR_API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '{
       "ssn": "ev:debug:UJJn8/4KRA8f+G47:A1Sq3fd2OBst4zsZNBbZex9XSEItenNkt99M1EBVehgy:BNOnINL4WcCLr5b70CRbAs0VrH6K4wO6Tw==:$",
       "creditCard": {
         "number": "ev:debug:fHs4yviecz4ui23O:A3MRMElymESwgydJE5z3B7cPUyC0K6TT5THYkylAEb0E:9TTGYz0CDTwqfBXrEGNw0dLCBLuh29wlQ0P+tyBlbkNYGSY=:$",
         "cvv": "ev:debug:ZA7b52W/h0PVBbhx:A1Sq3fd2OBst4zsZNBbZex9XSEItenNkt99M1EBVehgy:yMTM47CmzqefKVedyokvKfPXZA==:$",
         "expiry": "ev:debug:OZxh1MEomn+X7M0X:A3MRMElymESwgydJE5z3B7cPUyC0K6TT5THYkylAEb0E:m8e0b4AUiadzmOuvUcmXBJZH7qLr:$"
       }
     }'
warningThis command will not encrypt your data before sending it to the Cage.

List Cages

List all the Cages for a team by sending a GET request:

http
GET https://api.evervault.com/cages
API-Key: <YOUR_API_KEY>

Here’s how to run with cURL:

bash
curl --request GET \
     --url https://api.evervault.com/cages \
     --header 'API-Key: <YOUR_API_KEY>'
Was this page useful?