Sanlam

Connect any or all of the following endpoints to buy and manage auto-products from Sanlam.

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

Buy Auto Comprehensive

Use this end-point to buy auto comprehensive insurance from Sanlam.

POST https://api.mycover.ai/v1/products/sanlam/buy-comprehensive-auto

Request Body

NameTypeDescription

vehicle_make*

string

This is the brand of the vehicle. See Auxiliary endpoints.

vehicle_model*

string

This is the vehicle's model. See Auxiliary endpoints.

address*

string

Customer's physical address

gender*

string

Gender of customer

registration_number*

string

Customer's vehicle registration number

engine_number*

string

Customer's vehicle chassis number

chassis_number*

string

Customer's vehicle chassis number

year_of_manufacture*

string

The year customer's vehicle was manufactured

vehicle_color*

string

Colour of customer's vehicle

first_name*

string

Customer's legal first name

last_name*

string

Customer's legal last name

email*

string

Customer's email address

date_of_birth*

string

Customer's date of birth as it appears on legal documents

phone_number*

string

Customer's phone number

product_id*

string

This is the ID of the insurance plan.

state*

string

Customer's state of residence

identification_name*

string

Type of identity. Must be one of [Drivers License, NIN, International Passport, Phone number]

identification_url*

string

Link to the identification file. Must be a picture file (jpg, png)

vehicle_category*

string

What type of vehicle is it? Must be one of ['Bus', 'Car', 'Jeep - Suv', 'Truck']

vehicle_cost*

number

How much you bought you vehicle.

{
    "responseCode": 1,
    "responseText": "policy purchase successful",
    "data": {
        "id": "f79e59a9-0597-4e11-b196-001d6b19071b",
        "app_mode": "test",
        "active": false,
        "first_name": "John",
        "last_name": "Doe",
        "email": "jon41413302@gmail.com",
        "dob": "1992-04-01",
        "phone": "07114378506",
        "start_date": "2023-12-19T00:00:00.000Z",
        "expiration_date": "2024-12-19T00:00:00.000Z",
        "activation_date": "2023-12-19T00:00:00.000Z",
        "distributor_id": "10cd1dac-3a5c-43ee-b935-641d53f9cb27",
        "customer_id": "43af8e11-afbb-40ec-beb4-85486ff438f1",
        "buyer_id": "43af8e11-afbb-40ec-beb4-85486ff438f1",
        "product_id": "c94e6f4d-e868-4782-bb35-df6e3344ae7e",
        "product_category_id": "978ced0d-0e05-4de6-b43a-b408c0e8b95e",
        "provider_id": "63dbfce7-a743-47bd-bc49-b95703054aa1",
        "meta": {
            "payload": {
                "Dob": "1992-04-01",
                "KYC": null,
                "Email": "khc.jon41413302@gmail.com",
                "Fname": "John",
                "Lname": "Doe",
                "Mname": "N/A",
                "Phone": "07114378506",
                "Gender": "Male",
                "PmtRef": "5d5d3c79-508e-4958-824b-ac61ac754d1d",
                "UserId": "pxv.jon41413302@gmail.com",
                "Address": "Surulere, Lagos, Lagos",
                "AgentId": "001",
                "AmtPaid": 65000,
                "VehMake": "Acura",
                "VehType": "Car",
                "yrManft": "2013",
                "ChasisNo": "SV30-0169220",
                "EngineNo": "PJ12345U123051P",
                "RiskDetl": "7994ac85-9aba-4f34-b5e9-51e23002aa31",
                "VehColor": "BLACK",
                "VehModel": "MDX",
                "VehRegNo": "ABC-103DE",
                "ChannelId": "WEB",
                "CoverType": "Comprehensive",
                "ProductId": "STDC001",
                "Occupation": "N/A",
                "Nationality": "Nigerian",
                "ProductClassId": "AUTO"
            },
            "policy_number": "12/P/WEB/AUTO/00001809/23/19",
            "certificate_url": "",
            "vehicle_registration_number": "ABC-103DE"
        },
        "genius_price": 65000,
        "market_price": 65000,
        "purchase_id": "e2a1d4e7-0c4f-427c-b1d2-80120fd14c0c",
        "profit": 13000,
        "submitted_to_provider": true,
        "updated_at": "2023-12-19T09:39:08.514Z",
        "created_at": "2023-12-19T09:39:08.514Z",
        "deleted_at": null,
        "inspection_id": null
    }
}
Sample Request Payload
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "jon41413302@gmail.com",
  "phone_number": "07114378506",
  "date_of_birth": "1992-04-01",
  "address": "Surulere, Lagos",
  "gender": "Male",
  "state": "Lagos",
  "identification_name": "Drivers License",
  "identification_url": "https://via.placeholder.com/300/09f/fff.png",
  "vehicle_category": "Car",
  "registration_number": "ABC-103DE",
  "engine_number": "PJ12345U123051P",
  "chassis_number": "SV30-0169220",
  "vehicle_make": "Acura",
  "vehicle_model": "MDX",
  "vehicle_color": "BLACK",
  "year_of_manufacture": "2013",
  "vehicle_cost": 1300000,
  "product_id": "c94e6f4d-e868-4782-bb35-df6e3344ae7e"
}

Buy Third-party Auto

Use this end-point to buy third-party insurance from Sanlam.

POST https://api.mycover.ai/v1/products/sanlam/buy-third-party-auto

Request Body

NameTypeDescription

vehicle_make*

string

This is the brand of the vehicle. See Auxiliary endpoints.

vehicle_model*

string

This is the vehicle's model. See Auxiliary endpoints.

address*

string

Customer's physical address

gender*

string

Gender of customer

registration_number*

string

Customer's vehicle registration number

engine_number*

string

Customer's vehicle chassis number

chassis_number*

string

Customer's vehicle chassis number

year_of_manufacture*

string

The year customer's vehicle was manufactured

vehicle_color*

string

Colour of customer's vehicle

first_name*

string

Customer's legal first name

last_name*

string

Customer's legal last name

email*

string

Customer's email address

date_of_birth*

string

Customer's date of birth as it appears on legal documents

phone_number*

string

Customer's phone number

product_id*

string

This is the ID of the insurance plan.

state*

string

Customer's state of residence

identification_name*

string

Type of identity. Must be one of [Drivers License, NIN, International Passport, Phone number]

identification_url*

string

Link to the identification file. Must be a picture file (jpg, png)

vehicle_category*

string

What type of vehicle is it? Must be one of ['Bus', 'Car', 'Jeep - Suv', 'Truck']

{
    "responseCode": 1,
    "responseText": "policy purchase successful",
    "data": {
        "id": "a60a806f-47ae-48c7-a619-bbffbcff54ac",
        "app_mode": "test",
        "active": true,
        "first_name": "John",
        "last_name": "Doe",
        "email": "jon41413302@gmail.com",
        "dob": "1992-04-01",
        "phone": "07114378506",
        "start_date": "2023-12-20T00:00:00.000Z",
        "expiration_date": "2024-12-20T00:00:00.000Z",
        "activation_date": "2023-12-20T00:00:00.000Z",
        "distributor_id": "10cd1dac-3a5c-43ee-b935-641d53f9cb27",
        "customer_id": "43af8e11-afbb-40ec-beb4-85486ff438f1",
        "buyer_id": "43af8e11-afbb-40ec-beb4-85486ff438f1",
        "product_id": "b83d5f4d-e868-4782-bb35-df6e3344ae7d",
        "product_category_id": "978ced0d-0e05-4de6-b43a-b408c0e8b95e",
        "provider_id": "63dbfce7-a743-47bd-bc49-b95703054aa1",
        "meta": {
            "payload": {
                "Dob": "1992-04-01",
                "KYC": null,
                "Email": "gfi.jon41413302@gmail.com",
                "Fname": "John",
                "Lname": "Doe",
                "Mname": "N/A",
                "Phone": "07114378506",
                "Gender": "Male",
                "PmtRef": "5846f579-a3eb-4378-ae11-5ea322e65947",
                "UserId": "jla.jon41413302@gmail.com",
                "Address": "Surulere, Lagos, Lagos",
                "AgentId": "001",
                "AmtPaid": 15000,
                "VehMake": "Acura",
                "VehType": "Car",
                "yrManft": "2013",
                "ChasisNo": "SV30-0169220",
                "EngineNo": "PJ12345U123051P",
                "RiskDetl": "a0e64785-a2d8-4818-b7c2-0b4023ec215f",
                "VehColor": "BLACK",
                "VehModel": "MDX",
                "VehRegNo": "ABC-103DE",
                "ChannelId": "WEB",
                "CoverType": "Third Party",
                "ProductId": "TPO0001",
                "Occupation": "N/A",
                "Nationality": "Nigerian",
                "ProductClassId": "AUTO"
            },
            "policy_number": "12/P/WEB/AUTO/00001810/23/20",
            "certificate_url": "",
            "vehicle_registration_number": "ABC-103DE"
        },
        "genius_price": 15000,
        "market_price": 15000,
        "purchase_id": "616bbdc8-7dfa-45e3-b245-b569496e1927",
        "profit": 3000,
        "submitted_to_provider": true,
        "updated_at": "2023-12-20T11:47:55.231Z",
        "created_at": "2023-12-20T11:47:55.231Z",
        "deleted_at": null,
        "inspection_id": null
    }
}
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "jon41413302@gmail.com",
  "phone_number": "07114378506",
  "date_of_birth": "1992-04-01",
  "address": "Surulere, Lagos",
  "gender": "Male",
  "state": "Lagos",
  "identification_name": "Drivers License",
  "identification_url": "https://via.placeholder.com/300/09f/fff.png",
  "vehicle_category": "Car",
  "registration_number": "ABC-103DE",
  "engine_number": "PJ12345U123051P",
  "chassis_number": "SV30-0169220",
  "vehicle_make": "Acura",
  "vehicle_model": "MDX",
  "vehicle_color": "BLACK",
  "year_of_manufacture": "2013",
  "product_id": "b83d5f4d-e868-4782-bb35-df6e3344ae7d"
}

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

Auxiliary

Last updated