Evervault API
The Evervault API API from Evervault — 0 operation(s) for evervault api.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/evervault-evervault-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Evervault API
version: 0.0.1
description: The Evervault API allows developers to interact programmatically with their Evervault apps using HTTP requests.
contact:
email: support@evervault.com
name: Evervault Support Team
url: https://evervault.com
servers:
- url: https://api.evervault.com
description: The Evervault API server
tags:
- name: Evervault API
paths: {}
webhooks:
functionRunCompleted:
post:
operationId: functionRunCompleted
summary: function.run.completed
description: This event is triggered when a function run is completed.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- function.run.completed
description: The type of webhook event.
data:
$ref: '#/components/schemas/FunctionRun'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: function.run.completed
data:
id: function_run_0aa6ff0fee57
status: success
result:
foo: bar
error: null
createdAt: 1692972623233
tags:
- Evervault API
functionDeploymentStarted:
post:
operationId: functionDeploymentStarted
summary: function.deployment.started
description: This event is triggered when a function deployment is started.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- function.deployment.started
description: The type of webhook event.
data:
$ref: '#/components/schemas/FunctionDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: function.deployment.started
data:
function:
id: func_0aa6ff0fee57
name: my-function
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Starting function deployment
status: in-progress
dashboardUrl: https://dashboard.evervault.com/functions/func_0aa6ff0fee57
createdAt: 1692972623233
updatedAt: 1692972623233
tags:
- Evervault API
functionDeploymentUpdated:
post:
operationId: functionDeploymentUpdated
summary: function.deployment.updated
description: This event is triggered when a function deployment is updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- function.deployment.updated
description: The type of webhook event.
data:
$ref: '#/components/schemas/FunctionDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: function.deployment.updated
data:
function:
id: func_0aa6ff0fee57
name: my-function
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Provisioning function
status: in-progress
dashboardUrl: https://dashboard.evervault.com/functions/func_0aa6ff0fee57
createdAt: 1692972623233
updatedAt: 1692972623233
tags:
- Evervault API
functionDeploymentFinished:
post:
operationId: functionDeploymentFinished
summary: function.deployment.finished
description: This event is triggered when a function deployment is finished.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- function.deployment.finished
description: The type of webhook event.
data:
$ref: '#/components/schemas/FunctionDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: function.deployment.finished
data:
function:
id: func_0aa6ff0fee57
name: my-function
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Function deployment completed
status: success
dashboardUrl: https://dashboard.evervault.com/functions/func_0aa6ff0fee57
createdAt: 1692972623233
updatedAt: 1692972623233
tags:
- Evervault API
merchantUpdated:
post:
operationId: merchantUpdated
summary: payments.merchant.updated
description: Occurs when a merchant is updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- payments.merchant.updated
description: The type of webhook event.
data:
$ref: '#/components/schemas/Merchant'
examples:
updatedMerchant:
value:
id: webhook_event_0aa6ff0fee57
type: payments.merchant.updated
data:
id: merchant_eead1d640d7c
name: Ollivanders Wand Shop
website: https://www.ollivanders.co.uk
categoryCode: '5945'
business:
legalName: Ollivanders Wand Shop Ltd.
address:
line1: Diagon Alley
city: London
postalCode: WD1 1AA
country: gb
networkTokens:
enrolment:
- cardBrand: mastercard
tokenRequestorIdentifier: '50165156978'
status: active
- cardBrand: visa
tokenRequestorIdentifier: '40238123804'
status: active
- cardBrand: american-express
tokenRequestorIdentifier: null
status: inactive
applePay:
domains:
- domain: ollivanders.co.uk
status: pending
createdAt: 1692972623233
updatedAt: 1692972623768
tags:
- Evervault API
networkTokenUpdated:
post:
operationId: networkTokenUpdated
summary: payments.network-token.updated
description: Occurs when a Network Token is updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- payments.network-token.updated
description: The type of webhook event.
data:
$ref: '#/components/schemas/NetworkToken'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: payments.network-token.updated
data:
id: network_token_eead1d640d7c
number: '4242424242424242'
expiry:
month: '12'
year: '27'
card:
lastFour: '4242'
expiry:
month: '12'
year: '29'
brand: visa
paymentAccountReference: '71288989897319237219'
tokenRequestorIdentifier: '40020248564'
tokenServiceProvider: vts
merchant: merchant_a1ef231b7947
status: active
createdAt: 1709293284000
updatedAt: 1711633194688
tags:
- Evervault API
cardUpdated:
post:
operationId: cardUpdated
summary: payments.card.updated
description: Occurs when a Card is updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- payments.card.updated
description: The type of webhook event.
data:
$ref: '#/components/schemas/Card'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: payments.card.updated
data:
id: card_eead1d640d7c
number: ev:debug:Tk9D:number:nTepvAI585M7lUVp...
bin: '424242'
lastFour: '4242'
expiry:
month: '12'
year: '29'
brand: visa
segment: consumer
issuer: Gringotts Wizarding Bank and Trust Company
country: gb
currency: gbp
funding: debit
status: active
automaticUpdates: enabled
createdAt: 1709293284000
updatedAt: 1711633194688
tags:
- Evervault API
threeDSSessionSuccess:
post:
operationId: threeDSSessionSuccess
summary: payments.3ds-session.success
description: Triggered when a 3DS session is successfully authenticated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- payments.3ds-session.success
description: The type of webhook event.
data:
$ref: '#/components/schemas/ThreeDSSession'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: payments.3ds-session.success
data:
id: tds_57aa862f8bf7
merchant:
name: Ollivanders Wand Shop
website: https://www.ollivanders.co.uk
categoryCode: '5945'
country: gb
card:
lastFour: '4242'
expiry:
month: 09
year: '26'
brand: visa
funding: debit
segment: consumer
country: gb
currency: gbp
initiator:
type: customer
challenge:
preference: no-preference
reason: null
acquirer:
bin: '567834'
merchantIdentifier: '530249576123943'
country: gb
payment:
type: one-off
amount: 1000
currency: eur
accessControlServer:
transactionIdentifier: d351441b-f9e6-46e3-a726-9fc4f39bbaaa
referenceNumber: 3DS_LOA_ACS_STIN_020200_00417
directoryServer:
transactionIdentifier: 18030e14-fafa-462e-bfc0-da733196e808
referenceNumber: 3DS_LOA_DIS_VISA_020200_00828
network: visa
threeDSServer:
transactionIdentifier: a623edc1-54bc-455d-9dea-c909783a37c3
version: 2.2.0
status: success
authentication:
flow: frictionless
cryptogram: MTIzNDU2Nzg5MDA5ODc2NTQzMjE=
eci:
value: '05'
descriptor: fully-authenticated
liabilityShift: true
ares:
transStatus:
value: Y
detail: Authentication/Account Verification Successful
transStatusReason: null
cres: null
createdAt: 1692972623233
updatedAt: 1692972623768
tags:
- Evervault API
threeDSSessionFailure:
post:
operationId: threeDSSessionFailure
summary: payments.3ds-session.failure
description: Triggered when a 3DS session fails authentication.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- payments.3ds-session.failure
description: The type of webhook event.
data:
$ref: '#/components/schemas/ThreeDSSession'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: payments.3ds-session.failure
data:
id: tds_57aa862f8bf7
merchant:
name: Ollivanders Wand Shop
website: https://www.ollivanders.co.uk
categoryCode: '5945'
country: gb
card:
lastFour: '4242'
expiry:
month: 09
year: '26'
brand: visa
funding: debit
segment: consumer
country: gb
currency: gbp
initiator:
type: customer
challenge:
preference: no-preference
reason: null
acquirer:
bin: '567834'
merchantIdentifier: '530249576123943'
country: gb
payment:
type: one-off
amount: 1000
currency: eur
accessControlServer:
transactionIdentifier: d351441b-f9e6-46e3-a726-9fc4f39bbaaa
referenceNumber: 3DS_LOA_ACS_STIN_020200_00417
directoryServer:
transactionIdentifier: 18030e14-fafa-462e-bfc0-da733196e808
referenceNumber: 3DS_LOA_DIS_VISA_020200_00828
network: visa
threeDSServer:
transactionIdentifier: a623edc1-54bc-455d-9dea-c909783a37c3
version: 2.2.0
status: failure
ares:
transStatus:
value: Y
detail: Authentication/Account Verification Successful
transStatusReason: null
cardholderInfo: We're sorry, your purchase requires additional verification. Please call the number on the back of your card for assistance.
cres: null
createdAt: 1692972623233
updatedAt: 1692972623768
tags:
- Evervault API
enclaveDeploymentStarted:
post:
operationId: enclaveDeploymentStarted
summary: enclave.deployment.started
description: This event is triggered when a enclave deployment is started.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- enclave.deployment.started
description: The type of webhook event.
data:
$ref: '#/components/schemas/EnclaveDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: enclave.deployment.started
data:
id: enclave_deployment_0aa6ff0fee57
enclave:
id: enclave_0aa6ff0fee57
name: My Enclave
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Deployment started. Building image on Evervault infrastructure
status: in-progress
stage: image.building
dashboardUrl: https://app.evervault.com/[TEAM_UUID]/[APP_UUID]/enclaves/[ENCLAVE_UUID]/versions
versionMetadata:
version: 1
controlPlaneVersion: 1.0.9
dataPlaneVersion: 1.0.9
debugMode: false
pcrs:
pcr0: cfd273de62d2646cafb8bb20dbdc273123590d7b44878d94acaa3bd60d519919939c6052390869a5ac308a626ff3dd15
pcr1: 0343b056cd8485ca7890ddd833476d78460aed2aa161548e4e26bedf321726696257d623e8805f3f605946b3d8b0c6aa
pcr2: 8cb4c46e9f502de67494ffd582d65ca088bfc0c90b44582de793eb9903002be6959d2860698da0097c95ac564d980a41
pcr8: f1a721d53b6e9aa936eab11b8d57a0bd3f2863526f75e4d74220ddb921933d59e298fb22179c3595ec867f3389119ffe
createdAt: '2024-07-04T13:33:24.940Z'
updatedAt: '2024-07-04T13:33:24.940Z'
startedAt: '2024-07-04T13:33:24.939Z'
tags:
- Evervault API
enclaveDeploymentUpdated:
post:
operationId: enclaveDeploymentUpdated
summary: enclave.deployment.updated
description: This event is triggered when a enclave deployment is updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- enclave.deployment.updated
description: The type of webhook event.
data:
$ref: '#/components/schemas/EnclaveDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: enclave.deployment.updated
data:
id: enclave_deployment_0aa6ff0fee57
enclave:
id: enclave_0aa6ff0fee57
name: My Enclave
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Deployment started. Building image on Evervault infrastructure
status: in-progress
stage: image.building
dashboardUrl: https://app.evervault.com/[TEAM_UUID]/[APP_UUID]/enclaves/[ENCLAVE_UUID]/versions
versionMetadata:
version: 1
controlPlaneVersion: 1.0.9
dataPlaneVersion: 1.0.9
debugMode: false
pcrs:
pcr0: cfd273de62d2646cafb8bb20dbdc273123590d7b44878d94acaa3bd60d519919939c6052390869a5ac308a626ff3dd15
pcr1: 0343b056cd8485ca7890ddd833476d78460aed2aa161548e4e26bedf321726696257d623e8805f3f605946b3d8b0c6aa
pcr2: 8cb4c46e9f502de67494ffd582d65ca088bfc0c90b44582de793eb9903002be6959d2860698da0097c95ac564d980a41
pcr8: f1a721d53b6e9aa936eab11b8d57a0bd3f2863526f75e4d74220ddb921933d59e298fb22179c3595ec867f3389119ffe
createdAt: '2024-07-04T13:33:24.940Z'
updatedAt: '2024-07-04T13:33:24.940Z'
startedAt: '2024-07-04T13:33:24.939Z'
tags:
- Evervault API
enclaveDeploymentFinished:
post:
operationId: enclaveDeploymentFinished
summary: enclave.deployment.finished
description: This event is triggered when a enclave deployment is finished.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- enclave.deployment.finished
description: The type of webhook event.
data:
$ref: '#/components/schemas/EnclaveDeployment'
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: enclave.deployment.finished
data:
id: enclave_deployment_0aa6ff0fee57
enclave:
id: enclave_0aa6ff0fee57
name: My Enclave
app:
id: app_0aa6ff0fee57
name: Production
team:
id: team_0aa6ff0fee57
name: My Team
message: Deployment finished.
status: success
stage: image.built
dashboardUrl: https://app.evervault.com/[TEAM_UUID]/[APP_UUID]/enclaves/[ENCLAVE_UUID]/versions
versionMetadata:
version: 1
controlPlaneVersion: 1.0.9
dataPlaneVersion: 1.0.9
debugMode: false
pcrs:
pcr0: cfd273de62d2646cafb8bb20dbdc273123590d7b44878d94acaa3bd60d519919939c6052390869a5ac308a626ff3dd15
pcr1: 0343b056cd8485ca7890ddd833476d78460aed2aa161548e4e26bedf321726696257d623e8805f3f605946b3d8b0c6aa
pcr2: 8cb4c46e9f502de67494ffd582d65ca088bfc0c90b44582de793eb9903002be6959d2860698da0097c95ac564d980a41
pcr8: f1a721d53b6e9aa936eab11b8d57a0bd3f2863526f75e4d74220ddb921933d59e298fb22179c3595ec867f3389119ffe
createdAt: '2024-07-04T13:33:24.940Z'
updatedAt: '2024-07-04T13:33:24.940Z'
startedAt: '2024-07-04T13:33:24.939Z'
tags:
- Evervault API
auditLogEvent:
post:
operationId: auditLogEvent
summary: audit-log.event
description: Triggered when something is changed inside your team or app.
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the webhook event.
type:
type: string
enum:
- audit-log.event
description: The type of webhook event.
data:
type: object
properties:
id:
type: string
description: The id of the audit log event.
evervault:
type: object
properties:
resource:
type: object
properties:
type:
type: string
description: The type of the resource.
uuid:
type: string
description: The uuid of the resource.
team:
type: object
properties:
uuid:
type: string
description: The uuid of the team.
app:
type: object
properties:
uuid:
type: string
description: The uuid of the app.
user:
type: object
properties:
id:
type:
- string
- 'null'
description: The email of the user.
apiKey:
type:
- 'null'
- object
properties:
uuid:
type: string
description: The uidid of the api key.
action:
type: object
properties:
type:
type: string
description: The type of the action.
action:
type: string
description: The action that was performed.
details:
type: object
description: Metadata associated with the action.
additionalProperties: true
client:
type: object
properties:
ip:
type: string
description: The ip address of the client.
'@timestamp':
type: integer
description: The timestamp of the event in milliseconds.
examples:
success:
value:
id: webhook_event_0aa6ff0fee57
type: audit-log.event
data:
id: event_0aa6ff0fee57
evervault:
resource:
type: api_key
uuid: api_key_0aa6ff0fee57
team:
uuid: team_0aa6ff0fee57
app:
uuid: app_0aa6ff0fee57
user:
id: example@team.com
apiKey: null
action:
type: scoped_api_key
action: CreateScopedApiKey
details:
appUuid: app_0aa6ff0fee57
teamUuid: team_0aa6ff0fee57
resourceUuid: api_key_0aa6ff0fee57
grants: []
client:
ip: 82.124.39.23
'@timestamp': 1692972623233
tags:
- Evervault API
components:
schemas:
ThreeDSInitiator:
type: object
description: Details about the transaction initiation process.
oneOf:
- type: object
summary: Customer-Initiated Transaction (CIT)
properties:
type:
type: string
enum:
- customer
description: The value `customer`.
- type: object
summary: Merchant-Initiated Transaction (MIT)
properties:
type:
type: string
enum:
- merchant
description: The value `merchant`.
reason:
type: string
enum:
- recurring
- installment
- mail-order
- telephone-order
- add-card
- maintain-card
- other-payment
- account-verification
- split-shipment
- delayed-shipment
description: The reason for the transaction to be initiated by the merchant. This field is mandatory when the `type` is `merchant`.
initialSession:
type: string
description: 'The ID of the initial session. This can either be an Evervault 3DS Session ID or a `threeDSServer.transactionIdentifier`. This field should be provided if the merchant has previously authenticated the cardholder using 3DS.
The API does not currently enforce this requirement, but it is recommended to always provide this field. In some cases Authentications will error if this field is not populated.
'
Acquirer:
type: object
description: The acquirer of the payment.
properties:
bin:
type: string
pattern: ^[0-9]{6,11}$
minLength: 6
maxLength: 11
description: The Bank Identification Number (BIN) of the acquirer. Must be 6 to 11 digits.
example: '42424242'
merchantIdentifier:
type: string
description: The merchant identifier assigned by the acquirer.
example: '5945'
country:
type: string
description: The country code of the acquirer
format: iso-3166-1-alpha-2
example: ie
required:
- bin
- merchantIdentifier
- country
Card:
x-section: Payments
x-group: Cards
type: object
summary: The Card Object
properties:
id:
type: string
description: The unique identifier for the card.
example: card_eead1d640d7c
number:
type: string
description: The Evervault encrypted card number. This can be decrypted using Relay dec
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/evervault/refs/heads/main/openapi/evervault-evervault-api-api-openapi.yml