Identity API

List phones for a firm

Returns phones belonging to the specified firm and visible to the authenticated customer, paginated by continuation token.

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

A page of phones belonging to the firm.

itemsarray[object]required

A phone record returned by V2 phone endpoints.

Show Child Parameters
pageobjectrequired

Page metadata for a token-based list response.

Show Child Parameters
get/v2/firms/{firmId}/phones
 
application/json

Insurance Policies

Operations for managing E&O insurance policies

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

policyIdstring(uuid)required

Unique identifier of the insurance policy.

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}
 
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

Insurance policy deleted successfully.

delete/v2/insurance-policies/{policyId}
 

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

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

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}

Body

{ "type": "INDIVIDUAL", "carrier": "Acme Insurance Co.", "effectiveOn": "2024-01-01", "policyNumber": "POL-001", "certificateNumber": "CERT-001" }
 
application/json