Documents

Enterprise Documents API

Uploads a service request form and saves its details

Uploads a service request form and stores its details in the system. A document ID will be provided for reference.

post

Headers

x-correlation-idstring

Body

multipart/form-data
filestring

The service request form file to upload. Either file or metadata.publicFormUrl is required.

metadataobjectrequired
Show Child Parameters

Response

application/json

Service request form uploaded successfully

ServiceRequestFormUploadResponse

documentIdstring

Unique document ID

Example:670e23dfab593b4387210b81

correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

post/document/v3/service-request-form/upload

Body

{}
 
Error initializing code snippet
application/json

Searches for a service request form based on the provided criteria

Searches for a service request form using the given details. Results will be returned based on the specified search criteria.

post

Query Parameters

limitinteger(int32)

Default:10

offsetinteger(int32)

Default:0

x-correlation-idstring

Body

application/json

ServiceRequestFormSearchRequest

parentCarrierCodestringrequired

client code associated with the document search

Example:EVGL

formIdstring

Id to the specific form instance

Example:123456 CA

stateApplicablestring

State where the form is applicable or valid

Example:NY

formCategorystring

Category of the form

Example:Financial

formTypestring

Type of form

Example:Redemption

formSubTypestring

More specific classification under the form type

Example:Full Surrender

orderBystring

The field used to sort the search results; defaults to ‘createDate’ if not specified

Example:createDate

orderByDirectionstring

Direction of the sort order for search results, either ascending or descending

Allowed values:ASCDESC

Example:DESC

Response

application/json

service request forms retrieved successfully

SearchServiceRequestFormResponse

countinteger(int64)

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/service-request-form/search

Body

{ "parentCarrierCode": "EVGL" }
 
application/json

Updates a service request form using the provided ID

Updates a service request form based on the given ID. The form details will be modified as per the provided information.

put

Path Parameters

documentIdstringrequired

Headers

x-correlation-idstring

Body

multipart/form-data
filestring
metadataobjectrequired
Show Child Parameters

Response

application/json

service request form updated successfully

ServiceRequestFormMetadataOperationsResponse

correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

put/document/v3/service-request-form/update/{documentId}

Body

{}
 
Error initializing code snippet
application/json

Retrieves a service request form by its ID

Retrieves the service request form based on the provided ID. If a document key is available, the form is returned as binary data; otherwise, a public URL to access the form is provided.

get

Query Parameters

documentClassificationstring

Allowed values:INBOUNDOUTBOUND

parentCarrierCodestring

Path Parameters

documentIdstringrequired

Headers

x-correlation-idstring

Response

application/json

service request form downloaded successfully

ServiceRequestFormDownloadResponse

fileExtensionstring

File extension of the document

Example:pdf

formNamestring

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/service-request-form/{documentId}/download
 
application/json

Documents V2