GOgoodleap
Application

Update Applicant on Application

Changed on

Update Application Applicant

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

Request

Path parameters

applicationIdunknown required

The ID of the application to update the applicants for.

Request body

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.

Response

The request has been processed successfully.

Changes

  • 30a51d431498Revision changes
    • info

      api operation id patchApplicationsByApplicationIdApplicants was added

  • f3b2f62c2a21Revision changes
    • warning

      changed the pattern of the request property ////// from /^[A-Z]{2}$/ to ^[A-Z]{2}$

    • warning

      changed the pattern of the request property ////// from /^\d{5}(?:-\d{4})?$/ to ^\d{5}(?:-\d{4})?$

    • info

      added the non-success response with the status