x-correlation-idstring
Uploads a document and saves its metadata
Accepts a file with metadata and returns a document Id
post
Headers
Body
multipart/form-data
Body
multipart/form-data
filestringrequired
metadataobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
document stored successfully
DocumentUploadResponse
documentIdstring
Unique ID
Example:670e23dfab593b4387210b81
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
messagestring
Response message
Example:Document uploaded successfully
statusCodeinteger(int32)
Status code of the response
Example:200
successboolean
post/document/v3/documents
Authentication
Headers
Body
No file selected
{
"docClassification": "OUTBOUND",
"docCategory": "NEW_BUSINESS",
"fileType": "PDF",
"documentType": "NB_STATE_REPLACEMENT",
"documentTypeDescription": "Address Change Letter"
}
Error initializing code snippet
application/json
Gets metadata for a document
Fetches metadata details, including version history if requested
get
Query Parameters
isAllVersionsNeededboolean
Indicates if all versions are required in the response
Default:false
Example:true
documentTypestring
Type of document indicating its purpose
Example:NB Application
documentClassificationstring
Classification of the document, e.g., OUTBOUND OR INBOUND
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
parentCarrierCodestring
Client code associated with the document
Example:EVGL
Path Parameters
documentIdstringrequired
Unique ID in EDS db
Example:670e23dfab593b4387210b81
Headers
Authorizationstringrequired
Authorization token
Example:Bearer <token>
x-correlation-idstring
Unique ID for correlating requests
Example:1760f822-dcbf-49fc-a623-a1998383f4b9
Response
application/json
Response
application/json
document metadata retrieved successfully
MetadataByIdResponse
metadataobject
Show Child Parameters
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
get/document/v3/documents/{documentId}
Authentication
Path Parameters
Query Parameters
Headers
application/json
updates document content or metadata
modifies metadata and optionally replaces the file
put
Path Parameters
documentIdstringrequired
Headers
x-correlation-idstring
Body
multipart/form-data
Body
multipart/form-data
filestring
metadataobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Document updated successfully
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
messagestring
Example:Document updated successfully
statusCodeinteger(int32)
Example:204
successboolean
Example:true
put/document/v3/documents/{documentId}
Authentication
Path Parameters
Headers
Body
{}
Error initializing code snippet
application/json
Retrieves a document by ID
Downloads a document based on its unique identifier
get
Query Parameters
documentClassificationstring
Classification of the document, e.g., OUTBOUND or INBOUND
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
parentCarrierCodestring
Client code associated with the document
Example:EVGL
policyNumberstring
Policy number associated with the document
Example:23109168
planCodestring
Plan code
Example:565
Path Parameters
documentIdstringrequired
Unique ID in EDS DB
Example:670e23dfab593b4387210b81
Headers
Authorizationstringrequired
Authorization token
Example:Bearer <token>
x-correlation-idstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Response
application/json
Response
application/json
document downloaded successfully
DocumentDownloadResponse
fileExtensionstring
File extension of the document
Example:pdf
fileNamestring
Name of the document
Example:NB Application
binaryDatastring
Binary data of the document
Example:wdvb2ekllkk189w0enjansle..
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
get/document/v3/documents/{documentId}/download
Authentication
Path Parameters
Query Parameters
Headers
application/json
Searches for documents
finds documents based on filters like document classification, document type, policy number etc
post
Query Parameters
limitinteger(int32)
Number of documents to be fetched. Max=1000
Default:10
<= 1000
Example:25
offsetinteger(int32)
Offset value for pagination
Default:0
Example:1
Headers
Authorizationstringrequired
Authorization token
Example:Bearer <token>
x-correlation-idstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Body
application/json
Body
application/json
SearchRequest
SearchRequest
Any OfdocumentStartDatestring(date)required
Start date of the document period for filtering results
Example:2024-10-01
documentEndDatestring(date)required
End date of the document period for filtering results
Example:2024-10-31
parentCarrierCodestring
Client code associated with the document search
Example:EVGL
documentClassificationstring
Classification of the document indicating type, e.g., outbound or inbound
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
documentTypestring
Type of document, defining its primary purpose
Example:NB Application
documentCategorystring
Category of the document, such as New Business or Claim
Allowed values:NEW_BUSINESSPOST_ISSUEDEATHCORRESPONDENCEAGENTSUITABILITY
Example:NEW_BUSINESS
policyNumberstring
Policy number associated with the document, used for identification
Example:23109168
planCodestring
Plan code associated with the document, used for identification
Example:plan67890f
documentStatusarray[string]
List of statuses the document may have, supporting filtering by multiple statuses
Allowed values:ACTIVEINACTIVE
Example:["ACTIVE","INACTIVE"]
appIdstring
Application ID tied to the document for tracking and retrieval
Example:EDJ041120240000000001
zinniaLiveCaseIdstring
Unique case ID in the Zinnia system associated with the document
Example:ZLC09876
orderBystring
The field used to order search results; default is document Date
Example:documentDate
orderByDirectionstring
Direction of the sort order for search results, either ascending or descending
Allowed values:ASCDESC
Example:DESC
recipientstring
Recipient of the document
Allowed values:AGENTCLIENT
Example:AGENT
appVersioninteger(int32)
App Version
Example:1
masterAgentNumberstring
Master Agent Number
Example:MA98416687
Response
application/json
Response
application/json
documents retrieved successfully
SearchDocumentResponse
countinteger(int32)
Number of total documents found matching the search criteria
Example:100
documentsarray[object]
Show Child Parameters
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
post/document/v3/documents/search
Authentication
Query Parameters
Headers
Body
{}
application/json