POST api/Policy/Motor/CreatePolicy
API URL: https://api.alpsltd.co.uk/api/Policy/Motor/CreatePolicy
Create a new motor legal expenses policy
Request Information
Authorisation Type
Basic Auth
URI Parameters
None.
Body Parameters
AddPolicy| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressDetails |
Standard Address Fields |
Address | |
| ClientDetails |
Client's details |
Client | |
| StartDate |
Date the policy is due to start |
date |
REQUIRED |
| ExpiryDate |
Date the policy is due to expire (policies expire at 23:59:59 on date provided) |
date |
REQUIRED |
| VehicleDetails |
The registration of the vehicle |
Vehicle | |
| InsComName |
The core insurance provider |
string |
Max length: 300 |
| InsPolNum |
The core insurance policy number |
string |
Max length: 200 |
| FeePaidIncIPT |
The amount the end client has paid, including IPT |
decimal number |
REQUIRED |
| CustomerType |
The type of customer ID (See api/Policy/CustomerTypes for options) |
integer |
REQUIRED Range: inclusive between 1 and 5 |
| ProductType |
The type of product ID (See api/Policy/ProductTypes for options) |
integer |
REQUIRED Range: inclusive between 1 and 2 |
Request Formats
application/json, text/json
{
"AddressDetails": {
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"Address4": "sample string 4",
"Postcode": "sample string 5"
},
"ClientDetails": {
"Title": "sample string 1",
"Firstname": "sample string 2",
"Surname": "sample string 3"
},
"StartDate": "2026-05-28T10:57:16.133196+01:00",
"ExpiryDate": "2026-05-28T10:57:16.133196+01:00",
"VehicleDetails": {
"Reg": "sample string 1",
"Make": "sample string 2",
"Model": "sample string 3"
},
"InsComName": "sample string 3",
"InsPolNum": "sample string 4",
"FeePaidIncIPT": 5.0,
"CustomerType": 6,
"ProductType": 7
}
application/xml, text/xml
<AddPolicy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
<AddressDetails>
<Address1>sample string 1</Address1>
<Address2>sample string 2</Address2>
<Address3>sample string 3</Address3>
<Address4>sample string 4</Address4>
<Postcode>sample string 5</Postcode>
</AddressDetails>
<ClientDetails>
<Firstname>sample string 2</Firstname>
<Surname>sample string 3</Surname>
<Title>sample string 1</Title>
</ClientDetails>
<CustomerType>6</CustomerType>
<ExpiryDate>2026-05-28T10:57:16.133196+01:00</ExpiryDate>
<FeePaidIncIPT>5</FeePaidIncIPT>
<InsComName>sample string 3</InsComName>
<InsPolNum>sample string 4</InsPolNum>
<ProductType>7</ProductType>
<StartDate>2026-05-28T10:57:16.133196+01:00</StartDate>
<VehicleDetails>
<Make>sample string 2</Make>
<Model>sample string 3</Model>
<Reg>sample string 1</Reg>
</VehicleDetails>
</AddPolicy>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Policy| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyID |
The new policy ID |
integer | |
| CoverLevel |
The type of policy purchased |
string | |
| BrokerName |
The name of the broker selling the policy |
string | |
| AddressDetails |
Address Fields |
Address | |
| ClientDetails |
The client details |
Client | |
| StartDate |
Date the policy is due to start |
date | |
| ExpiryDate |
Date the policy is due to expire (policies expire at 23:59:59 on date provided) |
date | |
| VehicleDetails |
Vehicle details |
Vehicle | |
| InsComName |
The core insurance company |
string | |
| InsPolNum |
The core insurance policy number |
string | |
| FeePaidIncIPT |
The amount the client has paid, including IPT |
decimal number | |
| IPT |
The IPT amount |
decimal number | |
| ALPSChargeExIPT |
The amount ALPS charge excluding IPT |
decimal number | |
| CustomerType |
The type of customer (See api/Policy/CustomerTypes list) |
string | |
| ProductType |
The type of product (See api/Policy/ProductTypes list) |
string | |
| Documentation |
List of associated documents |
Collection of Documents |
Response Formats
application/json, text/json
{
"PolicyID": 1,
"CoverLevel": "sample string 2",
"BrokerName": "sample string 3",
"AddressDetails": {
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"Address4": "sample string 4",
"Postcode": "sample string 5"
},
"ClientDetails": {
"Title": "sample string 1",
"Firstname": "sample string 2",
"Surname": "sample string 3"
},
"StartDate": "2026-05-28T10:57:16.164914+01:00",
"ExpiryDate": "2026-05-28T10:57:16.164914+01:00",
"VehicleDetails": {
"Reg": "sample string 1",
"Make": "sample string 2",
"Model": "sample string 3"
},
"InsComName": "sample string 6",
"InsPolNum": "sample string 7",
"FeePaidIncIPT": 8.0,
"IPT": 9.0,
"ALPSChargeExIPT": 10.0,
"CustomerType": "sample string 11",
"ProductType": "sample string 12",
"Documentation": [
{
"DocumentName": "sample string 1",
"DocumentType": "sample string 2",
"Bytes": "QEA="
},
{
"DocumentName": "sample string 1",
"DocumentType": "sample string 2",
"Bytes": "QEA="
}
]
}
application/xml, text/xml
<Policy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
<ALPSChargeExIPT>10</ALPSChargeExIPT>
<AddressDetails>
<Address1>sample string 1</Address1>
<Address2>sample string 2</Address2>
<Address3>sample string 3</Address3>
<Address4>sample string 4</Address4>
<Postcode>sample string 5</Postcode>
</AddressDetails>
<BrokerName>sample string 3</BrokerName>
<ClientDetails>
<Firstname>sample string 2</Firstname>
<Surname>sample string 3</Surname>
<Title>sample string 1</Title>
</ClientDetails>
<CoverLevel>sample string 2</CoverLevel>
<CustomerType>sample string 11</CustomerType>
<Documentation>
<Documents>
<Bytes>QEA=</Bytes>
<DocumentName>sample string 1</DocumentName>
<DocumentType>sample string 2</DocumentType>
</Documents>
<Documents>
<Bytes>QEA=</Bytes>
<DocumentName>sample string 1</DocumentName>
<DocumentType>sample string 2</DocumentType>
</Documents>
</Documentation>
<ExpiryDate>2026-05-28T10:57:16.164914+01:00</ExpiryDate>
<FeePaidIncIPT>8</FeePaidIncIPT>
<IPT>9</IPT>
<InsComName>sample string 6</InsComName>
<InsPolNum>sample string 7</InsPolNum>
<PolicyID>1</PolicyID>
<ProductType>sample string 12</ProductType>
<StartDate>2026-05-28T10:57:16.164914+01:00</StartDate>
<VehicleDetails>
<Make>sample string 2</Make>
<Model>sample string 3</Model>
<Reg>sample string 1</Reg>
</VehicleDetails>
</Policy>