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 V2 API

The Documents V2 API from Zinnia — 3 operation(s) for documents v2.

Zinnia Documents V2 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 V2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 12 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.

3 operations 3 paths 12 schemas 3 GET

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 V2 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Documents V2 3
GET
/document/v2/documents
Get documents
getDocuments 17 params → 200400401404
GET
/document/v2/documents/{documentId}
Get document
getDocument 5 params → 200400401404
GET
/document/v2/documents/{documentId}/download
Download document v2
downloadDocument-v2 6 params → 200400401404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Document (30 properties), DocumentMetadata (23 properties), InlineResponse400 (4 properties), InnerError (3 properties). Each schema is shown below with its type and property counts.

OdataError
object
3 properties 3 required
InlineResponse404
object
1 property 1 required
Recipient
string
InlineResponse400
object
4 properties 4 required
Document
object
30 properties 30 required
DocumentMetadata
object
23 properties 23 required
InlineResponse4001
object
1 property 1 required
InlineResponse401
object
1 property 1 required
Message
object
2 properties 2 required
InnerError
object
3 properties 3 required
InlineResponse200
object
2 properties 2 required
DownloadDocumentResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-documents-v2-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 V3 API
Zinnia Financial Transactions API
Where this information came from

This is an independent, third-party profile of Zinnia Documents V2 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.