Search
K
Documents

downloadTaxForm-v2

This is an endpoint to download a tax-form from SOVOS

get

Query Parameters

clientCodestring

Client code for the carrier/client

Example:EVGL

contractNumberstringrequired

Contract number for the document/tax-form

Example:1234567898

fCharstringrequired

Unique string character associated with the tax-form name

Example:R

taxYearstring

Tax-year for the form (defaults to current year-1)

Example:2023

Path Parameters

formIdstringrequired

Form id for the tax-form

Example:123456

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

Response

OK

DownloadDocumentResponse

fileExtensionstringrequired
binaryDatastringrequired
get/document/v2/taxForms/{formId}
 

Documents V3

Uploads a document and saves its metadata

Accepts a file with metadata and returns a document Id

post

Headers

x-correlation-idstring

Body

multipart/form-data
filestringrequired
metadataobjectrequired
Show Child Parameters

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

Body

{ "file": "file", "metadata": { "docClassification": "OUTBOUND", "docCategory": "NEW_BUSINESS", "fileType": "PDF", "documentType": "NB_STATE_REPLACEMENT", "documentTypeDescription": "Address Change Letter" } }
 
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

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}
 
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

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
 
application/json