Document API

Document types

URL	/api/v3/document/types/
Methods	GET

Calling this endpoint will generate a JSON list of document types that are currently defined. Here is an example of what we return.

[
    "Cancellation Schedule",
    "Endorsement Schedule",
    "Policy Schedule/COI",
    "Quote Slip",
    "Receipt",
    "Renewal Schedule",
    "Tax Invoice"
]

Listing templates

URL	/api/v3/document/templates/?type=<type>
Methods	GET

Key	Type	Description
type	String	An optional GET parameter which if defined and known will filter the list of templates returned to the caller by document templates of that type.

This endpoint provides a method to retrieve the different document templates that are defined. The list returned can be further filtered by specify a document type as a GET parameter.

{
    "templates": [
        {
            "id": 10000001,
            "name": "Group COI",
            "type": "Policy Schedule/COI"
        },
        {
            "id": 10000002,
            "name": "Group Quote",
            "type": "Quote Slip"
        }
    ]
}

Key	Type	Description
id
name	String	The display name for the template
type	String	The document type that this template is designed to be used for