Update a creditor applicant for an application

Update a creditor applicant for an application

Path Parameters
applicationId string — REQUIRED
creditorId string — REQUIRED
creditorApplicantId string — REQUIRED

Header Parameters
X-CreditApp-Creditor-ID uuid

Request Body The creditor applicant request
firstName string — REQUIRED The first name of the applicant
middleName string The middle name of the applicant
lastName string — REQUIRED The last name of the applicant
email string — REQUIRED The email of the applicant
phoneNumber string The phone number of the applicant
languagePreference string Possible values: [EN, FR] The language preference of the applicant
dateOfBirth date — REQUIRED The date of birth of the applicant
sin string The sin of the applicant
maritalStatus string Possible values: [SINGLE, MARRIED, DIVORCED, WIDOWED, SEPARATED, COMMON_LAW] The marital status of the applicant
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.

Responses
200 Success Schema — OPTIONAL applicantId string — OPTIONAL creditorApplicantId string — OPTIONAL
400 Bad Request Schema — OPTIONAL status integer — OPTIONAL message string — OPTIONAL