BeneficiaryResource

Basic beneficiary information returned by lookup endpoints.

idinteger<int64>

Beneficiary identifier. Long integer.

namestring

Beneficiary full name.

identity_document_typestring

Type of identity document (for example, NATIONAL_IDENTITY_CARD, PASSPORT).

identity_document_idstring

Identity document number.

member_codestring

Sponsor-side member code that identifies the beneficiary in the sponsor's system.

sponsor_slugstring

Slug of the sponsor providing coverage.

general_balance object

Aggregate benefit balance available to the beneficiary.

currency_code object

currency_codestring

default_fraction_digitsinteger<int32>

numeric_codeinteger<int32>

numeric_code_as_stringstring

symbolstring

display_namestring

maximum_benefitnumber

Total benefit granted for the coverage period. Decimal number.

maximum_benefit_availablenumber

Remaining benefit available for the coverage period. Decimal number.

out_of_pocket_accrued_amountnumber

Amount the beneficiary has paid out-of-pocket during the coverage period. Decimal number.

deductible_accrued_amountnumber

Amount accrued toward the beneficiary's deductible during the coverage period. Decimal number.

statusstring

Beneficiary status (for example, ENABLED, DISABLED).

minimum_benefit_required_by_sponsornumber

Minimum benefit amount the sponsor requires to be available before the beneficiary can be served.