Get policies created for your customers

GET 
/v1/policies

This endpoint allows you to get a listing of the policies that were created as a result of successfully proccessed orders made for your customers.

Request

Query Parameters

page integer
Default value: 1
The page of results.
Example: 4
per_page integer
Default value: 15
The maximum number of results per page.
Example: 25
customer_ref string
Filter policies by customer ref
Example: PartnerOne-1
insurance_type string
Possible values: [health, comprehensive_auto, 3rd_party_auto, life, marine, git, credit_life, fire_burglary, gadget, job_loss]
Filter policies by insurance type
Example: git
count integer

Possible values: [0, 1]

Returns only the count of the policies

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id integer
The unique ID of the policy
number string
The policy number
description string
The description of the policy
start_date date
The start date of the coverage
end_date date
The end date of the coverage
status string
Current status of the policy
document_url string
A url to download the polic document.
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
order object
An order for an insurance product
id integer
The unique ID of the order.
status string
the current status of the order.
amount_due float
the amount due for payment by partner, excluding the partner's commission
policy_start_date date
The date when the policy coverage is due to start
asset_ref string
An optional identifier for the asset the insurance covers. You may set this to a value that uniquley identifies the asset on your database.
currency string
The currency of all monetary parameters.
channel string
The channel through which the order was made.
created_at date
product object
An individual insurance product or plan
title string
The name of the product
code string
The unique identifier for technical purposes
id integer
Unique Id of the product.
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
name string
The generally accepted human friendly name
slug string
The unique identifier for technical purposes
cover-benefits object
list of the nefits covered.
created-at string
Date of product creation
price integer
Price of product
premium-type string
Define the product premium tier.
premium-rate-unit integer
premium-rate number
premium number
partner-commision-rate number
min-premium string
premium-rules string
premium_frequency string
Possible values: [monthly, quarterly, annually]
Default value: annually
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
policy object
The policy for which the order was made.
]
links object
first string
last string
prev string
next string
meta object
current_page integer
from integer
total integer

Example (from schema)

{
  "data": [
    {
      "id": 8,
      "number": "PH-34243TF",
      "description": "Lorem ipsum...",
      "start_date": "2022-03-24",
      "end_date": "2023-03-24",
      "status": "active",
      "document_url": "https://grow-api.test/api/v1/policies/1/doc",
      "customer": {
        "ref": "string",
        "email": "string",
        "phone": "408-867-5309",
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "insurer": {
        "code": "AXA",
        "name": "Axa Mansard",
        "logo_url": null,
        "terms_conditions": null
      },
      "order": {
        "id": 2,
        "status": "paid",
        "amount_due": 1470,
        "policy_start_date": "2022-04-06T00:00:00.000000Z",
        "asset_ref": "T2354354",
        "currency": "GHS",
        "channel": "API",
        "created_at": "2022-04-06T10:34:20.000000Z",
        "product": {
          "title": "Comprehensive Car Plan XYZ",
          "code": "auto-com-xyz",
          "id": 1,
          "insurer": {
            "code": "AXA",
            "name": "Axa Mansard",
            "logo_url": null,
            "terms_conditions": null
          },
          "product type": {
            "name": "Goods in Transit",
            "slug": "GIT"
          },
          "cover-benefits": {},
          "created-at": "string",
          "price": 0,
          "premium-type": "string",
          "premium-rate-unit": 0,
          "premium-rate": 0,
          "premium": 0,
          "partner-commision-rate": 0,
          "min-premium": "string",
          "premium-rules": "string",
          "premium_frequency": "annually"
        },
        "customer": {
          "ref": "string",
          "email": "string",
          "phone": "408-867-5309",
          "first_name": "Jane",
          "last_name": "Doe"
        },
        "policy": null
      }
    }
  ],
  "links": {
    "first": "https://api.grow.curacel.co/policies?page=1",
    "last": "https://api.grow.curacel.co/policies?page=3",
    "prev": "https://api.grow.curacel.co/policies?page=1",
    "next": "https://api.grow.curacel.co/policies?page=3"
  },
  "meta": {
    "current_page": 2,
    "from": 1,
    "total": 3
  }
}

422

Unprocessable Content

application/json

Schema

Schema

message string
errors object
customer_ref string[]
... string[]

Example (from schema)

{
  "message": "The given data was invalid",
  "errors": {
    "customer_ref": [
      "The selected customer ref is invalid"
    ],
    "...": [
      "..."
    ]
  }
}

Loading...