APG logo
Documentation Powered by ReDoc

AutoProtect Navigate Dealer API (1.0.0)

Download OpenAPI specification:Download

License: private

The Dealer API enables Dealers to create and send F&I applications to lenders and providers using Navigate.

Authentication

OAuth2

OAuth2 via our Single Sign On

Security Scheme Type API Key
Header parameter name: Authorization

api_key

API key for Usage plan

Security Scheme Type API Key
Header parameter name: x-api-key

Deal

Endpoints relating to the managing of F&I Deals.

Get a Provider Agreement Summary

Returns an agreement summary for a provider and the specified dealer

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "policyNumber": "string",
  • "customerName": "2019-08-24T14:15:22Z",
  • "salesPerson": "string",
  • "totalProfit": {
    },
  • "vehicle": {
    },
  • "products": [
    ]
}

Get Deals

Returns a list of F&I Deals matching parameters

Authorizations:
OAuth2
query Parameters
sort
string

Result sort direction - asc or desc

aq
string

Additional Query - when searching, this parameter filters the results by an additional search query

page
integer

The page number for pagination of results

dealerId
string

The Dealer ID

policyStatus
string

The policy status

dealId
string

The Deal ID

customerId
string

The Customer ID

pageSize
integer

The page size when paginating results

from
string <date-time>

Filters based on the last updated date & time

to
string <date-time>

Filters based on the last updated date & time

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Multiple Deals

Update Multiple Deals

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Create a Deal

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
referenceCode
string
currency
string
locale
string
object (Client)
object (Dealer)
object (User)
object (User)
status
string (DealStatus)
Enum: "NEW_DEAL" "UNSENT_DEAL" "AWAITING_DECISION" "CONDITIONALLY_APPROVED" "APPROVED" "AWAITING_DELIVERY" "AWAITING_E_SIGN" "AWAITING_PAYOUT" "PAID_OUT" "DECLINED_BY_ALL_LENDERS" "CANCELLED" "NOT_TAKEN_UP"

Enumeration that describes a deal status.

  • NEW_DEAL - The Deal is newly created.
  • UNSENT_DEAL - The Deal has not been sent to a Lender yet.
  • AWAITING_DECISION - Awaiting a decision from a Lender.
  • CONDITIONALLY_APPROVED - The Deal Finance has been conditionally approved by a Lender.
  • APPROVED - The Deal Finance has been approved by a Lender.
  • AWAITING_DELIVERY - The Deal vehicle is awaiting delivery.
  • AWAITING_E_SIGN - The Deal Finance is awaiting E-sign.
  • AWAITING_PAYOUT - The Deal Finance is awaiting payout from the Lender.
  • PAID_OUT - The Deal has been paid out.
  • DECLINED_BY_ALL_LENDERS - The Deal has been declined by all Lenders.
  • CANCELLED - The deal has been cancelled.
  • NOT_TAKEN_UP - The deal has not been taken up with the Lender.
type
required
string (DealType)
Enum: "PRIVATE" "BUSINESS"

Enumeration that describes a Deal type.

  • PRIVATE - A private, non commercial Deal.
  • BUSINESS - A business, commercial Deal.
Array of objects (Application)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Remove a Deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a Deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Update a Deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

x-api-validate
string

Header to toggle graph validation

Request Body schema: application/json
id
string
referenceCode
string
currency
string
locale
string
object (Client)
object (Dealer)
object (User)
object (User)
status
string (DealStatus)
Enum: "NEW_DEAL" "UNSENT_DEAL" "AWAITING_DECISION" "CONDITIONALLY_APPROVED" "APPROVED" "AWAITING_DELIVERY" "AWAITING_E_SIGN" "AWAITING_PAYOUT" "PAID_OUT" "DECLINED_BY_ALL_LENDERS" "CANCELLED" "NOT_TAKEN_UP"

Enumeration that describes a deal status.

  • NEW_DEAL - The Deal is newly created.
  • UNSENT_DEAL - The Deal has not been sent to a Lender yet.
  • AWAITING_DECISION - Awaiting a decision from a Lender.
  • CONDITIONALLY_APPROVED - The Deal Finance has been conditionally approved by a Lender.
  • APPROVED - The Deal Finance has been approved by a Lender.
  • AWAITING_DELIVERY - The Deal vehicle is awaiting delivery.
  • AWAITING_E_SIGN - The Deal Finance is awaiting E-sign.
  • AWAITING_PAYOUT - The Deal Finance is awaiting payout from the Lender.
  • PAID_OUT - The Deal has been paid out.
  • DECLINED_BY_ALL_LENDERS - The Deal has been declined by all Lenders.
  • CANCELLED - The deal has been cancelled.
  • NOT_TAKEN_UP - The deal has not been taken up with the Lender.
type
required
string (DealType)
Enum: "PRIVATE" "BUSINESS"

Enumeration that describes a Deal type.

  • PRIVATE - A private, non commercial Deal.
  • BUSINESS - A business, commercial Deal.
Array of objects (Application)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Replace a Deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
referenceCode
string
currency
string
locale
string
object (Client)
object (Dealer)
object (User)
object (User)
status
string (DealStatus)
Enum: "NEW_DEAL" "UNSENT_DEAL" "AWAITING_DECISION" "CONDITIONALLY_APPROVED" "APPROVED" "AWAITING_DELIVERY" "AWAITING_E_SIGN" "AWAITING_PAYOUT" "PAID_OUT" "DECLINED_BY_ALL_LENDERS" "CANCELLED" "NOT_TAKEN_UP"

Enumeration that describes a deal status.

  • NEW_DEAL - The Deal is newly created.
  • UNSENT_DEAL - The Deal has not been sent to a Lender yet.
  • AWAITING_DECISION - Awaiting a decision from a Lender.
  • CONDITIONALLY_APPROVED - The Deal Finance has been conditionally approved by a Lender.
  • APPROVED - The Deal Finance has been approved by a Lender.
  • AWAITING_DELIVERY - The Deal vehicle is awaiting delivery.
  • AWAITING_E_SIGN - The Deal Finance is awaiting E-sign.
  • AWAITING_PAYOUT - The Deal Finance is awaiting payout from the Lender.
  • PAID_OUT - The Deal has been paid out.
  • DECLINED_BY_ALL_LENDERS - The Deal has been declined by all Lenders.
  • CANCELLED - The deal has been cancelled.
  • NOT_TAKEN_UP - The deal has not been taken up with the Lender.
type
required
string (DealType)
Enum: "PRIVATE" "BUSINESS"

Enumeration that describes a Deal type.

  • PRIVATE - A private, non commercial Deal.
  • BUSINESS - A business, commercial Deal.
Array of objects (Application)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Create an Application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
status
string
Array of objects (Applicant)
object (Vehicle)

A vehicle, like a car

Array of objects (Additional Charge)
object (Financials)

Financial Entity

Array of objects (Additional Detail)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Get an Application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Replace an Application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
status
string
Array of objects (Applicant)
object (Vehicle)

A vehicle, like a car

Array of objects (Additional Charge)
object (Financials)

Financial Entity

Array of objects (Additional Detail)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Get Application Additional Charges

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "ACCESSORY",
  • "paymentType": "FINANCE",
  • "priceNet": {
    },
  • "priceGross": {
    },
  • "taxRate": 0
}

Create Application Additional Charges

Create additional charges for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Application Additional Details

Returns a list of additional details for the specified application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Application Additional Details

Update additional details for the specified application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Applicants

Returns a list of applicants for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an Applicant

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "isPrimary": true,
  • "type": "HIRER",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string",
  • "vehicleUsageType": "PRIVATE",
  • "marketing": {
    },
  • "bank": {
    },
  • "numberOfDependants": 0
}

Update an Applicant

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
isPrimary
boolean

Is the applicant the primary applicant.

type
string (ApplicantType)
Enum: "HIRER" "JOINT" "GUARANTOR"

Enumeration that describes an applicant type

  • HIRER - The applicant is the primary hirer.
  • JOINT - The applicant is a joint applicant for the primary hirer.
  • GUARANTOR - The applicant is the guarantor for the primary hirer.
forename
string
middleName
string
surname
string
maidenName
string
title
string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
gender
string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
Array of objects (Redidential Address)
Array of objects (Employment)
maritalStatus
string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
dateOfBirth
string <date-time>
mobileNumber
string
homeNumber
string
workNumber
string
emailAddress
string
passportType
string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
nationality
string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
drivingLicenceType
string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
drivingLicenceNumber
string
vehicleUsageType
string (UsageType)
Enum: "PRIVATE" "COMMERCIAL" "MOTABILITY" "HIRE_AND_REWARD" "LIFESTYLE" "DRIVING_SCHOOL"

Enumeration that describes a vehicle usage type.

  • PRIVATE - Social, domestic, pleasure and commuting.
  • COMMERCIAL - Commercial vehicle for business use.
  • MOTABILITY - Vehicle is being sold on Motability contract hire.
  • HIRE_AND_REWARD - Vehicle is used for Taxi, Private Hire, Courier or Minibus.
  • LIFESTYLE - Vehicle is used for a lifestyle or hobby activity.
  • DRIVING_SCHOOL - Vehicle is used for driving lessons.
object (Marketing)
object (Bank)
numberOfDependants
integer

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "isPrimary": true,
  • "type": "HIRER",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string",
  • "vehicleUsageType": "PRIVATE",
  • "marketing": {
    },
  • "bank": {
    },
  • "numberOfDependants": 0
}

Replace an Applicant

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
isPrimary
boolean

Is the applicant the primary applicant.

type
string (ApplicantType)
Enum: "HIRER" "JOINT" "GUARANTOR"

Enumeration that describes an applicant type

  • HIRER - The applicant is the primary hirer.
  • JOINT - The applicant is a joint applicant for the primary hirer.
  • GUARANTOR - The applicant is the guarantor for the primary hirer.
forename
string
middleName
string
surname
string
maidenName
string
title
string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
gender
string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
Array of objects (Redidential Address)
Array of objects (Employment)
maritalStatus
string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
dateOfBirth
string <date-time>
mobileNumber
string
homeNumber
string
workNumber
string
emailAddress
string
passportType
string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
nationality
string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
drivingLicenceType
string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
drivingLicenceNumber
string
vehicleUsageType
string (UsageType)
Enum: "PRIVATE" "COMMERCIAL" "MOTABILITY" "HIRE_AND_REWARD" "LIFESTYLE" "DRIVING_SCHOOL"

Enumeration that describes a vehicle usage type.

  • PRIVATE - Social, domestic, pleasure and commuting.
  • COMMERCIAL - Commercial vehicle for business use.
  • MOTABILITY - Vehicle is being sold on Motability contract hire.
  • HIRE_AND_REWARD - Vehicle is used for Taxi, Private Hire, Courier or Minibus.
  • LIFESTYLE - Vehicle is used for a lifestyle or hobby activity.
  • DRIVING_SCHOOL - Vehicle is used for driving lessons.
object (Marketing)
object (Bank)
numberOfDependants
integer

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "isPrimary": true,
  • "type": "HIRER",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string",
  • "vehicleUsageType": "PRIVATE",
  • "marketing": {
    },
  • "bank": {
    },
  • "numberOfDependants": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isPrimary": true,
  • "type": "HIRER",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string",
  • "vehicleUsageType": "PRIVATE",
  • "marketing": {
    },
  • "bank": {
    },
  • "numberOfDependants": 0
}

Get Applicant Addresses

Returns the addresses for an applicant

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Applicant Address

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Remove an Applicant Address

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Applicant Address

Returns an applicant address

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "houseNumber": "1",
  • "street": "1 Upper Lane",
  • "city": "Leeds",
  • "county": "West Yorkshire",
  • "district": "",
  • "countryName": "United Kingdom",
  • "countryCode": "UK",
  • "postcode": "LS1 2QE",
  • "fromDate": "2018-01-01T09:00:00.000Z",
  • "residentialStatus": "HOME_OWNER"
}

Get an applicant's bank

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "accountName": "string",
  • "accountNumber": "string",
  • "sortCode": "string",
  • "fromDate": "string",
  • "address": {
    }
}

Create an applicant's bank

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string
accountName
string
accountNumber
string
sortCode
string
fromDate
string
object (Commercial Address)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "accountName": "string",
  • "accountNumber": "string",
  • "sortCode": "string",
  • "fromDate": "string",
  • "address": {
    }
}

Remove an applicant's bank details

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Applicant Employments

Returns a list of employments for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create applicant employments

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
id
string
occupation
string
employmentStatus
string (EmploymentStatus)
Enum: "FULL_TIME_PERMANENT" "PART_TIME_PERMANENT" "FULL_TIME_TEMPORARY" "PART_TIME_TEMPORARY" "FULL_TIME_AGENCY" "PART_TIME_AGENCY" "SUB_CONTRACTOR" "SELF_EMPLOYED" "UNEMPLOYED" "RETIRED" "STUDENT" "HOME_MAKER" "UNABLE_TO_WORK"

Enumeration that describes an employment status.

  • FULL_TIME_PERMANENT - The applicant has full time permanent employment.
  • PART_TIME_PERMANENT - The applicant has part time permanent employment.
  • FULL_TIME_TEMPORARY - The applicant has full time temporary employment.
  • PART_TIME_TEMPORARY - The applicant has part time temporary employment.
  • FULL_TIME_AGENCY - The applicant works full time for an agency.
  • PART_TIME_AGENCY - The applicant works part time for an agency.
  • SUB_CONTRACTOR - The applicant is a sub contractor.
  • SELF_EMPLOYED - The applicant is self employed.
  • UNEMPLOYED - The applicant is unemployed.
  • RETIRED - The applicant is retired.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • UNABLE_TO_WORK - The applicant is unable to work.
companyName
string
fromDate
string <date-time>
endDate
string <date-time>
employmentSector
string (EmploymentSector)
Enum: "PRIVATE" "GOVERNMENT" "MILITARY" "SELF_EMPLOYED" "STUDENT" "HOME_MAKER" "RETIRED" "UNABLE_TO_WORK" "UNEMPLOYED"

Enumeration that describes an employment sector.

  • PRIVATE - The applicant works for a private sector company.
  • GOVERNMENT - The applicant works for the government.
  • MILITARY - The applicant works for the military.
  • SELF_EMPLOYED - The applicant is self employed.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • RETIRED - The applicant is retired.
  • UNABLE_TO_WORK - The applicant is unable to work.
  • UNEMPLOYED - The applicant is unemployed.
annualIncome
number
object (Commercial Address)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Remove Applicant Employments

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Applicant Employment

Returns an applicant employment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "occupation": "Baker",
  • "employmentStatus": "FULL_TIME_PERMANENT",
  • "companyName": "ACME Bakery",
  • "fromDate": "2019-01-02T09:00:00.000Z",
  • "employmentSector": "PRIVATE",
  • "annualIncome": 30000,
  • "address": {
    }
}

Replace an Applicant Employment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "occupation": "Baker",
  • "employmentStatus": "FULL_TIME_PERMANENT",
  • "companyName": "ACME Bakery",
  • "fromDate": "2019-01-02T09:00:00.000Z",
  • "employmentSector": "PRIVATE",
  • "annualIncome": 30000,
  • "address": {
    }
}

Generate Stripe Payment Intent

Generate Stripe Payment Intent

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

applicantId
required
string

The id of the applicant

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Remove a vehicle

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a vehicle

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Update Vehicle

Update a vehicle

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Create a vehicle

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
type
string (VehicleType)
Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"

Enumeration that describes a vehicle type.

  • PRIVATE_LIGHT_GOODS_VEHICLE - The vehicle is a private light goods vehicle.
  • LIGHT_COMMERCIAL_VEHICLE - The vehicle is a light commercial vehicle.
  • CARAVAN - The vehicle is a caravan.
  • MOTORHOME - The vehicle is a motorhome.
  • MOTORBIKE - The vehicle is a motorbike.
  • OTHER - The vehicle type is not defined.
  • HEAVY_GOODS_VEHICLE - The vehicle is a heavy goods vehicle.
isNew
boolean
make
string
makeValue
string
model
string
modelValue
string
engineSize
string
style
string
styleValue
string
doors
number
registrationNumber
string
grossWeight
integer
firstRegistered
string <date-time>
vin
string
capcode
string
glassesCode
string
glassesFamily
string
colour
string
fuelType
string
transmissionType
string
yearOfManufacture
number
imported
boolean
mileage
integer
stockNumber
string
deliveryDate
string <date-time>
isUkSpecification
boolean
purchaseDate
string <date-time>
motDueDate
string <date-time>
mfrWarrantyExpiryDate
string <date-time>
nonEditableFields
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Replace a vehicle

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
type
string (VehicleType)
Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"

Enumeration that describes a vehicle type.

  • PRIVATE_LIGHT_GOODS_VEHICLE - The vehicle is a private light goods vehicle.
  • LIGHT_COMMERCIAL_VEHICLE - The vehicle is a light commercial vehicle.
  • CARAVAN - The vehicle is a caravan.
  • MOTORHOME - The vehicle is a motorhome.
  • MOTORBIKE - The vehicle is a motorbike.
  • OTHER - The vehicle type is not defined.
  • HEAVY_GOODS_VEHICLE - The vehicle is a heavy goods vehicle.
isNew
boolean
make
string
makeValue
string
model
string
modelValue
string
engineSize
string
style
string
styleValue
string
doors
number
registrationNumber
string
grossWeight
integer
firstRegistered
string <date-time>
vin
string
capcode
string
glassesCode
string
glassesFamily
string
colour
string
fuelType
string
transmissionType
string
yearOfManufacture
number
imported
boolean
mileage
integer
stockNumber
string
deliveryDate
string <date-time>
isUkSpecification
boolean
purchaseDate
string <date-time>
motDueDate
string <date-time>
mfrWarrantyExpiryDate
string <date-time>
nonEditableFields
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Get Lender Decisions

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Latest Lender Decisions

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "lenderProposalReference": "string",
  • "proposalReference": "string",
  • "lenderStatus": true,
  • "figures": {
    },
  • "notes": [
    ],
  • "errors": [
    ],
  • "signature": {
    }
}

Get finance packages

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Application Financials

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Update Application Financials

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
financeProduct
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
object (Money Type)
object (Money Type)
assetVatQualifying
boolean
object (Money Type)
object (Money Type)
object (Money Type)
loanToValue
number
vatRate
number
object (Financial Deposit)
maxAnnualMileage
integer
object (Money Type)
object (Money Type)
term
integer
aprRate
number
object (Money Type)
object (Money Type)
object (Financial Totals)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create Application Financials

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
financeProduct
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
object (Money Type)
object (Money Type)
assetVatQualifying
boolean
object (Money Type)
object (Money Type)
object (Money Type)
loanToValue
number
vatRate
number
object (Financial Deposit)
maxAnnualMileage
integer
object (Money Type)
object (Money Type)
term
integer
aprRate
number
object (Money Type)
object (Money Type)
object (Financial Totals)

Responses

Request samples

Content type
application/json
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Response samples

Content type
application/json
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Replace Application Financials

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
financeProduct
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
object (Money Type)
object (Money Type)
assetVatQualifying
boolean
object (Money Type)
object (Money Type)
object (Money Type)
loanToValue
number
vatRate
number
object (Financial Deposit)
maxAnnualMileage
integer
object (Money Type)
object (Money Type)
term
integer
aprRate
number
object (Money Type)
object (Money Type)
object (Financial Totals)

Responses

Request samples

Content type
application/json
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Response samples

Content type
application/json
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Get Application Financial Deposit

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Create a Financial Deposit

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)

Responses

Request samples

Content type
application/json
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Response samples

Content type
application/json
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Replace a Financial Deposit

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)

Responses

Request samples

Content type
application/json
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Response samples

Content type
application/json
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Get Application Lender Sends

Returns a list of all lender sends for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Lender Finance Packages

Returns lender finance package

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "productCode": "string",
  • "financeType": "HIRE_PURCHASE",
  • "financePackageType": "STANDARD",
  • "applicationType": [
    ],
  • "vehicleType": [
    ],
  • "interestMethod": "FLAT_RATE",
  • "newUsedType": [
    ],
  • "isActive": true
}

Get a Lender's full info

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "packages": [
    ],
  • "config": {
    },
  • "additionalDetails": [
    ]
}

Get Application Lender Decisions

Returns a list of decisions for a specific lender on an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Application Latest Lender Decision

Returns the latest application decision for a specific lender

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "lenderProposalReference": "string",
  • "proposalReference": "string",
  • "lenderStatus": true,
  • "figures": {
    },
  • "notes": [
    ],
  • "errors": [
    ],
  • "signature": {
    }
}

Get Application Sends For Lender

Returns a list of lenders sends for a specific lender and application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Application Latest Lender Send

Returns the latest lender send for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "dealId": "string",
  • "applicationId": "string",
  • "lenderId": "string",
  • "financePackage": {
    },
  • "sendStatus": "string",
  • "decisionStatus": "string",
  • "errors": [
    ],
  • "notes": [
    ],
  • "figures": {
    },
  • "signature": {
    },
  • "lenderReference": "string",
  • "initialSendDate": "2019-08-24T14:15:22Z",
  • "latestSendDate": "2019-08-24T14:15:22Z",
  • "latestDecisionDate": "2019-08-24T14:15:22Z"
}

Get Provider Products

Returns a list of provider products, based on the provider ID

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Provider Agreements

Returns agreements for a provider and the specified deal application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Provider Agreement

Returns an agreement for a provider and the specified deal application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "soldDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "state": "UNDEFINED",
  • "amendmentState": "AMENDMENT_IN_PROGRESS",
  • "status": {
    },
  • "authorisationStatus": {
    },
  • "authorisationType": "string",
  • "dealer": {
    },
  • "currencyCode": "string",
  • "locale": "string",
  • "salesPerson": "string",
  • "customer": {
    },
  • "vehicle": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "actions": {
    },
  • "amendments": {
    },
  • "preActivationValidationErrors": {
    }
}

Get a agreement's document for a provider

Returns agreement's document for a provider

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

documentType
required
string

Type of the document

query Parameters
versionId
string

Version Id of s3 document

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "type": "string",
  • "size": "string",
  • "storageDate": "2019-08-24T14:15:22Z",
  • "lastAccessDate": "2019-08-24T14:15:22Z",
  • "emailSummary": {
    }
}

Get an exception form

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "type": "string",
  • "size": "string",
  • "storageDate": "2019-08-24T14:15:22Z",
  • "lastAccessDate": "2019-08-24T14:15:22Z",
  • "emailSummary": {
    }
}

Get a agreements' documents for a provider

Returns agreements' documents for a provider

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get product price details

Get product price details

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

productId
required
string

The ID of the product

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array of objects (Provider Product Additional Cover)
retailPrice
number <float>
labourRateCode
required
string
rateCardId
required
string
hasPremiumFunding
required
boolean
claimLimitCode
required
string
durationCode
required
string
productTypeCode
required
string

Responses

Request samples

Content type
application/json
{
  • "additionalCover": [
    ],
  • "retailPrice": 0,
  • "labourRateCode": "string",
  • "rateCardId": "string",
  • "hasPremiumFunding": true,
  • "claimLimitCode": "string",
  • "durationCode": "string",
  • "productTypeCode": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "retailPrice": {
    },
  • "dealerNetPrice": {
    },
  • "dealerNetPriceBreakdown": {
    },
  • "customerVat": {
    },
  • "customerVatBreakDown": {
    },
  • "reclaimedVat": {
    },
  • "reclaimedVatBreakDown": {
    },
  • "adminFee": {
    },
  • "adminFeeBreakDown": {
    },
  • "ipt": {
    },
  • "iptBreakDown": {
    },
  • "claimsFund": {
    },
  • "claimsFundBreakDown": {
    },
  • "notionalClaimsFund": {
    },
  • "notionalClaimsFundBreakDown": {
    },
  • "remainingBalance": {
    }
}

Request an amendment

Request an amendment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Submit Special Acceptance

Submit Dealer's Special Acceptance

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a compliance document for a deal

Returns compliance document for a deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

documentType
required
string

Type of the document

query Parameters
versionId
string

Version Id of s3 document

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "type": "string",
  • "size": "string",
  • "storageDate": "2019-08-24T14:15:22Z",
  • "lastAccessDate": "2019-08-24T14:15:22Z",
  • "emailSummary": {
    }
}

Get a compliance document with name for a deal

Returns compliance document by name for a deal

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

providerId
required
string

The ID of the Provider

documentType
required
string

Type of the document

documentName
required
string

Name of the document

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "type": "string",
  • "size": "string",
  • "storageDate": "2019-08-24T14:15:22Z",
  • "lastAccessDate": "2019-08-24T14:15:22Z",
  • "emailSummary": {
    }
}

Get Application Quotes

Returns a list of quotes for a finance package

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

financePackageId
required
string

The id of the finance package

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send an Application

Send an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Application Sends

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send an Application to a Lender

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
lenderId
string
financePackageId
string

Responses

Request samples

Content type
application/json
{
  • "lenderId": "string",
  • "financePackageId": "string"
}

Response samples

Content type
application/json
{
  • "lenderProposalReference": "string",
  • "proposalReference": "string",
  • "lenderStatus": true,
  • "figures": {
    },
  • "notes": [
    ],
  • "errors": [
    ],
  • "signature": {
    }
}

Get Latest Application Send

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "dealId": "string",
  • "applicationId": "string",
  • "lenderId": "string",
  • "financePackage": {
    },
  • "sendStatus": "string",
  • "decisionStatus": "string",
  • "errors": [
    ],
  • "notes": [
    ],
  • "figures": {
    },
  • "signature": {
    },
  • "lenderReference": "string",
  • "initialSendDate": "2019-08-24T14:15:22Z",
  • "latestSendDate": "2019-08-24T14:15:22Z",
  • "latestDecisionDate": "2019-08-24T14:15:22Z"
}

Remove all VAPs

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get VAPS

Returns all VAPS for an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update multiple Vaps

Update Multiple Value Added Product

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Create VAPs

Create a Value Added Products

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
id
string
required
object (Provider)
name
required
string
category
required
string
categoryId
string
status
string
productCode
required
string
productName
string
productTypeCode
required
string
rateCardId
required
string
required
object (Provider Product Labour Rate)
required
object (Provider Product Claim Limit)
required
object (Provider Product Duration)
Array of objects (Provider Product Additional Cover)
hasSpecialAcceptance
boolean
object (Money Type)
required
object (Money Type)
taxRate
required
number <float>
taxType
required
string (TaxType)
Enum: "VAT" "IPT" "ZERO_RATED"

Enumeration that describes a tax type.

  • VAT - Value added tax
  • IPT - Insurance premium tax
  • ZERO_RATED - A taxable product, but with a 0% tax rate
coverStartDate
string <date-time>
saleDate
string <date-time>
paymentType
string (PaymentType)
Enum: "FINANCE" "CASH" "DIRECT_DEBIT"

Enumeration that describes a payment type.

  • FINANCE - Payment will be financed.
  • CASH - Payment will be made in cash.
  • DIRECT_DEBIT - Payment will be taken by Direct Debit.
isDeleted
boolean
hasPremiumFunding
boolean
isInsured
boolean
object (Response Statement of Price)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Remove a VAP

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

vapId
required
string

The ID of a VAP

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a VAP by ID

Returns a value added product matching an ID

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

vapId
required
string

The ID of a VAP

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "provider": {
    },
  • "name": "string",
  • "category": "string",
  • "categoryId": "string",
  • "status": "string",
  • "productCode": "string",
  • "productName": "string",
  • "productTypeCode": "string",
  • "rateCardId": "string",
  • "labourRate": {
    },
  • "claimLimit": {
    },
  • "duration": {
    },
  • "additionalCover": [
    ],
  • "hasSpecialAcceptance": true,
  • "priceNet": {
    },
  • "priceGross": {
    },
  • "taxRate": 0,
  • "taxType": "VAT",
  • "coverStartDate": "2019-08-24T14:15:22Z",
  • "saleDate": "2019-08-24T14:15:22Z",
  • "paymentType": "FINANCE",
  • "isDeleted": true,
  • "hasPremiumFunding": true,
  • "isInsured": true,
  • "statementOfPrice": {
    }
}

Update a VAP

Update a Value Added Product

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

vapId
required
string

The ID of a VAP

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string
category
string
categoryId
string
object (Provider Product Claim Limit)
object (Provider Product Duration)
Array of objects (Provider Product Additional Cover)
hasSpecialAcceptance
boolean
object (Money Type)
object (Money Type)
taxRate
number <float>
taxType
string (TaxType)
Enum: "VAT" "IPT" "ZERO_RATED"

Enumeration that describes a tax type.

  • VAT - Value added tax
  • IPT - Insurance premium tax
  • ZERO_RATED - A taxable product, but with a 0% tax rate
coverStartDate
string <date-time>
saleDate
string <date-time>
paymentType
string (PaymentType)
Enum: "FINANCE" "CASH" "DIRECT_DEBIT"

Enumeration that describes a payment type.

  • FINANCE - Payment will be financed.
  • CASH - Payment will be made in cash.
  • DIRECT_DEBIT - Payment will be taken by Direct Debit.
hasPremiumFunding
boolean
isInsured
boolean
object (Request Statement of Price)
rateCardId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "category": "string",
  • "categoryId": "string",
  • "claimLimit": {
    },
  • "duration": {
    },
  • "additionalCover": [
    ],
  • "hasSpecialAcceptance": true,
  • "priceNet": {
    },
  • "priceGross": {
    },
  • "taxRate": 0,
  • "taxType": "VAT",
  • "coverStartDate": "2019-08-24T14:15:22Z",
  • "saleDate": "2019-08-24T14:15:22Z",
  • "paymentType": "FINANCE",
  • "hasPremiumFunding": true,
  • "isInsured": true,
  • "statementOfPrice": {
    },
  • "rateCardId": "string"
}

Update a VAP's cover start date

Update a Value Added Product's cover start date

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

vapId
required
string

The ID of a VAP

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
coverStartDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "coverStartDate": "2019-08-24T14:15:22Z"
}

Remove a Payment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get payment

Get payment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "pclTermsAndConditionsAccepted": true,
  • "PremiumFundingQuote": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create a payment

Create a payment

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
quoteType
string
quoteId
string
pclTermsAndConditionsAccepted
boolean
applicantId
string
dateOfBirth
string

Responses

Request samples

Content type
application/json
{
  • "quoteType": "string",
  • "quoteId": "string",
  • "pclTermsAndConditionsAccepted": true,
  • "applicantId": "string",
  • "dateOfBirth": "string"
}

Create a new agreement

Create a new agreement

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
accountName
string
accountNumber
string
sortCode
string

Responses

Request samples

Content type
application/json
{
  • "accountName": "string",
  • "accountNumber": "string",
  • "sortCode": "string"
}

Get premium funding quote from PCL

Get premium funding quote from PCL

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

query Parameters
productIds
required
string

The IDs of the products

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "dealId": "string",
  • "applicationId": "string",
  • "products": [
    ],
  • "annualPercentageRate": "string",
  • "totalAmountPayable": {
    },
  • "firstCollectionAmount": {
    },
  • "collectionsNumber": 0,
  • "collecionAmount": {
    },
  • "paymentScheme": "string",
  • "quoteReference": "string",
  • "quote": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "expiryTime": 0
}

Get affordability check from PCL

Get affordability check from PCL

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "loanCheckReference": "string",
  • "affordabilityIndicator": 0,
  • "loanCheckResult": 0,
  • "schemeCode": "string",
  • "forename": "string",
  • "surname": "string",
  • "requestStatusMessage": "string",
  • "loanConfirmed": true
}

Add Product To NotTakenUpProduct

Add product to NotTakenUpProduct

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Provider)
productTypeName
string
productTypeId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "provider": {
    },
  • "productTypeName": "string",
  • "productTypeId": "string"
}

Process Stripe Payment intent event

Process Stripe Payment intent event

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

stripe-signature
required
string

Header to pass stripe signature

Responses

Get User

Returns a user matching the supplied userId

Authorizations:
OAuth2
path Parameters
userId
required
string

The ID of a user

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "forename": "string",
  • "surname": "string",
  • "phone": "string",
  • "mobile": "string",
  • "email": "string",
  • "defaultDealer": {
    },
  • "isActive": true
}

Validate an Application

Returns the validation state of an application

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Dealer

Endpoints relating to Dealers.

Get User's Dealers

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search Dealers

Authorizations:
OAuth2
query Parameters
page
integer

The page number for pagination of results

pageSize
integer

The page size when paginating results

aq
required
string

Additional Query - when searching, this parameter filters the results by an additional search query

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Dealer's Lenders

Returns a list of Lenders that a Dealer has a relationship with

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Dealer Agreement Statuses

Returns Dealer agreement statuses for a provider

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

providerId
required
string

The ID of the Provider

query Parameters
agreements
required
Array of integers

Agreement Ids

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get a Dealer's Provider Agreements

Returns a Dealer's agreements for a provider

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

providerId
required
string

The ID of the Provider

query Parameters
aq
string

Additional Query - when searching, this parameter filters the results by an additional search query

sort
string

Result sort direction - asc or desc

page
integer

The page number for pagination of results

pageSize
integer

The page size when paginating results

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Dealer Provider Agreement

Returns a Dealer agreement for a provider

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

providerId
required
string

The ID of the Provider

agreementId
required
string

The ID of an agreement

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "soldDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "state": "UNDEFINED",
  • "amendmentState": "AMENDMENT_IN_PROGRESS",
  • "status": {
    },
  • "authorisationStatus": {
    },
  • "authorisationType": "string",
  • "dealer": {
    },
  • "currencyCode": "string",
  • "locale": "string",
  • "salesPerson": "string",
  • "customer": {
    },
  • "vehicle": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "actions": {
    },
  • "amendments": {
    },
  • "preActivationValidationErrors": {
    }
}

Get Dealer Statuses

Returns a list of dealer statuses

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get Dealer Users

Returns a list of users for a dealer

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List dealer finance companies

Returns a list of finance companies for the dealer

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Decision

Endpoints relating to Lender decisions.

Get Lender Decisions

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Latest Lender Decisions

Authorizations:
OAuth2
path Parameters
dealId
required
string

The id of the finance deal

applicationId
required
string

the id of the finance application

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "lenderProposalReference": "string",
  • "proposalReference": "string",
  • "lenderStatus": true,
  • "figures": {
    },
  • "notes": [
    ],
  • "errors": [
    ],
  • "signature": {
    }
}

Request a decision from a lender

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Reset a decision request

Authorizations:
OAuth2
path Parameters
requestId
required
string

The id of the request

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Client

Endpoints relating to clients and related entities.

Get clients

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a client

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string
shortName
string
isActive
boolean
isSharedCognitoPool
boolean
cognitoPoolName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "shortName": "string",
  • "isActive": true,
  • "isSharedCognitoPool": true,
  • "cognitoPoolName": "string"
}

Get a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "shortName": "string",
  • "isActive": true,
  • "isSharedCognitoPool": true,
  • "cognitoPoolName": "string"
}

Update a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string
shortName
string
isActive
boolean
isSharedCognitoPool
boolean
cognitoPoolName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "shortName": "string",
  • "isActive": true,
  • "isSharedCognitoPool": true,
  • "cognitoPoolName": "string"
}

Get dealer groups belonging to a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dealer group

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Client)
name
string
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "name": "string",
  • "isActive": true
}

Get a dealer group

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

dealerGroupId
required
string

The id of the dealer group

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "name": "string",
  • "isActive": true
}

Update a dealer group

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

dealerGroupId
required
string

The id of the dealer group

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Client)
name
string
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "name": "string",
  • "isActive": true
}

Get dealers belonging to a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a dealer

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Client)
object (Dealer Group)
name
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
postcode
string
profile
string
phone
string
email
string
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "dealerGroup": {
    },
  • "name": "string",
  • "building": "string",
  • "subBuilding": "string",
  • "street": "string",
  • "city": "string",
  • "county": "string",
  • "district": "string",
  • "postcode": "string",
  • "profile": "string",
  • "phone": "string",
  • "email": "string",
  • "isActive": true
}

Get a dealer

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "dealerGroup": {
    },
  • "name": "string",
  • "building": "string",
  • "subBuilding": "string",
  • "street": "string",
  • "city": "string",
  • "county": "string",
  • "district": "string",
  • "postcode": "string",
  • "profile": "string",
  • "phone": "string",
  • "email": "string",
  • "isActive": true
}

Update a dealer

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Client)
object (Dealer Group)
name
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
postcode
string
profile
string
phone
string
email
string
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "client": {
    },
  • "dealerGroup": {
    },
  • "name": "string",
  • "building": "string",
  • "subBuilding": "string",
  • "street": "string",
  • "city": "string",
  • "county": "string",
  • "district": "string",
  • "postcode": "string",
  • "profile": "string",
  • "phone": "string",
  • "email": "string",
  • "isActive": true
}

Get a client's finance packages

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a client finance package

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Lender Finance Package)
name
string
pauseType
string
acceptanceFee
integer
acceptanceFeePaymentMethod
string
acceptanceFeeInterestCharged
boolean
acceptanceFeePayments
integer
acceptanceFeeEditable
boolean
closureFee
integer
closureFeePaymentMethod
string
closureFeeInterestCharged
boolean
closureFeePayments
integer
closureFeeEditable
boolean
docFeeBranch
number
docFeeGroup
number
allowSubsidy
boolean
allowVaps
boolean
fixedTrueRate
number
minInterest
number
vatAssist
boolean
vatRepaymentMonth
integer
capPercentage
number
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "lenderFinancePackage": {
    },
  • "name": "string",
  • "pauseType": "string",
  • "acceptanceFee": 0,
  • "acceptanceFeePaymentMethod": "string",
  • "acceptanceFeeInterestCharged": true,
  • "acceptanceFeePayments": 0,
  • "acceptanceFeeEditable": true,
  • "closureFee": 0,
  • "closureFeePaymentMethod": "string",
  • "closureFeeInterestCharged": true,
  • "closureFeePayments": 0,
  • "closureFeeEditable": true,
  • "docFeeBranch": 0,
  • "docFeeGroup": 0,
  • "allowSubsidy": true,
  • "allowVaps": true,
  • "fixedTrueRate": 0,
  • "minInterest": 0,
  • "vatAssist": true,
  • "vatRepaymentMonth": 0,
  • "capPercentage": 0,
  • "isActive": true
}

Get a client finance package

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

financePackageId
required
string

The id of the finance package

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderFinancePackage": {
    },
  • "name": "string",
  • "pauseType": "string",
  • "acceptanceFee": 0,
  • "acceptanceFeePaymentMethod": "string",
  • "acceptanceFeeInterestCharged": true,
  • "acceptanceFeePayments": 0,
  • "acceptanceFeeEditable": true,
  • "closureFee": 0,
  • "closureFeePaymentMethod": "string",
  • "closureFeeInterestCharged": true,
  • "closureFeePayments": 0,
  • "closureFeeEditable": true,
  • "docFeeBranch": 0,
  • "docFeeGroup": 0,
  • "allowSubsidy": true,
  • "allowVaps": true,
  • "fixedTrueRate": 0,
  • "minInterest": 0,
  • "vatAssist": true,
  • "vatRepaymentMonth": 0,
  • "capPercentage": 0,
  • "isActive": true
}

Update a client finance package

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

financePackageId
required
string

The id of the finance package

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
object (Lender Finance Package)
name
string
pauseType
string
acceptanceFee
integer
acceptanceFeePaymentMethod
string
acceptanceFeeInterestCharged
boolean
acceptanceFeePayments
integer
acceptanceFeeEditable
boolean
closureFee
integer
closureFeePaymentMethod
string
closureFeeInterestCharged
boolean
closureFeePayments
integer
closureFeeEditable
boolean
docFeeBranch
number
docFeeGroup
number
allowSubsidy
boolean
allowVaps
boolean
fixedTrueRate
number
minInterest
number
vatAssist
boolean
vatRepaymentMonth
integer
capPercentage
number
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "lenderFinancePackage": {
    },
  • "name": "string",
  • "pauseType": "string",
  • "acceptanceFee": 0,
  • "acceptanceFeePaymentMethod": "string",
  • "acceptanceFeeInterestCharged": true,
  • "acceptanceFeePayments": 0,
  • "acceptanceFeeEditable": true,
  • "closureFee": 0,
  • "closureFeePaymentMethod": "string",
  • "closureFeeInterestCharged": true,
  • "closureFeePayments": 0,
  • "closureFeeEditable": true,
  • "docFeeBranch": 0,
  • "docFeeGroup": 0,
  • "allowSubsidy": true,
  • "allowVaps": true,
  • "fixedTrueRate": 0,
  • "minInterest": 0,
  • "vatAssist": true,
  • "vatRepaymentMonth": 0,
  • "capPercentage": 0,
  • "isActive": true
}

Get a client's lender config

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "isResendAllowed": true,
  • "isPackageServiceAvailable": true,
  • "isExtraDataRequired": true,
  • "hasManualSend": true,
  • "hasBusinessManualSend": true,
  • "hasBusinessSupport": true,
  • "hasLeisureAssetSupport": true
}

Update a client's lender config

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
isResendAllowed
boolean
isPackageServiceAvailable
boolean
isExtraDataRequired
boolean
hasManualSend
boolean
hasBusinessManualSend
boolean
hasBusinessSupport
boolean
hasLeisureAssetSupport
boolean

Responses

Request samples

Content type
application/json
{
  • "isResendAllowed": true,
  • "isPackageServiceAvailable": true,
  • "isExtraDataRequired": true,
  • "hasManualSend": true,
  • "hasBusinessManualSend": true,
  • "hasBusinessSupport": true,
  • "hasLeisureAssetSupport": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Get a client's users

Returns a client's users

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a user

Create a user belonging to a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
username
string
forename
string
surname
string
phone
string
mobile
string
email
string
object (Dealer)
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "forename": "string",
  • "surname": "string",
  • "phone": "string",
  • "mobile": "string",
  • "email": "string",
  • "defaultDealer": {
    },
  • "isActive": true
}

Get a user

Returns a user belonging to a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

userId
required
string

The ID of a user

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "forename": "string",
  • "surname": "string",
  • "phone": "string",
  • "mobile": "string",
  • "email": "string",
  • "defaultDealer": {
    },
  • "isActive": true
}

Update a user

Update a user belonging to a client

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

userId
required
string

The ID of a user

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
username
string
forename
string
surname
string
phone
string
mobile
string
email
string
object (Dealer)
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "forename": "string",
  • "surname": "string",
  • "phone": "string",
  • "mobile": "string",
  • "email": "string",
  • "defaultDealer": {
    },
  • "isActive": true
}

Get a user's dealers

Returns the Dealers that a user has access to

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

userId
required
string

The ID of a user

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "dealers": [
    ],
  • "defaultDealer": {
    }
}

Assign dealers to a user

Assign one or more dealers to a user, specifying one dealer as the default

Authorizations:
OAuth2
path Parameters
clientShortName
required
string

The short name of the client

userId
required
string

The ID of a user

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
dealerIds
Array of strings

An array of Dealer IDs

defaultDealerId
string

Responses

Request samples

Content type
application/json
{
  • "dealerIds": [
    ],
  • "defaultDealerId": "string"
}

Lender

Endpoints relating to lenders.

Get lenders

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a lender

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get a lender

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update a lender

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get Lender Additional Details

Returns a list of additional details for a lender

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Lender Finance Packages

Returns a list of lender finance packages

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "productCode": "string",
  • "financeType": "HIRE_PURCHASE",
  • "financePackageType": "STANDARD",
  • "applicationType": [
    ],
  • "vehicleType": [
    ],
  • "interestMethod": "FLAT_RATE",
  • "newUsedType": [
    ],
  • "isActive": true
}

Create Lender Finance Package

Create a lender finance package

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a lender finance package

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

financePackageId
required
string

The id of the finance package

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "productCode": "string",
  • "financeType": "HIRE_PURCHASE",
  • "financePackageType": "STANDARD",
  • "applicationType": [
    ],
  • "vehicleType": [
    ],
  • "interestMethod": "FLAT_RATE",
  • "newUsedType": [
    ],
  • "isActive": true
}

Update a lender's finance package

Authorizations:
OAuth2
path Parameters
lenderId
required
string

The id of the lender

financePackageId
required
string

The id of the finance package

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
name
string
productCode
string
financeType
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
financePackageType
string (FinancePackageType)
Enum: "STANDARD" "SCHEME"

Enumeration that describes a finance package type.

  • STANDARD - A standard finance package.
  • SCHEME - A scheme (promotional) finance package, e.g. short term discounts and offers.
applicationType
Array of strings (DealType)
Items Enum: "PRIVATE" "BUSINESS"
vehicleType
Array of strings (VehicleType)
Items Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"
interestMethod
string (InterestMethod)
Enum: "FLAT_RATE" "APR"

Enumeration that describes an interest method.

  • FLAT_RATE - Flat Rate interest method.
  • APR - Annual Percentage Rate interest method.
newUsedType
Array of strings (VehicleNewUsedType)
Items Enum: "NEW" "USED"
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "productCode": "string",
  • "financeType": "HIRE_PURCHASE",
  • "financePackageType": "STANDARD",
  • "applicationType": [
    ],
  • "vehicleType": [
    ],
  • "interestMethod": "FLAT_RATE",
  • "newUsedType": [
    ],
  • "isActive": true
}

Provider

Endpoints relating to providers.

Build AutoProtect product data

Build AutoProtect product data. This endpoint is restricted to administrators.

Authorizations:
api_key
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Update AutoProtect policies

Update AutoProtect policies statuses and state. This endpoint is restricted to administrators.

Authorizations:
OAuth2api_key
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Process esign events

Process SigniFlow document authorisation events

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Create provider client

Create provider client and dealer

Authorizations:
api_key
path Parameters
providerName
required
string

The name of a Provider

externalReference
required
string

The external reference of a Dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
name
string
isComplianceEnabled
boolean
isActive
boolean
isDealerGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isComplianceEnabled": true,
  • "isActive": true,
  • "isDealerGroup": true
}

Migrate provider dealer

Migrate provider dealer

Authorizations:
api_key
path Parameters
providerName
required
string

The name of a Provider

externalReference
required
string

The external reference of a Dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
isComplianceEnabled
boolean
isDealerGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "isComplianceEnabled": true,
  • "isDealerGroup": true
}

Get dealer migration

Returns a summary of a dealer migration status

Authorizations:
api_key
path Parameters
providerName
required
string

The name of a Provider

externalReference
required
string

The external reference of a Dealer

query Parameters
isDealerGroup
boolean

Whether or not a provided ID belongs to a dealer group

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "shortName": "string",
  • "isActive": true,
  • "isSharedCognitoPool": true,
  • "cognitoPoolName": "string"
}

Update provider dealer data

Update provider dealer data. This endpoint is restricted to administrators.

Authorizations:
api_key
path Parameters
providerName
required
string

The name of a Provider

externalReference
required
string

The external reference of a Dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
isComplianceEnabled
boolean
isDealerGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "isComplianceEnabled": true,
  • "isDealerGroup": true
}

List

Endpoints that list enumerations.

List Addresses by Postcode

Returns a list of addresses matching a postcode

Authorizations:
OAuth2
query Parameters
postcode
required
string

The postcode

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List an Address

Returns an address matching an address ID

Authorizations:
OAuth2
path Parameters
addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Agreement Cancellation Reasons

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Agreement Manual Sign Reasons

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Asset Fuel Types

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Asset Makes

Returns asset makes

Authorizations:
OAuth2
query Parameters
vehicleType
required
string
Examples:
  • vehicleType=PRIVATE_LIGHT_GOODS_VEHICLE - Car
  • vehicleType=LIGHT_COMMERCIAL_VEHICLE - Van

The vehicle type in the naturalCode format (e.g PRIVATE_LIGHT_GOODS_VEHICLE) from the getVehicleTypes endpoint

lookupType
string
Default: "CAP"
Examples:
  • lookupType=CAP -
  • lookupType=GLASS -

Lookup provider type - currently we only support either CAP or GLASS data

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

List Asset Models

Returns asset models

Authorizations:
OAuth2
query Parameters
make
string

The vehicle make

vehicleType
required
string
Examples:
  • vehicleType=PRIVATE_LIGHT_GOODS_VEHICLE - Car
  • vehicleType=LIGHT_COMMERCIAL_VEHICLE - Van

The vehicle type in the naturalCode format (e.g PRIVATE_LIGHT_GOODS_VEHICLE) from the getVehicleTypes endpoint

lookupType
string
Default: "CAP"
Examples:
  • lookupType=CAP -
  • lookupType=GLASS -

Lookup provider type - currently we only support either CAP or GLASS data

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Asset Styles

Returns asset styles

Authorizations:
OAuth2
query Parameters
model
string

The vehicle model

make
string

The vehicle make

vehicleType
required
string
Examples:
  • vehicleType=PRIVATE_LIGHT_GOODS_VEHICLE - Car
  • vehicleType=LIGHT_COMMERCIAL_VEHICLE - Van

The vehicle type in the naturalCode format (e.g PRIVATE_LIGHT_GOODS_VEHICLE) from the getVehicleTypes endpoint

lookupType
string
Default: "CAP"
Examples:
  • lookupType=CAP -
  • lookupType=GLASS -

Lookup provider type - currently we only support either CAP or GLASS data

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Asset Transmission Types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Asset Usages

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List vehicle types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

List Banks

Returns a list of banks matching an account number and sort code

Authorizations:
OAuth2
query Parameters
accountNumber
string

A bank account number

sortCode
string

A bank sort code

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Countries

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List dealer finance companies

Returns a list of finance companies for the dealer

Authorizations:
OAuth2
path Parameters
dealerId
required
string

The id of the dealer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Driving Licence Types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Employment Occupations

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Employment Sectors

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Employment Statuses

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List finance payment methods

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List finance payment types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List VAT Options

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Marital Statuses

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Nationalities

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Passport Types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Compliance Opt-out Disclaimer Types

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Residential Statuses

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List user titles

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

List Vehicle by VRM

Returns a vehicle matching the provided VRM and/or VIN for a specific provider

Authorizations:
OAuth2
query Parameters
vrm
string

Vehicle registration mark

providerId
integer

Vehicle lookup provider Id

vin
string

Vehicle identification number

getMotData
string

Returns additional MOT information about the vehicle

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Customer

Endpoints relating to customers.

Get Customers

Returns a list of customers

Authorizations:
OAuth2
query Parameters
sort
string

Result sort direction - asc or desc

aq
string

Additional Query - when searching, this parameter filters the results by an additional search query

page
integer

The page number for pagination of results

pageSize
integer

The page size when paginating results

dealerId
string

The Dealer ID

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Customer

Authorizations:
OAuth2
header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a Customer

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string"
}

Update a Customer

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
forename
string
middleName
string
surname
string
maidenName
string
title
string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
gender
string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
Array of objects (Redidential Address)
Array of objects (Employment)
maritalStatus
string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
dateOfBirth
string <date-time>
mobileNumber
string
homeNumber
string
workNumber
string
emailAddress
string
passportType
string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
nationality
string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
drivingLicenceType
string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
drivingLicenceNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string"
}

Get Customer Addresses

Returns the addresses for a customer

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Customer Address

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Update Customer Addresses

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
id
string
flat
string
houseName
string
houseNumber
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
countryName
string
countryCode
string
postcode
string
fromDate
string <date-time>
endDate
string <date-time>
residentialStatus
string (ResidentialStatus)
Enum: "HOME_OWNER" "CO_HOME_OWNER" "COUNCIL_TENANT" "HOUSING_ASSOCIATION" "LIVING_WITH_PARENTS" "PRIVATE_TENANT"

Enumeration that describes a residential status.

  • HOME_OWNER - The applicant is a home owner.
  • CO_HOME_OWNER - The applicant owns a home with someone else.
  • COUNCIL_TENANT - The applicant is a council tenant.
  • HOUSING_ASSOCIATION - The applicant is a housing association tenant.
  • LIVING_WITH_PARENTS - The applicant lives with their parents.
  • PRIVATE_TENANT - The applicant is a private tenant.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Remove a Customer Address

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a Customer Address

Returns a customer address

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "houseNumber": "1",
  • "street": "1 Upper Lane",
  • "city": "Leeds",
  • "county": "West Yorkshire",
  • "district": "",
  • "countryName": "United Kingdom",
  • "countryCode": "UK",
  • "postcode": "LS1 2QE",
  • "fromDate": "2018-01-01T09:00:00.000Z",
  • "residentialStatus": "HOME_OWNER"
}

Update a Customer Address

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

addressId
required
string

The id of the address

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
id
string
flat
string
houseName
string
houseNumber
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
countryName
string
countryCode
string
postcode
string
fromDate
string <date-time>
endDate
string <date-time>
residentialStatus
string (ResidentialStatus)
Enum: "HOME_OWNER" "CO_HOME_OWNER" "COUNCIL_TENANT" "HOUSING_ASSOCIATION" "LIVING_WITH_PARENTS" "PRIVATE_TENANT"

Enumeration that describes a residential status.

  • HOME_OWNER - The applicant is a home owner.
  • CO_HOME_OWNER - The applicant owns a home with someone else.
  • COUNCIL_TENANT - The applicant is a council tenant.
  • HOUSING_ASSOCIATION - The applicant is a housing association tenant.
  • LIVING_WITH_PARENTS - The applicant lives with their parents.
  • PRIVATE_TENANT - The applicant is a private tenant.

Responses

Request samples

Content type
application/json
{
  • "id": "1",
  • "houseNumber": "1",
  • "street": "1 Upper Lane",
  • "city": "Leeds",
  • "county": "West Yorkshire",
  • "district": "",
  • "countryName": "United Kingdom",
  • "countryCode": "UK",
  • "postcode": "LS1 2QE",
  • "fromDate": "2018-01-01T09:00:00.000Z",
  • "residentialStatus": "HOME_OWNER"
}

Get Customer Employments

Returns a list of employments for a customer

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Customer Employment

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
id
string
occupation
string
employmentStatus
string (EmploymentStatus)
Enum: "FULL_TIME_PERMANENT" "PART_TIME_PERMANENT" "FULL_TIME_TEMPORARY" "PART_TIME_TEMPORARY" "FULL_TIME_AGENCY" "PART_TIME_AGENCY" "SUB_CONTRACTOR" "SELF_EMPLOYED" "UNEMPLOYED" "RETIRED" "STUDENT" "HOME_MAKER" "UNABLE_TO_WORK"

Enumeration that describes an employment status.

  • FULL_TIME_PERMANENT - The applicant has full time permanent employment.
  • PART_TIME_PERMANENT - The applicant has part time permanent employment.
  • FULL_TIME_TEMPORARY - The applicant has full time temporary employment.
  • PART_TIME_TEMPORARY - The applicant has part time temporary employment.
  • FULL_TIME_AGENCY - The applicant works full time for an agency.
  • PART_TIME_AGENCY - The applicant works part time for an agency.
  • SUB_CONTRACTOR - The applicant is a sub contractor.
  • SELF_EMPLOYED - The applicant is self employed.
  • UNEMPLOYED - The applicant is unemployed.
  • RETIRED - The applicant is retired.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • UNABLE_TO_WORK - The applicant is unable to work.
companyName
string
fromDate
string <date-time>
endDate
string <date-time>
employmentSector
string (EmploymentSector)
Enum: "PRIVATE" "GOVERNMENT" "MILITARY" "SELF_EMPLOYED" "STUDENT" "HOME_MAKER" "RETIRED" "UNABLE_TO_WORK" "UNEMPLOYED"

Enumeration that describes an employment sector.

  • PRIVATE - The applicant works for a private sector company.
  • GOVERNMENT - The applicant works for the government.
  • MILITARY - The applicant works for the military.
  • SELF_EMPLOYED - The applicant is self employed.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • RETIRED - The applicant is retired.
  • UNABLE_TO_WORK - The applicant is unable to work.
  • UNEMPLOYED - The applicant is unemployed.
annualIncome
number
object (Commercial Address)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Remove a Customer Employment

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Get a Customer Employment

Returns a customer employment

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "occupation": "Baker",
  • "employmentStatus": "FULL_TIME_PERMANENT",
  • "companyName": "ACME Bakery",
  • "fromDate": "2019-01-02T09:00:00.000Z",
  • "employmentSector": "PRIVATE",
  • "annualIncome": 30000,
  • "address": {
    }
}

Update a Customer Employment

Authorizations:
OAuth2
path Parameters
customerId
required
string

The id of the customer

employmentId
required
string

The id of the employment

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Request Body schema: application/json
Array ()
id
string
occupation
string
employmentStatus
string (EmploymentStatus)
Enum: "FULL_TIME_PERMANENT" "PART_TIME_PERMANENT" "FULL_TIME_TEMPORARY" "PART_TIME_TEMPORARY" "FULL_TIME_AGENCY" "PART_TIME_AGENCY" "SUB_CONTRACTOR" "SELF_EMPLOYED" "UNEMPLOYED" "RETIRED" "STUDENT" "HOME_MAKER" "UNABLE_TO_WORK"

Enumeration that describes an employment status.

  • FULL_TIME_PERMANENT - The applicant has full time permanent employment.
  • PART_TIME_PERMANENT - The applicant has part time permanent employment.
  • FULL_TIME_TEMPORARY - The applicant has full time temporary employment.
  • PART_TIME_TEMPORARY - The applicant has part time temporary employment.
  • FULL_TIME_AGENCY - The applicant works full time for an agency.
  • PART_TIME_AGENCY - The applicant works part time for an agency.
  • SUB_CONTRACTOR - The applicant is a sub contractor.
  • SELF_EMPLOYED - The applicant is self employed.
  • UNEMPLOYED - The applicant is unemployed.
  • RETIRED - The applicant is retired.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • UNABLE_TO_WORK - The applicant is unable to work.
companyName
string
fromDate
string <date-time>
endDate
string <date-time>
employmentSector
string (EmploymentSector)
Enum: "PRIVATE" "GOVERNMENT" "MILITARY" "SELF_EMPLOYED" "STUDENT" "HOME_MAKER" "RETIRED" "UNABLE_TO_WORK" "UNEMPLOYED"

Enumeration that describes an employment sector.

  • PRIVATE - The applicant works for a private sector company.
  • GOVERNMENT - The applicant works for the government.
  • MILITARY - The applicant works for the military.
  • SELF_EMPLOYED - The applicant is self employed.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • RETIRED - The applicant is retired.
  • UNABLE_TO_WORK - The applicant is unable to work.
  • UNEMPLOYED - The applicant is unemployed.
annualIncome
number
object (Commercial Address)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Vehicle

Endpoints relating to vehicless.

Get Vehicle Valuation

Get Vehicle Valuation from VRM or Capcode

Authorizations:
OAuth2
query Parameters
vrm
string

Vehicle registration mark

mileage
required
string

The mileage of a vehicle

capCode
string

Cap Code for the vehicle

firstRegisteredDate
string

The vehicle registration date

header Parameters
x-datadog-trace-id
string

Allows Datadog to link traces with RUM resource

x-datadog-sampling-priority
string

To make sure that the Agent keeps the trace

x-datadog-parent-id
string

Allows Datadog to generate the first span from the trace

x-datadog-origin
string

Set origin of traces from RUM

Responses

Response samples

Content type
application/json
{
  • "retail": {
    },
  • "clean": {
    }
}

Deal

id
string
referenceCode
string
currency
string
locale
string
object (Client)
object (Dealer)
object (User)
object (User)
status
string (DealStatus)
Enum: "NEW_DEAL" "UNSENT_DEAL" "AWAITING_DECISION" "CONDITIONALLY_APPROVED" "APPROVED" "AWAITING_DELIVERY" "AWAITING_E_SIGN" "AWAITING_PAYOUT" "PAID_OUT" "DECLINED_BY_ALL_LENDERS" "CANCELLED" "NOT_TAKEN_UP"

Enumeration that describes a deal status.

  • NEW_DEAL - The Deal is newly created.
  • UNSENT_DEAL - The Deal has not been sent to a Lender yet.
  • AWAITING_DECISION - Awaiting a decision from a Lender.
  • CONDITIONALLY_APPROVED - The Deal Finance has been conditionally approved by a Lender.
  • APPROVED - The Deal Finance has been approved by a Lender.
  • AWAITING_DELIVERY - The Deal vehicle is awaiting delivery.
  • AWAITING_E_SIGN - The Deal Finance is awaiting E-sign.
  • AWAITING_PAYOUT - The Deal Finance is awaiting payout from the Lender.
  • PAID_OUT - The Deal has been paid out.
  • DECLINED_BY_ALL_LENDERS - The Deal has been declined by all Lenders.
  • CANCELLED - The deal has been cancelled.
  • NOT_TAKEN_UP - The deal has not been taken up with the Lender.
type
required
string (DealType)
Enum: "PRIVATE" "BUSINESS"

Enumeration that describes a Deal type.

  • PRIVATE - A private, non commercial Deal.
  • BUSINESS - A business, commercial Deal.
Array of objects (Application)
{
  • "id": "string",
  • "referenceCode": "string",
  • "currency": "string",
  • "locale": "string",
  • "client": {
    },
  • "dealer": {
    },
  • "assignedUser": {
    },
  • "assignedSalesUser": {
    },
  • "status": "NEW_DEAL",
  • "type": "PRIVATE",
  • "applications": [
    ]
}

Client

id
string
name
string
shortName
string
isActive
boolean
isSharedCognitoPool
boolean
cognitoPoolName
string
{
  • "id": "string",
  • "name": "string",
  • "shortName": "string",
  • "isActive": true,
  • "isSharedCognitoPool": true,
  • "cognitoPoolName": "string"
}

Customer

id
string
forename
string
middleName
string
surname
string
maidenName
string
title
string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
gender
string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
Array of objects (Redidential Address)
Array of objects (Employment)
maritalStatus
string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
dateOfBirth
string <date-time>
mobileNumber
string
homeNumber
string
workNumber
string
emailAddress
string
passportType
string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
nationality
string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
drivingLicenceType
string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
drivingLicenceNumber
string
{
  • "id": "string",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string"
}

Dealer

id
string
object (Client)
object (Dealer Group)
name
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
postcode
string
profile
string
phone
string
email
string
isActive
boolean
{
  • "id": "string",
  • "client": {
    },
  • "dealerGroup": {
    },
  • "name": "string",
  • "building": "string",
  • "subBuilding": "string",
  • "street": "string",
  • "city": "string",
  • "county": "string",
  • "district": "string",
  • "postcode": "string",
  • "profile": "string",
  • "phone": "string",
  • "email": "string",
  • "isActive": true
}

Dealer Group

id
string
object (Client)
name
string
isActive
boolean
{
  • "id": "string",
  • "client": {
    },
  • "name": "string",
  • "isActive": true
}

Application

id
string
status
string
Array of objects (Applicant)
object (Vehicle)

A vehicle, like a car

Array of objects (Additional Charge)
object (Financials)

Financial Entity

Array of objects (Additional Detail)
{
  • "id": "string",
  • "status": "string",
  • "applicants": [
    ],
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    },
  • "additionalDetails": [
    ]
}

Applicant

id
string
isPrimary
boolean

Is the applicant the primary applicant.

type
string (ApplicantType)
Enum: "HIRER" "JOINT" "GUARANTOR"

Enumeration that describes an applicant type

  • HIRER - The applicant is the primary hirer.
  • JOINT - The applicant is a joint applicant for the primary hirer.
  • GUARANTOR - The applicant is the guarantor for the primary hirer.
forename
string
middleName
string
surname
string
maidenName
string
title
string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
gender
string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
Array of objects (Redidential Address)
Array of objects (Employment)
maritalStatus
string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
dateOfBirth
string <date-time>
mobileNumber
string
homeNumber
string
workNumber
string
emailAddress
string
passportType
string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
nationality
string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
drivingLicenceType
string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
drivingLicenceNumber
string
vehicleUsageType
string (UsageType)
Enum: "PRIVATE" "COMMERCIAL" "MOTABILITY" "HIRE_AND_REWARD" "LIFESTYLE" "DRIVING_SCHOOL"

Enumeration that describes a vehicle usage type.

  • PRIVATE - Social, domestic, pleasure and commuting.
  • COMMERCIAL - Commercial vehicle for business use.
  • MOTABILITY - Vehicle is being sold on Motability contract hire.
  • HIRE_AND_REWARD - Vehicle is used for Taxi, Private Hire, Courier or Minibus.
  • LIFESTYLE - Vehicle is used for a lifestyle or hobby activity.
  • DRIVING_SCHOOL - Vehicle is used for driving lessons.
object (Marketing)
object (Bank)
numberOfDependants
integer
{
  • "id": "string",
  • "isPrimary": true,
  • "type": "HIRER",
  • "forename": "string",
  • "middleName": "string",
  • "surname": "string",
  • "maidenName": "string",
  • "title": "MR",
  • "gender": "MALE",
  • "addresses": [
    ],
  • "employments": [
    ],
  • "maritalStatus": "SINGLE",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "mobileNumber": "string",
  • "homeNumber": "string",
  • "workNumber": "string",
  • "emailAddress": "string",
  • "passportType": "UK_PASSPORT",
  • "nationality": "AFGHAN",
  • "drivingLicenceType": "FULL",
  • "drivingLicenceNumber": "string",
  • "vehicleUsageType": "PRIVATE",
  • "marketing": {
    },
  • "bank": {
    },
  • "numberOfDependants": 0
}

Commercial Address

id
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
countryName
string
countryCode
string
postcode
string
{
  • "id": "string",
  • "building": "string",
  • "subBuilding": "string",
  • "street": "string",
  • "city": "string",
  • "county": "string",
  • "district": "string",
  • "countryName": "string",
  • "countryCode": "string",
  • "postcode": "string"
}

Residential Address

id
string
flat
string
houseName
string
houseNumber
string
building
string
subBuilding
string
street
string
city
string
county
string
district
string
countryName
string
countryCode
string
postcode
string
fromDate
string <date-time>
endDate
string <date-time>
residentialStatus
string (ResidentialStatus)
Enum: "HOME_OWNER" "CO_HOME_OWNER" "COUNCIL_TENANT" "HOUSING_ASSOCIATION" "LIVING_WITH_PARENTS" "PRIVATE_TENANT"

Enumeration that describes a residential status.

  • HOME_OWNER - The applicant is a home owner.
  • CO_HOME_OWNER - The applicant owns a home with someone else.
  • COUNCIL_TENANT - The applicant is a council tenant.
  • HOUSING_ASSOCIATION - The applicant is a housing association tenant.
  • LIVING_WITH_PARENTS - The applicant lives with their parents.
  • PRIVATE_TENANT - The applicant is a private tenant.
{
  • "id": "1",
  • "houseNumber": "1",
  • "street": "1 Upper Lane",
  • "city": "Leeds",
  • "county": "West Yorkshire",
  • "district": "",
  • "countryName": "United Kingdom",
  • "countryCode": "UK",
  • "postcode": "LS1 2QE",
  • "fromDate": "2018-01-01T09:00:00.000Z",
  • "residentialStatus": "HOME_OWNER"
}

Bank

id
string
name
string
accountName
string
accountNumber
string
sortCode
string
fromDate
string
object (Commercial Address)
{
  • "id": "string",
  • "name": "string",
  • "accountName": "string",
  • "accountNumber": "string",
  • "sortCode": "string",
  • "fromDate": "string",
  • "address": {
    }
}

Financials

financeProduct
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
object (Money Type)
object (Money Type)
assetVatQualifying
boolean
object (Money Type)
object (Money Type)
object (Money Type)
loanToValue
number
vatRate
number
object (Financial Deposit)
maxAnnualMileage
integer
object (Money Type)
object (Money Type)
term
integer
aprRate
number
object (Money Type)
object (Money Type)
object (Financial Totals)
{
  • "financeProduct": "HIRE_PURCHASE",
  • "assetPriceNet": {
    },
  • "assetPriceGross": {
    },
  • "assetVatQualifying": true,
  • "roadPriceNet": {
    },
  • "roadPriceGross": {
    },
  • "balanceToFinance": {
    },
  • "loanToValue": 0,
  • "vatRate": 0,
  • "deposit": {
    },
  • "maxAnnualMileage": 0,
  • "gfv": {
    },
  • "balloon": {
    },
  • "term": 0,
  • "aprRate": 0,
  • "monthlyPayment": {
    },
  • "commission": {
    },
  • "totals": {
    }
}

Financial Deposit

object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
{
  • "partExchangeDeposit": {
    },
  • "settlement": {
    },
  • "cashDeposit": {
    },
  • "cardDeposit": {
    },
  • "chequeDeposit": {
    },
  • "manufacturerDeposit": {
    }
}

Financial Total

object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
object (Money Type)
{
  • "vehicleNet": {
    },
  • "vehicleGross": {
    },
  • "accessoriesNet": {
    },
  • "accessoriesGross": {
    },
  • "additionalChargesNet": {
    },
  • "additionalChargesGross": {
    }
}

Additional Charge

name
string
type
string (AdditionalChargeType)
Enum: "ACCESSORY" "FEE"

Enumeration that describes an additional charge type

  • ACCESSORY - The charge type is an accessory, e.g. car mats or a sat nav.
  • FEE - The charge type is a fee, e.g. delivery fee or road tax.
paymentType
string (PaymentType)
Enum: "FINANCE" "CASH" "DIRECT_DEBIT"

Enumeration that describes a payment type.

  • FINANCE - Payment will be financed.
  • CASH - Payment will be made in cash.
  • DIRECT_DEBIT - Payment will be taken by Direct Debit.
object (Money Type)
object (Money Type)
taxRate
number
{
  • "name": "string",
  • "type": "ACCESSORY",
  • "paymentType": "FINANCE",
  • "priceNet": {
    },
  • "priceGross": {
    },
  • "taxRate": 0
}

Additional Detail

object (Lender)
name
string
sequence
string
type
string
isRequired
boolean
values
Array of strings
{
  • "lender": {
    },
  • "name": "string",
  • "sequence": "string",
  • "type": "string",
  • "isRequired": true,
  • "values": [
    ]
}

Provider

id
string
name
string
{
  • "id": "string",
  • "name": "string"
}

Provider Agreement

id
string
reference
string
createdDate
string <date-time>
soldDate
string <date-time>
activationDate
string <date-time>
lastUpdatedDate
string <date-time>
state
string (ProviderAgreementState)
Enum: "UNDEFINED" "QUOTED" "APPROVAL_REQUIRED" "APPROVAL_PENDING" "APPROVAL_DECLINED" "AUTHORISATION_REQUIRED" "AUTHORISATION_REAUTH_REQUIRED" "AUTHORISATION_PENDING" "AUTHORISATION_APPROVED" "AUTHORISATION_DECLINED" "ACTIVATION_REQUIRED" "ACTIVATION_APPROVED" "ACTIVATION_DECLINED"

Enumeration that describes the state of an agreement

  • UNDEFINED - It is impossible to determine the policy state.
  • QUOTED - The agreement quotation process is in a completed state.
  • APPROVAL_REQUIRED - The agreement is in a state where approval is required approval from a provider.
  • APPROVAL_PENDING - The agreement is in a state where it is pending approval from a provider.
  • APPROVAL_DECLINED - Approval from a provider has been declined.
  • AUTHORISATION_REQUIRED - Authorisation for a provider agreement is required.
  • AUTHORISATION_REAUTH_REQUIRED - Re-authorisation for a provider agreement is required.
  • AUTHORISATION_PENDING - The agreement is in a state where it is pending authorisation from a provider.
  • AUTHORISATION_APPROVED - Authorisation has been given for a provider agreement.
  • AUTHORISATION_DECLINED - Authorisation for a provider agreement has been declined.
  • ACTIVATION_REQUIRED - Activation for a provider agreement is required.
  • ACTIVATION_APPROVED - Activation has been given for a provider agreement.
  • ACTIVATION_DECLINED - Activation for a provider agreement has been declined.
amendmentState
string (ProviderAgreementAmendmentState)
Enum: "AMENDMENT_IN_PROGRESS" null

Enumeration that describes the state of an agreement amendment

  • AMENDMENT_IN_PROGRESS - Provider agreement amendment waiting to apply or cancel.
  • null - Provider agreement is not in amendment state.
object
object
authorisationType
string
object (Provider Agreement Dealer)
currencyCode
string
locale
string
salesPerson
string
object (Provider Agreement Customer)
object (Provider Agreement Vehicle)
Array of objects (Provider Agreement Product)
Array of objects (Provider Agreement Document)
object (Provider Agreement Actions)
object (Provider Agreement Amendments)
object (Validation errors)
{
  • "id": "string",
  • "reference": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "soldDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "state": "UNDEFINED",
  • "amendmentState": "AMENDMENT_IN_PROGRESS",
  • "status": {
    },
  • "authorisationStatus": {
    },
  • "authorisationType": "string",
  • "dealer": {
    },
  • "currencyCode": "string",
  • "locale": "string",
  • "salesPerson": "string",
  • "customer": {
    },
  • "vehicle": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "actions": {
    },
  • "amendments": {
    },
  • "preActivationValidationErrors": {
    }
}

Lender

id
string
name
string
{
  • "id": "string",
  • "name": "string"
}

Lender Finance Package

id
string
name
string
productCode
string
financeType
string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
financePackageType
string (FinancePackageType)
Enum: "STANDARD" "SCHEME"

Enumeration that describes a finance package type.

  • STANDARD - A standard finance package.
  • SCHEME - A scheme (promotional) finance package, e.g. short term discounts and offers.
applicationType
Array of strings (DealType)
Items Enum: "PRIVATE" "BUSINESS"
vehicleType
Array of strings (VehicleType)
Items Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"
interestMethod
string (InterestMethod)
Enum: "FLAT_RATE" "APR"

Enumeration that describes an interest method.

  • FLAT_RATE - Flat Rate interest method.
  • APR - Annual Percentage Rate interest method.
newUsedType
Array of strings (VehicleNewUsedType)
Items Enum: "NEW" "USED"
isActive
boolean
{
  • "id": "string",
  • "name": "string",
  • "productCode": "string",
  • "financeType": "HIRE_PURCHASE",
  • "financePackageType": "STANDARD",
  • "applicationType": [
    ],
  • "vehicleType": [
    ],
  • "interestMethod": "FLAT_RATE",
  • "newUsedType": [
    ],
  • "isActive": true
}

Client Finance Package

id
string
object (Lender Finance Package)
name
string
pauseType
string
acceptanceFee
integer
acceptanceFeePaymentMethod
string
acceptanceFeeInterestCharged
boolean
acceptanceFeePayments
integer
acceptanceFeeEditable
boolean
closureFee
integer
closureFeePaymentMethod
string
closureFeeInterestCharged
boolean
closureFeePayments
integer
closureFeeEditable
boolean
docFeeBranch
number
docFeeGroup
number
allowSubsidy
boolean
allowVaps
boolean
fixedTrueRate
number
minInterest
number
vatAssist
boolean
vatRepaymentMonth
integer
capPercentage
number
isActive
boolean
{
  • "id": "string",
  • "lenderFinancePackage": {
    },
  • "name": "string",
  • "pauseType": "string",
  • "acceptanceFee": 0,
  • "acceptanceFeePaymentMethod": "string",
  • "acceptanceFeeInterestCharged": true,
  • "acceptanceFeePayments": 0,
  • "acceptanceFeeEditable": true,
  • "closureFee": 0,
  • "closureFeePaymentMethod": "string",
  • "closureFeeInterestCharged": true,
  • "closureFeePayments": 0,
  • "closureFeeEditable": true,
  • "docFeeBranch": 0,
  • "docFeeGroup": 0,
  • "allowSubsidy": true,
  • "allowVaps": true,
  • "fixedTrueRate": 0,
  • "minInterest": 0,
  • "vatAssist": true,
  • "vatRepaymentMonth": 0,
  • "capPercentage": 0,
  • "isActive": true
}

Dealer Lender Credential

username
string
password
string
docsUsername
string
docsPassword
string
quoteUsername
string
quotePassword
string
{
  • "username": "string",
  • "password": "string",
  • "docsUsername": "string",
  • "docsPassword": "string",
  • "quoteUsername": "string",
  • "quotePassword": "string"
}

Dealer Lender Identifier

object (Client Finance Package)
vehicleType
string (VehicleType)
Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"

Enumeration that describes a vehicle type.

  • PRIVATE_LIGHT_GOODS_VEHICLE - The vehicle is a private light goods vehicle.
  • LIGHT_COMMERCIAL_VEHICLE - The vehicle is a light commercial vehicle.
  • CARAVAN - The vehicle is a caravan.
  • MOTORHOME - The vehicle is a motorhome.
  • MOTORBIKE - The vehicle is a motorbike.
  • OTHER - The vehicle type is not defined.
  • HEAVY_GOODS_VEHICLE - The vehicle is a heavy goods vehicle.
identifier
string
{
  • "clientFinancePackage": {
    },
  • "vehicleType": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "identifier": "string"
}

Value Added Product (VAP)

id
string
required
object (Provider)
name
required
string
category
required
string
categoryId
string
status
string
productCode
required
string
productName
string
productTypeCode
required
string
rateCardId
required
string
required
object (Provider Product Labour Rate)
required
object (Provider Product Claim Limit)
required
object (Provider Product Duration)
Array of objects (Provider Product Additional Cover)
hasSpecialAcceptance
boolean
object (Money Type)
required
object (Money Type)
taxRate
required
number <float>
taxType
required
string (TaxType)
Enum: "VAT" "IPT" "ZERO_RATED"

Enumeration that describes a tax type.

  • VAT - Value added tax
  • IPT - Insurance premium tax
  • ZERO_RATED - A taxable product, but with a 0% tax rate
coverStartDate
string <date-time>
saleDate
string <date-time>
paymentType
string (PaymentType)
Enum: "FINANCE" "CASH" "DIRECT_DEBIT"

Enumeration that describes a payment type.

  • FINANCE - Payment will be financed.
  • CASH - Payment will be made in cash.
  • DIRECT_DEBIT - Payment will be taken by Direct Debit.
isDeleted
boolean
hasPremiumFunding
boolean
isInsured
boolean
object (Response Statement of Price)
{
  • "id": "string",
  • "provider": {
    },
  • "name": "string",
  • "category": "string",
  • "categoryId": "string",
  • "status": "string",
  • "productCode": "string",
  • "productName": "string",
  • "productTypeCode": "string",
  • "rateCardId": "string",
  • "labourRate": {
    },
  • "claimLimit": {
    },
  • "duration": {
    },
  • "additionalCover": [
    ],
  • "hasSpecialAcceptance": true,
  • "priceNet": {
    },
  • "priceGross": {
    },
  • "taxRate": 0,
  • "taxType": "VAT",
  • "coverStartDate": "2019-08-24T14:15:22Z",
  • "saleDate": "2019-08-24T14:15:22Z",
  • "paymentType": "FINANCE",
  • "isDeleted": true,
  • "hasPremiumFunding": true,
  • "isInsured": true,
  • "statementOfPrice": {
    }
}

Quotation

id
required
string
quotationDate
string <date-time>
expiryDate
string <date-time>
object (Client Finance Package)
object (Lender)
object (Vehicle)

A vehicle, like a car

Array of objects (Additional Charge)
object (Financials)

Financial Entity

{
  • "id": "string",
  • "quotationDate": "2019-08-24T14:15:22Z",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "financePackage": {
    },
  • "lender": {
    },
  • "asset": {
    },
  • "additionalCharges": [
    ],
  • "financials": {
    }
}

User

id
string
username
string
forename
string
surname
string
phone
string
mobile
string
email
string
object (Dealer)
isActive
boolean
{
  • "id": "string",
  • "username": "string",
  • "forename": "string",
  • "surname": "string",
  • "phone": "string",
  • "mobile": "string",
  • "email": "string",
  • "defaultDealer": {
    },
  • "isActive": true
}

Vehicle

type
string (VehicleType)
Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"

Enumeration that describes a vehicle type.

  • PRIVATE_LIGHT_GOODS_VEHICLE - The vehicle is a private light goods vehicle.
  • LIGHT_COMMERCIAL_VEHICLE - The vehicle is a light commercial vehicle.
  • CARAVAN - The vehicle is a caravan.
  • MOTORHOME - The vehicle is a motorhome.
  • MOTORBIKE - The vehicle is a motorbike.
  • OTHER - The vehicle type is not defined.
  • HEAVY_GOODS_VEHICLE - The vehicle is a heavy goods vehicle.
isNew
boolean
make
string
makeValue
string
model
string
modelValue
string
engineSize
string
style
string
styleValue
string
doors
number
registrationNumber
string
grossWeight
integer
firstRegistered
string <date-time>
vin
string
capcode
string
glassesCode
string
glassesFamily
string
colour
string
fuelType
string
transmissionType
string
yearOfManufacture
number
imported
boolean
mileage
integer
stockNumber
string
deliveryDate
string <date-time>
isUkSpecification
boolean
purchaseDate
string <date-time>
motDueDate
string <date-time>
mfrWarrantyExpiryDate
string <date-time>
nonEditableFields
Array of strings
{
  • "type": "PRIVATE_LIGHT_GOODS_VEHICLE",
  • "isNew": true,
  • "make": "string",
  • "makeValue": "string",
  • "model": "string",
  • "modelValue": "string",
  • "engineSize": "string",
  • "style": "string",
  • "styleValue": "string",
  • "doors": 0,
  • "registrationNumber": "string",
  • "grossWeight": 0,
  • "firstRegistered": "2019-08-24T14:15:22Z",
  • "vin": "string",
  • "capcode": "string",
  • "glassesCode": "string",
  • "glassesFamily": "string",
  • "colour": "string",
  • "fuelType": "string",
  • "transmissionType": "string",
  • "yearOfManufacture": 0,
  • "imported": true,
  • "mileage": 0,
  • "stockNumber": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "isUkSpecification": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "motDueDate": "2019-08-24T14:15:22Z",
  • "mfrWarrantyExpiryDate": "2019-08-24T14:15:22Z",
  • "nonEditableFields": [
    ]
}

Error

type
required
string
code
required
integer
message
required
string
{
  • "type": "string",
  • "code": 0,
  • "message": "string"
}

Money Type

amount
string
currency
string
{
  • "amount": "1000",
  • "currency": "GBP"
}

Additional Charge Type

string (AdditionalChargeType)
Enum: "ACCESSORY" "FEE"

Enumeration that describes an additional charge type

  • ACCESSORY - The charge type is an accessory, e.g. car mats or a sat nav.
  • FEE - The charge type is a fee, e.g. delivery fee or road tax.
"ACCESSORY"

Applicant Type

string (ApplicantType)
Enum: "HIRER" "JOINT" "GUARANTOR"

Enumeration that describes an applicant type

  • HIRER - The applicant is the primary hirer.
  • JOINT - The applicant is a joint applicant for the primary hirer.
  • GUARANTOR - The applicant is the guarantor for the primary hirer.
"HIRER"

Dealer Type

string (DealerType)
Enum: "FRANCHISE" "USED_CARS" "CAR_SUPERMARKET" "OTHER"

Enumeration that describes an dealer type.

  • FRANCHISE - A franchise dealer.
  • USED_CARS - A used car dealer.
  • CAR_SUPERMARKET - A car supermarket dealer.
  • OTHER - An unspecified type of dealer.
"FRANCHISE"

Deal Status

string (DealStatus)
Enum: "NEW_DEAL" "UNSENT_DEAL" "AWAITING_DECISION" "CONDITIONALLY_APPROVED" "APPROVED" "AWAITING_DELIVERY" "AWAITING_E_SIGN" "AWAITING_PAYOUT" "PAID_OUT" "DECLINED_BY_ALL_LENDERS" "CANCELLED" "NOT_TAKEN_UP"

Enumeration that describes a deal status.

  • NEW_DEAL - The Deal is newly created.
  • UNSENT_DEAL - The Deal has not been sent to a Lender yet.
  • AWAITING_DECISION - Awaiting a decision from a Lender.
  • CONDITIONALLY_APPROVED - The Deal Finance has been conditionally approved by a Lender.
  • APPROVED - The Deal Finance has been approved by a Lender.
  • AWAITING_DELIVERY - The Deal vehicle is awaiting delivery.
  • AWAITING_E_SIGN - The Deal Finance is awaiting E-sign.
  • AWAITING_PAYOUT - The Deal Finance is awaiting payout from the Lender.
  • PAID_OUT - The Deal has been paid out.
  • DECLINED_BY_ALL_LENDERS - The Deal has been declined by all Lenders.
  • CANCELLED - The deal has been cancelled.
  • NOT_TAKEN_UP - The deal has not been taken up with the Lender.
"NEW_DEAL"

Deal Type

string (DealType)
Enum: "PRIVATE" "BUSINESS"

Enumeration that describes a Deal type.

  • PRIVATE - A private, non commercial Deal.
  • BUSINESS - A business, commercial Deal.
"PRIVATE"

Driving Licence Type

string (DrivingLicenceType)
Enum: "FULL" "NON_UK" "PROVISIONAL" "NONE" "EU"

Enumeration that describes a driving licence type.

  • FULL - The applicant has a full UK diving licence.
  • NON_UK - The applicant has an international diving licence.
  • PROVISIONAL - The applicant has a provisional UK diving licence.
  • NONE - The applicant does not have a driving licence.
  • EU - The applicant has an European Union diving licence.
"FULL"

Employment Sector

string (EmploymentSector)
Enum: "PRIVATE" "GOVERNMENT" "MILITARY" "SELF_EMPLOYED" "STUDENT" "HOME_MAKER" "RETIRED" "UNABLE_TO_WORK" "UNEMPLOYED"

Enumeration that describes an employment sector.

  • PRIVATE - The applicant works for a private sector company.
  • GOVERNMENT - The applicant works for the government.
  • MILITARY - The applicant works for the military.
  • SELF_EMPLOYED - The applicant is self employed.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • RETIRED - The applicant is retired.
  • UNABLE_TO_WORK - The applicant is unable to work.
  • UNEMPLOYED - The applicant is unemployed.
"PRIVATE"

Employment Status

string (EmploymentStatus)
Enum: "FULL_TIME_PERMANENT" "PART_TIME_PERMANENT" "FULL_TIME_TEMPORARY" "PART_TIME_TEMPORARY" "FULL_TIME_AGENCY" "PART_TIME_AGENCY" "SUB_CONTRACTOR" "SELF_EMPLOYED" "UNEMPLOYED" "RETIRED" "STUDENT" "HOME_MAKER" "UNABLE_TO_WORK"

Enumeration that describes an employment status.

  • FULL_TIME_PERMANENT - The applicant has full time permanent employment.
  • PART_TIME_PERMANENT - The applicant has part time permanent employment.
  • FULL_TIME_TEMPORARY - The applicant has full time temporary employment.
  • PART_TIME_TEMPORARY - The applicant has part time temporary employment.
  • FULL_TIME_AGENCY - The applicant works full time for an agency.
  • PART_TIME_AGENCY - The applicant works part time for an agency.
  • SUB_CONTRACTOR - The applicant is a sub contractor.
  • SELF_EMPLOYED - The applicant is self employed.
  • UNEMPLOYED - The applicant is unemployed.
  • RETIRED - The applicant is retired.
  • STUDENT - The applicant is a student.
  • HOME_MAKER - The applicant is a home maker.
  • UNABLE_TO_WORK - The applicant is unable to work.
"FULL_TIME_PERMANENT"

Finance Type

string (FinanceType)
Enum: "HIRE_PURCHASE" "PERSONAL_CONTRACT_PURCHASE" "MOTOR_LOAN" "LEASE" "LEASE_PURCHASE" "CONTRACT_HIRE" "FINANCE_LEASE" "CASH"

Enumeration that describes a finance type.

  • HIRE_PURCHASE - Hire Purchase.
  • PERSONAL_CONTRACT_PURCHASE - Personal Contract Purchase.
  • MOTOR_LOAN - Motor Loan.
  • LEASE - Lease.
  • LEASE_PURCHASE - Lease Purchase.
  • CONTRACT_HIRE - Contract Hire.
  • FINANCE_LEASE - Finance Lease.
  • CASH - Cash.
"HIRE_PURCHASE"

Finance Package Type

string (FinancePackageType)
Enum: "STANDARD" "SCHEME"

Enumeration that describes a finance package type.

  • STANDARD - A standard finance package.
  • SCHEME - A scheme (promotional) finance package, e.g. short term discounts and offers.
"STANDARD"

Fuel Type

string (FuelType)
Enum: "PETROL" "DIESEL" "PETROL_LPG" "PETROL_CNG" "ELECTRIC" "HYBRID" "PETROL_BIO_ETHANOL" "DIESEL_ELECTRIC" "PETROL_PLUGIN_ELECTRIC" "DIESEL_PLUGIN_ELECTRIC"

Enumeration that describes a finance type.

  • PETROL - Petrol
  • DIESEL - Diesel
  • PETROL_LPG - Petrol / Liquefied Petroleum Gas (LPG)
  • PETROL_CNG - Petrol / Compressed Natural Gas (CNG)
  • ELECTRIC - Electric
  • HYBRID - Petrol / Electric Hybrid
  • PETROL_BIO_ETHANOL - Petrol / Bio-Ethanol (E85)
  • DIESEL_ELECTRIC - Diesel / Electric Hybrid
  • PETROL_PLUGIN_ELECTRIC - Petrol / PlugIn Electric Hybrid
  • DIESEL_PLUGIN_ELECTRIC - Diesel / PlugIn Electric Hybrid
"PETROL"

Gender Type

string (GenderType)
Enum: "MALE" "FEMALE"

Enumeration that describes a gender type.

  • MALE - Male gender type.
  • FEMALE - Female gender type.
"MALE"

Interest Method

string (InterestMethod)
Enum: "FLAT_RATE" "APR"

Enumeration that describes an interest method.

  • FLAT_RATE - Flat Rate interest method.
  • APR - Annual Percentage Rate interest method.
"FLAT_RATE"

Lender Decision Status

string (LenderDecisionStatus)
Enum: "NO_DECISION" "UNKNOWN" "APPROVED" "COND_APPROVED" "REFERRED" "DECLINED" "CANCELLED" "NTU" "ERROR" "RECEIVED_OK" "INFO_REQUIRED" "DOCS_RECEIVED" "PAID_OUT" "RESUBMIT_REQUIRED" "NOT_SENT" "TIMEOUT" "CONTACT_UNDERWRITER" "CCA_CANCELLED" "CUSTOMER_CANCELLED" "THIRD_PARTY_CANCELLED" "UNWOUND" "DOCUMENT_ERROR"

Enumeration that describes an lender decision status.

  • NO_DECISION - The lender has no decision yet.
  • UNKNOWN - The decision is unknown.
  • APPROVED - Finance has been approved.
  • COND_APPROVED - Finance has been conditionally approved.
  • REFERRED - The lender decision is referred.
  • DECLINED - The lender has declined finance for the application.
  • CANCELLED - The application has been cancelled with the lender.
  • NTU - The finance was not taken up by the applicant.
  • ERROR - There has been an error processing a decision.
  • RECEIVED_OK - The application has been received successfully.
  • INFO_REQUIRED - More information is required about the application.
  • DOCS_RECEIVED - Documents have been received for the application.
  • PAID_OUT - Finance has been paid out by the lender.
  • RESUBMIT_REQUIRED - The application requires resubmission.
  • NOT_SENT - The application has not been sent to the lender yet.
  • TIMEOUT - Sending the application to the lender timed out.
  • CONTACT_UNDERWRITER - The applicant must contact the underwriter.
  • CCA_CANCELLED - The customer credit agreement has been cancelled.
  • CUSTOMER_CANCELLED - The customer cancelled the finance application.
  • THIRD_PARTY_CANCELLED - A third party cancelled the finance application.
  • UNWOUND - The application has been unwound by the lender.
  • DOCUMENT_ERROR - There has been an error processing a document for this application.
"NO_DECISION"

Marital Status

string (MaritalStatus)
Enum: "SINGLE" "MARRIED" "COMMON_LAW" "CIVIL_PARTNERS" "SEPARATED" "DIVORCED" "WIDOWED" "UNKNOWN"

Enumeration that describes a marital status.

  • SINGLE - The applicant is single.
  • MARRIED - The applicant is married.
  • COMMON_LAW - The applicant is in a common law relationship.
  • CIVIL_PARTNERS - The applicant is in a civil partner relationship.
  • SEPARATED - The applicant is separated.
  • DIVORCED - The applicant is divorced.
  • WIDOWED - The applicant has been widowed.
  • UNKNOWN - The applicant's marital status is unknown.
"SINGLE"

Name Title

string (NameTitle)
Enum: "MR" "MRS" "MS" "MISS" "DR"

Enumeration that describes a name title.

  • MR - A name title of Mr.
  • MRS - A name title of Mrs.
  • MS - A name title of Ms.
  • MISS - A name title of Miss.
  • DR - A name title of Doctor.
"MR"

Nationality

string (Nationality)
Enum: "AFGHAN" "ALAND_ISLANDER" "ALBANIAN" "ALGERIAN" "ANDORRAN" "ANGOLAN" "ANGUILLAN" "ARGENTINE_ARGENTINIAN" "ARMENIAN" "AUSTRALIAN" "AUSTRIAN" "AZERBAIJANI" "BAHAMIAN" "BAHRAINI" "BANGLADESHI" "BARBADIAN" "BELARUSIAN" "BELGIAN" "BENINESE" "BHUTANESE" "BOLIVIAN" "BRAZILIAN" "BRITISH_CITIZEN" "BRITISH_VIRGIN_ISLANDER" "BULGARIAN" "BURKINABE_BURKINAN" "CAMBODIAN" "CAMEROONIAN" "CANADIAN" "CAPE_VERDEAN" "CAYMAN_ISLANDER" "CHADIAN" "CHILEAN" "CHINESE" "CITIZEN_OF_ANTARCTICA" "CITIZEN_OF_ANTIGUA_AND_BARBUDA" "CITIZEN_OF_ARUBA" "CITIZEN_OF_BELIZE" "CITIZEN_OF_BERMUDA" "CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA" "CITIZEN_OF_BOSNIA_AND_HERZEGOVINA" "CITIZEN_OF_BOTSWANA" "CITIZEN_OF_BOUVET_ISLAND" "CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY" "CITIZEN_OF_BRUNEI" "CITIZEN_OF_BURUNDI" "CITIZEN_OF_CHRISTMAS_ISLAND" "CITIZEN_OF_COCOS_ISLANDS" "CITIZEN_OF_CURACAO" "CITIZEN_OF_FIJI" "CITIZEN_OF_FRENCH_GUIANA" "CITIZEN_OF_FRENCH_POLYNESIA" "CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES" "CITIZEN_OF_GUADELOUPE" "CITIZEN_OF_GUAM" "CITIZEN_OF_GUERNSEY" "CITIZEN_OF_GUINEA_BISSAU" "CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "CITIZEN_OF_ISLE_OF_MAN" "CITIZEN_OF_JERSEY" "CITIZEN_OF_KIRIBATI" "CITIZEN_OF_LESOTHO" "CITIZEN_OF_MACAO" "CITIZEN_OF_MADAGASCAR" "CITIZEN_OF_MALAYSIA" "CITIZEN_OF_MAYOTTE" "CITIZEN_OF_MYANMAR" "CITIZEN_OF_NEW_CALEDONIA" "CITIZEN_OF_NIGER" "CITIZEN_OF_NORFOLK_ISLAND" "CITIZEN_OF_NORTHERN_MARIANA_ISLANDS" "CITIZEN_OF_REUNION" "CITIZEN_OF_SAINT_BARTHELEMY" "CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA" "CITIZEN_OF_SAINT_MARTIN" "CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON" "CITIZEN_OF_SAN_MARINO" "CITIZEN_OF_SAO_TOME_AND_PRINCIPE" "CITIZEN_OF_SEYCHELLES" "CITIZEN_OF_SINT_MAARTEN" "CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "CITIZEN_OF_SRI_LANKA" "CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS" "CITIZEN_OF_SVALBARD_AND_JAN_MAYEN" "CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC" "CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA" "CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_DOMINICAN_REPUBLIC" "CITIZEN_OF_THE_IVORY_COAST" "CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO" "CITIZEN_OF_THE_UNITED_ARAB_EMIRATES" "CITIZEN_OF_TOKELAU" "CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "CITIZEN_OF_VANUATU" "CITIZEN_OF_WESTERN_SAHARA" "COLOMBIAN" "COMORAN" "COOK_ISLANDER" "COSTA_RICAN" "CROATIAN" "CUBAN" "CYPRIOT" "CZECH" "DANE" "DJIBOUTIAN" "DOMINICAN" "DUTCH_CITIZEN" "EAST_TIMORESE" "ECUADOREAN" "EGYPTIAN" "EQUATORIAL_GUINEAN" "ERITREAN" "ESTONIAN" "ETHIOPIAN" "FALKLAND_ISLANDER" "FAROE_ISLANDER" "FILIPINO_FILIPINA" "FINN" "FRENCH_CITIZEN" "GABONESE" "GAMBIAN" "GEORGIAN" "GERMAN" "GHANAIAN" "GIBRALTARIAN" "GREEK" "GREENLANDIC" "GRENADIAN" "GUATEMALAN" "GUINEAN" "GUYANESE" "HAITIAN" "HONDURAN" "HONG_KONGER" "HUNGARIAN" "ICELANDER" "INDIAN" "INDONESIAN" "IRANIAN" "IRAQI" "IRISH" "ISRAELI" "ITALIAN" "JAMAICAN" "JAPANESE" "JORDANIAN" "KAZAKH" "KENYAN" "KUWAITI" "KYRGYZ" "LAO" "LATVIAN" "LEBANESE" "LIBERIAN" "LIBYAN" "LIECHTENSTEIN_CITIZEN" "LITHUANIAN" "LUXEMBOURGER" "MACEDONIAN" "MALAWIAN" "MALDIVIAN" "MALIAN" "MALTESE" "MARSHALL_ISLANDER" "MARTINIQUAIS" "MAURITANIAN" "MAURITIAN" "MEXICAN" "MICRONESIAN" "MOLDOVAN" "MONEGASQUE" "MONGOLIAN" "MONTENEGRIN" "MONTSERRATIAN" "MOROCCAN" "MOZAMBICAN" "NAMIBIAN" "NAURUAN" "NEPALESE" "NEW_ZEALANDER" "NICARAGUAN" "NIGERIAN" "NIUEAN" "NORWEGIAN" "OMANI" "PAKISTANI" "PALAUAN" "PALESTINIAN" "PANAMANIAN" "PAPUA_NEW_GUINEAN" "PARAGUAYAN" "PERUVIAN" "PITCAIRN_ISLANDER" "POLE" "PORTUGUESE" "PUERTO_RICAN" "QATARI" "ROMANIAN" "RUSSIAN" "RWANDAN" "SALVADOREAN" "SAMOAN" "SAUDI_ARABIAN" "SENEGALESE" "SERBIAN" "SIERRA_LEONEAN" "SINGAPOREAN" "SLOVAK" "SLOVENE" "SOLOMON_ISLANDER" "SOMALI" "SOUTH_AFRICAN" "SOUTH_KOREAN" "SOUTH_SUDANESE" "SPANIARD_SPANISH_CITIZEN" "ST_LUCIAN" "SUDANESE" "SURINAMER" "SWAZI" "SWEDE" "SWISS" "SYRIAN" "TAIWANESE" "TAJIK" "TANZANIAN" "THAI" "TOGOLESE" "TONGAN" "TRINIDAD_AND_TOBAGO_CITIZEN" "TUNISIAN" "TURK" "TURKMEN" "TURKS_AND_CAICOS_ISLANDER" "TUVALUAN" "UGANDAN" "UKRAINIAN" "UNITED_STATES_CITIZEN" "URUGUAYAN" "US_VIRGIN_ISLANDER" "UZBEK" "VATICAN_CITIZEN" "VENEZUELAN" "VIETNAMESE" "VINCENTIAN" "WALLISIAN" "YEMENI" "ZAMBIAN" "ZIMBABWEAN"

Enumeration that describes a nationality.

  • AFGHAN` - Afghan
  • ALAND_ISLANDER - Aland Islander
  • ALBANIAN - Albanian
  • ALGERIAN - Algerian
  • ANDORRAN - Andorran
  • ANGOLAN - Angolan
  • ANGUILLAN - Anguillan
  • ARGENTINE_ARGENTINIAN - Argentine, Argentinian
  • ARMENIAN - Armenian
  • AUSTRALIAN - Australian
  • AUSTRIAN - Austrian
  • AZERBAIJANI - Azerbaijani
  • BAHAMIAN - Bahamian
  • BAHRAINI - Bahraini
  • BANGLADESHI - Bangladeshi
  • BARBADIAN - Barbadian
  • BELARUSIAN - Belarusian
  • BELGIAN - Belgian
  • BENINESE - Beninese
  • BHUTANESE - Bhutanese
  • BOLIVIAN - Bolivian
  • BRAZILIAN - Brazilian
  • BRITISH_CITIZEN - British citizen
  • BRITISH_VIRGIN_ISLANDER - British Virgin Islander
  • BULGARIAN - Bulgarian
  • BURKINABE_BURKINAN - Burkinabe, Burkinan
  • CAMBODIAN - Cambodian
  • CAMEROONIAN - Cameroonian
  • CANADIAN - Canadian
  • CAPE_VERDEAN - Cape Verdean
  • CAYMAN_ISLANDER - Cayman Islander
  • CHADIAN - Chadian
  • CHILEAN - Chilean
  • CHINESE - Chinese
  • CITIZEN_OF_ANTARCTICA - Citizen of Antarctica
  • CITIZEN_OF_ANTIGUA_AND_BARBUDA - Citizen of Antigua and Barbuda
  • CITIZEN_OF_ARUBA - Citizen of Aruba
  • CITIZEN_OF_BELIZE - Citizen of Belize
  • CITIZEN_OF_BERMUDA - Citizen of Bermuda
  • CITIZEN_OF_BONAIRE_SINT_EUSTATIUS_AND_SABA - Citizen of Bonaire, Sint Eustatius and Saba
  • CITIZEN_OF_BOSNIA_AND_HERZEGOVINA - Citizen of Bosnia and Herzegovina
  • CITIZEN_OF_BOTSWANA - Citizen of Botswana
  • CITIZEN_OF_BOUVET_ISLAND - Citizen of Bouvet Island
  • CITIZEN_OF_BRITISH_INDIAN_OCEAN_TERRITORY - Citizen of British Indian Ocean Territory
  • CITIZEN_OF_BRUNEI - Citizen of Brunei
  • CITIZEN_OF_BURUNDI - Citizen of Burundi
  • CITIZEN_OF_CHRISTMAS_ISLAND - Citizen of Christmas Island
  • CITIZEN_OF_COCOS_ISLANDS - Citizen of Cocos Islands
  • CITIZEN_OF_CURACAO - Citizen of Curacao
  • CITIZEN_OF_FIJI - Citizen of Fiji
  • CITIZEN_OF_FRENCH_GUIANA - Citizen of French Guiana
  • CITIZEN_OF_FRENCH_POLYNESIA - Citizen of French Polynesia
  • CITIZEN_OF_FRENCH_SOUTHERN_TERRITORIES - citizen of French Southern Territories
  • CITIZEN_OF_GUADELOUPE - Citizen of Guadeloupe
  • CITIZEN_OF_GUAM - Citizen of Guam
  • CITIZEN_OF_GUERNSEY - Citizen of Guernsey
  • CITIZEN_OF_GUINEA_BISSAU - Citizen of Guinea-Bissau
  • CITIZEN_OF_HEARD_ISLAND_AND_MCDONALD_ISLANDS - Citizen of Heard Island and McDonald Islands
  • CITIZEN_OF_ISLE_OF_MAN - Citizen of Isle of Man
  • CITIZEN_OF_JERSEY - Citizen of Jersey
  • CITIZEN_OF_KIRIBATI - Citizen of Kiribati
  • CITIZEN_OF_LESOTHO - Citizen of Lesotho
  • CITIZEN_OF_MACAO - Citizen of Macao
  • CITIZEN_OF_MADAGASCAR - Citizen of Madagascar
  • CITIZEN_OF_MALAYSIA - Citizen of Malaysia
  • CITIZEN_OF_MAYOTTE - Citizen of Mayotte
  • CITIZEN_OF_MYANMAR - Citizen of Myanmar
  • CITIZEN_OF_NEW_CALEDONIA - Citizen of New Caledonia
  • CITIZEN_OF_NIGER - Citizen of Niger
  • CITIZEN_OF_NORFOLK_ISLAND - Citizen of Norfolk Island
  • CITIZEN_OF_NORTHERN_MARIANA_ISLANDS - Citizen of Northern Mariana Islands
  • CITIZEN_OF_REUNION - Citizen of Reunion
  • CITIZEN_OF_SAINT_BARTHELEMY - Citizen of Saint Barthelemy
  • CITIZEN_OF_SAINT_HELENA_ASCENSION_AND_TRISTAN_DA_CUNHA - Citizen of Saint Helena, Ascension and Tristan da Cunha
  • CITIZEN_OF_SAINT_MARTIN - Citizen of Saint Martin
  • CITIZEN_OF_SAINT_PIERRE_AND_MIQUELON - Citizen of Saint Pierre and Miquelon
  • CITIZEN_OF_SAN_MARINO - Citizen of San Marino
  • CITIZEN_OF_SAO_TOME_AND_PRINCIPE - Citizen of Sao Tome and Principe
  • CITIZEN_OF_SEYCHELLES - Citizen of Seychelles
  • CITIZEN_OF_SINT_MAARTEN - Citizen of Sint Maarten
  • CITIZEN_OF_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS - Citizen of South Georgia and the South Sandwich Islands
  • CITIZEN_OF_SRI_LANKA - Citizen of Sri Lanka
  • CITIZEN_OF_ST_CHRISTOPHER_AND_NEVIS - Citizen of St Christopher (St Kitts) and Nevis
  • CITIZEN_OF_SVALBARD_AND_JAN_MAYEN - Citizen of Svalbard and Jan Mayen
  • CITIZEN_OF_THE_CENTRAL_AFRICAN_REPUBLIC - Citizen of the Central African Republic
  • CITIZEN_OF_THE_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA - Citizen of the Democratic People\s Republic of Korea
  • CITIZEN_OF_THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO - Citizen of The Democratic Republic of the Congo
  • CITIZEN_OF_THE_DOMINICAN_REPUBLIC - Citizen of the Dominican Republic
  • CITIZEN_OF_THE_IVORY_COAST - Citizen of the Ivory Coast
  • CITIZEN_OF_THE_REPUBLIC_OF_THE_CONGO - Citizen of the Republic of the Congo
  • CITIZEN_OF_THE_UNITED_ARAB_EMIRATES - Citizen of the United Arab Emirates
  • CITIZEN_OF_TOKELAU - Citizen of Tokelau
  • CITIZEN_OF_UNITED_STATES_MINOR_OUTLYING_ISLANDS - Citizen of United States Minor Outlying Islands
  • CITIZEN_OF_VANUATU - Citizen of Vanuatu
  • CITIZEN_OF_WESTERN_SAHARA - Citizen of Western Sahara
  • COLOMBIAN - Colombian
  • COMORAN - Comoran
  • COOK_ISLANDER - Cook Islander
  • COSTA_RICAN - Costa Rican
  • CROATIAN - Croatian
  • CUBAN - Cuban
  • CYPRIOT - Cypriot
  • CZECH - Czech
  • DANE - Dane
  • DJIBOUTIAN - Djiboutian
  • DOMINICAN - Dominican
  • DUTCH_CITIZEN - Dutch citizen
  • EAST_TIMORESE - East Timorese
  • ECUADOREAN - Ecuadorean
  • EGYPTIAN - Egyptian
  • EQUATORIAL_GUINEAN - Equatorial Guinean
  • ERITREAN - Eritrean
  • ESTONIAN - Estonian
  • ETHIOPIAN - Ethiopian
  • FALKLAND_ISLANDER - Falkland Islander
  • FAROE_ISLANDER - Faroe Islander
  • FILIPINO_FILIPINA - Filipino, Filipina
  • FINN - Finn
  • FRENCH_CITIZEN - French citizen
  • GABONESE - Gabonese
  • GAMBIAN - Gambian
  • GEORGIAN - Georgian
  • GERMAN - German
  • GHANAIAN - Ghanaian
  • GIBRALTARIAN - Gibraltarian
  • GREEK - Greek
  • GREENLANDIC - Greenlandic
  • GRENADIAN - Grenadian
  • GUATEMALAN - Guatemalan
  • GUINEAN - Guinean
  • GUYANESE - Guyanese
  • HAITIAN - Haitian
  • HONDURAN - Honduran
  • HONG_KONGER - Hong Konger
  • HUNGARIAN - Hungarian
  • ICELANDER - Icelander
  • INDIAN - Indian
  • INDONESIAN - Indonesian
  • IRANIAN - Iranian
  • IRAQI - Iraqi
  • IRISH - Irish
  • ISRAELI - Israeli
  • ITALIAN - Italian
  • JAMAICAN - Jamaican
  • JAPANESE - Japanese
  • JORDANIAN - Jordanian
  • KAZAKH - Kazakh
  • KENYAN - Kenyan
  • KUWAITI - Kuwaiti
  • KYRGYZ - Kyrgyz
  • LAO - Lao
  • LATVIAN - Latvian
  • LEBANESE - Lebanese
  • LIBERIAN - Liberian
  • LIBYAN - Libyan
  • LIECHTENSTEIN_CITIZEN - Liechtenstein citizen
  • LITHUANIAN - Lithuanian
  • LUXEMBOURGER - Luxembourger
  • MACEDONIAN - Macedonian
  • MALAWIAN - Malawian
  • MALDIVIAN - Maldivian
  • MALIAN - Malian
  • MALTESE - Maltese
  • MARSHALL_ISLANDER - Marshall Islander
  • MARTINIQUAIS - Martiniquais
  • MAURITANIAN - Mauritanian
  • MAURITIAN - Mauritian
  • MEXICAN - Mexican
  • MICRONESIAN - Micronesian
  • MOLDOVAN - Moldovan
  • MONEGASQUE - Monegasque
  • MONGOLIAN - Mongolian
  • MONTENEGRIN - Montenegrin
  • MONTSERRATIAN - Montserratian
  • MOROCCAN - Moroccan
  • MOZAMBICAN - Mozambican
  • NAMIBIAN - Namibian
  • NAURUAN - Nauruan
  • NEPALESE - Nepalese
  • NEW_ZEALANDER - New Zealander
  • NICARAGUAN - Nicaraguan
  • NIGERIAN - Nigerian
  • NIUEAN - Niuean
  • NORWEGIAN - Norwegian
  • OMANI - Omani
  • PAKISTANI - Pakistani
  • PALAUAN - Palauan
  • PALESTINIAN - Palestinian
  • PANAMANIAN - Panamanian
  • PAPUA_NEW_GUINEAN - Papua New Guinean
  • PARAGUAYAN - Paraguayan
  • PERUVIAN - Peruvian
  • PITCAIRN_ISLANDER - Pitcairn Islander
  • POLE - Pole
  • PORTUGUESE - Portuguese
  • PUERTO_RICAN - Puerto Rican
  • QATARI - Qatari
  • ROMANIAN - Romanian
  • RUSSIAN - Russian
  • RWANDAN - Rwandan
  • SALVADOREAN - Salvadorean
  • SAMOAN - Samoan
  • SAUDI_ARABIAN - Saudi Arabian
  • SENEGALESE - Senegalese
  • SERBIAN - Serbian
  • SIERRA_LEONEAN - Sierra Leonean
  • SINGAPOREAN - Singaporean
  • SLOVAK - Slovak
  • SLOVENE - Slovene
  • SOLOMON_ISLANDER - Solomon Islander
  • SOMALI - Somali
  • SOUTH_AFRICAN - South African
  • SOUTH_KOREAN - South Korean
  • SOUTH_SUDANESE - South Sudanese
  • SPANIARD_SPANISH_CITIZEN - Spaniard, Spanish citizen
  • ST_LUCIAN - St Lucian
  • SUDANESE - Sudanese
  • SURINAMER - Surinamer
  • SWAZI - Swazi
  • SWEDE - Swede
  • SWISS - Swiss
  • SYRIAN - Syrian
  • TAIWANESE - Taiwanese
  • TAJIK - Tajik
  • TANZANIAN - Tanzanian
  • THAI - Thai
  • TOGOLESE - Togolese
  • TONGAN - Tongan
  • TRINIDAD_AND_TOBAGO_CITIZEN - Trinidad and Tobago citizen
  • TUNISIAN - Tunisian
  • TURK - Turk
  • TURKMEN - Turkmen
  • TURKS_AND_CAICOS_ISLANDER - Turks and Caicos Islander
  • TUVALUAN - Tuvaluan
  • UGANDAN - Ugandan
  • UKRAINIAN - Ukrainian
  • UNITED_STATES_CITIZEN - United States citizen
  • URUGUAYAN - Uruguayan
  • US_VIRGIN_ISLANDER - US Virgin Islander
  • UZBEK - Uzbek
  • VATICAN_CITIZEN - Vatican citizen
  • VENEZUELAN - Venezuelan
  • VIETNAMESE - Vietnamese
  • VINCENTIAN - Vincentian
  • WALLISIAN - Wallisian
  • YEMENI - Yemeni
  • ZAMBIAN - Zambian
  • ZIMBABWEAN - Zimbabwean
"AFGHAN"

Payment Type

string (PaymentType)
Enum: "FINANCE" "CASH" "DIRECT_DEBIT"

Enumeration that describes a payment type.

  • FINANCE - Payment will be financed.
  • CASH - Payment will be made in cash.
  • DIRECT_DEBIT - Payment will be taken by Direct Debit.
"FINANCE"

Passport Type

string (PassportType)
Enum: "UK_PASSPORT" "UK_CITIZEN_NO_PASSPORT" "EU_PASSPORT" "OTHER"

Enumeration that describes a residential status.

  • UK_PASSPORT - A an applicant with a UK passport.
  • UK_CITIZEN_NO_PASSPORT - A UK applicant with no passport.
  • EU_PASSPORT - An applicant with a European Union passport.
  • OTHER - The applicant's passport type is unknown.
"UK_PASSPORT"

Residential Status

string (ResidentialStatus)
Enum: "HOME_OWNER" "CO_HOME_OWNER" "COUNCIL_TENANT" "HOUSING_ASSOCIATION" "LIVING_WITH_PARENTS" "PRIVATE_TENANT"

Enumeration that describes a residential status.

  • HOME_OWNER - The applicant is a home owner.
  • CO_HOME_OWNER - The applicant owns a home with someone else.
  • COUNCIL_TENANT - The applicant is a council tenant.
  • HOUSING_ASSOCIATION - The applicant is a housing association tenant.
  • LIVING_WITH_PARENTS - The applicant lives with their parents.
  • PRIVATE_TENANT - The applicant is a private tenant.
"HOME_OWNER"

Tax Type

string (TaxType)
Enum: "VAT" "IPT" "ZERO_RATED"

Enumeration that describes a tax type.

  • VAT - Value added tax
  • IPT - Insurance premium tax
  • ZERO_RATED - A taxable product, but with a 0% tax rate
"VAT"

Usage Type

string (UsageType)
Enum: "PRIVATE" "COMMERCIAL" "MOTABILITY" "HIRE_AND_REWARD" "LIFESTYLE" "DRIVING_SCHOOL"

Enumeration that describes a vehicle usage type.

  • PRIVATE - Social, domestic, pleasure and commuting.
  • COMMERCIAL - Commercial vehicle for business use.
  • MOTABILITY - Vehicle is being sold on Motability contract hire.
  • HIRE_AND_REWARD - Vehicle is used for Taxi, Private Hire, Courier or Minibus.
  • LIFESTYLE - Vehicle is used for a lifestyle or hobby activity.
  • DRIVING_SCHOOL - Vehicle is used for driving lessons.
"PRIVATE"

Vehicle Body Style

string (VehicleBodyStyle)
Enum: "HARDTOP" "CABRIOLET" "COUPE" "ESTATE" "FASTBACK" "HATCHBACK" "SOFT_TOP" "SPEEDSTER" "ROADSTER" "SALOON" "TOURER" "CONVERTIBLE" "STATION_WAGON"

Enumeration that describes a vehicle body style

  • HARDTOP - Hard top
  • CABRIOLET - Cabriolet
  • COUPE - Coupe
  • ESTATE - Estate
  • FASTBACK - Fastback
  • HATCHBACK - Hatchback
  • SOFT_TOP - Soft top
  • SPEEDSTER - Speedster
  • ROADSTER - Roadster
  • SALOON - Saloon
  • TOURER - Tourer
  • CONVERTIBLE - Convertible
  • STATION_WAGON - Station wagon
"HARDTOP"

Vehicle Type

string (VehicleType)
Enum: "PRIVATE_LIGHT_GOODS_VEHICLE" "LIGHT_COMMERCIAL_VEHICLE" "CARAVAN" "MOTORHOME" "MOTORBIKE" "OTHER" "HEAVY_GOODS_VEHICLE"

Enumeration that describes a vehicle type.

  • PRIVATE_LIGHT_GOODS_VEHICLE - The vehicle is a private light goods vehicle.
  • LIGHT_COMMERCIAL_VEHICLE - The vehicle is a light commercial vehicle.
  • CARAVAN - The vehicle is a caravan.
  • MOTORHOME - The vehicle is a motorhome.
  • MOTORBIKE - The vehicle is a motorbike.
  • OTHER - The vehicle type is not defined.
  • HEAVY_GOODS_VEHICLE - The vehicle is a heavy goods vehicle.
"PRIVATE_LIGHT_GOODS_VEHICLE"

Vehicle Transmission Type

string (VehicleTransmissionType)
Enum: "MANUAL" "AUTOMATIC" "SEMI_AUTOMATIC"

Enumeration that describes a vehicle transmission type.

  • MANUAL - A vehicle with manual transmission.
  • AUTOMATIC - A vehicle with automatic transmission.
  • SEMI_AUTOMATIC - A vehicle with semi automatic transmission.
"MANUAL"