Documents
ServiceRequestFormMetaData
objectpublicFormUrlstring
Publicly accessible URL
Example:https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
formIdstring
Id to the specific form instance
Example:1234567
formNamestring
Name or title of the form
Example:Annuity Surrender Form
parentCarrierCodestring
The code of the parent carrier
Example:EVGL
fileTypestring
The type of file
Example:PDF
formTypestring
Type of the form
Example:Redemption
formSubTypestring
Further classification of the form type
Example:Full Surrender
formCategorystring
Category that describes the purpose of the form
Example:Financial
barcodeContentstring
Barcode data used for identifying or scanning the form
Example:13qwf312wfw312fqe2jtyktym
stateApplicablestring
State where the form is applicable or valid
Example:NY
Example
ServiceRequestFormUpdateMetaData
objectpublicFormUrlstring
Publicly accessible URL
Example:https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
formIdstring
Id to the specific form instance
Example:1234567
formNamestring
Name or title of the form
Example:Annuity Surrender Form
parentCarrierCodestring
The code of the parent carrier
Example:EVGL
fileTypestring
The type of file
Example:PDF
formTypestring
Type of the form
Example:Redemption
formSubTypestring
Further classification of the form type
Example:Full Surrender
formCategorystring
Category that describes the purpose of the form
Example:Financial
barcodeContentstring
Barcode data used for identifying or scanning the form
Example:13qwf312wfw312fqe2jtyktym
stateApplicablestring
State where the form is applicable or valid
Example:NY
formStatusstring
formStatus
Example:ACTIVE
Example
ServiceRequestFormUploadResponse
objectdocumentIdstring
Unique document ID
Example:670e23dfab593b4387210b81
correlationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Example
ServiceRequestFormMetadataOperationsResponse
objectcorrelationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Example
ServiceRequestFormSearchRequest
objectparentCarrierCodestringrequired
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