Create a new policy

POST 
/v1/policies

Request

application/json

Body

required

oneOf
ThirdPartyPurchaseData
product_id stringrequired
Product ID of the policy to be created
chassis_number stringrequired
Chassis number of the vehicle
manufacturer stringrequired
Manufacturer of the vehicle
model stringrequired
Model of the vehicle
year stringrequired
Year of manufacture of the vehicle
vehicle_regno stringrequired
Registration number of the vehicle
engine_no stringrequired
Engine number of the vehicle
color stringrequired
Color of the vehicle
vehicle_type stringrequired
Possible values: [Van, Cargo/Truck, Pick Up, SUV/Crossover, Saloon Car, Bus, Minivan, Trailer]
Type of the vehicle
email stringrequired
Email of the user
name stringrequired
Name of the user
phone stringrequired
Phone number of the user
gender stringrequired
Possible values: [male, female]
gender of the user
address stringrequired
Address of the user
license_number stringrequired
License number of the user
license_expiry daterequired
License expiry date of the user
ComprehensivePurchaseData
product_id stringrequired
Product ID of the policy to be created
chassis_number stringrequired
Chassis number of the vehicle
manufacturer stringrequired
Manufacturer of the vehicle
model stringrequired
Model of the vehicle
year stringrequired
Year of manufacture of the vehicle
vehicle_regno stringrequired
Registration number of the vehicle
engine_no stringrequired
Engine number of the vehicle
color stringrequired
Color of the vehicle
vehicle_type stringrequired
Possible values: [Van, Cargo/Truck, Pick Up, SUV/Crossover, Saloon Car, Bus, Minivan, Trailer]
Type of the vehicle
email stringrequired
Email of the user
name stringrequired
Name of the user
phone stringrequired
Phone number of the user
gender stringrequired
Possible values: [male, female]
gender of the user
address stringrequired
Address of the user
license_number stringrequired
License number of the user
license_expiry daterequired
License expiry date of the user
vehicle_value_currency string
Currency of the vehicle value
usage string
Possible values: [private, commercial]
Usage of the vehicle
address_proof_file_id integer
ID of the address proof file. Use the ID of the uploaded file
license_file_id integer
ID of the license file. Use the ID of the uploaded file
images object[]
Images of the vehicle
Array [
url string
URL of the file
part string
Possible values: [left, right, rear, front, dashboard, vin, plate_number]
Side of the vehicle
]

Responses

201

OK

application/json

Schema

Schema

id integer

ID of the policy

full_name string

Full name of the user

start_date string

Start date of the policy

policy_type string

Possible values: [third_party, comprehensive]

Type of the policy

purchase_date string

Date of purchase of the policy

end_date string

End date of the policy

status string

Status of the policy

product string

Name of the product

premium string

Premium of the policy

policy_document string

URL of the policy document

policy_number string

Number of the policy

Example (from schema)

{
  "id": 0,
  "full_name": "string",
  "start_date": "string",
  "policy_type": "third_party",
  "purchase_date": "string",
  "end_date": "string",
  "status": "string",
  "product": "string",
  "premium": "string",
  "policy_document": "string",
  "policy_number": "string"
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

401

Unauthenticated - no valid API key was provided.

application/json

Schema

Schema

data string

Example (from schema)

{
  "data": "Invalid Token"
}

422

Unprocessable Content

application/json

Schema

Schema

message string
error object
property name* string[]
Array [
string
]

Example (from schema)

{
  "message": "The given data was invalid",
  "error": {}
}

Loading...