Search
K
Documents

downloadDocument-v2

this is an endpoint to download a document

get

Query Parameters

sourcestring

Source of the document

Example:correspondence

clientCodestring

Carrier code of the document

Example:EVGL

policyNumberstring

Policy number associated with the document, used for identification

Example:1234567890

planCodestring

Plan code associated with the document, used for identification

Example:1234567890

Path Parameters

documentIdstringrequired

Unique number assigned to the document

Example:1234567890

Headers

Authorizationstringrequired

This will be passed as Bearer plus “token” as generated by above token API.

Example:Bearer eykjsfjfjasdasdad

Response

OK

DownloadDocumentResponse

fileExtensionstringrequired
binaryDatastringrequired
get/document/v2/documents/{documentId}/download
 

TaxForms V2

getTaxForms-v2

This is an endpoint to get a list of tax-forms from SOVOS

get

Query Parameters

clientCodestring

Client code for the carrier/client

Example:EVGL

contractNumberstringrequired

Contract number for the document/tax-form

Example:1234567898

taxYearstring

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

Example:2023

numYearsinteger(int32)

Default:1

>= 1<= 5

Example:1

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

Response

application/json

OK

TaxFormsResponse200

countnumberrequired
itemsarray[object]required
Show Child Parameters
get/document/v2/taxForms
 
application/json

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