Get a creditor applicant

Get a creditor applicant

Path Parameters
applicationId string — REQUIRED
creditorId string — REQUIRED

Header Parameters
X-CreditApp-Creditor-ID uuid

Responses

200 Success Schema — OPTIONAL object[] applicationId uuid — OPTIONAL applicantId uuid — OPTIONAL creditorApplicantId uuid — OPTIONAL isPrimary boolean — OPTIONAL title string — OPTIONAL Possible values: [DR, M, MISS, MME, MR, MRS, MS] The title (salutation) of the applicant firstName string — OPTIONAL middleName string — OPTIONAL lastName string — OPTIONAL dateOfBirth date — OPTIONAL sin string — OPTIONAL phoneNumber string — OPTIONAL email string — OPTIONAL languagePreference string — OPTIONAL Possible values: [EN, FR] maritalStatus string — OPTIONAL Possible values: [SINGLE, MARRIED, DIVORCED, WIDOWED, SEPARATED, COMMON_LAW] added boolean — OPTIONAL isShoppingCustomer boolean — OPTIONAL addressHistory object[] — OPTIONAL 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. employmentHistory object[] — OPTIONAL 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 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.