personIdstring(uuid)required
ID of the person
Create insurance policy for person
Creates a new E&O insurance policy for a person.
post
Path Parameters
Body
application/json
Body
application/json
CreateInsurancePolicyRequest
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 created 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.
post/v2/persons/{personId}/insurance-policies
Authentication
Path Parameters
Body
{
"type": "INDIVIDUAL",
"carrier": "Acme Insurance Co.",
"effectiveOn": "2024-01-01",
"policyNumber": "POL-001",
"certificateNumber": "CERT-001"
}
application/json
List insurance policies for firm
Returns a keyset-paginated list of E&O insurance policies for a firm, scoped to the authenticated customer.
get
Query Parameters
page_tokenstring
Opaque continuation token returned by the previous response’s page.nextToken. Omit on the first request. Format is server-controlled and may change without an API version bump.
page_sizeinteger(int32)
Requested number of items in the response. Defaults to 25 when omitted; values outside [1, 250] are rejected with 400 (not clamped). The actual size returned is reflected in page.size and may be smaller (last page or empty result).
Default:25
>= 1<= 250
Path Parameters
firmIdstring(uuid)required
ID of the firm
Response
application/json
Response
application/json
Paginated list of insurance policies.
itemsarray[object]required
Show Child Parameters
pageobjectrequired
Page metadata for a token-based list response.
Show Child Parameters
get/v2/firms/{firmId}/insurance-policies
Authentication
Path Parameters
Query Parameters
application/json
Create insurance policy for firm
Creates a new E&O insurance policy for a firm.
post
Path Parameters
firmIdstring(uuid)required
ID of the firm
Body
application/json
Body
application/json
CreateInsurancePolicyRequest
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 created 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.
post/v2/firms/{firmId}/insurance-policies
Authentication
Path Parameters
Body
{
"type": "INDIVIDUAL",
"carrier": "Acme Insurance Co.",
"effectiveOn": "2024-01-01",
"policyNumber": "POL-001",
"certificateNumber": "CERT-001"
}
application/json
BankAccountType
stringThe type of bank account
Allowed values:SAVINGSCHECKING
Example
BankAccountFullResponse
objectBank account resource returned by the single-resource GET endpoint. The number field contains the full account number. In all other endpoints number is masked to ****<last4>.
idstring(uuid)requiredread-only
The unique identifier for the bank account.
Example:550e8400-e29b-41d4-a716-446655440000
typestringrequired
The type of bank account
Allowed values:SAVINGSCHECKING
Example:CHECKING
holderNamestringrequired
Name of the account holder.
Example:Jane Doe
numberstringrequiredread-only
Full bank account number.
Example:1234567890
routingNumberstringrequiredread-only
Bank routing number.
Example:021000021
bankNamestringrequired
Name of the bank.
Example:Chase Bank
nicknamestring
Optional nickname for the bank account.
Example:Main
primaryAccountbooleanrequired
Indicates if this is the primary bank account.
Example:true
createdAtstring(date-time)requiredread-only
RFC3339 UTC timestamp when the bank account was created.
Example:2024-01-15T10:30:00Z
updatedAtstring(date-time)read-only
RFC3339 UTC timestamp when the bank account was last updated.
Example:2024-01-15T14:45:00Z
Example