Application Export Webhook
This webhook is triggered when a finance manager exports an application to an external integration. The webhook payload contains all application details, including applicant information, employment history, vehicle details, worksheet calculations, and additional amounts/fees.
Request Body
The request body is a JSON object with the following properties:
Top-Level Fields
-
retailerId(string, UUID, required)
The retailer that created the application. -
applicationId(string, UUID, required)
The exported application ID. -
creditorId(string, UUID, required)
The creditor the application was sent to. -
primaryApplicant(object, required)
See the Primary/Co-Applicant Structure below. -
relationship(string|null, enum)
Relationship of the co-applicant to the primary applicant.
One of:COMMON_LAW,EMPLOYER,FRIEND,IN_LAW,OTHER,PARENT,SIBLING,SPOUSE, ornull. -
coApplicant(object|null)
Same structure as Primary Applicant. Null or fields may be null if not present. -
worksheet(object|null)
See the Worksheet Structure below.
Applicant Structure
Both primaryApplicant and coApplicant share the following structure:
-
firstName(string|null) -
lastName(string|null) -
sin(string|null)
Social Insurance Number (optional). -
dateOfBirth(string|date|null) -
phoneNumber(string|null) -
email(string|null) -
addressHistory(array|null)
Array of objects with these fields:addressType(string)apartmentSuite(string)city(string)direction(string|null)id(string, UUID)monthlyRentOrMortgage(object)amount(number)currency(string)
monthsAtAddress(integer)pOBoxNumber(string)postalCode(string)province(string)
(e.g.,BC,ON)residenceType(string)searchAddress(string)streetName(string)streetNo(string)streetType(string)yearsAtAddress(integer)
-
employmentHistory(array|null)
Array of objects with these fields:additionalIncomeSources(array)
Enum valuesapartmentSuite(string)city(string)direction(string|null)employerName(string)employmentPhone(string)frequency(string)grossIncome(object)amount(number)currency(string)
id(string, UUID)monthsWorked(integer)occupation(string)postalCode(string)province(string)status(string)streetName(string)streetNo(string)streetType(string)type(string)yearsWorked(integer)
Worksheet Structure
-
programId(string, UUID) -
tierId(string, UUID) -
vehicle(object)id(string)vin(string)status(string)(NEW,USED)year(integer)make(string)model(string)trim(string)odometer(object)amount(number)unit(string)
msrp(object)amount(number)currency(string)
addOnOptions(array)addOns(array|null)deductOptions(array)deducts(array|null)roughWholesaleValue(object)cleanWholesaleValue(object)averageWholesaleValue(object)extraCleanWholesaleValue(object)
-
taxExempt(boolean) -
gstPercent(number) -
gst(object)amount(number)currency(string)
-
gstAdjusted(boolean) -
pstHstPercent(number) -
pstHst(object)amount(number)currency(string)
-
pstHstAdjusted(boolean) -
salePrice(object)amount(number)currency(string)
-
cashDown(object) -
rebate(object) -
tradeIn(string|null) -
dealerAdminFee(object) -
registrationFee(object) -
creditorFee(object) -
gpsFee(object) -
licenseFee(object) -
installationDeliveryFee(object) -
ahInsuranceFee(object) -
lifeInsuranceFee(object) -
gapInsurance(object) -
extServiceContract(object) -
dealerReserve(object) -
firstPaymentDate(string, date) -
deliveryDate(string, date) -
interestRate(number) -
term(integer) -
frequency(string)(BI_WEEKLY,MONTHLY, etc.) -
totalFinancedAmount(object) -
worksheetPayment(object) -
otherTaxable(object)amount(number)currency(string)
-
otherNonTaxable(object)amount(number)currency(string)
-
otherTaxableDescription(string) -
otherNonTaxableDescription(string)
Headers
X-CREDIT-APP-SIGNATURE(string, required)
HMAC signature for verifying request authenticity.
Example Request Body
{
"retailerId": "123e4567-e89b-12d3-a456-426614174000",
"applicationId": "823e4567-e89b-12d3-a456-426614174000",
"creditorId": "923e4567-e89b-12d3-a456-426614174000",
"primaryApplicant": {
"firstName": "John",
"lastName": "Doe",
"sin": "123456789",
"dateOfBirth": "1980-06-15",
"phoneNumber": "6045550110",
"email": "john.doe@example.com",
"addressHistory": [
{
"addressType": "CURRENT",
"apartmentSuite": "Apt 204",
"city": "Vancouver",
"direction": "N",
"monthlyRentOrMortgage": {
"amount": 1800,
"currency": "CAD"
},
"monthsAtAddress": 18,
"pOBoxNumber": "",
"postalCode": "V5K 0A1",
"province": "BC",
"residenceType": "RENT",
"searchAddress": "",
"streetName": "Oak",
"streetNo": "4321",
"streetType": "Street",
"yearsAtAddress": 1
},
{
"addressType": "STREET",
"apartmentSuite": "",
"city": "Burnaby",
"direction": null,
"monthlyRentOrMortgage": {
"amount": 1600,
"currency": "CAD"
},
"monthsAtAddress": 24,
"pOBoxNumber": "",
"postalCode": "V5C 6G8",
"province": "BC",
"residenceType": "RENT",
"searchAddress": "",
"streetName": "Kingsway",
"streetNo": "1000",
"streetType": "Avenue",
"yearsAtAddress": 2
}
],
"employmentHistory": [
{
"additionalIncomeSources": [],
"apartmentSuite": "",
"city": "Vancouver",
"direction": null,
"employerName": "TechNova Inc.",
"employmentPhone": "6045550115",
"frequency": "MONTHLY",
"grossIncome": {
"amount": 7000,
"currency": "CAD"
},
"monthsWorked": 36,
"occupation": "Software Engineer",
"postalCode": "V5K 0A1",
"province": "BC",
"status": "FULL_TIME",
"streetName": "Granville",
"streetNo": "587",
"streetType": "Street",
"type": "PROFESSIONAL",
"yearsWorked": 3
}
]
},
"relationship": "SPOUSE",
"coApplicant": {
"firstName": "Jane",
"lastName": "Doe",
"sin": "987654321",
"dateOfBirth": "1982-02-25",
"phoneNumber": "6045550220",
"email": "jane.doe@example.com",
"addressHistory": [
{
"addressType": "CURRENT",
"apartmentSuite": "Apt 204",
"city": "Vancouver",
"direction": "N",
"monthlyRentOrMortgage": {
"amount": 1800,
"currency": "CAD"
},
"monthsAtAddress": 18,
"pOBoxNumber": "",
"postalCode": "V5K 0A1",
"province": "BC",
"residenceType": "RENT",
"searchAddress": "",
"streetName": "Oak",
"streetNo": "4321",
"streetType": "Street",
"yearsAtAddress": 1
}
],
"employmentHistory": [
{
"additionalIncomeSources": ["CHILD_SUPPORT"],
"apartmentSuite": "",
"city": "Vancouver",
"direction": null,
"employerName": "CareWell Hospital",
"employmentPhone": "6045550330",
"frequency": "MONTHLY",
"grossIncome": {
"amount": 4800,
"currency": "CAD"
},
"monthsWorked": 60,
"occupation": "Nurse",
"postalCode": "V5K 0A1",
"province": "BC",
"status": "FULL_TIME",
"streetName": "Health",
"streetNo": "101",
"streetType": "Avenue",
"type": "PROFESSIONAL",
"yearsWorked": 5
}
]
},
"worksheet": {
"programId": "fa8c27de-5c61-4c6c-9bb3-d74193b7e001",
"tierId": "fa8c27de-5c61-4c6c-9bb3-d74193b7e002",
"vehicle": {
"id": "1ABC23DEF45678901",
"vin": "1HGCM82633A004352",
"status": "USED",
"year": 2021,
"make": "Toyota",
"model": "Corolla",
"trim": "LE",
"odometer": { "amount": 38000, "unit": "KILOMETERS" },
"msrp": { "amount": 24500, "currency": "CAD" },
"addOnOptions": [
{
"name": "Winter Tires",
"extraCleanValue": { "amount": 850, "currency": "CAD" },
"cleanValue": { "amount": 750, "currency": "CAD" },
"averageValue": { "amount": 650, "currency": "CAD" },
"roughValue": { "amount": 550, "currency": "CAD" }
}
],
"addOns": ["Winter Tires"],
"deductOptions": [],
"deducts": null,
"roughWholesaleValue": { "amount": 20000, "currency": "CAD" },
"cleanWholesaleValue": { "amount": 21500, "currency": "CAD" },
"averageWholesaleValue": { "amount": 21000, "currency": "CAD" },
"extraCleanWholesaleValue": { "amount": 22500, "currency": "CAD" }
},
"taxExempt": false,
"gstPercent": 5,
"gst": { "amount": 1322.35, "currency": "CAD" },
"gstAdjusted": false,
"pstHstPercent": 7,
"pstHst": { "amount": 1851.29, "currency": "CAD" },
"pstHstAdjusted": false,
"salePrice": { "amount": 23000, "currency": "CAD" },
"cashDown": { "amount": 3000, "currency": "CAD" },
"rebate": { "amount": 300, "currency": "CAD" },
"tradeIn": "1A2B3C4D5E6F7G8H9",
"dealerAdminFee": { "amount": 395, "currency": "CAD" },
"registrationFee": { "amount": 80, "currency": "CAD" },
"creditorFee": { "amount": 200, "currency": "CAD" },
"gpsFee": { "amount": 100, "currency": "CAD" },
"licenseFee": { "amount": 50, "currency": "CAD" },
"installationDeliveryFee": { "amount": 200, "currency": "CAD" },
"ahInsuranceFee": { "amount": 150, "currency": "CAD" },
"lifeInsuranceFee": { "amount": 100, "currency": "CAD" },
"gapInsurance": { "amount": 50, "currency": "CAD" },
"extServiceContract": { "amount": 200, "currency": "CAD" },
"dealerReserve": { "amount": 1000, "currency": "CAD" },
"firstPaymentDate": "2024-07-01",
"deliveryDate": "2024-06-24",
"interestRate": 6.9,
"term": 60,
"frequency": "MONTHLY",
"totalFinancedAmount": { "amount": 24000, "currency": "CAD" },
"worksheetPayment": { "amount": 475.7, "currency": "CAD" },
"taxProvince": "BC",
"otherTaxable": { "amount": 150, "currency": "CAD" },
"otherNonTaxable": { "amount": 200, "currency": "CAD" },
"otherTaxableDescription": "Wheel Locks",
"otherNonTaxableDescription": "Processing Fee"
}
}