Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Evervault Core API

The Core API from Evervault — 9 operation(s) for core.

Evervault Core API is one of 12 APIs that Evervault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Core. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 9 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.evervault.com.

14 operations 9 paths 12 schemas 2 DELETE4 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.evervault.com
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Evervault Core API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (ApiKey). It accepts HTTP bearer tokens (RunToken) (TokenAuth). It accepts HTTP bearer tokens (Token) (ClientSideToken).

  • ApiKey — Authentication using an API key. The username is the App ID and the password is the Api Key.
  • TokenAuth — Authentication using a short lived run token that you can share with clients. The Authorization header must be formatted as follow: "RunToken "
  • ClientSideToken — Authentication using a short lived token that you can share with clients. The Authorization header must be formatted as follow: "Token "

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 2 DELETE, 4 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Core 14
POST
/encrypt
Encrypt
encrypt body → 200
POST
/decrypt
Decrypt
decrypt body → 200
POST
/inspect
Inspect
inspect body → 200
POST
/functions/{function_name}/runs
Run a Function
createFunctionRun 1 param body → 200202408409
POST
/client-side-tokens
Create a Client Token
create-client-side-token body → 201
POST
/relays
Create a Relay
createRelay body → 201
GET
/relays
List all Relays
listRelays → 200
GET
/relays/{id}
Retrieve a Relay
fetchRelay 1 param → 200
PATCH
/relays/{id}
Updates a Relay
updateRelay 1 param body → 200
DELETE
/relays/{id}
Delete a Relay
deleteRelay 1 param → 202
POST
/relays/{relay_id}/custom-domains
Create a Custom Domain
createCustomDomain 1 param body → 201
GET
/relays/{relay_id}/custom-domains
List all Custom Domains
fetchCustomDomainsForRelay 1 param → 200
GET
/relays/{relay_id}/custom-domains/{id}
Retrieve a Custom Domain
retrieveCustomDomain 2 params → 200
DELETE
/relays/{relay_id}/custom-domains/{id}
Delete a Custom Domain
deleteCustomDomain 2 params → 202

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Relay (9 properties), CardMetadata (8 properties), CustomDomain (7 properties), FunctionRun (5 properties). Each schema is shown below with its type and property counts.

CardBrand
string
The card brand associated with the payment card.
RelayRoute
object
4 properties 3 required
CardMetadata
object
Only present if category is card-number
8 properties 2 required
Relay
object
9 properties
ClientSideToken
object
4 properties
RelaySelection
object
3 properties 1 required
CardSegment
string
The card segment indicates the primary market or usage category of the card.
RelayAction
object
2 properties 2 required
Error
object
5 properties
FunctionRun
object
5 properties
CardFunding
string
The card funding type specifies the method by which transactions are financed.
CustomDomain
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

evervault-core-api-openapi.yml Raw ↑

Other APIs Evervault publishes across the network.

Evervault 3D Secure API
Evervault Acquirers API
Evervault Card Account Updates API
Evervault Client Tokens API
Evervault Functions API
Evervault Insights API
Evervault Merchants API
Evervault Network Tokens API
Evervault Payments API
Evervault Relays API
Evervault Webhooks API