Identity API

List phones for a person

Returns phones belonging to the specified person 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

personIdstring(uuid)required

ID of the person

Response

application/json

A page of phones belonging to the person.

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/persons/{personId}/phones
 
application/json

Create a phone for a firm

Creates a new phone and associates it with the specified firm. A firm may have at most 5 phones.

post

Path Parameters

firmIdstring(uuid)required

ID of the firm

Headers

Idempotency-Keystring(uuid)

Client-generated UUID used to deduplicate retried requests. When provided, the server caches the first successful response for this key and returns it for any subsequent request with the same key from the same client, without re-processing.

Body

application/json

CreatePhoneRequest

typestringrequired

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example:CELL

numberstringrequired

Phone number (exactly 10 digits)

Match pattern:^[0-9]{10}$

Example:3035551234

extensionstring

Optional phone extension (max 6 characters)

<= 6 characters

Example:1234

preferredbooleanrequired

Whether this is the preferred phone number

Example:true

Response

application/json

Phone created successfully.

PhoneV2

A phone record returned by V2 phone endpoints.

idstring(uuid)requiredread-only

Phone identifier.

Example:550e8400-e29b-41d4-a716-446655440000

typestringrequired

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example:CELL

numberstringrequired

10-digit phone number.

Example:3035551234

extensionstring | null

Optional phone extension.

Example:1234

preferredbooleanrequired

Whether this is the preferred phone number.

Example:true

createdAtstring(date-time)requiredread-only

RFC3339 UTC timestamp when the phone was created.

Example:2024-01-15T10:30:00Z

updatedAtstring | null(date-time)read-only

RFC3339 UTC timestamp when the phone was last updated.

Example:2024-01-15T14:45:00Z

post/v2/firms/{firmId}/phones

Body

{ "type": "CELL", "number": "3035551234", "preferred": true }
 
application/json

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