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

Zest SPV Requests API

Submit SPV creation requests, inspect their lifecycle, and cancel pending ones. SPV requests are reviewed by Zest admins and produce SPV materialisation on approval.

Zest SPV Requests API is one of 8 APIs that Zest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SPV Requests. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://sandbox-api.zestequity.com.

4 operations 2 paths 11 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://public-api.zestequity.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zest SPV Requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 4

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

SPV Requests 4

Submit SPV creation requests, inspect their lifecycle, and cancel pending ones. SPV requests are reviewed by Zest admins and produce SPV materialisation on approval.

GET
/v1/spv-requests
List SPV requests
listSpvRequests 3 params → 200401422
POST
/v1/spv-requests
Create an SPV request
createSpvRequest 1 param body → 201400401403404409422
GET
/v1/spv-requests/{slug}
Get an SPV request
getSpvRequest 1 param → 200401404422
DELETE
/v1/spv-requests/{slug}
Cancel an SPV request
cancelSpvRequest 1 param → 200401404409422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SpvRequestResponse (14 properties), ShareClassFeesAndCarry (5 properties), PartnerErrorResponse (4 properties), MaterialisedRefsResponse (4 properties). Each schema is shown below with its type and property counts.

SpvRequestCreate
object
3 properties 3 required
PartnerValidationError
object
3 properties 3 required
ValidationError
object
3 properties 3 required
FeesAndCarryResponse
object
1 property
SpvRequestStatus
string
An enumeration.
HTTPValidationError
object
1 property
AggregationResponse
object
4 properties 1 required
MaterialisedRefsResponse
object
4 properties 4 required
ShareClassFeesAndCarry
object
5 properties 2 required
SpvRequestResponse
object
14 properties 9 required
PartnerErrorResponse
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zest-spv-requests-api-openapi.yml Raw ↑

Other APIs Zest publishes across the network.

Zest Authentication API
Zest Contracts API
Zest Investors API
Zest Subscription Forms API
Zest Subscription Fundings API
Zest Subscriptions API
Zest System API