api-docs-icon

Get maximum face amount for applicant

POST
/ v1/ max-face-amount

Calculate the maximum allowable coverage amount based on the applicant's age and optional household income, SSN, and policy exclusions.

Usage Scenarios:

  1. Check before application is created - Call this endpoint to determine the maximum coverage amount available for an applicant:

    • Required: applicant age
    • Optional: annual household income, SSN (at least one must be provided)
    • Do NOT include excludePolicyNumber for pre-application checks

  2. Check before displaying requote options - Call this endpoint to validate coverage amounts during requote operations:

    • Required: applicant age
    • Optional: annual household income, SSN (at least one must be provided)
    • Optional: excludePolicyNumber - should be the policy number of the current application to exclude it from the calculation

Note: This endpoint applies to SILT and SIDT products.











Response



x-partner-id
string
required

This is firm's or agency's national producer number (npn)

Example:
45820
x-trace-id
string

Custom Trace ID Header for Tracking Requests

Example:
035ae04d-a7d1-490d-be6b-bc26d2b9bb0b

age
integer<int32>
required

Age of the applicant (must be between 18 and 100)

Example:
65
annualHouseholdIncome
number<double>

Annual household income of the applicant (must be a positive number up to 100 billion, can be decimal). Required if socialSecurityNumber is not provided.

Example:
120000
excludePolicyNumber
string

Optional policy number to exclude from the calculation. Should be the policy number of the current application (maximum 50 characters)

Example:
POL123456
socialSecurityNumber
string

Social Security Number (9 digits, no hyphens). Required if annualHouseholdIncome is not provided.

Example:
111222333

Responses

Successful operation

maximumFaceAmount
number<double>
required

Maximum face amount available for the applicant based on age, income, SSN, and policy exclusions

Example:
600000