nCino Loan Applications API

Endpoints pertaining to loan applications

OpenAPI Specification

ncino-loan-applications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: nCino Mortgage Loan Applications API
  description: API framework built from the ground up to be more a robust, forward thinking solution with tools to support our developer community
  version: '1.0'
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.ncinomortgage.com
  description: Production server
security:
- OAuth2: []
tags:
- name: Loan Applications
  description: Endpoints pertaining to loan applications
paths:
  /loan_applications:
    post:
      tags:
      - Loan Applications
      operationId: loan_applications-create
      parameters:
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '201':
          description: Created loan application
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '409':
          description: Loan application already exists for borrower
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '412':
          description: No default loan officer set for organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        Create a <<glossary:loan application>>. Param keys with `_INDEX` should replace `_INDEX` with a number 1-5 for each entity being verified (e.g. `vogg_gift_amount_1` for first gift, `vogg_gift_amount_2` for second gift).'
      summary: 🚧 Create a loan application record (BETA)
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoanApplicationPostBody'
    get:
      tags:
      - Loan Applications
      operationId: loan_applications-index
      parameters:
      - name: borrower_external_customer_identifier
        description: External customer identifier for the borrower, by which to filter loan applications.
        required: false
        in: query
        schema:
          type: string
      - name: coborrower_external_customer_identifier
        description: External customer identifier for the coborrower, by which to filter loan applications.
        required: false
        in: query
        schema:
          type: string
      - name: is_active
        description: Filter loan applications by active status (default true).
        required: false
        in: query
        schema:
          type: boolean
      - name: loan_id
        description: Loan ID by which to filter loan applications (if loan has been created).
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: <<glossary:Loan officer>> ID by which to filter loan applications.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: org_id
        description: Organization (company, region, or branch) ID by which to filter loan applications.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: user_borrower_id
        description: User borrower ID by which to filter loan applications.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/CreatedAfter'
      - $ref: '#/components/parameters/CreatedBefore'
      - $ref: '#/components/parameters/UpdatedAfter'
      - $ref: '#/components/parameters/UpdatedBefore'
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoanApplicationPagination'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        Retrieve all <<glossary:loan application>>s'
      summary: 🚧 Retrieve all loan application records (BETA)
  /loan_applications/{loan_application_id}:
    get:
      tags:
      - Loan Applications
      operationId: loan_applications-show
      parameters:
      - name: loan_application_id
        description: loan_application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoanApplication.Detail'
            application/xml:
              schema:
                type: string
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        Retrieve a <<glossary:loan application>>. Param keys with `_INDEX` will have `_INDEX` replaced with a number 1-5 for each entity being verified (e.g. `vogg_gift_amount_1` for first gift, `vogg_gift_amount_2` for second gift).


        > 🙇 Heads up!

        Supplying the `Accept` header as `application/xml` will return the loan application in ILAD format (MISMO 3.4).'
      summary: 🚧 Retrieve a loan application (BETA)
    patch:
      tags:
      - Loan Applications
      operationId: loan_applications-update
      parameters:
      - name: loan_application_id
        description: Loan application ID
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '204':
          description: Successfully updated loan application
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContent'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        Update a <<glossary:loan application>>. Param keys with `_INDEX` should replace `_INDEX` with a number 1-5 for each entity being verified (e.g. `vogg_gift_amount_1` for first gift, `vogg_gift_amount_2` for second gift).


        > 📌 Replacing indexed key series

        Use `lists_to_update` to replace indexed key series.

        Keys are the value prefix (e.g. `global_asset_type` for keys like `global_asset_type_1`, `global_asset_type_2`).

        All existing keys matching `{prefix}_{number}` are removed and replaced with the provided values.

        Each prefix is processed independently. Pass an empty hash to remove all keys for that prefix.'
      summary: 🚧 Update a loan application (BETA)
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoanApplicationPatchBody'
    delete:
      tags:
      - Loan Applications
      operationId: loan_applications-destroy
      parameters:
      - name: loan_application_id
        description: loan application ID
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '204':
          description: Successfully deleted loan application
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContent'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        Delete a <<glossary:loan application>>'
      summary: 🚧 Delete a loan application (BETA)
  /loan_applications/{loan_application_id}/actions:
    post:
      tags:
      - Loan Applications
      operationId: loan_applications-actions
      parameters:
      - name: loan_application_id
        description: loan application ID
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '201':
          description: Created (CONVERT_TO_LOAN)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '204':
          description: No content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContent'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '412':
          description: Resource is in an invalid state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: '> 🚧 Under construction

        > **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.


        This endpoint allows a variety of actions to be taken on a <<glossary:loan application>>.


        > 📌 Available actions

        **DEACTIVATE** - Deactivate a loan application

        **ACTIVATE** - Activate a loan application

        **SHARE_APP** - send share app email to loan borrower

        **SUBMIT** - Submits a loan application

        **REJECT** - Rejects a loan application

        **REASSIGN_LO** - assign new <<glossary:loan officer>> to a loan application

        **CONVERT_TO_LOAN** - Convert a loan application to a loan'
      summary: 🚧 Perform action on a loan application (BETA)
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/ShareApp'
              - $ref: '#/components/schemas/DeactivateLoanApplication'
              - $ref: '#/components/schemas/ActivateLoanApplication'
              - $ref: '#/components/schemas/SubmitLoanApplication'
              - $ref: '#/components/schemas/RejectLoanApplication'
              - $ref: '#/components/schemas/ReassignLoanOfficer'
              - $ref: '#/components/schemas/ConvertToLoan'
              discriminator:
                propertyName: action
                mapping:
                  SHARE_APP: '#/components/schemas/ShareApp'
                  DEACTIVATE: '#/components/schemas/DeactivateLoanApplication'
                  ACTIVATE: '#/components/schemas/ActivateLoanApplication'
                  SUBMIT: '#/components/schemas/SubmitLoanApplication'
                  REJECT: '#/components/schemas/RejectLoanApplication'
                  REASSIGN_LO: '#/components/schemas/ReassignLoanOfficer'
                  CONVERT_TO_LOAN: '#/components/schemas/ConvertToLoan'
components:
  responses:
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSet'
      headers:
        X-Api-Version:
          $ref: '#/components/headers/ApiVersionResponseHeader'
        X-Api-Supported-Versions:
          $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
    NotFoundError:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSet'
      headers:
        X-Api-Version:
          $ref: '#/components/headers/ApiVersionResponseHeader'
        X-Api-Supported-Versions:
          $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSet'
      headers:
        X-Api-Version:
          $ref: '#/components/headers/ApiVersionResponseHeader'
        X-Api-Supported-Versions:
          $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
    BadRequestError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSet'
      headers:
        X-Api-Version:
          $ref: '#/components/headers/ApiVersionResponseHeader'
        X-Api-Supported-Versions:
          $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSet'
      headers:
        X-Api-Version:
          $ref: '#/components/headers/ApiVersionResponseHeader'
        X-Api-Supported-Versions:
          $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
  schemas:
    Suffixes:
      type: string
      enum:
      - ''
      - Jr.
      - Sr.
      - II
      - III
      - IV
      - V
      description: Suffixes a borrower declares on an application.
    LoanApplicationPatchBody:
      allOf:
      - $ref: '#/components/schemas/LoanApplicationBody'
      description: The available properties for updating a loan application record
      minProperties: 1
    GenderTypes:
      type: string
      enum:
      - Male
      - Female
      - I do not wish to provide this information
      description: Types of gender a borrower declares on an application.
    LoanApplicationBody:
      type: object
      properties:
        first_name:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Borrower's first name. Including first_name and last_name enables prospect creation and CRM sync.
        last_name:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Borrower's last name. Including first_name and last_name enables prospect creation and CRM sync.
        additional_real_estate_owned:
          type:
          - boolean
          - 'null'
          description: Whether additional real estate is owned.
        address:
          type:
          - string
          - 'null'
          maxLength: 255
          description: Borrower's street.
        alimony_amount:
          type:
          - integer
          - 'null'
          description: Amount of alimony paid by the borrower.
        asian_origin_other:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Specifies other Asian origin if applicable.
        assets1:
          type:
          - integer
          - 'null'
          description: Checking and savings account(s) amount.
        assets2:
          type:
          - integer
          - 'null'
          description: Additional asset(s) amount.
        assets_retirement:
          type:
          - integer
          - 'null'
          description: Borrower's retirement assets amount.
        borrower_bankruptcy_types:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BankruptcyTypes'
          description: Types of bankruptcies declared by the borrower.
        borrower_cell_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Borrower's cell phone number.
        borrower_citizenship_country:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Borrower's country of citizenship.
        borrower_citizenship_status:
          allOf:
          - $ref: '#/components/schemas/CitizenshipTypes'
          description: Borrower's citizenship status.
        borrower_contact_work_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Borrower's work phone number.
        borrower_conveyed_title_in_lieu_of_forclosure:
          type:
          - boolean
          - 'null'
          description: Whether the borrower has conveyed a title in lieu of foreclosure.
        borrower_domestic_relationship_other:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Specifies other domestic relationships for the borrower.
        borrower_domestic_relationship_state:
          oneOf:
          - $ref: '#/components/schemas/StateCode'
          - $ref: '#/components/schemas/EmptyString'
          description: U.S. state where the borrower's domestic relationship is recognized.
        borrower_domestic_relationship_type:
          allOf:
          - $ref: '#/components/schemas/DomesticRelationshipTypes'
          description: Type of domestic relationship.
        borrower_external_customer_identifier:
          type:
          - string
          - 'null'
          maxLength: 255
          description: External customer identifier for the borrower, persisted on the borrower's own AppUser record.
        borrower_family_or_business_affiliation_with_seller:
          type:
          - boolean
          - 'null'
          description: Whether borrower has a family or business relationship with the seller.
        borrower_home_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Borrower's home phone number.
        borrower_military_details:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MilitaryDetailTypes'
          description: Details about the borrower's military service (e.g. currently on active duty, surviving spouse).
        borrower_military_service:
          type:
          - boolean
          - 'null'
          description: Whether the borrower has military service history.
        borrower_military_service_expiration:
          type:
          - string
          - 'null'
          format: date
          description: Expiration date of borrower's military service if on active duty.
        borrower_mobile_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Borrower's mobile phone number.
        borrower_non_spouse_property_rights:
          type:
          - boolean
          - 'null'
          description: Whether the borrower has property rights with a non-spouse.
        borrower_other_obtained_or_borrowed_money_amount:
          type:
          - integer
          - 'null'
          description: Amount of money borrowed or obtained from another source.
        borrower_other_property_lien:
          type:
          - boolean
          - 'null'
          description: Whether borrower has a lien on another property.
        borrower_other_undisclosed_mortgage_closing_on_or_before:
          type:
          - boolean
          - 'null'
          description: Whether borrower has an undisclosed mortgage closing on or before a certain date.
        borrower_other_undisclosed_new_credit:
          type:
          - boolean
          - 'null'
          description: Whether borrower has undisclosed new credit.
        borrower_pre_forclosure_or_short_sale:
          type:
          - boolean
          - 'null'
          description: Whether borrower has undergone pre-foreclosure or a short sale.
        borrower_second_employer_still_employed:
          type:
          - boolean
          - 'null'
          description: Whether borrower is still employed at their second employer.
        borrower_share_info_authorization:
          type:
          - boolean
          - 'null'
          description: Authorization for borrower information sharing.
        borrower_two_years_at_current_address:
          type:
          - integer
          - 'null'
          description: How long the borrower has lived at the current address.
        borrower_voe_employment_is_self_employed_1:
          type:
          - boolean
          - 'null'
          description: Whether borrower is self-employed in VOE employment.
        branch_of_service:
          allOf:
          - $ref: '#/components/schemas/ServiceBranchTypes'
          description: Borrower's branch of military service.
        charm_acknowledgments:
          type:
          - boolean
          - 'null'
          description: Whether CHARM acknowledgments are signed (e.g. have they received a booklet?).
        city:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Borrower's city.
        co_borrower_verification_of_income_and_employment:
          type:
          - boolean
          - 'null'
          description: Whether coborrower’s income and employment verification is complete.
        coborrower_address:
          type:
          - string
          - 'null'
          description: Coborrower's street.
        coborrower_address_same_as_borrower:
          type:
          - boolean
          - 'null'
          description: Whether coborrower's address is the same as borrower's.
        coborrower_asian_origin_other:
          allOf:
          - $ref: '#/components/schemas/AsianOriginTypes'
          description: Specifies other Asian origin for coborrower.
        coborrower_bankruptcy_types:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BankruptcyTypes'
          description: Types of bankruptcies declared by the coborrower.
        coborrower_branch_of_service:
          allOf:
          - $ref: '#/components/schemas/ServiceBranchTypes'
          description: Coborrower’s branch of military service.
        coborrower_cell_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Coborrower’s cell phone number.
        coborrower_citizenship_country:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Coborrower’s country of citizenship.
        coborrower_citizenship_status:
          allOf:
          - $ref: '#/components/schemas/CitizenshipTypes'
          description: Coborrower’s citizenship status.
        coborrower_city:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Coborrower’s city.
        coborrower_contact_work_phone:
          type:
          - string
          - 'null'
          format: phone
          description: Coborrower’s work phone number.
        coborrower_conveyed_title_in_lieu_of_forclosure:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has conveyed title in lieu of foreclosure.
        coborrower_credit_authorization:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has authorized credit checks.
        coborrower_dependents_age:
          type:
          - string
          - 'null'
          maxLength: 20
          description: Ages of coborrower’s dependents.
        coborrower_dob:
          type:
          - string
          - 'null'
          maxLength: 10
          description: Coborrower’s date of birth (MM-DD-YYYY).
        coborrower_domestic_relationship_other:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Specifies other domestic relationships for coborrower.
        coborrower_domestic_relationship_state:
          oneOf:
          - $ref: '#/components/schemas/StateCode'
          - $ref: '#/components/schemas/EmptyString'
          description: U.S. state where the coborrower's domestic relationship is recognized.
        coborrower_domestic_relationship_type:
          allOf:
          - $ref: '#/components/schemas/DomesticRelationshipTypes'
          description: Type of domestic relationship for coborrower (e.g. Civil Union, Domestic Partnership).
        coborrower_econsent:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has provided eConsent.
        coborrower_email:
          type:
          - string
          - 'null'
          format: email
          maxLength: 255
          description: Coborrower’s email address.
        coborrower_employer_name:
          type:
          - string
          - 'null'
          maxLength: 255
          description: Coborrower’s employer name.
        coborrower_employer_years:
          type:
          - integer
          - 'null'
          description: Number of years coborrower has been with current employer.
        coborrower_employment_status:
          allOf:
          - $ref: '#/components/schemas/EmploymentStatusTypes'
          description: Coborrower’s employment status.
        coborrower_ethnicity:
          allOf:
          - $ref: '#/components/schemas/EthnicityTypes'
          description: Coborrower’s ethnicity.
        coborrower_ethnicity_latino:
          allOf:
          - $ref: '#/components/schemas/LatinEthnicityTypes'
          description: Coborrower's type of Hispanic or Latino origin.
        coborrower_external_customer_identifier:
          type:
          - string
          - 'null'
          maxLength: 255
          description: External customer identifier for the coborrower, persisted on the coborrower's own AppUser record.
        coborrower_family_or_business_affiliation_with_seller:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has an affiliation with the seller.
        coborrower_first_name:
          type:
          - string
          - 'null'
          maxLength: 100
          description: Coborrower’s first name.
        coborrower_gender:
          allOf:
          - $ref: '#/components/schemas/GenderTypes'
          description: Coborrower’s gender.
        coborrower_has_alimony:
          type:
          - boolean
          - 'null'
          description: Whether coborrower pays alimony.
        coborrower_has_bankruptcy:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has declared bankruptcy.
        coborrower_has_delinquent_debt:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has delinquent debt.
        coborrower_has_foreclosure:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has had a foreclosure.
        coborrower_has_obligations:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has financial obligations.
        coborrower_has_outstanding_judgements:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has outstanding judgments.
        coborrower_has_ownership_interest:
          type:
          - boolean
          - 'null'
          description: Whether coborrower has ownership interest in a property.
        coborrower_is_comaker_or_endorser:
          type:
          - boolean
          - 'null'
          description: Whether coborrower is a co-maker or endorser on a loan.
        coborrower_is_down_payment_borrowed:
          type:
          - boolean
          - 'null'
          description: Whether coborrower’s down payment is borrowed.
        coborrower_is_firsttimer:
          type:
          - boolean
          - 'null'
          description: Whether coborrower is a first-time homebuyer.
        coborrower_is_permanent_resident:
          type:
      

# --- truncated at 32 KB (146 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ncino/refs/heads/main/openapi/ncino-loan-applications-api-openapi.yml