Skip to main content
POST
/
v1
/
spv-requests
Create an SPV request
curl --request POST \
  --url https://api.example.com/v1/spv-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "templateId": "syndicate_secondary",
  "templateVersion": "1.0.0",
  "attributes": {
    "underlyingCompanySlug": "co_acme",
    "shareClasses": [
      {
        "name": "Class A",
        "managementFeePercent": "2.0",
        "carryPercent": "20.0"
      }
    ],
    "currency": "USD"
  }
}
'
{
  "spvRequestSlug": "<string>",
  "status": "pending-review",
  "templateId": "<string>",
  "templateVersion": "<string>",
  "tenantSlug": "<string>",
  "clientId": "<string>",
  "attributes": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "rejectionReason": "<string>",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "approvedAt": "2023-11-07T05:31:56Z",
  "materialisedRefs": {
    "opportunitySlug": "<string>",
    "vehicleSlug": "<string>",
    "spSlug": "<string>",
    "spcSlug": "<string>"
  },
  "feesAndCarry": {
    "shareClasses": [
      {
        "name": "<string>",
        "slug": "<string>",
        "managementFeePercent": "<string>",
        "carryPercent": "<string>",
        "setupFee": {}
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zestequity.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Body

application/json
templateId
string
required

Contract template id (e.g. 'syndicate_secondary').

Example:

"syndicate_secondary"

templateVersion
string
required

Contract template version (e.g. '1.0.0').

Example:

"1.0.0"

attributes
Attributes · object
required

Flat attribute map validated against the template.

Example:
{
"underlyingCompanySlug": "co_acme",
"shareClasses": [
{
"name": "Class A",
"managementFeePercent": "2.0",
"carryPercent": "20.0"
}
],
"currency": "USD"
}

Response

Successful Response

spvRequestSlug
string
required
status
enum<string>
required

An enumeration.

Available options:
pending-review,
approved,
rejected,
cancelled
templateId
string
required
templateVersion
string
required
tenantSlug
string
required
clientId
string
required
attributes
Attributes · object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
rejectionReason
string
cancelledAt
string<date-time>
approvedAt
string<date-time>
materialisedRefs
MaterialisedRefsResponse · object
feesAndCarry
FeesAndCarryResponse · object