Home Protection Plan APIs Create ADLD Policy

Create ADLD Policy API

This API allows external partners to create an Accidental Damage & Liquid Damage (ADLD) protection policy. It validates authentication, required fields, product eligibility, duration limits, calculates the protection plan price, generates a unique policy ID, and saves the policy record.

POST https://api.bigfix.in/api/assurify/adld-policy/
Purpose: Submit all required customer, device, and plan details to create and activate an ADLD protection policy. Returns the generated policy ID, warranty dates, and order information.

Authentication

All API requests must include the API key in the request header.

Header Type Required Description
X-API-Key string Required Your Assurify API key for authentication
Content-Type string Required application/json

Request Body Parameters

All fields marked as required must be included in the request payload.

Parameter Type Required Description
product string Required Product type (e.g., "Mobile", "Laptop"). Must be eligible for ADLD coverage.
duration string Required Plan duration in format "1 Year", "2 Years", etc. Must not exceed the maximum allowed duration for the product category.
deviceprice number Required Purchase price of the device. Used to calculate the protection plan premium.
name string Required Full name of the customer
email string Required Customer's email address
phone string Required Customer's phone number
address string Required Customer's full address
city string Required City name
state string Required State name
pincode string Required Postal/ZIP code
brand string Required Device brand (e.g., "Apple", "Samsung"). Used to determine the applicable premium rate.
model string Required Device model name or number
imei1_serialno string Required Device IMEI number or serial number
policysource string Required Partner/source company name. Must match an existing Assurify account.
brand_warranty_duration integer Required Manufacturer warranty duration in years (e.g., 1, 2). Used to calculate brand warranty end date.
Validation Rules: All 15 fields are mandatory. Duration must follow the format "1 Year" or "2 Years". The product must be eligible for ADLD coverage. Duration must not exceed the category maximum. The brand must have a defined rate under the product category. The policysource must match an existing Assurify account.

Success Response

On successful policy creation, the API returns HTTP 201 Created with the following fields:

Field Type Description
policyid string Generated unique policy ID (e.g., B250217P0010001)
device purchase date datetime Timestamp when the policy was created (used as device purchase date)
brand warranty start datetime Brand warranty start date (same as device purchase date)
brand warranty end datetime Brand warranty end date, calculated as start date + brand_warranty_duration years
plan purchase date datetime Timestamp when the protection plan was purchased
policy status string Always "Created" on successful policy creation
protection plan price number Calculated premium: deviceprice × rate × years, rounded to 2 decimal places
orderid string Generated cart order ID (format: BASC{count})

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
401 Unauthorized Authorization header is missing Include the X-API-Key header in your request
401 Unauthorized Un-Authorized API Call Ensure the X-API-Key value is valid and active
400 Bad Request One or more required fields are missing or empty Ensure all 15 required fields are present and non-empty
400 Validation Error Invalid duration format Use format "1 Year", "2 Years", etc.
400 Validation Error Product is not eligible for ADLD insurance Use a product type supported under ADLD coverage
400 Validation Error Duration exceeds maximum allowed for product category Reduce the duration to within the allowed limit for the product
400 Validation Error Rate not defined for the given brand and category Use a supported brand for the selected product
400 Validation Error ADLD plan not available for the given product and duration Verify the plan exists for the selected product and duration combination
400 Validation Error Policy source account does not exist Ensure policysource matches a valid registered Assurify account name
400 Serializer Error Policy or cart data failed validation Check the response body for specific field-level errors
Best Practice: Always store the returned policyid and orderid for future tracking, claims, and reconciliation purposes.
Home Protection Plan APIs ADLD Protection Plans

ADLD Protection Plans API

This API allows external partners to fetch Accidental Damage & Liquid Damage (ADLD) protection plan pricing. It validates the API key, checks mandatory query parameters, maps the product to its category, and returns applicable plan premiums based on device price and brand type.

GET https://api.bigfix.in/api/assurify/get-protection-plans/
Purpose: Retrieve ADLD protection plan premiums for a specific product, brand type, and device price. Returns all eligible plan durations with calculated premiums.

Authentication

All API requests must include the API key in the request header.

Header Type Required Description
X-API-Key string Required Your Assurify API key for authentication

Query Parameters

All three parameters are mandatory and must be passed as URL query strings.

Parameter Type Required Description
product string Required Product type (e.g., "Mobile", "Laptop", "Tablet"). Must be a product covered under ADLD plans.
brand_type string Required Brand type of the device. Accepted values: "Apple" or "Non-Apple"
deviceprice number Required Purchase price of the device. Must be a positive number greater than zero.
Validation Rules: All three query parameters are mandatory. Device price must be a positive numeric value greater than zero. Brand type must be either "Apple" or "Non-Apple". The product must be mapped to a supported ADLD category.

Success Response

When the request is valid, the API returns protection plan options with calculated premiums:

Field Type Description
Product string The product type passed in the request
Device Price number The device price passed in the request
Protection Plan Type string Always returns "ADLD"
Protection Plans object Key-value pairs of eligible plan durations and their premium amounts (e.g., "1 Year": 1500.00, "2 Year": 1500.00). Premiums are calculated as deviceprice × category_rate, rounded to 2 decimal places.

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
401 Unauthorized Authorization header is missing Include the X-API-Key header in your request
401 Unauthorized Un-Authorized API Call Ensure the X-API-Key value is valid and active
400 Bad Request Missing mandatory query parameters Provide product, brand_type, and deviceprice in the query string
400 Validation Error Invalid device price (non-numeric or zero/negative) Pass a positive numeric value for deviceprice
400 Validation Error Product is not covered under ADLD plans Use a supported product type available in the ADLD category map
400 Validation Error Invalid brand type for the given product Use "Apple" or "Non-Apple" as the brand_type value
Best Practice: Cache plan responses on your end where possible, as premiums for the same product, brand type, and price will return consistent results.
Home Protection Plan APIs Get Protection Plans

Get Protection Plans API

This API allows external partners to fetch available protection plan pricing for a given product and device price. It validates authentication, maps the product to its category, applies configured rates, and returns all eligible plan durations with calculated premiums.

GET https://api.bigfix.in/api/assurify/adld/protection-plans/
Purpose: Retrieve protection plan premium options for a specific product and device price. Supports both GET query parameters and POST body input. Returns all available plan durations with calculated premiums.

Authentication

All API requests must include the API key in the request header.

Header Type Required Description
X-API-Key string Required Your Assurify API key for authentication

Request Parameters

Parameters can be passed either as URL query strings (GET) or in the request body (POST). Both methods are supported.

Parameter Type Required Description
product string Required Product type (e.g., "Mobile", "Laptop", "Tablet"). Case-insensitive — automatically normalised to Title Case. Must be a product supported under protection plans.
deviceprice number Required Purchase price of the device. Must be a positive numeric value greater than zero. Used to calculate plan premiums.
Validation Rules: Both product and deviceprice are mandatory. Device price must be a positive number greater than zero — invalid or non-numeric values default to 0 and will be rejected. Product names are trimmed and normalised to Title Case before lookup.

Success Response

When the request is valid, the API returns HTTP 200 OK with all eligible plan durations and their premiums:

Field Type Description
Product string The normalised product name used for the lookup
Device Price number The device price passed in the request
Protection Plans object Key-value pairs of available plan durations and their calculated premiums (e.g., "1 Year": 1500.00, "2 Year": 2800.00). Premiums are computed as deviceprice × rate, rounded to 2 decimal places. Only durations with a configured rate are returned.

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
401 Unauthorized Authorization header is missing Include the X-API-Key header in your request
401 Unauthorized Un-Authorized API Call Ensure the X-API-Key value is valid and active
400 Bad Request Product name or device price is missing or device price is zero/negative Provide both product and a positive numeric deviceprice
400 Validation Error Product is not covered under any protection plan. Response includes a supported_products list. Use one of the supported product types returned in the error response
500 Server Error Rates not configured for the product's category Contact support — category rate configuration is missing on the server
Best Practice: Use the supported_products list returned in the 400 error response to build dynamic product dropdowns in your integration, ensuring only valid products are submitted.
Home Protection Plan APIs Create Protection Policy

Create Protection Policy API

This API allows external partners to create an Extended Warranty protection policy. It validates authentication, required fields, product eligibility, duration limits, calculates the protection plan price using category-based rates, generates a unique policy ID, and saves the policy and cart records.

POST https://api.bigfix.in/api/assurify/create-policy/
Purpose: Submit all required customer, device, and plan details to create and activate an Extended Warranty protection policy. Returns the generated policy ID, dates, plan price, and order information.

Authentication

All API requests must include the API key in the request header.

Header Type Required Description
X-API-Key string Required Your Assurify API key for authentication
Content-Type string Required application/json

Request Body Parameters

All fields marked as required must be included in the request payload.

Parameter Type Required Description
product string Required Product type (e.g., "Mobile", "Laptop", "Tablet"). Must be covered under Extended Warranty plans.
duration string Required Plan duration in format "1 Year", "2 Years", etc. Must not exceed the maximum allowed duration for the product category.
deviceprice number Required Purchase price of the device. Used to calculate the protection plan premium.
name string Required Full name of the customer
email string Required Customer's email address
phone string Required Customer's phone number
address string Required Customer's full address
city string Required City name
state string Required State name
pincode string Required Postal/ZIP code
brand string Required Device brand name (e.g., "Apple", "Samsung", "Dell")
model string Required Device model name or number
imei1_serialno string Required Device IMEI number or serial number
policysource string Required Partner/source company name. Must exactly match a registered Assurify account name.
brand_warranty_duration integer Required Manufacturer warranty duration in years (e.g., 1, 2). Used to calculate brand warranty start and end dates.
Validation Rules: All 15 fields are mandatory and must not be empty. Duration must match the format "1 Year" or "2 Years". The product must be covered under Extended Warranty plans. Duration must not exceed the category's maximum allowed years. The policysource must exactly match a registered Assurify account name. The plan must exist for the given product and duration combination.

Success Response

On successful policy creation, the API returns HTTP 201 Created with the following fields:

Field Type Description
policyid string Generated unique policy ID (format: B{YYMMDD}P{plan}{sequence}, e.g., B250217P0010001)
device purchase date datetime Timestamp of when the policy was created, used as the device purchase date
plan purchase date datetime Same as device purchase date — the timestamp when the protection plan was purchased
policy status string Always "Created" on successful policy creation
protection plan price number Calculated premium: deviceprice × category_rate[duration_index], rounded to 2 decimal places
orderid string Generated cart order ID (format: BASC{count}, e.g., BASC1042)

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
401 Unauthorized Authorization header is missing Include the X-API-Key header in your request
401 Unauthorized Un-Authorized API Call Ensure the X-API-Key value is valid and active
400 Bad Request One or more required fields are missing or empty Ensure all 15 required fields are present and non-empty
400 Validation Error Invalid duration format Use format "1 Year", "2 Years", etc.
400 Validation Error Product is not covered under Extended Warranty plans Check the list of supported products for insurance
400 Validation Error Duration exceeds the maximum allowed years for the product category Reduce the duration to within the allowed limit for the product
400 Validation Error Extended Warranty plan not available for the given product and duration Verify the plan exists for the selected product and duration combination
400 Validation Error Policy source account does not exist Ensure policysource exactly matches a registered Assurify account name
400 Serializer Error Policy or cart data failed serializer validation Check the response body for specific field-level errors
Best Practice: Always store the returned policyid and orderid for future tracking, claims processing, and reconciliation. Call the Get Protection Plans API first to confirm the plan price before submitting a policy creation request.