Skip to main content
POST
Import Historical Form Packet

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json
packetId
string<uuid>
required

Stable caller-generated packet id, retained across retries and import runs.

entityType
enum<string>
required
Available options:
quote,
policy
entityId
string<uuid>
required

An existing live quote or policy in this company.

name
string
required

Name of the historical packet.

Required string length: 1 - 255
issuedAt
integer<int64>
required

Original issuance time in Unix milliseconds, no later than the current time.

Required range: -62135596800000 <= x <= 8640000000000000
documents
object[]
required

PDFs in page order, at most 20 MB combined before base64 encoding.

Required array length: 1 - 50 elements

Response

Historical packet stored, or an identical prior import returned.

id
string<uuid>
required