Skip to main content
GET
/
v1
/
policy-holders
/
{policy_holder_id}
/
policies
cURL
curl --request GET \
  --url https://dev-api-cj-agc-vie.fnstack.dev/v1/policy-holders/{policy_holder_id}/policies \
  --header 'x-api-key: <api-key>'
[
  {
    "status": "ACTIVE",
    "policy_id": "policy_2c1x7V4r47ynM4RABVm1Co0UKkG",
    "policy_type": "CLASSIC_SAVINGS",
    "policy_number": 123,
    "policy_type_name": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
policy_holder_id
string
required
Minimum string length: 1
Example:

"phol_2c1x7V4r47ynM4RABVm1Co0UKkG"

Query Parameters

​
filter
enum<string>
default:ALL
Available options:
CLAIMABLE,
PAYABLE,
ALL

Response

The policy holder's policies

​
status
enum<string>
required
Available options:
ACTIVE,
CANCELED,
EXPIRED,
IN_GRACE_PERIOD,
LAPSED,
PENDING,
SUSPENDED
Example:

"ACTIVE"

​
policy_id
string
required
Minimum string length: 1
Example:

"policy_2c1x7V4r47ynM4RABVm1Co0UKkG"

​
policy_type
enum<string>
required
Available options:
CLASSIC_SAVINGS,
EDUCATIONAL_FORESIGHT,
MOBIL_PROTECT,
PENSION_SAVINGS
Example:

"CLASSIC_SAVINGS"

​
policy_number
number
required
​
policy_type_name
string
required