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 Client Case API

The ClientCase API from Zinnia — 9 operation(s) for clientcase.

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

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

This API exposes 11 operations across 9 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://uat.api.zinnia.io.

11 operations 9 paths 20 schemas 1 DELETE2 GET6 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zinnia Client Case API declares 1 security scheme for authenticating requests. It supports OpenID Connect (Auth0) discovered at https://login.uat.zinnia.com/.

Paths & Operations 11

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

ClientCase 11
GET
/client-case-manager/v1/client-case/{caseId}
Get a single client case with the specified id
getClientCaseManagerV1ClientCaseByCaseId 1 param → 200404
PATCH
/client-case-manager/v1/client-case/{caseId}
Update an existing client case
patchClientCaseManagerV1ClientCaseByCaseId 1 param body → 200400404
POST
/client-case-manager/v1/client-case
Create a new client case
postClientCaseManagerV1ClientCase body → 201400
GET
/client-case-manager/v1/client-case/search
Search for client cases
getClientCaseManagerV1ClientCaseSearch 12 params → 200
POST
/client-case-manager/v1/client-case/{caseId}/illustrations
Add an illustration to an existing client case
postClientCaseManagerV1ClientCaseByCaseIdIllustrations 1 param body → 200400404
DELETE
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}
Remove an illustration from an existing client case
deleteClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationId 2 params → 200400404
PATCH
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}
Update an existing illustration from an existing client case
patchClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationId 2 params body → 200400404
PATCH
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/archive
Archive an existing illustration
patchClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationIdArchive 2 params → 200400404
PATCH
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/reactivate
Reactivates a previously archived illustration
patchClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationIdReactivate 2 params → 200400404
PATCH
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/submitdeprecated
Selects an illustration from an existing client case
patchClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationIdSubmit 2 params → 200400404
PATCH
/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/select
Selects an illustration from an existing client case
patchClientCaseManagerV1ClientCaseByCaseIdIllustrationsByIllustrationIdSelect 2 params → 200400404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ClientCaseDto (20 properties), ClientCaseSummaryDto (15 properties), ClientCaseCreationInputDto (13 properties), InsuredDetailsDto (10 properties). Each schema is shown below with its type and property counts.

InsuredDetailsUpdateInputDto
object
9 properties
IllustrationCreationInputDto
object
6 properties 3 required
ClientCaseSummaryDto
object
15 properties
ClientCaseSortField
string
AgentDetailsCreationInputDto
object
5 properties 1 required
AgentDetailsUpdateInputDto
object
5 properties
AgentDetails
object
5 properties
ClientCaseUpdateInputDto
object
7 properties
Illustration
object
8 properties
IllustrationStatus
string
ClientCaseCreationInputDto
object
13 properties 4 required
ClientCaseSummaryDtoResultsPage
object
4 properties
SortDirection
string
ClientCaseDto
object
20 properties
UnderwritingClass
string
ProductType
string
TransactionType
string
InsuredDetailsDto
object
10 properties
SexAtBirth
string
InsuredDetailsCreationInputDto
object
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-clientcase-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 Comments API
Zinnia Dataset API
Zinnia Details API
Zinnia Documents V2 API
Zinnia Documents V3 API
Zinnia Financial Transactions API
Where this information came from

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