Documents

Enterprise Documents API

ServiceRequestFormSearchRequest

object
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

Example

MetadataSRFSearchResponse

object
idstring

id

Example:67124697f3bef2497b6accfb

formIdstring

Id to the specific form instance

Example:01 12345 3456 US

formStatusinteger(int32)

Status of the form

Example:1

formNamestring

Name of the form

Example:Annuity Payout Benefits Form

publicFormUrlstring

Publicly accessible URL where the form can be viewed or downloaded

Example:https//:zinnia.srf.com

uploadedDatestring(date-time)

Date and time when the form was uploaded

Example:2025-03-10T15:58:56.081Z

formCategorystring

Category that describes the purpose of the form

Example:Withdrawal

stateApplicablestring

State where the form is applicable or valid

Example:NY

fileTypestring

The type of file format for the form

Example:PDF

formVersionstring

Version number of the form

Example:1

formTypestring

Type of the form

Example:Redemption

formSubTypestring

Further classification of the form type

Example:Full Surrender

barcodeContentstring

Barcode data used for identifying or scanning the form

Example:13qwf312wfw312fqe2jtyktym

Example

SearchServiceRequestFormResponse

object
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

Example

ServiceRequestFormDownloadResponse

object
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

Example

ErrorResponse

object
correlationIdstring

Unique ID for correlating requests

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

messagestring

Response message

Example:No document types found/Invalid request/Access denied for document metadata fetch

statusCodeinteger(int32)

status code

successboolean
errorCodestring

Machine-readable error code, present on timeouts and unhandled errors.

Allowed values:GATEWAY_TIMEOUTDB_TIMEOUTINTERNAL_ERROR

Example