Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-08232554.8 KB
SPV Requests

Create an SPV request

Submits an SPV creation request. Validation runs against the spaas-contract template indicated by templateId. On success, Zest fires spv_request.created. Admin review materialises the SPV; success fires spv_request.completed.

post/v1/spv-requests

Headers

Idempotency-Keystring

Request body

templateIdstring required

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

templateVersionstring required

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

attributesobject required

Flat attribute map validated against the template.

Example request

{
  "templateId": "syndicate_secondary",
  "templateVersion": "1.0.0",
  "attributes": {
    "underlyingCompanySlug": "co_acme",
    "shareClasses": [
      {
        "name": "Class A",
        "managementFeePercent": "2.0",
        "carryPercent": "20.0"
      }
    ],
    "currency": "USD"
  }
}

Response

Successful Response

spvRequestSlugstring required
status'pending-review' | 'approved' | 'rejected' | 'cancelled' required

An enumeration.

templateIdstring required
templateVersionstring required
tenantSlugstring required
clientIdstring required
attributesobject required
rejectionReasonstring
cancelledAtstring date-time
approvedAtstring date-time
createdAtstring date-time required
updatedAtstring date-time required