How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zinnia Documents V3 API

The Documents V3 API from Zinnia — 4 operation(s) for documents v3.

Zinnia Documents V3 API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents V3. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against 4 base URLs: https://dev.api.zinnia.io, https://qa.api.zinnia.io, https://uat.api.zinnia.io, https://api.zinnia.io.

5 operations 4 paths 11 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://qa.api.zinnia.io
Authentication
HTTP Basic, OpenID Connect
Resource Areas
1

Authentication & Security 2

Zinnia Documents V3 API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OpenID Connect (Auth0) discovered at https://login.zinnia.com/.well-known/openid-configuration.

Paths & Operations 5

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

Documents V3 5
POST
/document/v3/documents
Uploads a document and saves its metadata
UploadDocuments 1 param body → 201400403
GET
/document/v3/documents/{documentId}
Gets metadata for a document
getMetadataByDocumentId 7 params → 200400403404500
PUT
/document/v3/documents/{documentId}
updates document content or metadata
updateDocuments 2 params body → 204400403
GET
/document/v3/documents/{documentId}/download
Retrieves a document by ID
downloadDocument-v3 7 params → 200403404500
POST
/document/v3/documents/search
Searches for documents
searchDocuments 4 params body → 200400403500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are MetadataResponse (36 properties), MetadataSearchResponse (24 properties), MetadataUpdate (14 properties), Metadata (14 properties). Each schema is shown below with its type and property counts.

MetadataResponse
object
36 properties
DocumentUploadResponse
object
5 properties
MetadataSearchResponse
object
24 properties
DocumentDownloadResponse
object
4 properties
SearchDocumentResponse
object
3 properties
Metadata
object
14 properties 5 required
DocumentUploadBadRequest
object
4 properties
MetadataByIdResponse
object
2 properties
MetadataUpdate
object
14 properties
DocumentUploadForbidden
object
4 properties
SearchRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-documents-v3-api-openapi.yml Raw ↑

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
Zinnia Annuity Version 1 API
Zinnia Annuity Version 2 API
Zinnia Attachment API
Zinnia Authorization Status Update API
Zinnia Case Instance API
Zinnia Client Case API
Zinnia Comments API
Zinnia Dataset API
Zinnia Details API
Zinnia Documents V2 API
Zinnia Financial Transactions API
Where this information came from

This is an independent, third-party profile of Zinnia Documents V3 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.