Get a specific application

Get a specific application

Path Parameters
applicationId string — REQUIRED

Header Parameters
X-CreditApp-Retailer-ID uuid

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. 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. 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]
401 Unauthorized Schema — OPTIONAL status integer — OPTIONAL