POST api/Application
Posting an application submits the application to us and performs a soft credit search on the applicant(s). An applicationId will be returned which then in turn can be used for posting a or checking the application status.
Request Information
Requires Authentication!
URI Parameters
None.
Body Parameters
AdvantageApplication| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicationId |
Application Id - This is not supplied by the sender, but it's returned on a successful request. |
integer |
None. |
| Advantage |
Contains the node for Amount of Applicants. |
Advantage |
Required |
| Applicants |
List of Applicants. |
Collection of Applicant |
Required Collection Length: inclusive between 1 and 2 |
| Income |
Details of the NET income for Main and Joint Customer. |
Income |
Required |
| Goods |
Contains the details of the vehicle. |
Goods |
None. |
| Dealer |
Dealer Authentication. |
Dealer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ApplicationId": 12345678,
"Advantage": {
"NumberOfApplicants": 1,
"NumberOfDependants": 1
},
"Applicants": [
{
"Id": 1,
"Title": 2,
"FirstName": "Richard",
"LastName": "Hill",
"DOB": "20/02/1990",
"MaritalStatus": 0,
"Email": "richardhill@mail.com",
"Mobile": "07123123456",
"ResidentialType": 0,
"DependantChildren": 1,
"Addresses": [
null,
{
"Id": 1,
"Flat": "10c",
"HouseName": "Acorn House",
"HouseNumber": "7",
"Street": "Moss Road",
"Town": "Grimsby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01234123456",
"TimeInMonth": 36,
"RentMortgageCost": 0.0,
"RentMortgageFrequency": 0
}
],
"EmploymentHistory": [
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
},
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
}
]
},
{
"Id": 1,
"Title": 2,
"FirstName": "Richard",
"LastName": "Hill",
"DOB": "20/02/1990",
"MaritalStatus": 0,
"Email": "richardhill@mail.com",
"Mobile": "07123123456",
"ResidentialType": 0,
"DependantChildren": 1,
"Addresses": [
null,
{
"Id": 1,
"Flat": "10c",
"HouseName": "Acorn House",
"HouseNumber": "7",
"Street": "Moss Road",
"Town": "Grimsby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01234123456",
"TimeInMonth": 36,
"RentMortgageCost": 0.0,
"RentMortgageFrequency": 0
}
],
"EmploymentHistory": [
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
},
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
}
]
}
],
"Income": {
"IncomeMain": 1200.0,
"IncomeMainFrequency": 2,
"IncomeJoint": 250.0,
"IncomeJointFrequency": 1,
"AdditionalIncome": 1200.0
},
"Goods": {
"Make": "Vauxhall",
"Model": "Insigna",
"Colour": "Grey",
"Mileage": "100000",
"DateReg": "2009-11-20T00:00:00",
"RegNo": "YC09UYH",
"CashPrice": 4000.0,
"CashDeposit": 500.0,
"PartExchange": 500.0,
"FinanceRequired": 3000.0
},
"Dealer": {
"DealerId": 1234,
"Password": "YourPassword",
"DealerReference": "Your Reference",
"DealerNote": "Add a diary note with the application"
}
}
application/xml, text/xml
Sample:
<AdvantageApplication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advantage.Blink.Web.WebModel.Application">
<ApplicationId>12345678</ApplicationId>
<Advantage>
<NumberOfApplicants>1</NumberOfApplicants>
<NumberOfDependants>1</NumberOfDependants>
</Advantage>
<Applicants>
<Applicant>
<Id>1</Id>
<Title>Mr</Title>
<FirstName>Richard</FirstName>
<LastName>Hill</LastName>
<DOB>20/02/1990</DOB>
<MaritalStatus>Married</MaritalStatus>
<Email>richardhill@mail.com</Email>
<Mobile>07123123456</Mobile>
<ResidentialType>Owner</ResidentialType>
<DependantChildren>1</DependantChildren>
<Addresses>
<Address i:nil="true" />
<Address>
<Id>1</Id>
<Flat>10c</Flat>
<HouseName>Acorn House</HouseName>
<HouseNumber>7</HouseNumber>
<Street>Moss Road</Street>
<Town>Grimsby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01234123456</Telephone>
<TimeInMonth>36</TimeInMonth>
<RentMortgageCost>0</RentMortgageCost>
<RentMortgageFrequency>Weekly</RentMortgageFrequency>
</Address>
</Addresses>
<EmploymentHistory>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
</EmploymentHistory>
</Applicant>
<Applicant>
<Id>1</Id>
<Title>Mr</Title>
<FirstName>Richard</FirstName>
<LastName>Hill</LastName>
<DOB>20/02/1990</DOB>
<MaritalStatus>Married</MaritalStatus>
<Email>richardhill@mail.com</Email>
<Mobile>07123123456</Mobile>
<ResidentialType>Owner</ResidentialType>
<DependantChildren>1</DependantChildren>
<Addresses>
<Address i:nil="true" />
<Address>
<Id>1</Id>
<Flat>10c</Flat>
<HouseName>Acorn House</HouseName>
<HouseNumber>7</HouseNumber>
<Street>Moss Road</Street>
<Town>Grimsby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01234123456</Telephone>
<TimeInMonth>36</TimeInMonth>
<RentMortgageCost>0</RentMortgageCost>
<RentMortgageFrequency>Weekly</RentMortgageFrequency>
</Address>
</Addresses>
<EmploymentHistory>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
</EmploymentHistory>
</Applicant>
</Applicants>
<Income>
<IncomeMain>1200</IncomeMain>
<IncomeMainFrequency>Monthly</IncomeMainFrequency>
<IncomeJoint>250</IncomeJoint>
<IncomeJointFrequency>Weekly</IncomeJointFrequency>
<AdditionalIncome>1200</AdditionalIncome>
</Income>
<Goods>
<Make>Vauxhall</Make>
<Model>Insigna</Model>
<Colour>Grey</Colour>
<Mileage>100000</Mileage>
<DateReg>2009-11-20T00:00:00</DateReg>
<RegNo>YC09UYH</RegNo>
<CashPrice>4000</CashPrice>
<CashDeposit>500</CashDeposit>
<PartExchange>500</PartExchange>
<FinanceRequired>3000</FinanceRequired>
</Goods>
<Dealer>
<DealerId>1234</DealerId>
<Password>YourPassword</Password>
<DealerReference>Your Reference</DealerReference>
<DealerNote>Add a diary note with the application</DealerNote>
</Dealer>
</AdvantageApplication>
Response Information
Resource Description
AdvantageApplication| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicationId |
Application Id - This is not supplied by the sender, but it's returned on a successful request. |
integer |
None. |
| Advantage |
Contains the node for Amount of Applicants. |
Advantage |
Required |
| Applicants |
List of Applicants. |
Collection of Applicant |
Required Collection Length: inclusive between 1 and 2 |
| Income |
Details of the NET income for Main and Joint Customer. |
Income |
Required |
| Goods |
Contains the details of the vehicle. |
Goods |
None. |
| Dealer |
Dealer Authentication. |
Dealer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ApplicationId": 12345678,
"Advantage": {
"NumberOfApplicants": 1,
"NumberOfDependants": 1
},
"Applicants": [
{
"Id": 1,
"Title": 2,
"FirstName": "Richard",
"LastName": "Hill",
"DOB": "20/02/1990",
"MaritalStatus": 0,
"Email": "richardhill@mail.com",
"Mobile": "07123123456",
"ResidentialType": 0,
"DependantChildren": 1,
"Addresses": [
null,
{
"Id": 1,
"Flat": "10c",
"HouseName": "Acorn House",
"HouseNumber": "7",
"Street": "Moss Road",
"Town": "Grimsby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01234123456",
"TimeInMonth": 36,
"RentMortgageCost": 0.0,
"RentMortgageFrequency": 0
}
],
"EmploymentHistory": [
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
},
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
}
]
},
{
"Id": 1,
"Title": 2,
"FirstName": "Richard",
"LastName": "Hill",
"DOB": "20/02/1990",
"MaritalStatus": 0,
"Email": "richardhill@mail.com",
"Mobile": "07123123456",
"ResidentialType": 0,
"DependantChildren": 1,
"Addresses": [
null,
{
"Id": 1,
"Flat": "10c",
"HouseName": "Acorn House",
"HouseNumber": "7",
"Street": "Moss Road",
"Town": "Grimsby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01234123456",
"TimeInMonth": 36,
"RentMortgageCost": 0.0,
"RentMortgageFrequency": 0
}
],
"EmploymentHistory": [
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
},
{
"Id": 1,
"JobTitle": "Programmer",
"CompanyName": "Advantage Finance Ltd",
"Street": "Moss Road",
"Town": "Grismby",
"County": "South Humberside",
"Postcode": "DN320LW",
"Telephone": "01472586321",
"TimeInMonths": 24,
"Status": 0
}
]
}
],
"Income": {
"IncomeMain": 1200.0,
"IncomeMainFrequency": 2,
"IncomeJoint": 250.0,
"IncomeJointFrequency": 1,
"AdditionalIncome": 1200.0
},
"Goods": {
"Make": "Vauxhall",
"Model": "Insigna",
"Colour": "Grey",
"Mileage": "100000",
"DateReg": "2009-11-20T00:00:00",
"RegNo": "YC09UYH",
"CashPrice": 4000.0,
"CashDeposit": 500.0,
"PartExchange": 500.0,
"FinanceRequired": 3000.0
},
"Dealer": {
"DealerId": 1234,
"Password": "YourPassword",
"DealerReference": "Your Reference",
"DealerNote": "Add a diary note with the application"
}
}
application/xml, text/xml
Sample:
<AdvantageApplication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advantage.Blink.Web.WebModel.Application">
<ApplicationId>12345678</ApplicationId>
<Advantage>
<NumberOfApplicants>1</NumberOfApplicants>
<NumberOfDependants>1</NumberOfDependants>
</Advantage>
<Applicants>
<Applicant>
<Id>1</Id>
<Title>Mr</Title>
<FirstName>Richard</FirstName>
<LastName>Hill</LastName>
<DOB>20/02/1990</DOB>
<MaritalStatus>Married</MaritalStatus>
<Email>richardhill@mail.com</Email>
<Mobile>07123123456</Mobile>
<ResidentialType>Owner</ResidentialType>
<DependantChildren>1</DependantChildren>
<Addresses>
<Address i:nil="true" />
<Address>
<Id>1</Id>
<Flat>10c</Flat>
<HouseName>Acorn House</HouseName>
<HouseNumber>7</HouseNumber>
<Street>Moss Road</Street>
<Town>Grimsby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01234123456</Telephone>
<TimeInMonth>36</TimeInMonth>
<RentMortgageCost>0</RentMortgageCost>
<RentMortgageFrequency>Weekly</RentMortgageFrequency>
</Address>
</Addresses>
<EmploymentHistory>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
</EmploymentHistory>
</Applicant>
<Applicant>
<Id>1</Id>
<Title>Mr</Title>
<FirstName>Richard</FirstName>
<LastName>Hill</LastName>
<DOB>20/02/1990</DOB>
<MaritalStatus>Married</MaritalStatus>
<Email>richardhill@mail.com</Email>
<Mobile>07123123456</Mobile>
<ResidentialType>Owner</ResidentialType>
<DependantChildren>1</DependantChildren>
<Addresses>
<Address i:nil="true" />
<Address>
<Id>1</Id>
<Flat>10c</Flat>
<HouseName>Acorn House</HouseName>
<HouseNumber>7</HouseNumber>
<Street>Moss Road</Street>
<Town>Grimsby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01234123456</Telephone>
<TimeInMonth>36</TimeInMonth>
<RentMortgageCost>0</RentMortgageCost>
<RentMortgageFrequency>Weekly</RentMortgageFrequency>
</Address>
</Addresses>
<EmploymentHistory>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
<Employment>
<Id>1</Id>
<JobTitle>Programmer</JobTitle>
<CompanyName>Advantage Finance Ltd</CompanyName>
<Street>Moss Road</Street>
<Town>Grismby</Town>
<County>South Humberside</County>
<Postcode>DN320LW</Postcode>
<Telephone>01472586321</Telephone>
<TimeInMonths>24</TimeInMonths>
<Status>FullTime</Status>
</Employment>
</EmploymentHistory>
</Applicant>
</Applicants>
<Income>
<IncomeMain>1200</IncomeMain>
<IncomeMainFrequency>Monthly</IncomeMainFrequency>
<IncomeJoint>250</IncomeJoint>
<IncomeJointFrequency>Weekly</IncomeJointFrequency>
<AdditionalIncome>1200</AdditionalIncome>
</Income>
<Goods>
<Make>Vauxhall</Make>
<Model>Insigna</Model>
<Colour>Grey</Colour>
<Mileage>100000</Mileage>
<DateReg>2009-11-20T00:00:00</DateReg>
<RegNo>YC09UYH</RegNo>
<CashPrice>4000</CashPrice>
<CashDeposit>500</CashDeposit>
<PartExchange>500</PartExchange>
<FinanceRequired>3000</FinanceRequired>
</Goods>
<Dealer>
<DealerId>1234</DealerId>
<Password>YourPassword</Password>
<DealerReference>Your Reference</DealerReference>
<DealerNote>Add a diary note with the application</DealerNote>
</Dealer>
</AdvantageApplication>