Create an application

Create an application

Header Parameters
X-CreditApp-Retailer-ID uuid
X-CreditApp-Creditor-ID uuid

Request Body — REQUIRED
applicationType string — REQUIRED Possible values: [APPROVAL, PRE_APPROVAL] The type of application.
isReadOnly boolean Indicates that only the caller should be able to modify the details of the application. Typically this means that the source of truth for the application is outside of CreditApp. Only used for creditor created applications.
referenceNumber string The reference number. This is only used for creditor created applications.
primaryApplicant object — REQUIRED firstName string middleName string lastName string dateOfBirth date sin string selfReportedCreditScore number The self reported credit score. This is used to run pre-credit lender filter rules. When converting from a range, take the lower bound. For example, if the range is 700-750, use 700. phoneNumber string email string primaryAddress object residenceType string Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string postalCode string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number monthsAtAddress number poBoxNumber string addressType string Possible values: [STREET, PO_BOX] The type of address. addressHistory object[] residenceType string Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string postalCode string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number monthsAtAddress number poBoxNumber string addressType string Possible values: [STREET, PO_BOX] The type of address. noPreviousAddress boolean Indicates if the applicant has no previous address. primaryEmployment object type string Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number frequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string employerName string occupation string employmentPhone string yearsWorked number monthsWorked number additionalIncomeSources object[] type string — REQUIRED Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number — REQUIRED frequency string — REQUIRED Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. employmentHistory object[] type string Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number frequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string employerName string occupation string employmentPhone string yearsWorked number monthsWorked number additionalIncomeSources object[] type string — REQUIRED Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number — REQUIRED frequency string — REQUIRED Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. noPreviousEmployment boolean Indicates if the applicant has no previous employment.
coApplicant object firstName string middleName string lastName string relationship string Possible values: [COMMON_LAW, EMPLOYER, FRIEND, IN_LAW, OTHER, PARENT, SIBLING, SPOUSE] The relationship. dateOfBirth date sin string phoneNumber string email string primaryAddress object residenceType string Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string postalCode string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number monthsAtAddress number poBoxNumber string addressType string Possible values: [STREET, PO_BOX] The type of address. addressHistory object[] residenceType string Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string postalCode string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number monthsAtAddress number poBoxNumber string addressType string Possible values: [STREET, PO_BOX] The type of address. noPreviousAddress boolean Indicates if the applicant has no previous address. primaryEmployment object type string Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number frequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string employerName string occupation string employmentPhone string yearsWorked number monthsWorked number additionalIncomeSources object[] type string — REQUIRED Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number — REQUIRED frequency string — REQUIRED Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. employmentHistory object[] type string Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number frequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string streetNo string streetName string streetType string direction string Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string province string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string employerName string occupation string employmentPhone string yearsWorked number monthsWorked number additionalIncomeSources object[] type string Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number frequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. noPreviousEmployment boolean Indicates if the applicant has no previous employment.
worksheet salePrice number The sales price. cashDown number The cash down amount. rebate number The rebate amount. gst number The GST amount. pstHst number The PST amount. gstPercent number The GST percentage. pstHstPercent number The PST percentage. taxExempt boolean Whether the applicant is tax exempt. vehicle object — REQUIRED The worksheet vehicle. vin string The vehicle VIN. odometer number The vehicle odometer. uvc string The vehicle UVC. year number The vehicle year. make string The vehicle make. model string The vehicle model. trim string The vehicle trim. series string The vehicle series. color string The vehicle color. carfaxClaims number The number of carfax claims. addOns string[] deducts string[] dealerAdminFee number The dealer admin fee. registrationFee number The registration fee. gapInsurance number The gap insurance. extServiceContract number The extended service contract (warranty). pstNotApplicableOnExServiceContract boolean Indicates if the PST is not applicable on the extended service contract. firstPaymentDate date The first payment date. deliveryDate date The delivery date. tradeIn object The worksheet trade-in. vin string — REQUIRED The trade-in VIN. odometer number The trade-in odometer. year number — REQUIRED The trade-in year. make string — REQUIRED The trade-in make. model string — REQUIRED The trade-in model. allowance number The trade-in allowance. lienAmount number The trade-in lien amount. lienHolder string The trade-in lien holder. interestRate number The interest rate. term number The term. paymentFrequency string Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY] otherNonTaxable number Other Non-Taxable amount otherTaxable number Other Taxable amount otherNonTaxableDescription string Other Non-Taxable description otherTaxableDescription string Other Taxable description taxProvince string Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT]

Responses
200 The response of the application Schema — OPTIONAL applicationId string — OPTIONAL The application ID. createdAt date-time — OPTIONAL The date and time the application was created. updatedAt date-time — OPTIONAL The date and time the application was last updated. assignedRetailerUserId uuid — OPTIONAL The user ID of the retailer user that the application is assigned to. status string — OPTIONAL Possible values: [STARTED, DRAFT, SAVED, SUBMITTED, ARCHIVED] The application status. hasCoApplicant boolean — OPTIONAL Indicates if the application has a co-applicant. applicationType string — OPTIONAL Possible values: [APPROVAL, PRE_APPROVAL] The type of application. source string — OPTIONAL The source of the application. isReadOnly boolean — OPTIONAL Indicates if the application is read only. primaryApplicant object — OPTIONAL applicantId string — OPTIONAL The applicant ID. firstName string — OPTIONAL middleName string — OPTIONAL lastName string — OPTIONAL dateOfBirth date — OPTIONAL sin string — OPTIONAL selfReportedCreditScore number — OPTIONAL phoneNumber string — OPTIONAL email string — OPTIONAL addressHistory object[] — OPTIONAL id string — OPTIONAL The address ID. residenceType string — OPTIONAL Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number — OPTIONAL apartmentSuite string — OPTIONAL streetNo string — OPTIONAL streetName string — OPTIONAL streetType string — OPTIONAL direction string — OPTIONAL Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string — OPTIONAL postalCode string — OPTIONAL province string — OPTIONAL Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number — OPTIONAL monthsAtAddress number — OPTIONAL poBoxNumber string — OPTIONAL addressType string — OPTIONAL Possible values: [STREET, PO_BOX] The type of address. noPreviousAddress boolean — OPTIONAL Indicates if the applicant has no previous address. employmentHistory object[] — OPTIONAL id string — OPTIONAL The employment ID. type string — OPTIONAL Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string — OPTIONAL Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number — OPTIONAL frequency string — OPTIONAL Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string — OPTIONAL streetNo string — OPTIONAL streetName string — OPTIONAL streetType string — OPTIONAL direction string — OPTIONAL Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string — OPTIONAL province string — OPTIONAL Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string — OPTIONAL employerName string — OPTIONAL occupation string — OPTIONAL employmentPhone string — OPTIONAL yearsWorked number — OPTIONAL monthsWorked number — OPTIONAL additionalIncomeSources object[] — OPTIONAL type string — OPTIONAL Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number — OPTIONAL frequency string — OPTIONAL Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. noPreviousEmployment boolean — OPTIONAL Indicates if the applicant has no previous employment. coApplicant object — OPTIONAL applicantId string — OPTIONAL The applicant ID. firstName string — OPTIONAL middleName string — OPTIONAL lastName string — OPTIONAL relationship string — OPTIONAL Possible values: [COMMON_LAW, EMPLOYER, FRIEND, IN_LAW, OTHER, PARENT, SIBLING, SPOUSE] The relationship. dateOfBirth date — OPTIONAL sin string — OPTIONAL phoneNumber string — OPTIONAL email string — OPTIONAL addressHistory object[] — OPTIONAL id string — OPTIONAL The address ID. residenceType string — OPTIONAL Possible values: [RENT, OWN_FREE_AND_CLEAR, OWN_WITH_MORTGAGE, OWN_MOBILE_HOME, RESERVE_HOUSING, WITH_PARENTS, OTHER] The type of residence. monthlyRentOrMortgage number — OPTIONAL apartmentSuite string — OPTIONAL streetNo string — OPTIONAL streetName string — OPTIONAL streetType string — OPTIONAL direction string — OPTIONAL Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string — OPTIONAL postalCode string — OPTIONAL province string — OPTIONAL Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. yearsAtAddress number — OPTIONAL monthsAtAddress number — OPTIONAL poBoxNumber string — OPTIONAL addressType string — OPTIONAL Possible values: [STREET, PO_BOX] The type of address. noPreviousAddress boolean — OPTIONAL Indicates if the applicant has no previous address. employmentHistory object[] — OPTIONAL id string — OPTIONAL The employment ID. type string — OPTIONAL Possible values: [AT_HOME, EXECUTIVE, LABOURER, MANAGEMENT, OFFICE_STAFF, OTHER, PRODUCTION, PROFESSIONAL, RETIRED, SALES, SELF_EMPLOYED, SERVICE, STUDENT, TRADES, UNEMPLOYED] The type of employment. status string — OPTIONAL Possible values: [FULL_TIME, FULL_TIME_PROBATION, PART_TIME, PART_TIME_CASUAL, RETIRED, SEASONAL_SUMMER, SEASONAL_WINTER, SELF_EMPLOYED, UNEMPLOYED] The employment status. grossIncome number — OPTIONAL frequency string — OPTIONAL Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. apartmentSuite string — OPTIONAL streetNo string — OPTIONAL streetName string — OPTIONAL streetType string — OPTIONAL direction string — OPTIONAL Possible values: [N, NE, E, SE, S, SW, W, NW] The direction. city string — OPTIONAL province string — OPTIONAL Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT] The province. postalCode string — OPTIONAL employerName string — OPTIONAL occupation string — OPTIONAL employmentPhone string — OPTIONAL yearsWorked number — OPTIONAL monthsWorked number — OPTIONAL additionalIncomeSources object[] — OPTIONAL type string — OPTIONAL Possible values: [CAR_ALLOWANCE, CHILD_SUPPORT, DISABILITY_PAYMENTS, INVESTMENT_INCOME, PENSIONS, RENTAL_INCOME, WORKERS_COMPENSATION, OTHER] The type of additional income. grossIncome number — OPTIONAL frequency string — OPTIONAL Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY, YEARLY] The income frequency. noPreviousEmployment boolean — OPTIONAL Indicates if the applicant has no previous employment. worksheet object — OPTIONAL salePrice number — OPTIONAL The sales price. cashDown number — OPTIONAL The cash down amount. rebate number — OPTIONAL The rebate amount. gst number — OPTIONAL The GST amount. pstHst number — OPTIONAL The PST amount. gstPercent number — OPTIONAL The GST percentage. pstHstPercent number — OPTIONAL The PST percentage. taxExempt boolean — OPTIONAL Whether the applicant is tax exempt. vehicle object The worksheet vehicle. vin string — OPTIONAL The vehicle VIN. odometer number — OPTIONAL The vehicle odometer. uvc string — OPTIONAL The vehicle UVC. year number — OPTIONAL The vehicle year. make string — OPTIONAL The vehicle make. model string — OPTIONAL The vehicle model. trim string — OPTIONAL The vehicle trim. series string — OPTIONAL The vehicle series. color string — OPTIONAL The vehicle color. carfaxClaims number — OPTIONAL The number of carfax claims. dealerAdminFee number — OPTIONAL The dealer admin fee. registrationFee number — OPTIONAL The registration fee. gapInsurance number — OPTIONAL The gap insurance. extServiceContract number — OPTIONAL The extended service contract (warranty). pstNotApplicableOnExServiceContract boolean — OPTIONAL Indicates if the PST is not applicable on the extended service contract. firstPaymentDate date — OPTIONAL The first payment date. deliveryDate date — OPTIONAL The delivery date. tradeIn object — OPTIONAL The worksheet trade-in. vin string — OPTIONAL The trade-in VIN. odometer number — OPTIONAL The trade-in odometer. year number The trade-in year. make string The trade-in make. model string The trade-in model. allowance number — OPTIONAL The trade-in allowance. lienAmount number — OPTIONAL The trade-in lien amount. lienHolder string — OPTIONAL The trade-in lien holder. interestRate number — OPTIONAL The interest rate. term number — OPTIONAL The term. paymentFrequency string — OPTIONAL Possible values: [BI_WEEKLY, MONTHLY, SEMI_MONTHLY, WEEKLY]
400 Bad Request Schema — OPTIONAL status integer — OPTIONAL message string — OPTIONAL
401 Unauthorized Schema — OPTIONAL status integer — OPTIONAL