Skip to main content
POST
/
policies
Issue policy
curl --request POST \
  --url https://sandbox.yasmina.ai/api/v1/life-snp/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offer_id": "<string>",
  "applicant_id": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "male",
  "smoker": true,
  "policy_term_years": 22,
  "premium_frequency": "monthly",
  "agreed_premium": 51,
  "start_date": "2023-12-25",
  "beneficiaries": [
    {
      "name": "<string>",
      "national_id": "<string>",
      "relationship": "spouse",
      "share_percentage": 50
    }
  ],
  "consent": true
}
'
{
  "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.

Body

application/json
​
offer_id
string
required

Offer identifier returned by /offers.

​
applicant_id
string
required
​
date_of_birth
string<date>
required
​
gender
enum<string>
required
Available options:
male,
female
​
smoker
boolean
required
​
policy_term_years
integer
required
Required range: 5 <= x <= 40
​
premium_frequency
enum<string>
required
Available options:
monthly,
quarterly,
semi_annual,
annual
​
agreed_premium
number
required
Required range: x >= 50
​
start_date
string<date>
required
​
beneficiaries
object[]
required
Minimum array length: 1
​
consent
boolean
required

Customer consents to policy issuance and bank auto-debit.

​
sum_assured
number
Required range: x >= 10000
​
iban
string

Customer bank IBAN for premium collection.

Example:

"SA0380000000608010167519"

​
extra_fields
object

Optional key-value extras (max JSON-encoded size 255 chars).

Response

Created

​
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