GET
/
policies
List policies
curl --request GET \
  --url https://staging.yasmina.ai/api/v1/life-snp/policies \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "client_id": "<string>",
    "provider_policy_id": 123,
    "provider_policy": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "policy_term_years": 123,
    "sum_assured": 123,
    "premium_amount": 123,
    "premium_frequency": "<string>",
    "approval_status": 123,
    "order_status": 123,
    "status": "active",
    "beneficiaries": [
      {
        "name": "<string>",
        "national_id": "<string>",
        "relationship": "<string>",
        "share_percentage": 123
      }
    ],
    "iban_masked": "SA03*****************519",
    "is_claimed": true,
    "canceled_at": "<string>",
    "invoice": "<string>",
    "cancellation_document": "<string>",
    "meta_data": {},
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

id
integer
client_id
string
provider_policy_id
integer
provider_policy
string
start_date
string
end_date
string
policy_term_years
integer
sum_assured
number
premium_amount
number
premium_frequency
string
approval_status
integer
order_status
integer
status
string
Example:

"active"

beneficiaries
object[]
iban_masked
string
Example:

"SA03*****************519"

is_claimed
boolean
canceled_at
string | null
invoice
string
cancellation_document
string
meta_data
object
created_at
string
updated_at
string