InsurancePolicyV2
objectUnique identifier for the insurance policy.
The type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
Name of the insurance carrier.
Maximum coverage limit for the policy.
Date the insurance policy became effective (YYYY-MM-DD).
Date the insurance policy expires (YYYY-MM-DD).
Policy number assigned by the carrier.
Certificate number for the policy.
Whether a certificate file has been uploaded for this policy.
Presigned download URL for the certificate file. Present only when hasFile is true. Expires 10 minutes after the response is generated.
RFC3339 UTC timestamp when the record was created.
RFC3339 UTC timestamp when the record was last updated.
UpdateInsurancePolicyRequest
objectThe type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
Name of the insurance carrier.
Example:Acme Insurance Co.
Maximum coverage limit for the policy.
>= 1<= 10000000
Example:1000000
Date the insurance policy becomes effective (YYYY-MM-DD).
Example:2024-01-01
Date the insurance policy expires (YYYY-MM-DD).
Example:2025-01-01
Policy number assigned by the carrier.
Example:POL-001
Certificate number for the policy.
Example:CERT-001
CreateInsurancePolicyRequest
objectThe type of insurance policy
Allowed values:CORPORATIONINDIVIDUALJOINT
Example:INDIVIDUAL
Name of the insurance carrier.
Example:Acme Insurance Co.
Maximum coverage limit for the policy.
>= 1<= 10000000
Example:1000000
Date the insurance policy becomes effective (YYYY-MM-DD).
Example:2024-01-01
Date the insurance policy expires (YYYY-MM-DD).
Example:2025-01-01
Policy number assigned by the carrier.
Example:POL-001
Certificate number for the policy.
Example:CERT-001
FirmV2
objectCustomer-facing firm resource. The FEIN is always masked to ****; the full FEIN is available only via GET /v2/firms/{firmId}/fein (audited).
The unique identifier of the firm.
Example:550e8400-e29b-41d4-a716-446655440000
National Producer Number.
Example:1234567
Legal name of the firm.
Example:Acme Insurance LLC
Primary contact email address.
Example:contact@acme.com
Business entity type (SC, LLC, SP).
Example:LLC
FINRA CRD number (digits only, max 11 characters).
Example:12345
Masked Federal Employer Identification Number. Always returned as ****. The full FEIN is never exposed by this endpoint.
Example:****6789
Whether this is a test account.
ISO-8601 UTC timestamp when the firm was created.
Example:2024-01-15T10:30:00Z
ISO-8601 UTC timestamp of the last update.
Example:2024-06-01T14:22:00Z
FirmV2List
objectKeyset-paginated list of firms (F5 envelope).
Customer-facing firm resource. The FEIN is always masked to ****; the full FEIN is available only via GET /v2/firms/{firmId}/fein (audited).
Show Child Parameters
Page metadata for a token-based list response.