Insured Person Info

Returns normalized insured person profile for supported providers.

GET /insured-person-info

Inputs

name	required	in	type	aliases	default	description
insurance	yes	query	string	ins		Insurance slug (ma, razi, asia, ... , dana).
cmnid	yes	query	string	cmnId, cmn_id		Insured computer code (cmnId). For Dana this can also be the national code.
policy_id	yes	query	int	policyId		Policy identifier.
health_policy_insured_person_id	yes	query	int	healthPolicyInsuredPersonId, policy_link_id, policyLinkId		Health policy insured person ID.
illness_id	no	query	int	illnessId	101	Illness identifier.

Response Format

path	type	description
ok	bool	True on success.
error	string\|null	Error message when ok=false.
provider	string	Selected provider key.
insurance	string	Insurance slug.
meta.provider_status	int\|null	Provider HTTP status.
meta.franshiz_rate	int\|null	Franshiz rate from provider.
meta.remain_amount	int\|null	Accessible remain amount from provider.
meta.base_insurance.id	int\|null	Dana base insurance ID when available.
meta.base_insurance.label	string\|null	Dana base insurance label when available.
meta.insurance_amount	int\|null	Dana insurance amount (remaining ceiling) when available.
meta.base_coverage_amount	int\|null	Dana base coverage amount when available.
meta.family_coverage_amount	int\|null	Dana family coverage amount when available.
meta.kart_talaei_amount	int\|null	Dana Kart Talaei amount when available.
data.cmn_id	int\|null	Computer code (cmnId).
data.birth_year	int\|null	Birth year (Jalali).
data.gender.slug	string\|null	Gender slug.
data.gender.label	string\|null	Gender label.
data.identity_no	string\|null	Identity number.
data.national_code	string\|null	National code.
data.first_name	string\|null	First name.
data.last_name	string\|null	Last name.
data.is_iranian	bool\|null	Iranian citizenship flag.
data.passport_no	string\|null	Passport number.
data.naturalized_code	string\|null	Naturalized code.

Examples

Success

Request

GET /insured-person-info?insurance=asia&cmnid=123456&policy_id=5001&health_policy_insured_person_id=3001

Response

{
    "ok": true,
    "provider": "mad",
    "insurance": "asia",
    "meta": {
        "provider_status": 200,
        "franshiz_rate": 10,
        "remain_amount": 5000000
    },
    "data": {
        "cmn_id": 123456,
        "birth_year": 1400,
        "gender": {
            "slug": "male",
            "label": "Male"
        },
        "identity_no": "1234567890",
        "national_code": "1234567890",
        "first_name": "Example",
        "last_name": "Person",
        "is_iranian": true,
        "passport_no": null,
        "naturalized_code": null
    }
}

Success (Dana)

Request

GET /insured-person-info?insurance=dana&cmnid=1234567890&policy_id=7001&health_policy_insured_person_id=8101&illness_id=2699

Response

{
    "ok": true,
    "provider": "dana",
    "insurance": "dana",
    "meta": {
        "provider_status": 200,
        "franshiz_rate": 10,
        "remain_amount": 9956288691,
        "base_insurance": {
            "id": 780,
            "label": "Social Security"
        },
        "insurance_amount": 9956288691,
        "base_coverage_amount": 99999999999,
        "family_coverage_amount": 0,
        "kart_talaei_amount": 0
    },
    "data": {
        "cmn_id": 11078530,
        "birth_year": 1379,
        "gender": {
            "slug": "male",
            "label": "Male"
        },
        "identity_no": "1234567890",
        "national_code": "1234567890",
        "first_name": "Example",
        "last_name": "Person",
        "is_iranian": true,
        "passport_no": null,
        "naturalized_code": null
    }
}