Suite Actuarial
Menu

API Documentation

Complete reference for all 31 available REST endpoints.

Base URL

https://api-suite.gonor.me/api/v1

Content-Type

application/json

Authentication

No authentication required

Swagger UI

View interactive documentation at /docs

5 endpoints

POST/api/v1/pricing/temporal

Calculates the net and gross premium for a term life product using the EMSSA-09 mortality table. The response includes calculation_metadata with validation_tier and the assumption sources.

Parameters

NameTypeRequiredDefaultDescription
edadintRequired-Age of the insured in completed years (0-120)
sexostringRequired-Sex: masculino or femenino (any other value is rejected with 422)
suma_aseguradafloatRequired-Sum insured in MXN (> 0)
plazo_yearsintRequired-Policy term in years (1-99)
tasa_interesfloatOptional0.055Technical interest rate (0-0.15)
frecuencia_pagostringOptionalanualPayment frequency: anual, semestral, trimestral, mensual
recargo_gastos_adminfloatOptional0.05Admin expense loading (0-1)
recargo_gastos_adqfloatOptional0.10Acquisition expense loading (0-1)
recargo_utilidadfloatOptional0.03Profit loading (0-1)
POST/api/v1/pricing/ordinario

Calculates the premium for a whole life product. The plazo_years field sets the premium-paying period, not the coverage: coverage runs to the table's omega age.

Same parameters as /pricing/temporal (see above).

POST/api/v1/pricing/dotal

Calculates the premium for an endowment product that pays on death during the term or on survival at the end of the term.

Same parameters as /pricing/temporal (see above).

POST/api/v1/pricing/dotal/lab

Builds a limited-pay endowment and opens it up: present value of the death benefit and of the survival benefit, premium annuity factor, equivalent annual net premium, and the year-by-year reserve path. The verificaciones block contrasts the engine against an independent route (Dx/Nx/Mx commutation columns and the retrospective Fackler recursion) and publishes the numeric gaps, not just a boolean.

Parameters

NameTypeRequiredDefaultDescription
edadintRequired-Age of the insured in completed years (0-120)
sexostringRequired-Sex: masculino or femenino
suma_aseguradafloatRequired-Sum insured in MXN (> 0)
plazo_yearsintRequired-Policy term in years (1-99)
plazo_pagointRequired-Premium-paying term in years (1-99); shorter than plazo_years for a limited-pay design
tasa_interesfloatOptional0.055Technical interest rate (0-0.15)
frecuencia_pagostringOptionalanualPayment frequency: anual, semestral, trimestral, mensual
recargo_gastos_adminfloatOptional0.05Admin expense loading (0-1)
recargo_gastos_adqfloatOptional0.10Acquisition expense loading (0-1)
recargo_utilidadfloatOptional0.03Profit loading (0-1)
POST/api/v1/pricing/compare

Compares all three life products (temporal, ordinario, dotal) for the same insured with identical parameters. Returns a full pricing response per product.

Same parameters as /pricing/temporal (see above).