API Reference

Pricing Only

post
https://zyins.isaapi.com/v3/quote

Evaluates the applicant and returns every qualified product for each requested face amount or budget as one flat plans array. Face-amount offers carry death_benefit (period null); monthly-budget offers carry budget (period monthly). Group client-side by the requested dimension — death_benefit.amount.cents for face-amount requests, budget.amount.cents for monthly-budget requests — without the shape ever changing. Returns the identical flat shape as Run a prequalification — same uniform pricing[] table and integer-cents {cents, display} money, the v2 string-money map is gone. Use this when a UI compares multiple coverage amounts at once; use prequalify when one best-offer-per-product list per applicant is enough.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Same as PrequalifyRequest plus optional accuracy and optional age. At least one of date_of_birth or age is required.

date

Date of birth in YYYY-MM-DD format. Preferred when both date_of_birth and age are provided.

integer
0 to 120

Age in years. Used when date_of_birth is omitted. Server converts to DOB for underwriting.

string
required
length between 2 and 20

US state as 2-letter abbreviation (e.g., "TX", "CA") or full name (e.g., "Texas", "California"). Use values consistent with the reference datasets you cache from GET /v3/datasets (there is no separate /states dataset route).

integer
1 to 108

Height in inches

integer
1 to 1000

Weight in pounds

nicotine_usage
object

Complete nicotine usage information

quote_options
object
required

Evaluates one applicant against several coverage amounts or monthly budgets in a single call. quote_type selects which dimension the amounts values represent, and the response stays one flat plans array regardless of how many amounts are sent.

string
enum

How to round displayed prices. "nearest" = round to nearest increment; "next" = round up (ceiling) to next increment.

products
array of strings

Regex patterns to filter products (same as prequalify).

products
string

ZIP code for location-specific pricing.

string

Filter results to a specific product class (same as prequalify).

include_product_class
array of strings

Include additional product classes (same as prequalify).

include_product_class
string

Minimum rank filter (same as prequalify).

string

Filter results to a specific plan group (term length). Examples: "20-year", "10-year", "30-year", "plan-a" (medsup). When set, only products matching this plan_group are returned.

boolean
Defaults to false

When true, deduplicate products by carrier+product, keeping only the highest-ranked (best) plan for each. Use with plan_group to get one result per product at the best available rate class. A product that only qualifies for STANDARD is still returned even if the caller conceptually wants PREFERRED — it is the best that product offers.

Headers
uuid

Client-supplied idempotency token for mutating /v3/* requests.

When the service has already completed a request for the same account, route, key, and identical JSON body within the 24-hour replay window, it returns the stored HTTP status and body instead of executing again. Reusing the same key with a different body returns 409 Conflict.

Unlike /v1 and /v2, the /v3 surface accepts only a UUID v4 value — non-UUID and SHA-256-derived keys are rejected with validation_error. Mint a fresh UUID v4 per distinct logical operation and reuse it across retries of that same operation.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 20 hours ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 20 hours ago