latestOpenAPI 3.0.02026-08-2227616429.6 KB

0ba836de8da3

Application

Update Applicant on Application

Update Application Applicant

patch/posfinancing/rest/v2/applications/{applicationId}/applicants

{"stackTrail":"paths:/posfinancing/rest/v2/applications/{applicationId}/applicants:patch:parameters:0:schema","oasType":"schema","type":"unknown"}

The ID of the application to update the applicants for.

type'APPLICANT' | 'COAPPLICANT' required

The type of applicant.

isOnTitleboolean

Whether the applicant is on the property title.

firstNamestring

The applicant's first name.

lastNamestring

The applicant's last name.

dateOfBirthstring date-time

The applicant's date of birth.

homeOccupancy'PRIMARY' | 'SECONDARY' | 'INVESTMENT' | 'OTHER'

Occupancy status of the applicant's property.

homeOwnership'NOT_OWNED' | 'OWNED_WITH_MORTGAGE' | 'OWNED_FREE_AND_CLEAR'

Ownership status of the applicant's property.

emailstring

The applicant's email address.

spokenLanguage'ENGLISH' | 'SPANISH'

The applicant's spoken language.

employmentStatus'EMPLOYED' | 'RETIRED' | 'NOT_EMPLOYED' | 'OTHER'

The applicant's employment status.

citizenshipStatus'US_CITIZEN' | 'LAWFUL_PERMANENT_RESIDENT_ALIEN' | 'OTHER'

The applicant's citizenship status.

maritalStatus'SINGLE' | 'MARRIED' | 'DIVORCED' | 'SEPARATED' | 'WIDOWED'

The applicant's marital status.

The request has been processed successfully.