Aiico

Connect the following endpoints to buy and manage content insurance from AIICO.

Certain properties obtain their values from supplementary endpoints. Refer to the Auxiliary page for a list of these additional endpoints.

Buy Office Content Cover

Use this end-point to buy Content Cover for Office belongings for your customers from AIICO.

See Auxiliary for more endpoints

POST https://api.mycover.ai/v1/products/aiico/buy-office-content-cover

See Auxiliary APIs for additional data for - GET /title - GET /gender

Request Body

Name

Type

Description

pre_ownership*

string

tenancy*

string

address*

string

Customer's legal address

office_items*

array

Array of office items objects. Check below for description

lga*

string

LGA of the customer. Refer to features list using miscellaneous link below

is_full_year*

string

Customer's purchase type whether a full year purchase or not. (true, false)

first_name*

string

Customer's legal first name

last_name*

string

Customer's legal last name

email*

string

Customer's valid email address

phone_number*

string

Customer's valid phone number

date_of_birth*

string

Customer's date of birth

title*

string

Title of customer ('Mr', 'Engr'....). Refer to titles list in miscellaneous link below.

gender*

string

Customer's gender

identification_name*

string

ID type of the customer. Refer to ID types using miscellaneous link below

identification_url*

string

Image URL of the customer ID

insurance_start_date*

string

Start date of the insurance

product_id*

string

ID of the insurance plan

{
    "responseCode": 1,
    "responseText": "policy purchase successful",
    "data": {
        "id": "1b9d36bf-f0ae-4053-a5f9-83e8d5e3aa28",
        "app_mode": "test",
        "active": true,
        "first_name": "Kato",
        "last_name": "Pearson",
        "email": "loxa@mailinator.com",
        "dob": "2004-03-05",
        "phone": "+1 (549) 631-9254",
        "start_date": "2023-09-13T00:00:00.000Z",
        "expiration_date": "2024-09-13T00:00:00.000Z",
        "activation_date": "2023-09-13T00:00:00.000Z",
        "distributor_id": "92e39bc5-6110-4dcb-8583-bc50c2e6922b",
        "customer_id": "b93afc90-54ab-4d1c-8e35-907019b05e7f",
        "buyer_id": "b93afc90-54ab-4d1c-8e35-907019b05e7f",
        "product_id": "57a6df7e-87f4-40e8-bf78-5b1f85c6d87e",
        "product_category_id": "9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
        "provider_id": "63dbfce7-a743-47bd-bc49-b95703054aa1",
        "meta": {
            "payload": {
                "wef": "2023-09-13",
                "wet": "2024-09-13",
                "lgaId": "fc33ae6c-98e4-e711-83bb-44850015c0e4",
                "smsTel": "+1 (549) 631-9254",
                "TitleId": "0c439e44-98cf-e711-83b7-44850015c0e7",
                "address": "Est est cillum neque",
                "tenancy": "Debitis consequat V",
                "GenderId": "01439e44-98cf-e711-83b7-44850015c0e7",
                "lastName": "Pearson",
                "pryEmail": "jbm.loxa@mailinator.com",
                "firstName": "Kato",
                "productId": "1a2f284a-6325-e811-a2cc-005056a02281",
                "isFullYear": true,
                "dateOfBirth": "2004-03-05",
                "officeItems": [
                    {
                        "name": "Air conditioner",
                        "amount": "150000"
                    },
                    {
                        "name": "Table",
                        "amount": "100000"
                    },
                    {
                        "name": "Chairs",
                        "amount": "130000"
                    }
                ],
                "preOwnership": "Ea ab amet blanditi",
                "physicalAddrs": "Est est cillum neque",
                "valueOfContents": "0150000100000130000",
                "identificationUrl": "https://via.placeholder.com/300/09f/fff.png",
                "identificationName": "International Passport",
                "subclassSectCovtypeId": "9668e363-5d25-e811-a2cc-005056a02281"
            },
            "policy_number": "120500512301",
            "certificate_url": null,
            "provider_policy_id": 0
        },
        "genius_price": 10000,
        "market_price": 10000,
        "purchase_id": "540305c4-7ea6-498b-a44f-ab60a0c045dd",
        "profit": 2000,
        "submitted_to_provider": true,
        "updated_at": "2023-09-13T08:02:28.714Z",
        "created_at": "2023-09-13T08:02:28.714Z",
        "deleted_at": null,
        "inspection_id": null
    }
}

The office_items parameter above is an array of object. Below are the parameters of the object.

"office_items": [
    {
      "name": "string",
      "amount": 0
    }
  ]

Sample Request Payload

{
   "first_name":"Kato",
   "last_name":"Pearson",
   "email":"loxa@mailinator.com",
   "phone_number":"+1 (549) 631-9254",
   "date_of_birth":"2004-03-05",
   "address":"Est est cillum neque",
   "gender":"Male",
   "product_id":"57a6df7e-87f4-40e8-bf78-5b1f85c6d87e",
   "pre_ownership":"Ea ab amet blanditi",
   "identification_name":"International Passport",
   "identification_url":"https://via.placeholder.com/300/09f/fff.png",
   "tenancy":"Debitis consequat V",
   "lga":"ABIA-Ikwuano",
   "is_full_year":true,
   "insurance_start_date":"2022-03-10",
   "title":"Excellency",
   "office_items":[
      {
         "name":"Air conditioner",
         "amount":"150000"
      },
      {
         "name":"Table",
         "amount":"100000"
      },
      {
         "name":"Chairs",
         "amount":"130000"
      }
   ]
}

Buy Home Content Cover

Use this end-point to buy Content Cover for Home belongings for your customers from AIICO.

POST https://api.mycover.ai/v1/products/aiico/buy-home-content-cover

See Auxiliary APIs for additional data for - GET /title - GET /gender

Request Body

Name

Type

Description

pre_ownership*

string

tenancy*

string

description*

string

address*

string

home_items*

array of objects

lga*

string

is_full_year*

string

first_name*

string

last_name*

string

email*

string

phone_number*

string

date_of_birth*

string

title*

string

gender*

string

identification_name*

string

identification_url*

string

insurance_start_date*

string

product_id*

string

{
   "responseCode":1,
   "responseText":"policy purchase successful",
   "data":{
      "first_name":"Cassandra",
      "last_name":"Stewart",
      "email":"terucafan@mailinator.com",
      "phone":"+1 (148) 113-4481",
      "dob":"2004-03-04",
      "customer_id":"49731594-f147-4d87-a119-1963c083399f",
      "buyer_id":"49731594-f147-4d87-a119-1963c083399f",
      "product_id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
      "product_category_id":"9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
      "distributor_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
      "provider_id":"63dbfce7-a743-47bd-bc49-b95703054aa1",
      "activation_date":"2022-03-03",
      "start_date":"2022-03-03",
      "expiration_date":"Fri, 02 Sep 2022 23:00:00 GMT",
      "meta":{
         "policy_number":"121501332201",
         "certificate_url":null,
         "provider_policy_id":0,
         "payload":{
            "preOwnership":"Facere unde et vero",
            "tenancy":"Dolor ullamco explic",
            "address":"Aliqua Sint esse l",
            "homeItems":[
               {
                  "name":"Mallory Smith",
                  "amount":"53"
               },
               {
                  "name":"Steven Knox",
                  "amount":"62"
               }
            ],
            "subclassSectCovtypeId":"3f439e93-5d25-e811-a2cc-005056a02281",
            "lgaId":"fc33ae6c-98e4-e711-83bb-44850015c0e4",
            "isFullYear":false,
            "valueOfContents":"05362",
            "TitleId":"0c439e44-98cf-e711-83b7-44850015c0e7",
            "GenderId":"01439e44-98cf-e711-83b7-44850015c0e7",
            "firstName":"Cassandra",
            "lastName":"Stewart",
            "dateOfBirth":"2004-03-04",
            "pryEmail":"terucafan@mailinator.com",
            "smsTel":"+1 (148) 113-4481",
            "physicalAddrs":"Aliqua Sint esse l",
            "wef":"2022-03-03",
            "wet":"Fri, 02 Sep 2022 23:00:00 GMT",
            "productId":"52f33528-6325-e811-a2cc-005056a02281",
            "identificationName":"Drivers License",
            "identificationUrl":"https://s3.eu-west-2.amazonaws.com/staging.mycover.ai/3cde40c3-ec99-4c6a-91d4-cc90a8f345fa-cassandra_stewart_1647509840772_screenshot-2021-08-16-at-3.58.28-pm.png"
         }
      },
      "active":true,
      "genius_price":"10000.00",
      "market_price":"10000.00",
      "profit":2000,
      "purchase_id":"7247d8bf-8e6e-4840-a39f-027717a4a5ca",
      "submitted_to_provider":true,
      "id":"bf90045a-3b96-4d8b-a87c-8a0fe7633ed3",
      "created_at":"2022-03-17T08:37:26.005Z",
      "updated_at":"2022-03-17T08:37:26.005Z"
   }
}

Sample Request Payload

{
   "first_name":"Evangeline",
   "last_name":"Frederick",
   "email":"zywobekyga@mailinator.com",
   "phone_number":"+1 (242) 349-5809",
   "date_of_birth":"2004-03-11",
   "address":"Officiis et quo inci",
   "gender":"Male",
   "product_id":"0386fe30-a3be-4ff2-a64a-048d2c99504b",
   "pre_ownership":"In fugiat ab in sin",
   "identification_name":"Drivers License",
   "identification_url":"https://via.placeholder.com/300/09f/fff.png",
   "tenancy":"Sed qui sed animi c",
   "lga":"ABIA-Ikwuano",
   "is_full_year":false,
   "description":"Praesentium nisi exe",
   "insurance_start_date":"2022-03-09",
   "title":"Clergyman",
   "home_items":[
      {
         "name":"Television",
         "amount":"150000"
      },
      {
         "name":"Sound bar",
         "amount":"120000"
      },
      {
         "name":"Air conditioner",
         "amount":"200000"
      },
      {
         "name":"Furnitures",
         "amount":"200000"
      }
   ]
}

Buy Shop Content Cover

Buy AIIco shop content cover for SME business owners

POST https://api.mycover.ai/v1/products/aiico/buy-shop-content-cover

See Auxiliary APIs for additional data for - GET /title - GET /gender

Request Body

Name

Type

Description

shop_type*

string

The type of the shop

nature_of_business*

string

The nature of the business

nature_of_stock*

string

The nature of the stock either perishable, non perishable, or mixed

stock_keeping*

boolean

Is it a stock keeping shop?

stock_taking_interval*

string

How often do you do stock taking? Either daily, weekly, monthly, quarterly, or yearly

stock_amount*

number

The total cost of all the goods in the shop

address*

string

The shop address

title*

string

The shop owner's title e.g Chief

gender*

string

The shop owner's gender e.g Male

identification_name*

string

Type of identification. Acceptable: Drivers License, NIN, International Passport

identification_url*

string

The image url after uploading the identification

first_name*

string

Owner's first name

last_name*

string

Owner's last name

email*

string

Owner's email

phone_number*

string

Owner's phone number

date_of_birth*

string

Owner's date of birth

product_id*

string

The product's UID

{
    "responseCode": 1,
    "responseText": "policy purchase successful",
    "data": {
        "id": "f853ce34-fe3e-4646-8768-b0322d1f4599",
        "app_mode": "test",
        "active": true,
        "first_name": "Jahohash",
        "last_name": "Bilblo",
        "email": "fabaro4721@onlcool.com",
        "dob": "1996-03-11",
        "phone": "09027773827",
        "start_date": "2023-09-05T00:00:00.000Z",
        "expiration_date": "2024-09-05T00:00:00.000Z",
        "activation_date": "2023-09-05T00:00:00.000Z",
        "distributor_id": "92e39bc5-6110-4dcb-8583-bc50c2e6922b",
        "customer_id": "3df902c8-5475-4fdb-9a45-d09aec17c94a",
        "buyer_id": "3df902c8-5475-4fdb-9a45-d09aec17c94a",
        "product_id": "58a6df7e-87f4-40e8-bf78-5b1f85c6d87f",
        "product_category_id": "9e9d5fe0-2129-41a5-9f44-9c9fe90b3855",
        "provider_id": "63dbfce7-a743-47bd-bc49-b95703054aa1",
        "meta": {
            "payload": {
                "wef": "2023-09-05",
                "wet": "2024-09-05",
                "smsTel": "09027773827",
                "TitleId": "08439e44-98cf-e711-83b7-44850015c0e7",
                "address": "Officiis et quo inci",
                "GenderId": "01439e44-98cf-e711-83b7-44850015c0e7",
                "lastName": "Bilblo",
                "pryEmail": "gls.fabaro4721@onlcool.com",
                "firstName": "Jahohash",
                "productId": "939e9f6c-6325-e811-a2cc-005056a02281",
                "isFullYear": true,
                "typeOfShop": "Retail",
                "dateOfBirth": "1996-03-11",
                "stockAmount": 700000,
                "natureOfStock": "perishable",
                "physicalAddrs": "Officiis et quo inci",
                "premiumAmount": "15000.00",
                "keepsStockBook": true,
                "stockTakingMode": "daily",
                "natureOfBusiness": "Alumako",
                "identificationUrl": "https://via.placeholder.com/300/09f/fff.png",
                "natureOfStructure": "Alumako",
                "identificationName": "Drivers License",
                "subclassSectCovtypeId": "99e246a7-5d25-e811-a2cc-005056a02281",
                "keepsStockBookInSafePlace": true
            },
            "policy_number": "120600282301",
            "certificate_url": null,
            "provider_policy_id": 0
        },
        "genius_price": 15000,
        "market_price": 15000,
        "purchase_id": "5aefcb2e-a84e-4c3f-bf6e-0eeef481dc0a",
        "profit": 3000,
        "submitted_to_provider": true,
        "updated_at": "2023-09-05T10:55:14.172Z",
        "created_at": "2023-09-05T10:55:14.172Z",
        "deleted_at": null,
        "inspection_id": null
    }
}

Sample payload

{
  "shop_type": "Retail",
  "nature_of_business": "Alumako",
  "nature_of_stock": "perishable",
  "stock_keeping": true,
  "stock_taking_interval": "daily",
  "stock_amount": 700000,
  "address": "Officiis et quo inci",
  "title": "Chief",
  "gender": "Male",
  "identification_name": "Drivers License",
  "identification_url": "https://via.placeholder.com/300/09f/fff.png",
  "first_name": "Jahohash",
  "last_name": "Bilblo",
  "email": "fabaro4721@onlcool.com",
  "phone_number": "09027773827",
  "date_of_birth": "1996-03-11",
  "product_id": "58a6df7e-87f4-40e8-bf78-5b1f85c6d87f"
}

Auxiliary

Certain properties obtain their values from supplementary endpoints. Refer to the Auxiliary page for a list of these additional endpoints.

PreviousContent (Home/Office)NextCoronation

Last updated 9 months ago

Was this helpful?

Buy Office Content Cover

See Auxiliary for more endpoints

Request Body

Buy Home Content Cover

See Auxiliary for more related endpoints

Request Body

Buy Shop Content Cover

See Auxiliary for more related endpoints

Request Body