policyIdstring(uuid)required
Unique identifier of the insurance policy.
Get insurance policy by ID
Returns a single E&O insurance policy by ID, scoped to the authenticated customer. Includes a presigned certificate download URL when a file has been uploaded (TTL 10 minutes).
get
Path Parameters
Response
application/json
Response
application/json
Insurance policy retrieved successfully.
InsurancePolicyV2
idstring(uuid)requiredread-only
Unique identifier for the insurance policy.
typestringrequired
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
carrierstringrequired
Name of the insurance carrier.
totalLimitnumber(double)
Maximum coverage limit for the policy.
effectiveOnstring(date)required
Date the insurance policy became effective (YYYY-MM-DD).
expiresOnstring(date)
Date the insurance policy expires (YYYY-MM-DD).
policyNumberstringrequired
Policy number assigned by the carrier.
certificateNumberstringrequired
Certificate number for the policy.
hasFilebooleanread-only
Whether a certificate file has been uploaded for this policy.
certificateUrlstring | null(uri)read-only
Presigned download URL for the certificate file. Present only when hasFile is true. Expires 10 minutes after the response is generated.
createdAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was created.
updatedAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was last updated.
get/v2/insurance-policies/{policyId}
Authentication
Path Parameters
application/json
Delete insurance policy
Permanently deletes an E&O insurance policy by ID, scoped to the authenticated customer. Returns 404 if the policy does not exist or is not accessible to the caller. A 403 is returned only when the caller’s token lacks the required scope; cross-customer access returns 404, not 403.
delete
Path Parameters
policyIdstring(uuid)required
The unique identifier for the insurance policy.
Example:550e8400-e29b-41d4-a716-446655440000
Response
Response
Insurance policy deleted successfully.
delete/v2/insurance-policies/{policyId}
Authentication
Path Parameters
Update insurance policy
Updates an existing E&O insurance policy by ID. The policy must be owned by the authenticated customer; unknown or cross-customer IDs return 404.
put
Path Parameters
policyIdstring(uuid)required
The unique identifier for the insurance policy.
Example:550e8400-e29b-41d4-a716-446655440000
Body
application/json
Body
application/json
UpdateInsurancePolicyRequest
typestringrequired
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
carrierstringrequired
Name of the insurance carrier.
Example:Acme Insurance Co.
totalLimitnumber(double)
Maximum coverage limit for the policy.
>= 1<= 10000000
Example:1000000
effectiveOnstring(date)required
Date the insurance policy becomes effective (YYYY-MM-DD).
Example:2024-01-01
expiresOnstring(date)
Date the insurance policy expires (YYYY-MM-DD).
Example:2025-01-01
policyNumberstringrequired
Policy number assigned by the carrier.
Example:POL-001
certificateNumberstringrequired
Certificate number for the policy.
Example:CERT-001
Response
application/json
Response
application/json
Insurance policy updated successfully.
InsurancePolicyV2
idstring(uuid)requiredread-only
Unique identifier for the insurance policy.
typestringrequired
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
carrierstringrequired
Name of the insurance carrier.
totalLimitnumber(double)
Maximum coverage limit for the policy.
effectiveOnstring(date)required
Date the insurance policy became effective (YYYY-MM-DD).
expiresOnstring(date)
Date the insurance policy expires (YYYY-MM-DD).
policyNumberstringrequired
Policy number assigned by the carrier.
certificateNumberstringrequired
Certificate number for the policy.
hasFilebooleanread-only
Whether a certificate file has been uploaded for this policy.
certificateUrlstring | null(uri)read-only
Presigned download URL for the certificate file. Present only when hasFile is true. Expires 10 minutes after the response is generated.
createdAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was created.
updatedAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was last updated.
put/v2/insurance-policies/{policyId}
Authentication
Path Parameters
Body
{
"type": "INDIVIDUAL",
"carrier": "Acme Insurance Co.",
"effectiveOn": "2024-01-01",
"policyNumber": "POL-001",
"certificateNumber": "CERT-001"
}
application/json
Delete insurance policy certificate file
Deletes the E&O certificate file attached to an insurance policy, scoped to the authenticated customer. The policy record itself is preserved; hasFile becomes false and the presigned certificate URL is no longer returned. Returns 204 whether or not a file was attached (deleting a file that does not exist is a no-op). Returns 404 if the policy does not exist or is not accessible to the caller. A 403 is returned only when the caller’s token lacks the required scope; cross-customer access returns 404, not 403.
delete
Path Parameters
policyIdstring(uuid)required
The unique identifier for the insurance policy.
Example:550e8400-e29b-41d4-a716-446655440000
Response
Response
Certificate file deleted successfully (or no file was attached).
delete/v2/insurance-policies/{policyId}/files
Authentication
Path Parameters
Upload insurance policy certificate file
Uploads (or replaces) the E&O certificate file for a policy, scoped to the authenticated customer. Accepts a single multipart/form-data file part (PDF, JPEG, or PNG). On success the policy’s hasFile becomes true and the response includes a presigned certificateUrl (TTL 10 minutes). Returns 404 if the policy does not exist or is not accessible to the caller; a 403 is returned only when the caller’s token lacks the required scope (cross-customer access returns 404, not 403).
post
Path Parameters
policyIdstring(uuid)required
The unique identifier for the insurance policy.
Example:550e8400-e29b-41d4-a716-446655440000
Body
multipart/form-data
Body
multipart/form-data
filestringrequired
The certificate file to upload (PDF, JPEG, or PNG).
Response
application/json
Response
application/json
File uploaded successfully; returns the updated insurance policy.
InsurancePolicyV2
idstring(uuid)requiredread-only
Unique identifier for the insurance policy.
typestringrequired
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
carrierstringrequired
Name of the insurance carrier.
totalLimitnumber(double)
Maximum coverage limit for the policy.
effectiveOnstring(date)required
Date the insurance policy became effective (YYYY-MM-DD).
expiresOnstring(date)
Date the insurance policy expires (YYYY-MM-DD).
policyNumberstringrequired
Policy number assigned by the carrier.
certificateNumberstringrequired
Certificate number for the policy.
hasFilebooleanread-only
Whether a certificate file has been uploaded for this policy.
certificateUrlstring | null(uri)read-only
Presigned download URL for the certificate file. Present only when hasFile is true. Expires 10 minutes after the response is generated.
createdAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was created.
updatedAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the record was last updated.
post/v2/insurance-policies/{policyId}/files
Authentication
Path Parameters
Body
No file selected
Error initializing code snippet
application/json