---
title: "Update Applicant on Application"
method: PATCH
path: "/posfinancing/rest/v2/applications/{applicationId}/applicants"
tags: ["Application"]
---

# Update Applicant on Application

`PATCH /posfinancing/rest/v2/applications/{applicationId}/applicants`

Update Application Applicant

## Path parameters

- `applicationId` unknown, required

## Request body

- UndefinedUpdateApplicantInput[]
  - `type` 'APPLICANT' | 'COAPPLICANT', required — The type of applicant.
  - `isOnTitle` boolean — Whether the applicant is on the property title.
  - `firstName` string — The applicant's first name.
  - `lastName` string — The applicant's last name.
  - `dateOfBirth` string, date-time — The applicant's date of birth.
  - `personalIdentity` UndefinedPersonalIdentityInputDto
    - `type` 'SSN', required — The document type.
    - `value` string, required — The unique identification number.
  - `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.
  - `annualIncome` UndefinedCurrencyMeasurementInputDto
    - `type` 'USD', required — The currency type.
    - `value` number, required — The currency value.
  - `email` string — The applicant's email address.
  - `primaryPhoneNumber` UndefinedPhoneInputDto
    - `phoneNumber` string, required — The phone number.
    - `type` 'HOME' | 'MOBILE', required — The phone number type.
  - `secondaryPhoneNumber` UndefinedPhoneInputDto
    - `phoneNumber` string, required — The phone number.
    - `type` 'HOME' | 'MOBILE', required — The phone number type.
  - `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.
  - `address` UndefinedAddress
    - `line1` string, required — The street address.
    - `line2` string — Additional details such as apartment or unit number, suite, floor, building, etc.
    - `city` string, required — The city.
    - `state` string, required — The state.
    - `zip` string, required — The ZIP code.
    - `country` string — The country in ISO 3166-1 alpha-2 format. Defaults to US.
  - `maritalStatus` 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'SEPARATED' | 'WIDOWED' — The applicant's marital status.
  - `maritalPartner` UndefinedMaritalPartnerInputDto
    - `firstName` string, required — The marital partner's first name.
    - `lastName` string, required — The marital partner's last name.
    - `contact` UndefinedMaritalPartnerContactInputDto, required
      - `email` string, required — The marital partner's email address.
      - `primaryPhoneNumber` UndefinedPhoneInputDto, required
        - `phoneNumber` string, required — The phone number.
        - `type` 'HOME' | 'MOBILE', required — The phone number type.
      - `secondaryPhoneNumber` UndefinedPhoneInputDto
        - `phoneNumber` string, required — The phone number.
        - `type` 'HOME' | 'MOBILE', required — The phone number type.

## Response `204`

The request has been processed successfully.

## Other responses

- `400` — The request cannot be processed due to malformed data.
- `401` — Unauthorized access to the requested resource.
- `403` — Access to the requested resource is forbidden.
- `404` — The resource was not found.

---

[API](https://skmtc.net/goodleap/apis/developer-api.md) · [All operations](https://skmtc.net/goodleap/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/goodleap/developer-api/revisions/0ba836de8da3/schema)