Zest Equity Subscription Forms API
Upload signed subscription forms (PDF or image) for partner-managed subscriptions. Files are streamed to private storage and referenced on the Bid.
Upload signed subscription forms (PDF or image) for partner-managed subscriptions. Files are streamed to private storage and referenced on the Bid.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/zest-equity:zest-equity-subscription-forms-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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: 3.2.0
info:
title: Zest equity public Subscription Forms API
version: 0.1.0
description: Upload signed subscription forms (PDF or image) for partner-managed subscriptions. Files are streamed to private storage and referenced on the Bid.
servers:
- url: https://sandbox-api.zestequity.com
description: Staging
tags:
- name: Subscription Forms
description: Upload signed subscription forms (PDF or image) for partner-managed subscriptions. Files are streamed to private storage and referenced on the Bid.
paths:
/v1/spvs/{spv_slug}/subscription/{person_id}/forms:
post:
tags:
- Subscription Forms
summary: Upload signed subscription form
description: 'Uploads a signed subscription form for a partner-managed subscription. Multipart/form-data with a single `file` field. Max 10 MB. Allowed content types: PDF, JPEG, PNG, WEBP. Emits `signed_subscription_form.uploaded` webhook on success.'
operationId: uploadSubscriptionForm
parameters:
- required: true
schema:
type: string
title: Spv Slug
name: spv_slug
in: path
- required: true
schema:
type: string
title: Person Id
name: person_id
in: path
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_uploadSubscriptionForm'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormUploadResponse'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'401':
description: Invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'403':
description: Service not provisioned for partner API
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'404':
description: SPV or person not found
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'409':
description: Bid is in a terminal status
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'413':
description: File too large (>10 MB)
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'415':
description: Unsupported media type
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerErrorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
FormUploadResponse:
properties:
subscriptionSlug:
type: string
title: Subscriptionslug
spvSlug:
type: string
title: Spvslug
personId:
type: string
title: Personid
subscriptionFormUrl:
type: string
title: Subscriptionformurl
uploadedAt:
type: string
format: date-time
title: Uploadedat
type: object
required:
- subscriptionSlug
- spvSlug
- personId
- subscriptionFormUrl
- uploadedAt
title: FormUploadResponse
PartnerErrorResponse:
properties:
detail:
type: string
title: Detail
default: 'ex: Something went wrong'
examples:
- Something went wrong
errorId:
type: string
title: Errorid
code:
type: string
title: Code
description: Stable top-level error code (see PartnerErrorCode enum).
validationErrors:
items:
$ref: '#/components/schemas/PartnerValidationError'
type: array
title: Validationerrors
description: Populated only when code='validation_error'.
type: object
required:
- code
title: PartnerErrorResponse
Body_uploadSubscriptionForm:
properties:
file:
type: string
format: binary
title: File
type: object
required:
- file
title: Body_uploadSubscriptionForm
PartnerValidationError:
properties:
attribute:
type: string
title: Attribute
description: Attribute path (e.g. 'deal_name', 'share_class.name').
code:
type: string
title: Code
description: Stable validation error code (see ValidationErrorCode enum).
message:
type: string
title: Message
description: Human-readable message.
type: object
required:
- attribute
- code
- message
title: PartnerValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-provenance:
method: harvested
publisher: Zest Equity
source: https://docs.zestequity.com/api-reference/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)