Documents
DocumentUploadBadRequest
objectcorrelationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
messagestring
Error message
Example:Invalid request payload
statusCodeinteger(int32)
Status code of the response
Example:400
successboolean
Example
DocumentUploadForbidden
objectcorrelationIdstring
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
messagestring
Error message
Example:Forbidden
statusCodeinteger(int32)
Status code of the response
Example:403
successboolean
Example
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