Documents API

Action	Endpoint
Fetch a Document instance	GET/document/{tenantLocator}/documents/{locator}
Fetch the Rendered artifact for a Document	GET/document/{tenantLocator}/documents/{locator}/document
Fetch the Source for a Document	GET/document/{tenantLocator}/documents/{locator}/source
Fetch Documents for a Policy Term	GET/document/{tenantLocator}/documents/policy/{policyLocator}/term/{termLocator}/summary
Fetch Documents for a Policy Segment	GET/document/{tenantLocator}/documents/segment/{locator}/list
Fetch Documents for a Policy Transaction	GET/document/{tenantLocator}/documents/transaction/{locator}/list
Fetch Documents for a Quote	GET/document/{tenantLocator}/documents/quote/{locator}/list
Fetch Document for an Invoice	GET/document/{tenantLocator}/documents/invoices/{locator}
Copy Documents On Issue	POST/document/{tenantLocator}/documents/quote/{locator}/copyOnIssue
Attach Document	POST/document/{tenantLocator}/documents/attach
Replace Document	PATCH/document/{tenantLocator}/documents/{locator}
Delete Document	DELETE/document/{tenantLocator}/documents/{locator}
Render Document	POST/document/{tenantLocator}/documents/render

Fetch

Fetch a Document instance

Fetch a Document instancefetchDocument

GET/document/{tenantLocator}/documents/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DocumentInstanceResponse

Security Group:documents

Permission:

read

DocumentInstanceResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`documentInstanceState`	`Enum draft \| dataReady \| ready \| dataError \| renderError \| conversionError`
`documentFormat`	`Enum csv \| doc \| docx \| html \| jpeg \| jpg \| pdf \| text \| txt \| xls \| xlsx \| zip`
`external`	`boolean`
`referenceType`	`Enum quote \| policy \| invoice \| transaction \| segment \| term`
`createdAt`	`datetime`
`consolidatedFrom`	`ulid[]`
`consolidatedTo`	`ulid[]`
`metadata`	`map<string, object>`
`renderingData`	`map<string, object>`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`termLocator`	`ulid?`
`transactionLocator`	`ulid?`
`segmentLocator`	`ulid?`
`referenceDocumentLocator`	`ulid?`
`staticName`	`string?`
`name`	`string?`
`category`	`string?`
`copyOnIssuance`	`boolean?`
`processingErrors`	`string?`
`readyAt`	`datetime?`
`createdBy`	`uuid?`

Fetch the Rendered artifact for a Document

Fetch the Rendered artifact for a DocumentfetchDocumentResource

GET/document/{tenantLocator}/documents/{locator}/document

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:StreamingResponseBody<string>

Security Group:documents

Permission:

read

Fetch the Source for a Document

Fetch the Source for a DocumentfetchSourceForDocument

GET/document/{tenantLocator}/documents/{locator}/source

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:StreamingResponseBody<string>

Security Group:documents

Permission:

read

Fetch Documents for a Policy Term

Fetch Documents for a Policy TermfetchDocumentsForTerm

GET/document/{tenantLocator}/documents/policy/{policyLocator}/term/{termLocator}/summary

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`termLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

Fetch Documents for a Policy Segment

Fetch Documents for a Policy SegmentfetchDocumentsForSegment

GET/document/{tenantLocator}/documents/segment/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

Fetch Documents for a Policy Transaction

Fetch Documents for a Policy TransactionfetchDocumentsForTransaction

GET/document/{tenantLocator}/documents/transaction/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

Fetch Documents for a Quote

Fetch Documents for a QuotefetchDocumentsForQuote

GET/document/{tenantLocator}/documents/quote/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

DocumentListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DocumentInstanceResponse[]`

Fetch Document for an Invoice

Fetch Document for an InvoicefetchInvoiceDocument

GET/document/{tenantLocator}/documents/invoices/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DocumentInstanceResponse

Security Group:documents

Permission:

read

Copy

Copy Documents On Issue

Copy Documents On IssuecopyDocumentsOnIssue

POST/document/{tenantLocator}/documents/quote/{locator}/copyOnIssue

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`deleteAllDocuments`	query	`boolean?`	No

Response:void

Security Group:documents

Permission:

trigger

Modification

Attach Document

Attach DocumentattachDocument

POST/document/{tenantLocator}/documents/attach

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceLocator`	query	`ulid`	Yes
`referenceType`	query	`Enum quote \| policy \| invoice \| transaction \| segment \| term`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string?`	No
`documentFormat`	query	`Enum csv \| doc \| docx \| eml \| html \| jpeg \| jpg \| msg \| pdf \| text \| txt \| xls \| xlsx \| zip`	Yes
`metadata`	query	`string?`	No
`transactionLocator`	query	`ulid?`	No
`segmentLocator`	query	`ulid?`	No
`category`	query	`string?`	No
`copyOnIssuance`	query	`boolean?`	No

Request:file

Response:DocumentInstanceResponse

Security Group:documents

Permission:

upload-external

In the request, the key name for the file content should be document.

If referenceType is policy, either a transactionLocator or segmentLocator must be supplied.

Replace Document

Replace DocumentreplaceDocument

PATCH/document/{tenantLocator}/documents/{locator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`metadata`	query	`string?`	No
`category`	query	`string?`	No

Request:file

Response:DocumentInstanceResponse

Security Group:documents

Permission:

replace-external

Delete Document

Delete DocumentdeleteDocument

DELETE/document/{tenantLocator}/documents/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:void

Security Group:documents

Permission:

delete-external

Ad-hoc Rendering

Render Document

Render DocumentrenderDocument

POST/document/{tenantLocator}/documents/render

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceType`	query	`Enum quote \| policy \| invoice \| transaction \| segment \| term`	Yes
`referenceLocator`	query	`ulid`	Yes
`productName`	query	`string?`	No
`templateFormat`	query	`Enum? liquid \| velocity`	No
`documentConfig`	query	`string?`	No
`staticName`	query	`string?`	No
`templateName`	query	`string?`	No

Request:TemplateResponse

Response:StreamingResponseBody<string>

Security Group:documents

Permission:

render-external

Documents API

Fetch

Fetch a Document instance

Fetch the Rendered artifact for a Document

Fetch the Source for a Document

Fetch Documents for a Policy Term

Fetch Documents for a Policy Segment

Fetch Documents for a Policy Transaction

Fetch Documents for a Quote

Fetch Document for an Invoice

Copy

Copy Documents On Issue

Modification

Attach Document

Replace Document

Delete Document

Ad-hoc Rendering

Render Document

See Also

On this page