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

E-signature for DocuSign: load recipients, submit the case, poll signer status, cancel ceremony (void envelope; Pending), and retrigger signing email when in progress

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

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

This API exposes 6 operations across 6 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.3.

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

6 operations 6 paths 16 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.3
Base URL
https://qa.api.zinnia.io
Authentication
OpenID Connect
Terms of Service
Resource Areas
1

Authentication & Security 1

Zinnia Esignature API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openIdConnect) discovered at https://login.qa.zinnia.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • openIdConnect — OpenID Connect via Auth0. Clients present a JWT bearer token issued by the tenant in the Authorization: Bearer header.

Paths & Operations 6

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

ESignature 6

E-signature for DocuSign: load recipients, submit the case, poll signer status, cancel ceremony (void envelope; Pending), and retrigger signing email when in progress

GET
/market-connect/order-entry/v1/esignature/{transactionId}
Retrieves the e-signature signer list for a transaction
getEsignature 1 param → 200400401403404429500502
GET
/market-connect/order-entry/v1/esignature/{transactionId}/signer-status
Retrieves DocuSign signer status for each recipient on a transaction
getEsignatureSignerStatus 1 param → 200400401403404429500502
POST
/market-connect/order-entry/v1/esignature
Submits the Order Entry case for e-signature with the configured signer roster
submitEsignature body → 200400401403404429500502
POST
/market-connect/order-entry/v1/esignature/cancel-ceremony
Cancels the e-signature ceremony for a case (voids the DocuSign envelope and…
cancelEsignatureCeremony body → 200400401403404429500502
POST
/market-connect/order-entry/v1/esignature/retrigger-email-notification
Retriggers the DocuSign e-signature email notification for a case (only when…
retriggerEsignatureEmailNotification body → 200400401403404429500502
POST
/market-connect/order-entry/v1/esignature/update-signer
Updates signer email or phone for a case while e-signature is pending upstream
updateEsignSignerDetails body → 200400401403404429500502

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SaveEsignatureSignerRequest (9 properties), EsignatureSigner (9 properties), EsignatureSignerStatus (8 properties), UpdateEsignSignerRequest (6 properties). Each schema is shown below with its type and property counts.

ErrorInfo
object
4 properties 2 required
RetriggerEsignatureEmailNotificationRequest
object
1 property 1 required
CancelEsignatureCeremonyResponse
object
2 properties
EsignatureResponse
object
3 properties
UpdateEsignSignerRequest
object
6 properties
SaveEsignatureResponse
object
2 properties
EsignatureSignerStatusResponse
object
2 properties
CancelEsignatureCeremonyRequest
object
1 property 1 required
UpdateEsignSignerDetailsResponse
object
2 properties
SaveEsignatureSignerRequest
object
9 properties
RetriggerEsignatureEmailNotificationResponse
object
2 properties
UpdateEsignSignerDetailsRequest
object
2 properties 1 required
EsignatureSigner
object
9 properties
ErrorResponse
object
2 properties 2 required
EsignatureSignerStatus
object
8 properties
SaveEsignatureRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-esignature-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 Documents V3 API
Where this information came from

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