---
info:
  title: nCino Mortgage 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: []
openapi: 3.0.0
paths:
  "/oauth/token":
    post:
      tags:
      - Authentication
      operationId: authentication-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthToken"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthError"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthError"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: Initiate the <<glossary:authentication workflow>> using supported
        grant types.
      summary: Initiate authentication workflow
      security: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/OAuthTokenClientBody"
              - "$ref": "#/components/schemas/OAuthTokenRefreshBody"
              - "$ref": "#/components/schemas/OAuthTokenCodeBody"
              discriminator:
                propertyName: grant_type
                mapping:
                  client_credentials: "#/components/schemas/OAuthTokenClientBody"
                  refresh_token: "#/components/schemas/OAuthTokenRefreshBody"
                  authorization_code: "#/components/schemas/OAuthTokenCodeBody"
    get:
      tags:
      - Authentication
      operationId: authentication-show
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthTokenInfo"
          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: This endpoint will retrieve <<glossary:access token>> information.
      summary: Retrieve access token information
  "/oauth/token/actions":
    post:
      tags:
      - Authentication
      operationId: authentication-actions
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthTokenIntrospect"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthError"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/OAuthError"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "This endpoint will perform an action on an <<glossary:access token>>.\n\n>
        \U0001F4CC Available actions\n  **REVOKE** - Revoke an existing access token\n
        \ **INTROSPECT** - Introspect an access token"
      summary: Perform an action on access token
      security: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/OAuthActionBody"
              discriminator:
                propertyName: action
                mapping:
                  REVOKE: "#/components/schemas/OAuthActionBody"
                  INTROSPECT: "#/components/schemas/OAuthActionBody"
  "/webhooks":
    post:
      tags:
      - Webhooks
      operationId: webhooks-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created webhook
          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: Webhook already exists for the given URL
          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: This endpoint will create a new <<glossary:webhook>> record.
      summary: Create a new webhook record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/WebhookPostBody"
    get:
      tags:
      - Webhooks
      operationId: webhooks-index
      parameters:
      - "$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/WebhookPagination"
          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: This endpoint will retrieve all <<glossary:webhook>> records.
      summary: Retrieve all webhook records
  "/webhooks/{webhook_id}":
    get:
      tags:
      - Webhooks
      operationId: webhooks-show
      parameters:
      - name: webhook_id
        description: Webhook 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/Webhook.Detail"
          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: This endpoint will retrieve a <<glossary:webhook>> record.
      summary: Retrieve a webhook record
    patch:
      tags:
      - Webhooks
      operationId: webhooks-update
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Updated webhook
          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: This endpoint will update a <<glossary:webhook>> record.
      summary: Update a webhook record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/WebhookPatchBody"
    delete:
      tags:
      - Webhooks
      operationId: webhooks-destroy
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Deleted webhook
          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: This endpoint will delete a <<glossary:webhook>> record.
      summary: Delete a webhook record
  "/webhooks/{webhook_id}/test_events":
    post:
      tags:
      - Webhooks
      operationId: webhooks-test_events
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Successfully sent webhook request
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/WebhookTestResponse"
          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: Use this endpoint to test events being sent to your <<glossary:webhook>>.
      summary: Perform test event on a webhook
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/JobStatusChangedTestEvent0"
              - "$ref": "#/components/schemas/LoanAppStartedTestEvent0"
              - "$ref": "#/components/schemas/LoanAppUpdatedTestEvent0"
              - "$ref": "#/components/schemas/LoanAppSubmittedTestEvent0"
              - "$ref": "#/components/schemas/LoanAppImportedTestEvent0"
              - "$ref": "#/components/schemas/LoanAppAbandonedTestEvent0"
              - "$ref": "#/components/schemas/DocumentUploadedTestEvent0"
              - "$ref": "#/components/schemas/DocumentCreatedTestEvent0"
              - "$ref": "#/components/schemas/DocumentUpdatedTestEvent0"
              - "$ref": "#/components/schemas/LoanMilestoneUpdatedTestEvent0"
              - "$ref": "#/components/schemas/LoanMilestoneCompletedTestEvent0"
              - "$ref": "#/components/schemas/LoanCreatedTestEvent0"
              - "$ref": "#/components/schemas/LoanUpdatedTestEvent0"
              - "$ref": "#/components/schemas/LoanDeletedTestEvent0"
              - "$ref": "#/components/schemas/LoanActivatedTestEvent0"
              - "$ref": "#/components/schemas/LoanDeactivatedTestEvent0"
              - "$ref": "#/components/schemas/MilestonesReorderedTestEvent0"
              - "$ref": "#/components/schemas/MilestoneCreatedTestEvent0"
              - "$ref": "#/components/schemas/MilestoneDeletedTestEvent0"
              - "$ref": "#/components/schemas/OrganizationCreatedTestEvent0"
              - "$ref": "#/components/schemas/OrganizationDeletedTestEvent0"
              - "$ref": "#/components/schemas/StateLicenseCreatedTestEvent0"
              - "$ref": "#/components/schemas/StateLicenseUpdatedTestEvent0"
              - "$ref": "#/components/schemas/StateLicenseDeletedTestEvent0"
              - "$ref": "#/components/schemas/AccountAssignmentCreatedTestEvent0"
              - "$ref": "#/components/schemas/AccountAssignmentDeletedTestEvent0"
              - "$ref": "#/components/schemas/LoanOfficerPromotedTestEvent0"
              - "$ref": "#/components/schemas/LoanOfficerDemotedTestEvent0"
              - "$ref": "#/components/schemas/UserCreatedTestEvent0"
              - "$ref": "#/components/schemas/UserUpdatedTestEvent0"
              - "$ref": "#/components/schemas/UserEnabledTestEvent0"
              - "$ref": "#/components/schemas/UserDisabledTestEvent0"
              - "$ref": "#/components/schemas/UserFirstLoginTestEvent0"
              - "$ref": "#/components/schemas/UserDeletedTestEvent0"
              - "$ref": "#/components/schemas/VerificationAvailableTestEvent0"
              discriminator:
                propertyName: event
                mapping:
                  job_status_changed: "#/components/schemas/JobStatusChangedTestEvent0"
                  loan_app_started: "#/components/schemas/LoanAppStartedTestEvent0"
                  loan_app_updated: "#/components/schemas/LoanAppUpdatedTestEvent0"
                  loan_app_submitted: "#/components/schemas/LoanAppSubmittedTestEvent0"
                  loan_app_imported: "#/components/schemas/LoanAppImportedTestEvent0"
                  loan_app_abandoned: "#/components/schemas/LoanAppAbandonedTestEvent0"
                  document_uploaded: "#/components/schemas/DocumentUploadedTestEvent0"
                  document_created: "#/components/schemas/DocumentCreatedTestEvent0"
                  document_updated: "#/components/schemas/DocumentUpdatedTestEvent0"
                  loan_milestone_updated: "#/components/schemas/LoanMilestoneUpdatedTestEvent0"
                  loan_milestone_completed: "#/components/schemas/LoanMilestoneCompletedTestEvent0"
                  loan_created: "#/components/schemas/LoanCreatedTestEvent0"
                  loan_updated: "#/components/schemas/LoanUpdatedTestEvent0"
                  loan_deleted: "#/components/schemas/LoanDeletedTestEvent0"
                  loan_activated: "#/components/schemas/LoanActivatedTestEvent0"
                  loan_deactivated: "#/components/schemas/LoanDeactivatedTestEvent0"
                  milestones_reordered: "#/components/schemas/MilestonesReorderedTestEvent0"
                  milestone_created: "#/components/schemas/MilestoneCreatedTestEvent0"
                  milestone_deleted: "#/components/schemas/MilestoneDeletedTestEvent0"
                  organization_created: "#/components/schemas/OrganizationCreatedTestEvent0"
                  organization_deleted: "#/components/schemas/OrganizationDeletedTestEvent0"
                  state_license_created: "#/components/schemas/StateLicenseCreatedTestEvent0"
                  state_license_updated: "#/components/schemas/StateLicenseUpdatedTestEvent0"
                  state_license_deleted: "#/components/schemas/StateLicenseDeletedTestEvent0"
                  account_assignment_created: "#/components/schemas/AccountAssignmentCreatedTestEvent0"
                  account_assignment_deleted: "#/components/schemas/AccountAssignmentDeletedTestEvent0"
                  loan_officer_promoted: "#/components/schemas/LoanOfficerPromotedTestEvent0"
                  loan_officer_demoted: "#/components/schemas/LoanOfficerDemotedTestEvent0"
                  user_created: "#/components/schemas/UserCreatedTestEvent0"
                  user_updated: "#/components/schemas/UserUpdatedTestEvent0"
                  user_enabled: "#/components/schemas/UserEnabledTestEvent0"
                  user_disabled: "#/components/schemas/UserDisabledTestEvent0"
                  user_first_login: "#/components/schemas/UserFirstLoginTestEvent0"
                  user_deleted: "#/components/schemas/UserDeletedTestEvent0"
                  verification_available: "#/components/schemas/VerificationAvailableTestEvent0"
  "/webhooks/{webhook_id}/actions":
    post:
      tags:
      - Webhooks
      operationId: webhooks-actions
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '201':
          description: Created <<glossary:asynchronous job>> to process action
          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: Webhook already exists for the given URL
          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: "> \U0001F4CC Available actions\n  **ENABLE** - Activate webhook\n
        \ **DISABLE** - Deactivate webhook\n  **TEST** - Test webhook connection to
        URL\n  **CHANGE_URL** - Change URL for webhook"
      summary: Perform action on a webhook
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/WebhookAction"
              discriminator:
                propertyName: action
                mapping:
                  ENABLE: "#/components/schemas/WebhookAction"
                  DISABLE: "#/components/schemas/WebhookAction"
                  TEST: "#/components/schemas/WebhookAction"
                  CHANGE_URL: "#/components/schemas/ChangeUrlAction"
  "/webhooks/{webhook_id}/subscriptions":
    post:
      tags:
      - Subscriptions
      operationId: subscriptions-create
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Subscription created
          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: Webhook is already subscribed to event
          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: Create a subscription for a <<glossary:webhook>>
      summary: Create a subscription for a webhook
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/WebhookSubscriptionSaveBody"
    get:
      tags:
      - Subscriptions
      operationId: subscriptions-index
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        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/WebhookSubscriptionPagination"
          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: This endpoint will retrieve all of a <<glossary:webhook>>'s subscription
        records.
      summary: Retrieve all of a webhook's subscription records
  "/webhooks/{webhook_id}/subscriptions/{webhook_subscription_id}":
    get:
      tags:
      - Subscriptions
      operationId: subscriptions-show
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: webhook_subscription_id
        description: Subscription 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/WebhookSubscription"
          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: This endpoint will retrieve a <<glossary:webhook>>'s subscription
        record.
      summary: Retrieve a webhook's subscription record
    patch:
      tags:
      - Subscriptions
      operationId: subscriptions-update
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: webhook_subscription_id
        description: Subscription ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Subscription updated
          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: Webhook is already subscribed to event
          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: This endpoint will update a <<glossary:webhook>>'s subscription
        record.
      summary: Update a webhook's subscription record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/WebhookSubscriptionSaveBody"
    delete:
      tags:
      - Subscriptions
      operationId: subscriptions-destroy
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: webhook_subscription_id
        description: Subscription ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Subscription removed
          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: This endpoint will delete a <<glossary:webhook>>'s subscription
        record (i.e. unsubscribes a webhook from an event).
      summary: Delete a webhook's subscription record
  "/branches/{branch_id}/images/{image_key}":
    put:
      tags:
      - Branch Images
      operationId: branch_images-update
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated branch image
          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: "This endpoint uploads images to a <<glossary:branch>>. Available
        images and their image_keys, along with the supported file types and sizes
        are in the table below.\n\n> \U0001F647 Heads up!\n**All image file uploads
        should be base64 encoded.**\n<table border=1px cellpadding=5px>\n\t<tr>\n\t\t<th>image_key</th>\n\t\t<th>Supported
        File Types</th>\n\t\t<th>Image Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>1000x313</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_icon</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>100x100</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_homepage_logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>208x32</td>\n\t</tr>\n</table>"
      summary: Update a branch's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Branch Images
      operationId: branch_images-destroy
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted branch image
          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: This endpoint deletes a <<glossary:branch>>'s image for the image
        key provided.
      summary: Delete branch image
  "/branches/{branch_id}/links":
    get:
      tags:
      - Branch Links
      operationId: branch_links-index
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        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/LinkPagination"
          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: This endpoint retrieves a list of <<glossary:branch>> <<glossary:link>>s.
      summary: Retrieve branch links
    post:
      tags:
      - Branch Links
      operationId: branch_links-create
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created branch link
          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: URL already taken for a branch link
          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: This endpoint creates a <<glossary:branch>> <<glossary:link>>.
      summary: Create a branch link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkCreateBody"
  "/branches/{branch_id}/links/{link_id}":
    patch:
      tags:
      - Branch Links
      operationId: branch_links-update
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated branch link
          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: URL already taken for a branch link
          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: This endpoint updates a <<glossary:branch>> <<glossary:link>>.
      summary: Update a branch link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkUpdateBody"
    get:
      tags:
      - Branch Links
      operationId: branch_links-show
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link 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/Link"
          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: This endpoint retrieves a specific <<glossary:branch>> <<glossary:link>>.
      summary: Retrieve a branch link
    delete:
      tags:
      - Branch Links
      operationId: branch_links-destroy
      parameters:
      - name: branch_id
        description: "<Branch ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted branch link
          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: This endpoint deletes a <<glossary:branch>> <<glossary:link>>.
      summary: Delete a branch link
  "/branches/{branch_id}/reports":
    post:
      tags:
      - Branch Reports
      operationId: branch_reports-generate
      parameters:
      - name: branch_id
        description: "<<glossary:Branch>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint generates a <<glossary:branch>> report. The report
        will create an <<glossary:asynchronous job>> and can be accessed when the
        job returned in the response has successfully completed.
      summary: Generate a branch report
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              anyOf:
              - "$ref": "#/components/schemas/ReportPostBody"
              - "$ref": "#/components/schemas/TimeBoundReportPostBody"
              discriminator:
                propertyName: report_type
                mapping:
                  CO_BRANDED_APPS: "#/components/schemas/TimeBoundReportPostBody"
                  DOCUSIGN_ENVELOPES: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APP_DETAILS: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APPS_COUNT: "#/components/schemas/TimeBoundReportPostBody"
                  LO_ACTIVITY: "#/components/schemas/TimeBoundReportPostBody"
                  NPS_FEEDBACK: "#/components/schemas/TimeBoundReportPostBody"
                  PACKAGE_TRACKER: "#/components/schemas/TimeBoundReportPostBody"
                  PROSPECTS: "#/components/schemas/TimeBoundReportPostBody"
                  QR_CODES: "#/components/schemas/ReportPostBody"
                  VERIFICATION_OF_ASSETS_ORDERS: "#/components/schemas/TimeBoundReportPostBody"
  "/branches/{branch_id}/reports/{report_id}":
    get:
      tags:
      - Branch Reports
      operationId: branch_reports-download
      parameters:
      - name: branch_id
        description: Scope response to branch_id
        required: true
        in: path
        schema:
          type: string
      - name: report_id
        description: Scope response to report_id
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              "$ref": "#/components/headers/ContentDispositionResponseHeader"
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '410':
          description: Report has been archived
          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: This endpoint downloads a <<glossary:branch>> report.
      summary: Download a branch report
  "/branches/{branch_id}/state_licenses":
    post:
      tags:
      - Branch State Licenses
      operationId: branch_state_licenses-create
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created license
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a <<glossary:branch>> <<glossary:state
        license>>.
      summary: Create a branch state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseCreateBody"
    get:
      tags:
      - Branch State Licenses
      operationId: branch_state_licenses-index
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter state licenses.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicensePagination"
          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: This endpoint will retrieve all <<glossary:branch>> <<glossary:state
        license>>s.
      summary: Retrieve all branch state licenses
  "/branches/{branch_id}/state_licenses/{state_license_id}":
    patch:
      tags:
      - Branch State Licenses
      operationId: branch_state_licenses-update
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated state license
          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: This endpoint will update a <<glossary:branch>> <<glossary:state
        license>>.
      summary: Update a branch state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseUpdateBody"
    get:
      tags:
      - Branch State Licenses
      operationId: branch_state_licenses-show
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license 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/StateLicense"
          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: This endpoint will retrieve a <<glossary:branch>> <<glossary:state
        license>>.
      summary: Retrieve a branch state license
    delete:
      tags:
      - Branch State Licenses
      operationId: branch_state_licenses-destroy
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted state license
          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: This endpoint will delete a <<glossary:branch>> <<glossary:state
        license>>.
      summary: Delete a branch state license
  "/companies/{company_id}/images/{image_key}":
    put:
      tags:
      - Company Images
      operationId: company_images-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated company image
          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: "This endpoint will update a <<glossary:company>>'s image.\n\n<table
        border=1px cellpadding=5px>\n\t<tr>\n\t\t<th>image_key</th>\n\t\t<th>Supported
        File Types</th>\n\t\t<th>Image Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>1000x313</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_icon</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>100x100</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_homepage_logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>208x32</td>\n\t</tr>\n</table>"
      summary: Update a company's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Company Images
      operationId: company_images-destroy
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted company image
          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: This endpoint will delete a <<glossary:company>>'s image.
      summary: Delete a company's image
  "/companies/{company_id}/links":
    post:
      tags:
      - Company Links
      operationId: company_links-create
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created link
          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: URL already taken for a company link
          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: This endpoint will create a <<glossary:company>> <<glossary:link>>.
      summary: Create a company link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkCreateBody"
    get:
      tags:
      - Company Links
      operationId: company_links-index
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        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/LinkPagination"
          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: This endpoint will retrieve <<glossary:company>> <<glossary:link>>s.
      summary: Retrieve all company links
  "/companies/{company_id}/links/{link_id}":
    get:
      tags:
      - Company Links
      operationId: company_links-show
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link 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/Link"
          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: This endpoint will retrieve a <<glossary:company>> <<glossary:link>>.
      summary: Retrieve a company link
    patch:
      tags:
      - Company Links
      operationId: company_links-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated company link
          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: URL already taken for a company link
          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: This endpoint will update a <<glossary:company>> <<glossary:link>>.
      summary: Update a company link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkUpdateBody"
    delete:
      tags:
      - Company Links
      operationId: company_links-destroy
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted company link
          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: This endpoint will delete a <<glossary:company>> <<glossary:link>>.
      summary: Delete a company link
  "/companies/{company_id}/milestones":
    post:
      tags:
      - Company Milestones
      operationId: company_milestones-create
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created milestone
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a <<glossary:milestone>> for the given
        <<glossary:company>>.
      summary: Create a company milestone
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/MilestoneCreateBody"
    get:
      tags:
      - Company Milestones
      operationId: company_milestones-index
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        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/MilestonePagination"
          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: |-
        This endpoint retrieves all <<glossary:milestone>> for the given <<glossary:company>>.

        To reorder these milestones, use the `/companies/{company_id}/actions` endpoint.
      summary: Retrieve all company milestones
  "/companies/{company_id}/milestones/{milestone_id}":
    get:
      tags:
      - Company Milestones
      operationId: company_milestones-show
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: milestone_id
        description: Milestone 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/Milestone"
          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: This endpoint will retrieve a <<glossary:milestone>> for the given
        <<glossary:company>>.
      summary: Retrieve a company milestone record
    patch:
      tags:
      - Company Milestones
      operationId: company_milestones-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: milestone_id
        description: Milestone ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated milestone
          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: This endpoint updates a <<glossary:milestone>> for the given <<glossary:company>>.
      summary: Updates a company milestone
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/MilestoneUpdateBody"
    delete:
      tags:
      - Company Milestones
      operationId: company_milestones-destroy
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: milestone_id
        description: Milestone ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted milestone
          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: This endpoint will delete a <<glossary:milestone>> from the given
        <<glossary:company>>.
      summary: Delete a company milestone
  "/companies/{company_id}/regions/{region_id}":
    get:
      tags:
      - Company Regions
      operationId: company_regions-show
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region 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/Region"
          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: This endpoint retrieves a specific <<glossary:region>>.
      summary: Retrieve a specific region
    patch:
      tags:
      - Company Regions
      operationId: company_regions-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated region
          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: This endpoint updates a <<glossary:region>>.
      summary: Update a region
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RegionUpdateBody"
    delete:
      tags:
      - Company Regions
      operationId: company_regions-destroy
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created <<glossary:asynchronous job>> to delete region.
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "This endpoint will delete a <<glossary:region>>.\n\n> \U0001F647
        Heads up!\nThe region is not deleted immediately, but deleted in an <<glossary:asynchronous
        job>>."
      summary: Delete a region
  "/companies/{company_id}/regions":
    post:
      tags:
      - Company Regions
      operationId: company_regions-create
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created region
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint creates a <<glossary:region>>.
      summary: Create a new region
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RegionPostBody"
    get:
      tags:
      - Company Regions
      operationId: company_regions-index
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter regions.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/RegionPagination"
          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: This endpoint will retrieve a <<glossary:company>>'s <<glossary:region>>s.
      summary: Retrieve a company's regions
  "/companies/{company_id}/reports":
    post:
      tags:
      - Company Reports
      operationId: company_reports-generate
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: |-
        This endpoint will generate a <<glossary:company>> report.

        The report will be generated as an <<glossary:asynchronous job>> and can be accessed when the job returned in the response has successfully completed.
      summary: Generate a company report
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              anyOf:
              - "$ref": "#/components/schemas/ReportPostBody"
              - "$ref": "#/components/schemas/TimeBoundReportPostBody"
              discriminator:
                propertyName: report_type
                mapping:
                  CO_BRANDED_APPS: "#/components/schemas/TimeBoundReportPostBody"
                  DOCUSIGN_ENVELOPES: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APP_DETAILS: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APPS_COUNT: "#/components/schemas/TimeBoundReportPostBody"
                  LO_ACTIVITY: "#/components/schemas/TimeBoundReportPostBody"
                  NPS_FEEDBACK: "#/components/schemas/TimeBoundReportPostBody"
                  PACKAGE_TRACKER: "#/components/schemas/TimeBoundReportPostBody"
                  PROSPECTS: "#/components/schemas/TimeBoundReportPostBody"
                  QR_CODES: "#/components/schemas/ReportPostBody"
                  VERIFICATION_OF_ASSETS_ORDERS: "#/components/schemas/TimeBoundReportPostBody"
  "/companies/{company_id}/reports/{report_id}":
    get:
      tags:
      - Company Reports
      operationId: company_reports-download
      parameters:
      - name: company_id
        description: Scope response to company_id
        required: true
        in: path
        schema:
          type: string
      - name: report_id
        description: Scope response to report_id
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              "$ref": "#/components/headers/ContentDispositionResponseHeader"
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '410':
          description: Report has been archived
          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: This endpoint will download a report for a <<glossary:company>>.
      summary: Download a report for a company
  "/companies":
    get:
      tags:
      - Companies
      operationId: companies-index
      parameters:
      - "$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/CompanyPagination"
          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: This endpoint will retrieve all <<glossary:company>> records.
      summary: Retrieve all companies
  "/companies/{company_id}":
    get:
      tags:
      - Companies
      operationId: companies-show
      parameters:
      - name: company_id
        description: Company 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/Company"
          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: This endpoint will retrieve a <<glossary:company>> record.
      summary: Retrieve a company record
    patch:
      tags:
      - Companies
      operationId: companies-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated company
          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: This endpoint will update a <<glossary:company>> record.
      summary: Update a company record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/CompanyUpdateBody"
  "/companies/{company_id}/actions":
    post:
      tags:
      - Companies
      operationId: companies-actions
      parameters:
      - name: company_id
        description: Company ID
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: "This endpoint allows a variety of actions to be taken on a <<glossary:company>>.\n\n>
        \U0001F4CC Available actions\n  **REORDER_MILESTONES** - Reorder <<glossary:milestone>>s"
      summary: Perform action on a company
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/ReorderMilestonesCompanyAction"
              discriminator:
                propertyName: action
                mapping:
                  reorder_milestones: "#/components/schemas/ReorderMilestonesCompanyAction"
  "/companies/{company_id}/state_licenses":
    post:
      tags:
      - Company State Licenses
      operationId: company_state_licenses-create
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created state license
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a <<glossary:state license>> for the
        given <<glossary:company>>.
      summary: Create a company state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LimitedStateLicenseCreateBody"
    get:
      tags:
      - Company State Licenses
      operationId: company_state_licenses-index
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter state licenses.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicensePagination"
          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: This endpoint will retrieve all <<glossary:state license>>s for
        the given <<glossary:company>>.
      summary: Retrieve all company state licenses
  "/companies/{company_id}/state_licenses/{state_license_id}":
    get:
      tags:
      - Company State Licenses
      operationId: company_state_licenses-show
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license 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/StateLicense"
          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: This endpoint will retrieve a <<glossary:state license>> for the
        given <<glossary:company>>.
      summary: Retrieve a company state license
    patch:
      tags:
      - Company State Licenses
      operationId: company_state_licenses-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated state license
          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: This endpoint will update a <<glossary:state license>> for the
        given <<glossary:company>>.
      summary: Update a company state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LimitedStateLicenseUpdateBody"
    delete:
      tags:
      - Company State Licenses
      operationId: company_state_licenses-destroy
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted state license
          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: This endpoint will delete a <<glossary:state license>> from the
        given <<glossary:company>>.
      summary: Delete a company state license
  "/companies/{company_id}/state_license_templates":
    post:
      tags:
      - Company State License Templates
      operationId: company_state_license_templates-create
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created state license template
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a state license template for the given
        <<glossary:company>>.
      summary: Create a company state license template
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseTemplateCreateBody"
    get:
      tags:
      - Company State License Templates
      operationId: company_state_license_templates-index
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter state license templates.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicenseTemplatePagination"
          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: This endpoint will retrieve all state license templates for the
        given <<glossary:company>>.
      summary: Retrieve all company state license templates
  "/companies/{company_id}/state_license_templates/{state_license_template_id}":
    get:
      tags:
      - Company State License Templates
      operationId: company_state_license_templates-show
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_template_id
        description: State license template 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/StateLicenseTemplate"
          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: This endpoint will retrieve a state license template for the given
        <<glossary:company>>.
      summary: Retrieve a company state license template
    patch:
      tags:
      - Company State License Templates
      operationId: company_state_license_templates-update
      parameters:
      - name: company_id
        description: Company ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_template_id
        description: State license template ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated state license template
          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: This endpoint will update a state license template for the given
        <<glossary:company>>.
      summary: Update a company state license template
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseTemplateUpdateBody"
  "/jobs/{job_id}":
    get:
      tags:
      - Jobs
      operationId: jobs-show
      parameters:
      - name: job_id
        description: Job 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/Job"
          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: This endpoint will retrieve an <<glossary:asynchronous job>> record.
      summary: Retrieve a job record
  "/links":
    get:
      tags:
      - Links
      operationId: links-index
      parameters:
      - "$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/LinkPagination"
          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: "This endpoint will retrieve all organization <<glossary:link>>s.\n\n>
        \U0001F647 Heads up!\n**All Organization Links** - this will grab all links
        that are associated with the Company, Regions, and Branches"
      summary: Retrieve links
  "/loan_applications/{loan_application_id}/borrower_task_reminders":
    post:
      tags:
      - Loan App Borrower Task Reminders
      operationId: loan_app_borrower_task_reminders-create
      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: Reminder sent
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/NoContent"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '412':
          description: Unable to send reminder
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will send
        a reminder to a borrower about their incomplete tasks on a loan application."
      summary: "\U0001F6A7 Send a borrower task reminder (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/BorrowerTaskReminderPostBody"
  "/loan_applications/{loan_application_id}/borrowers":
    get:
      tags:
      - Loan Application Borrowers
      operationId: loan_application_borrowers-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: pair_index
        description: Pair index by which to filter borrowers on the loan application.
        required: false
        in: query
        schema:
          type: integer
      - "$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/BorrowerPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a list of borrowers
        on a <<glossary:loan application>>. Loan application borrowers are separate
        from <<glossary:borrower account>>s.\nA <<glossary:loan application borrower>>
        may or may not have an account in nCino Mortgage.\nThe corresponding user
        borrower account will be listed in the _links object, if available."
      summary: "\U0001F6A7 Retrieve all loan application borrowers (BETA)"
  "/loan_applications/{loan_application_id}/borrowers/{borrower_id}":
    get:
      tags:
      - Loan Application Borrowers
      operationId: loan_application_borrowers-show
      parameters:
      - name: borrower_id
        description: Loan application borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - 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/Borrower.Detail"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve a <<glossary:loan
        application borrower>>"
      summary: "\U0001F6A7 Retrieves a loan application borrower (BETA)"
  "/loan_applications/{loan_application_id}/borrowers/{borrower_id}/actions":
    post:
      tags:
      - Loan Application Borrowers
      operationId: loan_application_borrowers-actions
      parameters:
      - name: borrower_id
        description: Loan application borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - 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 <<glossary:asynchronous job>> to process action
          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"
        '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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint allows
        a variety of actions to be taken on a <<glossary:loan application borrower>>.\n\n>
        \U0001F4CC Available actions\n**ORDER_VERIFICATION** - order verification
        for the loan application borrower (requires Verifications v2 feature be enabled)\n**DISCONNECT_BORROWER**
        - disconnect loan application borrower payroll and bank data connections for
        verification purposes (requires Verifications v2 feature be enabled)\n**SEND_VERIFICATION_REMINDER**
        - send email reminder to loan application borrower to complete the verification
        experience (requires Verifications v2 feature be enabled)\n**SET_PRIMARY_BORROWER**
        - set loan borrower as the primary borrower on the user loan application.\n**LINK_BORROWER**
        - link a borrower to a loan"
      summary: "\U0001F6A7 Perform action on a loan application borrower (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/OrderVerification"
              - "$ref": "#/components/schemas/DisconnectBorrower"
              - "$ref": "#/components/schemas/SendVerificationReminder"
              - "$ref": "#/components/schemas/SetPrimaryBorrower"
              - "$ref": "#/components/schemas/LinkBorrower"
              discriminator:
                propertyName: action
                mapping:
                  ORDER_VERIFICATION: "#/components/schemas/OrderVerification"
                  DISCONNECT_BORROWER: "#/components/schemas/DisconnectBorrower"
                  SEND_VERIFICATION_REMINDER: "#/components/schemas/SendVerificationReminder"
                  SET_PRIMARY_BORROWER: "#/components/schemas/SetPrimaryBorrower"
                  LINK_BORROWER: "#/components/schemas/LinkBorrower"
  "/loan_applications/{loan_application_id}/custom_form_requests":
    post:
      tags:
      - Loan App Custom Form Requests
      operationId: loan_app_custom_form_requests-create
      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 custom form request
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        a custom form request for a loan application."
      summary: "\U0001F6A7 Create a custom form request (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/CustomFormRequestPostBody"
  "/loan_applications/{loan_application_id}/inquiry_tasks":
    post:
      tags:
      - Loan App Inquiry Tasks
      operationId: loan_app_inquiry_tasks-create
      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 inquiry task
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        an inquiry task for a loan application."
      summary: "\U0001F6A7 Create an inquiry task (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/InquiryTaskPostBody"
  "/loan_applications/{loan_application_id}/loan_doc_tasks":
    post:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-create
      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 loan doc task
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a loan doc task for a loan.
      summary: Create a loan doc task
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanDocTaskPostBody"
    get:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-index
      parameters:
      - name: doc_type
        description: Doc type by which to filter loan doc tasks.
        required: false
        in: query
        schema:
          type: string
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_borrower_id
        description: Loan borrower ID by which to filter loan doc tasks.
        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/LoanDocTaskPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a list of loan
        doc tasks on a loan."
      summary: "\U0001F6A7 Retrieve all loan doc tasks belonging to the loan application
        (BETA)"
  "/loan_applications/{loan_application_id}/loan_doc_tasks/{loan_doc_task_id}":
    get:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_doc_task_id
        description: Loan doc task 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/LoanDocTask"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retrieve
        a single loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Retrieve a loan doc task (BETA)"
    delete:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted loan doc task
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will delete
        a loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Delete a loan doc task (BETA)"
    put:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-update
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated loan doc task
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will update
        a loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Update a loan doc task (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanDocTaskUpdateBody"
  "/loan_applications/{loan_application_id}/loan_doc_tasks/{loan_doc_task_id}/actions":
    post:
      tags:
      - Loan App Doc Tasks
      operationId: loan_app_doc_tasks-actions
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '412':
          description: Loan doc task is already complete
          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: "This endpoint allows a variety of actions to be taken on a <<glossary:loan
        doc task>>.\n\n> \U0001F4CC Available actions\n  **MARK_AS_COMPLETE** - Mark
        a loan doc task as complete"
      summary: Mark a loan doc task as complete
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/MarkAsCompleteLoanDocTask"
              discriminator:
                propertyName: action
                mapping:
                  MARK_AS_COMPLETE: "#/components/schemas/MarkAsCompleteLoanDocTask"
  "/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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreate 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: "\U0001F6A7 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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve all <<glossary:loan
        application>>s"
      summary: "\U0001F6A7 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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve 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).\n\n> \U0001F647 Heads up!\nSupplying
        the `Accept` header as `application/xml` will return the loan application
        in ILAD format (MISMO 3.4)."
      summary: "\U0001F6A7 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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdate 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).\n\n> \U0001F4CC Replacing indexed key
        series\nUse `lists_to_update` to replace indexed key series.\nKeys are the
        value prefix (e.g. `global_asset_type` for keys like `global_asset_type_1`,
        `global_asset_type_2`).\nAll existing keys matching `{prefix}_{number}` are
        removed and replaced with the provided values.\nEach prefix is processed independently.
        Pass an empty hash to remove all keys for that prefix."
      summary: "\U0001F6A7 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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDelete a <<glossary:loan
        application>>"
      summary: "\U0001F6A7 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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint allows
        a variety of actions to be taken on a <<glossary:loan application>>.\n\n>
        \U0001F4CC Available actions\n**DEACTIVATE** - Deactivate a loan application\n**ACTIVATE**
        - Activate a loan application\n**SHARE_APP** - send share app email to loan
        borrower\n**SUBMIT** - Submits a loan application\n**REJECT** - Rejects a
        loan application\n**REASSIGN_LO** - assign new <<glossary:loan officer>> to
        a loan application\n**CONVERT_TO_LOAN** - Convert a loan application to a
        loan"
      summary: "\U0001F6A7 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"
  "/loan_applications/nested/{loan_application_id}/assets":
    get:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/AssetPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all assets
        in a <<glossary:loan application>>."
      summary: "\U0001F6A7 Retrieve all assets (BETA)"
    post:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-create
      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 asset items
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/AssetCollection"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Category 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"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nAppends one or more asset
        records to a <<glossary:loan application>>.\nEach record is a flat set of
        the form-defined asset fields (e.g.\n`type`, `value`, `owner`) plus any FI-custom
        fields the company's form\ndeclares. The batch is atomic — an invalid record
        writes nothing.\n\n> \U0001F6A7 Interim identifier scheme\n`_id` is an opaque
        string, stable only for the lifetime of the loan\napplication's current field
        ordering. A persisted, stable identifier is\nplanned as future work."
      summary: "\U0001F6A7 Creates one or more asset records (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AssetCollectionCreateBody"
    patch:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-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 asset records
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates multiple asset
        records."
      summary: "\U0001F6A7 Update multiple asset records. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AssetCollectionUpdateBody"
  "/loan_applications/nested/{loan_application_id}/assets/{record_id}":
    get:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Asset record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Asset"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Asset record 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"
        '400':
          "$ref": "#/components/responses/BadRequestError"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        asset record by ID."
      summary: "\U0001F6A7 Retrieve a specific asset record by ID. (BETA)"
    patch:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-update_item
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Asset record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated asset record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a specific asset
        record by ID."
      summary: "\U0001F6A7 Update a specific asset record. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AssetUpdateBody"
    delete:
      tags:
      - Loan Application (Nested) Assets
      operationId: loan_application_(nested)_assets-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Asset record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted asset record
          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':
          description: Invalid request body
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '404':
          "$ref": "#/components/responses/NotFoundError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDeletes a specific asset
        record by ID."
      summary: "\U0001F6A7 Delete a specific asset record. (BETA)"
  "/loan_applications/nested/{loan_application_id}/expenses":
    get:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ExpensePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all expenses
        in a <<glossary:loan application>>."
      summary: "\U0001F6A7 Retrieve all expenses (BETA)"
    post:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-create
      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 expense items
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ExpenseCollection"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreates new expense records."
      summary: "\U0001F6A7 Creates one or more expense records (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExpenseCollectionCreateBody"
    patch:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-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 expense records
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates multiple expense
        records."
      summary: "\U0001F6A7 Update multiple expense records. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExpenseCollectionUpdateBody"
  "/loan_applications/nested/{loan_application_id}/expenses/{record_id}":
    get:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Expense record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Expense"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        expense record by ID."
      summary: "\U0001F6A7 Retrieve a specific expense record by ID. (BETA)"
    patch:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-update_item
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Expense record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated expense record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a specific expense
        record by ID."
      summary: "\U0001F6A7 Update a specific expense record. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExpenseUpdateBody"
    delete:
      tags:
      - Loan Application (Nested) Expenses
      operationId: loan_application_(nested)_expenses-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Expense record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted expense record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDeletes a specific expense
        record by ID."
      summary: "\U0001F6A7 Delete a specific expense record. (BETA)"
  "/loan_applications/nested/{loan_application_id}/borrower_incomes":
    get:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/IncomePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all of the
        borrower's income records in a <<glossary:loan application>>."
      summary: "\U0001F6A7 Retrieve all of the borrower's income records (BETA)"
    post:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-create
      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 income items
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/IncomeCollection"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreates new income records
        for the borrower."
      summary: "\U0001F6A7 Creates one or more income records for the borrower. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeCollectionCreateBody"
    patch:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-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 income records
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates multiple income
        records for the borrower."
      summary: "\U0001F6A7 Update multiple income records for the borrower. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeCollectionUpdateBody"
  "/loan_applications/nested/{loan_application_id}/borrower_incomes/{record_id}":
    get:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Income"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        income record by ID."
      summary: "\U0001F6A7 Retrieve a specific income record by ID. (BETA)"
    patch:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-update_item
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated income record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a specific income
        record by ID."
      summary: "\U0001F6A7 Update a specific income record. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeUpdateBody"
    delete:
      tags:
      - Loan Application (Nested) Borrower Incomes
      operationId: loan_application_(nested)_borrower_incomes-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted income record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDeletes a specific income
        record by ID."
      summary: "\U0001F6A7 Delete a specific income record. (BETA)"
  "/loan_applications/nested/{loan_application_id}/coborrower_incomes":
    get:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/IncomePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all of the
        co-borrower's income records in a <<glossary:loan application>>."
      summary: "\U0001F6A7 Retrieve all of the co-borrower's income records (BETA)"
    post:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-create
      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 income items
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/IncomeCollection"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreates new income records
        for the co-borrower."
      summary: "\U0001F6A7 Creates one or more income records for the co-borrower.
        (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeCollectionCreateBody"
    patch:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-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 income records
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates multiple income
        records for the co-borrower."
      summary: "\U0001F6A7 Update multiple income records for the co-borrower. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeCollectionUpdateBody"
  "/loan_applications/nested/{loan_application_id}/coborrower_incomes/{record_id}":
    get:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Income"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        income record by ID."
      summary: "\U0001F6A7 Retrieve a specific income record by ID. (BETA)"
    patch:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-update_item
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated income record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a specific income
        record by ID."
      summary: "\U0001F6A7 Update a specific income record. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/IncomeUpdateBody"
    delete:
      tags:
      - Loan Application (Nested) Co-borrower Incomes
      operationId: loan_application_(nested)_co-borrower_incomes-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Income record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted income record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDeletes a specific income
        record by ID."
      summary: "\U0001F6A7 Delete a specific income record. (BETA)"
  "/loan_applications/nested/{loan_application_id}/liabilities":
    get:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-index
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/LiabilityPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all liabilities
        in a <<glossary:loan application>>."
      summary: "\U0001F6A7 Retrieve all liabilities (BETA)"
    post:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-create
      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 liability items
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/LiabilityCollection"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreates new liability
        records."
      summary: "\U0001F6A7 Creates one or more liability records (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LiabilityCollectionCreateBody"
    patch:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-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 liability records
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates multiple liability
        records."
      summary: "\U0001F6A7 Update multiple liability records. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LiabilityCollectionUpdateBody"
  "/loan_applications/nested/{loan_application_id}/liabilities/{record_id}":
    get:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-show
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Liability record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Liability"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        liability record by ID."
      summary: "\U0001F6A7 Retrieve a specific liability record by ID. (BETA)"
    patch:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-update_item
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Liability record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated liability record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a specific liability
        record by ID."
      summary: "\U0001F6A7 Update a specific liability record. (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LiabilityUpdateBody"
    delete:
      tags:
      - Loan Application (Nested) Liabilities
      operationId: loan_application_(nested)_liabilities-destroy
      parameters:
      - name: loan_application_id
        description: Loan application ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: record_id
        description: Liability record ID.
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted liability record
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDeletes a specific liability
        record by ID."
      summary: "\U0001F6A7 Delete a specific liability record. (BETA)"
  "/loan_applications/nested/{loan_application_id}":
    get:
      tags:
      - Loan Application (Nested)
      operationId: loan_application_(nested)-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/LoanApplicationNested"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a specific
        loan application by ID."
      summary: "\U0001F6A7 Retrieve a specific loan application by ID. (BETA)"
  "/loans/{loan_id}/borrower_task_reminders":
    post:
      tags:
      - Borrower Task Reminders
      operationId: borrower_task_reminders-create
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Reminder sent
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/NoContent"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '412':
          description: Unable to send reminder
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will send
        a reminder to a borrower about their incomplete tasks on a loan."
      summary: "\U0001F6A7 Send a borrower task reminder (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/BorrowerTaskReminderPostBody"
  "/loans/{loan_id}/borrowers":
    post:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-create
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created loan borrower
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        a <<glossary:loan borrower>> record."
      summary: "\U0001F6A7 Create a loan borrower record (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanBorrowerPostBody"
    get:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-index
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: pair_index
        description: Pair index by which to filter borrowers on the loan.
        required: false
        in: query
        schema:
          type: integer
      - "$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/BorrowerPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a list of borrowers
        on a loan. <<glossary:Loan borrower>>s are separate from <<glossary:borrower
        account>>s.\nA loan borrower may or may not have an account in nCino Mortgage.\nThe
        corresponding user borrower account will be listed in the _links object, if
        available."
      summary: "\U0001F6A7 Retrieve all loan borrowers (BETA)"
  "/loans/{loan_id}/borrowers/{borrower_id}":
    get:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-show
      parameters:
      - name: borrower_id
        description: Borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan 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/Borrower.Detail"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retrieve
        a single <<glossary:loan borrower>>."
      summary: "\U0001F6A7 Retrieve a loan borrower (BETA)"
    patch:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-update
      parameters:
      - name: borrower_id
        description: Borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated loan borrower
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will update
        any data provided via body params on the <<glossary:loan borrower>>. Only
        the body params listed maybe be used."
      summary: "\U0001F6A7 Update a loan borrower (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanBorrowerPatchBody"
    delete:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-destroy
      parameters:
      - name: borrower_id
        description: Borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted loan borrower
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will delete
        a <<glossary:loan borrower>>."
      summary: "\U0001F6A7 Delete a loan borrower (BETA)"
  "/loans/{loan_id}/borrowers/{borrower_id}/actions":
    post:
      tags:
      - Loan Borrowers
      operationId: loan_borrowers-actions
      parameters:
      - name: borrower_id
        description: Borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created <<glossary:asynchronous job>> to process action
          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"
        '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: "This endpoint allows a variety of actions to be taken on a <<glossary:loan
        borrower>>\n\n> \U0001F4CC Available actions\n**ORDER_VERIFICATION** - order
        verification for the loan borrower (requires Verifications v2 feature be enabled)\n**DISCONNECT_BORROWER**
        - disconnect loan borrower payroll and bank data connections for verification
        purposes (requires Verifications v2 feature be enabled)\n**SEND_VERIFICATION_REMINDER**
        - send email reminder to loan borrower to complete the verification experience
        (requires Verifications v2 feature be enabled)\n**SET_PRIMARY_BORROWER** -
        set loan borrower as the primary borrower on the loan.\n**LINK_BORROWER**
        - link a borrower to a loan"
      summary: Perform action on a loan borrower
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/OrderVerification"
              - "$ref": "#/components/schemas/DisconnectBorrower"
              - "$ref": "#/components/schemas/SendVerificationReminder"
              - "$ref": "#/components/schemas/SetPrimaryBorrower"
              - "$ref": "#/components/schemas/LinkBorrower"
              discriminator:
                propertyName: action
                mapping:
                  ORDER_VERIFICATION: "#/components/schemas/OrderVerification"
                  DISCONNECT_BORROWER: "#/components/schemas/DisconnectBorrower"
                  SEND_VERIFICATION_REMINDER: "#/components/schemas/SendVerificationReminder"
                  SET_PRIMARY_BORROWER: "#/components/schemas/SetPrimaryBorrower"
                  LINK_BORROWER: "#/components/schemas/LinkBorrower"
  "/loans/borrowers/{borrower_id}/verifications":
    get:
      tags:
      - Loan Borrower Verifications
      operationId: loan_borrower_verifications-index
      parameters:
      - name: borrower_id
        description: Borrower ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: report_type
        description: Type of verification to filter to.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/VerificationReportType"
      - "$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/LoanBorrowerVerificationPagination"
          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: "This endpoint will retrieve all of a <<glossary:loan borrower>>'s
        <<glossary:verification>> records.\n\n> \U0001F647 Heads up!\nRequires Verifications
        v2 feature be enabled."
      summary: Retrieve all loan borrower verification records
  "/loans/{loan_id}/custom_form_requests":
    post:
      tags:
      - Custom Form Requests
      operationId: custom_form_requests-create
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created custom form request
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        a custom form request for a loan."
      summary: "\U0001F6A7 Create a custom form request (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/CustomFormRequestPostBody"
  "/loans/{loan_id}/doc_package_orders":
    get:
      tags:
      - Doc Package Orders
      operationId: doc_package_orders-index
      parameters:
      - name: doc_vendor
        description: Filter by document vendor.
        required: false
        in: query
        schema:
          type: string
      - name: doc_vendor_order_id
        description: Filter by vendor order ID.
        required: false
        in: query
        schema:
          type: string
      - name: loan_id
        description: Loan GUID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: order_group_id
        description: Filter by order group ID. Use to poll all orders created by a
          single create request.
        required: false
        in: query
        schema:
          type: string
      - "$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/DocPackageOrderPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retrieve
        all doc package orders for a <<glossary:loan>>."
      summary: "\U0001F6A7 List doc package orders for a loan (BETA)"
    post:
      tags:
      - Doc Package Orders
      operationId: doc_package_orders-create
      parameters:
      - name: loan_id
        description: Loan GUID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '202':
          description: Doc package orders accepted for processing
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/DocPackageOrderAccepted"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '409':
          description: Orders already in progress for this loan
          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':
          description: No eligible borrower pairs 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"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '404':
          "$ref": "#/components/responses/NotFoundError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        a <<glossary:doc package order>> for each borrower pair on a <<glossary:loan>>\nand
        process them asynchronously. Poll the index endpoint with the returned\n`order_group_id`
        to track status."
      summary: "\U0001F6A7 Create doc package orders for a loan (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DocPackageOrderPostBody"
    patch:
      tags:
      - Doc Package Orders
      operationId: doc_package_orders-update
      parameters:
      - name: loan_id
        description: Loan GUID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '202':
          description: Failed doc package orders accepted for retry
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/DocPackageOrderAccepted"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: No doc package orders found for the given order_group_id
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '409':
          description: No failed orders to reset, orders already processing, or lock
            contention
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retry
        all failed <<glossary:doc package order>> for a given order group on a\n<<glossary:loan>>.
        Optionally, a subset of doc package order IDs can be passed to retry only\nthose
        specific orders. Poll the index endpoint with the returned `order_group_id`\nto
        track status."
      summary: "\U0001F6A7 Retry failed doc package orders for a loan (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DocPackageOrderPatchBody"
  "/loans/{loan_id}/doc_package_orders/{doc_package_order_id}":
    get:
      tags:
      - Doc Package Orders
      operationId: doc_package_orders-show
      parameters:
      - name: doc_package_order_id
        description: Doc package order GUID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan GUID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/DocPackageOrder"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retrieve
        a single doc package order for a <<glossary:loan>>."
      summary: "\U0001F6A7 Retrieve a doc package order (BETA)"
  "/loans/{loan_id}/documents":
    get:
      tags:
      - Loan Documents
      operationId: loan_documents-index
      parameters:
      - name: doc_type
        description: Filter by document type.
        required: false
        in: query
        schema:
          type: string
      - name: loan_borrower_id
        description: Filter by loan borrower ID.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        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/LoanDocumentPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all documents
        with uploaded files on a <<glossary:loan>>."
      summary: "\U0001F6A7 List documents for a loan (BETA)"
  "/loans/{loan_id}/documents/{document_id}":
    get:
      tags:
      - Loan Documents
      operationId: loan_documents-show
      parameters:
      - name: document_id
        description: Document ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan 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/LoanDocument"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a single document's
        metadata on a <<glossary:loan>>."
      summary: "\U0001F6A7 Retrieve a document (BETA)"
  "/loans/{loan_id}/documents/{document_id}/download":
    get:
      tags:
      - Loan Documents
      operationId: loan_documents-download
      parameters:
      - name: document_id
        description: Document ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              "$ref": "#/components/headers/ContentDispositionResponseHeader"
            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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDownloads the binary
        content of a document on a <<glossary:loan>>."
      summary: "\U0001F6A7 Download a document (BETA)"
  "/loans/{loan_id}/inquiry_tasks":
    post:
      tags:
      - Inquiry Tasks
      operationId: inquiry_tasks-create
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created inquiry task
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        an inquiry task for a loan."
      summary: "\U0001F6A7 Create an inquiry task (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/InquiryTaskPostBody"
  "/loans/{loan_id}/loan_doc_tasks":
    post:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-create
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created loan doc task
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a loan doc task for a loan.
      summary: Create a loan doc task
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanDocTaskPostBody"
    get:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-index
      parameters:
      - name: doc_type
        description: Doc type by which to filter loan doc tasks.
        required: false
        in: query
        schema:
          type: string
      - name: loan_borrower_id
        description: Loan Borrower ID by which to filter loan doc tasks.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        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/LoanDocTaskPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a list of loan
        doc tasks on a loan."
      summary: "\U0001F6A7 Retrieve all loan doc tasks belonging to the loan (BETA)"
  "/loans/{loan_id}/loan_doc_tasks/{loan_doc_task_id}":
    get:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-show
      parameters:
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan 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/LoanDocTask"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will retrieve
        a single loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Retrieve a loan doc task (BETA)"
    delete:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-destroy
      parameters:
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted loan doc task
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will delete
        a loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Delete a loan doc task (BETA)"
    put:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-update
      parameters:
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated loan doc task
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will update
        a loan doc <<glossary:task>>."
      summary: "\U0001F6A7 Update a loan doc task (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanDocTaskUpdateBody"
  "/loans/{loan_id}/loan_doc_tasks/{loan_doc_task_id}/actions":
    post:
      tags:
      - Loan Doc Tasks
      operationId: loan_doc_tasks-actions
      parameters:
      - name: loan_doc_task_id
        description: Loan doc task ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '412':
          description: Loan doc task is already complete
          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: "This endpoint allows a variety of actions to be taken on a <<glossary:loan
        doc task>>.\n\n> \U0001F4CC Available actions\n  **MARK_AS_COMPLETE** - Mark
        a loan doc task as complete"
      summary: Mark a loan doc task as complete
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/MarkAsCompleteLoanDocTask"
              discriminator:
                propertyName: action
                mapping:
                  MARK_AS_COMPLETE: "#/components/schemas/MarkAsCompleteLoanDocTask"
  "/loans/{loan_id}/loan_milestones":
    get:
      tags:
      - Loan Milestones
      operationId: loan_milestones-index
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        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/LoanMilestonePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all milestones
        on a loan, ordered by step."
      summary: "\U0001F6A7 List loan milestones (BETA)"
  "/loans/{loan_id}/loan_milestones/{loan_milestone_id}":
    get:
      tags:
      - Loan Milestones
      operationId: loan_milestones-show
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_milestone_id
        description: Loan milestone 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/LoanMilestone"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves a single milestone
        on a loan."
      summary: "\U0001F6A7 Retrieve a loan milestone (BETA)"
    patch:
      tags:
      - Loan Milestones
      operationId: loan_milestones-update
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_milestone_id
        description: Loan milestone 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/LoanMilestone"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdates a single milestone's
        completion status and/or notes."
      summary: "\U0001F6A7 Update a loan milestone (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanMilestonePatchBody"
  "/loans/{loan_id}/loan_milestones/{loan_milestone_id}/actions":
    post:
      tags:
      - Loan Milestones
      operationId: loan_milestones-actions
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_milestone_id
        description: Loan milestone 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/LoanMilestone"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '412':
          description: Milestone cascade failed
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nPerforms an action on
        a loan milestone.\n\n> \U0001F4CC Available actions\n  **CASCADE_STATUS**
        - Cascade the completion status of this milestone.\n  When completed is true:
        marks this and all preceding milestones as complete, all subsequent as incomplete.\n
        \ When completed is false: marks this and all subsequent milestones as incomplete."
      summary: "\U0001F6A7 Perform action on a loan milestone (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/CascadeStatusLoanMilestone"
              discriminator:
                propertyName: action
                mapping:
                  CASCADE_STATUS: "#/components/schemas/CascadeStatusLoanMilestone"
  "/loans":
    post:
      tags:
      - Loans
      operationId: loans-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created 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"
        '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"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: This endpoint will create a <<glossary:loan>> record.
      summary: Create a loan
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanPostBody"
    get:
      tags:
      - Loans
      operationId: loans-index
      parameters:
      - name: borrower_name
        description: Filter loans by borrower name (prefix match against the borrower
          or co-borrower first or last name).
        required: false
        in: query
        schema:
          type: string
      - name: closing_date_end
        description: Filter to loans with a closing date on or before this date (inclusive).
        required: false
        in: query
        schema:
          type: string
          format: date
      - name: closing_date_start
        description: Filter to loans with a closing date on or after this date (inclusive).
        required: false
        in: query
        schema:
          type: string
          format: date
      - name: in_los
        description: Filter loans by whether they are synced to the LOS.
        required: false
        in: query
        schema:
          type: boolean
      - name: is_active
        description: Filter loans by active status (default true).
        required: false
        in: query
        schema:
          type: boolean
      - name: loan_number
        description: Filter loans by exact loan number.
        required: false
        in: query
        schema:
          type: string
      - name: loan_officer_id
        description: "<<glossary:Loan officer>> ID by which to filter loans."
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_purpose
        description: Loan purpose search parameter by which to filter loans.
        required: false
        in: query
        schema:
          type: string
      - name: loan_type
        description: Loan type search parameter by which to filter loans.
        required: false
        in: query
        schema:
          type: string
      - name: order
        description: 'Sort by creation date: "asc" (oldest first, default) or "desc"
          (newest first).'
        required: false
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: org_id
        description: Organization (company, region, or branch) ID by which to filter
          loans.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: user_borrower_id
        description: User borrower ID by which to filter loans.
        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/LoanPagination"
          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: This endpoint will retrieve all <<glossary:loan>> records.
      summary: Retrieve all loans
  "/loans/{loan_id}":
    get:
      tags:
      - Loans
      operationId: loans-show
      parameters:
      - name: loan_id
        description: Loan 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/Loan.Detail"
          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: This endpoint will retrieve a <<glossary:loan>> record.
      summary: Retrieve a loan
    patch:
      tags:
      - Loans
      operationId: loans-update
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated loan
          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: This endpoint will update a <<glossary:loan>> record.
      summary: Update a loan
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanPatchBody"
    delete:
      tags:
      - Loans
      operationId: loans-destroy
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created <<glossary:asynchronous job>> to delete the 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"
        '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: This endpoint will delete a <<glossary:loan>> record.
      summary: Delete a loan
  "/loans/{loan_id}/actions":
    post:
      tags:
      - Loans
      operationId: loans-actions
      parameters:
      - name: loan_id
        description: Loan ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: "This endpoint will perform an action on a <<glossary:loan>> record.\n\n>
        \U0001F6A7 Under construction\n> **Certain actions on this endpoint are in
        beta.** Functionality or availability are subject to change and will be communicated.\n\n>
        \U0001F4CC Available actions\n**DEACTIVATE** - deactivate a loan (sets is_active
        to false)\n**ACTIVATE** - activate a loan (sets is_active to true)\n**REORDER_BORROWERS**
        - reorder a loan's borrowers\n**REASSIGN_LO** - reassign a loan's loan officer\n\U0001F6A7
        **ASSIGN_TEAM_MEMBER** - assign a team member to a loan\n\U0001F6A7 **UNASSIGN_TEAM_MEMBER**
        - unassign a team member from a loan"
      summary: Perform action on a loan
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/DeactivateLoan"
              - "$ref": "#/components/schemas/ActivateLoan"
              - "$ref": "#/components/schemas/ReorderBorrowers"
              - "$ref": "#/components/schemas/ReassignLo"
              - "$ref": "#/components/schemas/AssignTeamMember"
              - "$ref": "#/components/schemas/UnassignTeamMember"
              discriminator:
                propertyName: action
                mapping:
                  DEACTIVATE: "#/components/schemas/DeactivateLoan"
                  ACTIVATE: "#/components/schemas/ActivateLoan"
                  REORDER_BORROWERS: "#/components/schemas/ReorderBorrowers"
                  REASSIGN_LO: "#/components/schemas/ReassignLo"
                  ASSIGN_TEAM_MEMBER: "#/components/schemas/AssignTeamMember"
                  UNASSIGN_TEAM_MEMBER: "#/components/schemas/UnassignTeamMember"
  "/loans/{loan_id}/ron_eligibility":
    get:
      tags:
      - Loans
      operationId: loans-check_ron_eligibility
      parameters:
      - name: loan_id
        description: Loan 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/RonEligibility"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Loan 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"
        '400':
          "$ref": "#/components/responses/BadRequestError"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint checks
        whether a <<glossary:loan>> is eligible for Remote Online Notarization\n(RON),
        based on the loan's saved property address and the servicer's RON configuration."
      summary: "\U0001F6A7 Check RON eligibility for a loan (BETA)"
  "/permissions":
    get:
      tags:
      - Permissions
      operationId: permissions-index
      parameters:
      - name: group_key
        description: Filter <<glossary:permission>>s by category (group key).
        required: false
        in: query
        schema:
          type: string
      - name: name
        description: Filter <<glossary:permission>>s by name.
        required: false
        in: query
        schema:
          type: string
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/PermissionPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve all permissions
        that can be granted to a role, optionally filtered by name or category."
      summary: "\U0001F6A7 Retrieve all permissions (BETA)"
  "/permissions/templates/{template_key}":
    get:
      tags:
      - Permissions
      operationId: permissions-show
      parameters:
      - name: template_key
        description: The identifier for the default role template.
        required: true
        in: path
        schema:
          type: string
          enum:
          - branch_admin
          - company_admin
          - loan_officer
          - region_admin
          - support_admin
          - team_member
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/PermissionTemplate"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve the permissions
        included in a given default role template."
      summary: "\U0001F6A7 Retrieve the permissions included in a given default role
        template (BETA)"
  "/roles/{role_id}/permissions":
    get:
      tags:
      - Role Permissions
      operationId: role_permissions-index
      parameters:
      - name: role_id
        description: "<<glossary:role>> 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/RolePermissionsResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '400':
          "$ref": "#/components/responses/BadRequestError"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve a role's permissions\n\nLists
        the permission keys currently enabled on the role.\n\nTODO: Remove the line
        below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Retrieve a role's permissions (BETA)"
    post:
      tags:
      - Role Permissions
      operationId: role_permissions-create
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Updated permission keys
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RolePermissionsResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Unrecognized permission key
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nAssign permissions to
        a role\n\nAdds the supplied permission keys to the role. Idempotent: keys
        already\nenabled on the role are left unchanged.\n\nTODO: Remove the line
        below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Assign permissions to a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RolePermissionsBody"
    put:
      tags:
      - Role Permissions
      operationId: role_permissions-update
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Updated permission keys
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RolePermissionsResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Unrecognized permission key
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nReplace a role's permissions\n\nReplaces
        the role's permission set with exactly the supplied keys.\n\nTODO: Remove
        the line below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Replace a role's permissions (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RolePermissionsBody"
    delete:
      tags:
      - Role Permissions
      operationId: role_permissions-destroy
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Updated permission keys
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RolePermissionsResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Unrecognized permission key
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRemove permissions from
        a role\n\nRemoves the supplied permission keys from the role. Idempotent:
        keys\nthat are not currently enabled are ignored.\n\nTODO: Remove the line
        below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Remove permissions from a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RolePermissionsBody"
  "/roles":
    post:
      tags:
      - Roles
      operationId: roles-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created role
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Role.Detail"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '409':
          description: Role with this name already exists for this company
          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: Role limit reached
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nCreate a role record"
      summary: "\U0001F6A7 Create a role record (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RolePostBody"
    get:
      tags:
      - Roles
      operationId: roles-index
      parameters:
      - name: name
        description: Filter <<glossary:role>>s by name.
        required: false
        in: query
        schema:
          type: string
      - "$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/RolePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve all roles"
      summary: "\U0001F6A7 Retrieve all roles (BETA)"
  "/roles/{role_id}":
    get:
      tags:
      - Roles
      operationId: roles-show
      parameters:
      - name: role_id
        description: "<<glossary:role>> 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/Role.Detail"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve a role, including
        its enabled permissions"
      summary: "\U0001F6A7 Retrieve a role, including its enabled permissions (BETA)"
    patch:
      tags:
      - Roles
      operationId: roles-update
      parameters:
      - name: role_id
        description: "<<glossary:role>> 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/Role"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nUpdate a role\n\nUpdates
        a <<glossary:role>> record."
      summary: "\U0001F6A7 Update a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RolePatchBody"
    delete:
      tags:
      - Roles
      operationId: roles-destroy
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID"
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted role
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nDelete a role"
      summary: "\U0001F6A7 Delete a role (BETA)"
  "/roles/{role_id}/actions":
    post:
      tags:
      - Roles
      operationId: roles-actions
      parameters:
      - name: role_id
        description: Role ID
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will perform
        an action on a <<glossary:role>> record.\n\n> \U0001F4CC Available actions\n**DUPLICATE**
        - Duplicate a <<glossary:role>>"
      summary: "\U0001F6A7 Perform action on a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/DuplicateRoleAction"
              discriminator:
                propertyName: action
                mapping:
                  DUPLICATE: "#/components/schemas/DuplicateRoleAction"
  "/roles/{role_id}/users":
    get:
      tags:
      - Role Users
      operationId: role_users-index
      parameters:
      - name: email
        description: Filter by user's email (case-insensitive substring match).
        required: false
        in: query
        schema:
          type: string
      - name: name
        description: Filter by user's first or last name (case-insensitive substring
          match).
        required: false
        in: query
        schema:
          type: string
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RoleUserPagination"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '400':
          "$ref": "#/components/responses/BadRequestError"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve all users assigned
        to a role\n\nTODO: Remove the line below when endpoint is ready to go live
        for customers"
      summary: "\U0001F6A7 Retrieve all users assigned to a role (BETA)"
    post:
      tags:
      - Role Users
      operationId: role_users-create
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Updated user assignments
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RoleUserAssignmentResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '412':
          description: Role assignment limit exceeded for one or more users
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nAssign users to a role\n\nTODO:
        Remove the line below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Assign users to a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RoleUserPostBody"
    delete:
      tags:
      - Role Users
      operationId: role_users-destroy
      parameters:
      - name: role_id
        description: "<<glossary:role>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Updated user assignments
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/RoleUserAssignmentResult"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '404':
          description: Role 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"
        '400':
          "$ref": "#/components/responses/BadRequestError"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRemove users from a role\n\nTODO:
        Remove the line below when endpoint is ready to go live for customers"
      summary: "\U0001F6A7 Remove users from a role (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RoleUserDeleteBody"
  "/regions/{region_id}/branches":
    post:
      tags:
      - Region Branches
      operationId: region_branches-create
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created branch
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a <<glossary:branch>> in the platform
        under a given <<glossary:region>>.
      summary: Create a new branch for given region
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/BranchPostBody"
    get:
      tags:
      - Region Branches
      operationId: region_branches-index
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter branches.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/BranchPagination"
          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: This endpoint will retrieve a list of <<glossary:branch>>es under
        a given <<glossary:region>>.
      summary: Retrieve a region's branches
  "/regions/{region_id}/branches/{branch_id}":
    get:
      tags:
      - Region Branches
      operationId: region_branches-show
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region 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/Branch"
          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: This endpoint will retrieve a specific <<glossary:branch>> under
        a given <<glossary:region>>.
      summary: Retrieve a specific branch
    patch:
      tags:
      - Region Branches
      operationId: region_branches-update
      parameters:
      - name: branch_id
        description: Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated branch
          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: This endpoint will update a <<glossary:branch>> under a given <<glossary:region>>.
      summary: Update a branch's information
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/BranchPatchBody"
    delete:
      tags:
      - Region Branches
      operationId: region_branches-destroy
      parameters:
      - name: branch_id
        description: glossary:Branch ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: glossary:Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created asynchronous job to delete branch.
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "This endpoint will update a <<glossary:branch>> under a given
        <<glossary:region>>.\n\n> \U0001F647 Heads up!\n**The branch is not deleted
        immediately, but deleted in an <<glossary:asynchronous job>>.**"
      summary: Delete a branch
  "/regions/{region_id}/images/{image_key}":
    put:
      tags:
      - Region Images
      operationId: region_images-update
      parameters:
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated region image
          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: "Uploads images to a <<glossary:region>>. Available images and
        their image_keys, along with the supported file types and sizes are in the
        table below.\n\n> \U0001F647 Heads up!\n**All image file uploads should be
        base64 encoded.**\n<table border=1px cellpadding=5px>\n\t<tr>\n\t\t<th>image_key</th>\n\t\t<th>Supported
        File Types</th>\n\t\t<th>Image Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>1000x313</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_icon</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>100x100</td>\n\t</tr>\n\t<tr>\n\t\t<td>app_homepage_logo</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>208x32</td>\n\t</tr>\n</table>"
      summary: Update a region's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Region Images
      operationId: region_images-destroy
      parameters:
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - logo
          - app_icon
          - app_homepage_logo
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted region image
          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: This endpoint will delete a <<glossary:region>>'s image.
      summary: Delete a region's image
  "/regions/{region_id}/links":
    get:
      tags:
      - Region Links
      operationId: region_links-index
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        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/LinkPagination"
          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: Retrieve a <<glossary:region>>'s <<glossary:link>>s.
      summary: Retrieve region links
    post:
      tags:
      - Region Links
      operationId: region_links-create
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created link
          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: URL already taken for a region link
          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: Create a <<glossary:region>> <<glossary:link>>.
      summary: Create a region link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkCreateBody"
  "/regions/{region_id}/links/{link_id}":
    patch:
      tags:
      - Region Links
      operationId: region_links-update
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated region link
          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: URL already taken for a region link
          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: Update a <<glossary:region>> <<glossary:link>>.
      summary: Update a region link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkUpdateBody"
    get:
      tags:
      - Region Links
      operationId: region_links-show
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region 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/Link"
          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: Retrieve a <<glossary:region>> <<glossary:link>>.
      summary: Retrieve a region link
    delete:
      tags:
      - Region Links
      operationId: region_links-destroy
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted region link
          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: Delete a <<glossary:region>> <<glossary:link>>.
      summary: Delete a region link
  "/regions/{region_id}/reports":
    post:
      tags:
      - Region Reports
      operationId: region_reports-generate
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: Generate a <<glossary:region>> report. The report will generate
        an <<glossary:asynchronous job>> which can be accessed when the job returned
        in the response has successfully completed.
      summary: Generate a region report
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              anyOf:
              - "$ref": "#/components/schemas/ReportPostBody"
              - "$ref": "#/components/schemas/TimeBoundReportPostBody"
              discriminator:
                propertyName: report_type
                mapping:
                  CO_BRANDED_APPS: "#/components/schemas/TimeBoundReportPostBody"
                  DOCUSIGN_ENVELOPES: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APP_DETAILS: "#/components/schemas/TimeBoundReportPostBody"
                  LOAN_APPS_COUNT: "#/components/schemas/TimeBoundReportPostBody"
                  LO_ACTIVITY: "#/components/schemas/TimeBoundReportPostBody"
                  NPS_FEEDBACK: "#/components/schemas/TimeBoundReportPostBody"
                  PACKAGE_TRACKER: "#/components/schemas/TimeBoundReportPostBody"
                  PROSPECTS: "#/components/schemas/TimeBoundReportPostBody"
                  QR_CODES: "#/components/schemas/ReportPostBody"
                  VERIFICATION_OF_ASSETS_ORDERS: "#/components/schemas/TimeBoundReportPostBody"
  "/regions/{region_id}/reports/{report_id}":
    get:
      tags:
      - Region Reports
      operationId: region_reports-download
      parameters:
      - name: region_id
        description: Scope response to region_id
        required: true
        in: path
        schema:
          type: string
      - name: report_id
        description: Scope response to report_id
        required: true
        in: path
        schema:
          type: string
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              "$ref": "#/components/headers/ContentDispositionResponseHeader"
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '410':
          description: Report has been archived
          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: Download a report for a given <<glossary:region>>.
      summary: Download a region's report
  "/regions/{region_id}/state_licenses":
    post:
      tags:
      - Region State Licenses
      operationId: region_state_licenses-create
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created license
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: Create a <<glossary:state license>> for the given <<glossary:region>>.
      summary: Create a region's state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseCreateBody"
    get:
      tags:
      - Region State Licenses
      operationId: region_state_licenses-index
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter state licenses.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicensePagination"
          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: Retrieve all <<glossary:state license>>s for the given <<glossary:region>>.
      summary: Retrieve all region state licenses
  "/regions/{region_id}/state_licenses/{state_license_id}":
    patch:
      tags:
      - Region State Licenses
      operationId: region_state_licenses-update
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated state license
          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: Update a <<glossary:state license>> for the given <<glossary:region>>.
      summary: Update a region state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseUpdateBody"
    get:
      tags:
      - Region State Licenses
      operationId: region_state_licenses-show
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license 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/StateLicense"
          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: Retrieve a <<glossary:state license>> for the given <<glossary:region>>.
      summary: Retrieve a region state license
    delete:
      tags:
      - Region State Licenses
      operationId: region_state_licenses-destroy
      parameters:
      - name: region_id
        description: Region ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted state license
          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: Delete a <<glossary:state license>> from the given <<glossary:region>>.
      summary: Delete a region state license
  "/services/verifications":
    get:
      tags:
      - Verifications
      operationId: verifications-index
      parameters:
      - name: loan_borrower_id
        description: Loan borrower id reports belong to.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_id
        description: Loan id reports belong to.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: report_type
        description: Verification report type by which to filter verification reports.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/VerificationReportType"
      - "$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/VerificationPagination"
          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: "This endpoint will retrieve all <<glossary:verification>> records
        for the provided loan or <<glossary:loan borrower>>.\n\n> \U0001F647 Heads
        up!\nRequires Verifications v2 feature be enabled."
      summary: Retrieve all verification records
  "/services/verifications/{verification_id}/report.{format}":
    get:
      tags:
      - Verifications
      operationId: verifications-download
      parameters:
      - name: format
        description: Format of the report to download.
        required: true
        in: path
        schema:
          type: string
          enum:
          - pdf
          - json
      - name: verification_id
        description: Verification ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          headers:
            Content-Disposition:
              "$ref": "#/components/headers/ContentDispositionResponseHeader"
            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: "This endpoint will download a <<glossary:verification>> report
        into either .pdf or .json format.\n\n> \U0001F647 Heads up!\nRequires Verifications
        v2 feature be enabled."
      summary: Download a verification report
  "/services/verifications/{verification_id}":
    get:
      tags:
      - Verifications
      operationId: verifications-show
      parameters:
      - name: verification_id
        description: Verification 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/Verification"
          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: "This endpoint will retrieve a <<glossary:verification>> record
        for the provided loan or <<glossary:loan borrower>>.\n\n> \U0001F647 Heads
        up!\nRequires Verifications v2 feature be enabled."
      summary: Retrieve a verification record
  "/services/verifications/{verification_id}/actions":
    post:
      tags:
      - Verifications
      operationId: verifications-actions
      parameters:
      - name: verification_id
        description: Verification ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created <<glossary:asynchronous job>> to process action
          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"
        '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: "This endpoint allows a variety of actions to be taken on a <<glossary:verification>>
        record.\n\n> \U0001F4CC Available actions\n**REFRESH_VERIFICATION** - refresh
        a verification record for the <<glossary:loan borrower>>\n\n> \U0001F647 Heads
        up!\nRequires Verifications v2 feature be enabled."
      summary: Perform action on a verification record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/RefreshVerification"
              discriminator:
                propertyName: action
                mapping:
                  REFRESH_VERIFICATION: "#/components/schemas/RefreshVerification"
  "/state_licenses":
    get:
      tags:
      - State Licenses
      operationId: state_licenses-index
      parameters:
      - name: owner_type
        description: Owner organization type (company, region, or branch) by which
          to filter <<glossary:state license>>s.
        required: false
        in: query
        schema:
          type: string
          enum:
          - company
          - region
          - branch
      - name: state
        description: State by which to filter <<glossary:state license>>s.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicensePagination"
          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: This endpoint will retrieve all <<glossary:state license>>s.
      summary: Retrieve all state licenses
  "/users/borrowers":
    post:
      tags:
      - Borrowers
      operationId: borrowers-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created borrower account
          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: Borrower account already exists for the given email
          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: "This endpoint will create a <<glossary:borrower account>> in the
        platform.\n\nThe borrower will use this information to register or log in
        to their account on the specified <<glossary:loan officer>>'s shared application.\n>
        \U0001F647 Heads up!\n**This record is not to be confused with a <<glossary:loan
        borrower>> record,** which is directly associated with and created through
        a loan or loan application."
      summary: Create a borrower account
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/UserBorrowerPostBody"
    get:
      tags:
      - Borrowers
      operationId: borrowers-index
      parameters:
      - name: email
        description: Email by which to filter borrower accounts.
        required: false
        in: query
        schema:
          type: string
      - name: has_custom_consent
        description: Consent status by which to filter borrower accounts.
        required: false
        in: query
        schema:
          type: boolean
      - name: is_active
        description: Status by which to filter borrower accounts.
        required: false
        in: query
        schema:
          type: boolean
      - name: loan_officer_id
        description: Loan officer's ID by which to filter borrower accounts.
        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/UserBorrowerPagination"
          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: |-
        This endpoint will retrieve all <<glossary:borrower account>>s for the company.

        To filter the scope of records returned, leverage one or more of the query params found below. `Email` is a common parameter by which to filter.

        By default, all borrower accounts are returned regardless of `is_active` status.
      summary: Retrieve all borrower accounts
  "/users/borrowers/{user_borrower_id}":
    get:
      tags:
      - Borrowers
      operationId: borrowers-show
      parameters:
      - name: user_borrower_id
        description: Borrower account 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/UserBorrower"
          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: This endpoint will retrieve a single <<glossary:borrower account>>.
      summary: Retrieve a borrower account
    patch:
      tags:
      - Borrowers
      operationId: borrowers-update
      parameters:
      - name: user_borrower_id
        description: Borrower account ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated borrower account
          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: Borrower account already exists for the given email
          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: "This endpoint will update any data provided via body params on
        the <<glossary:borrower account>>. Only the body params listed maybe be used.\n\nPassing
        an empty body will result in a successful request but no changes in data.\n>
        \U0001F647 Heads up!\n**Email addresses may NOT be reused across borrower
        accounts.** Every borrower account must have a unique email address."
      summary: Update a borrower account
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/UserBorrowerPatchBody"
    delete:
      tags:
      - Borrowers
      operationId: borrowers-destroy
      parameters:
      - name: user_borrower_id
        description: Borrower account ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted borrower account
          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: "This endpoint will delete a <<glossary:borrower account>>.\n\n>
        \U0001F647 Heads up!\n**This action will delete all loan applications attached
        to the borrower account and thus should be considered an irreversible action.**"
      summary: Delete a borrower account
  "/users/borrowers/{user_borrower_id}/actions":
    post:
      tags:
      - Borrowers
      operationId: borrowers-actions
      parameters:
      - name: user_borrower_id
        description: Borrower account ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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"
        '409':
          description: An association already exists for the borrower account
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '201':
          description: Created borrower account
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: "This endpoint allows a variety of actions to be taken on a <<glossary:borrower
        account>>.\n\n> \U0001F4CC Available actions\n**SEND_WELCOME_EMAIL** - Resend
        welcome email\n**REASSIGN_LO** - Reassign borrower account to a different
        loan officer. Applications for the indicated borrower account may be reassigned
        to the new <<glossary:loan officer>>.\nIf existing applications are not reassigned
        or loan records are associated with the borrower account then a new borrower
        account will be created.\n<<glossary:Partner>> information will be removed
        during the reassignment and will need to be reestablished through a borrower
        account update.\nTo update the association of a loan officer and borrower
        account on a loan record, update the loan officer on the loan record.\n**ASSIGN_PARTNER**
        - Assign partner to borrower account\n**REMOVE_PARTNER** - Unassign partner
        from borrower account\n\nThe `action` property must be one of the available
        actions above, provided in the JSON as screaming snake case."
      summary: Perform action on a borrower account
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/SendWelcomeEmailUserBorrower"
              - "$ref": "#/components/schemas/ReassignLoUserBorrower"
              - "$ref": "#/components/schemas/AssignPartnerUserBorrower"
              - "$ref": "#/components/schemas/RemovePartnerUserBorrower"
              discriminator:
                propertyName: action
                mapping:
                  SEND_WELCOME_EMAIL: "#/components/schemas/SendWelcomeEmailUserBorrower"
                  REASSIGN_LO: "#/components/schemas/ReassignLoUserBorrower"
                  ASSIGN_PARTNER: "#/components/schemas/AssignPartnerUserBorrower"
                  REMOVE_PARTNER: "#/components/schemas/RemovePartnerUserBorrower"
  "/users/loan_officers/{loan_officer_id}/aliases":
    post:
      tags:
      - Loan Officer Aliases
      operationId: loan_officer_aliases-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created alias
          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: Alias 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"
        '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: "This endpoint will create a new <<glossary:loan officer>> <<glossary:alias>>
        in nCino Mortgage.\n\n> \U0001F647 Heads up!\n**Alias cannot be used to log
        in to the nCino Mortgage platform.**"
      summary: Create a loan officer alias
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AliasCreateBody"
    get:
      tags:
      - Loan Officer Aliases
      operationId: loan_officer_aliases-index
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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/AliasPagination"
          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: This endpoint will retrieve <<glossary:loan officer>> <<glossary:alias>>es.
      summary: Retrieve loan officer aliases
  "/users/loan_officers/{loan_officer_id}/aliases/{alias_id}":
    get:
      tags:
      - Loan Officer Aliases
      operationId: loan_officer_aliases-show
      parameters:
      - name: alias_id
        description: Alias ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer 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/Alias"
          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: This endpoint will retrieve an <<glossary:alias>> for the given
        <<glossary:loan officer>>.
      summary: Retrieve a loan officer alias
    delete:
      tags:
      - Loan Officer Aliases
      operationId: loan_officer_aliases-destroy
      parameters:
      - name: alias_id
        description: Alias ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted alias
          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: This endpoint will delete an <<glossary:alias>> for the given <<glossary:loan
        officer>>.
      summary: Delete a loan officer alias
  "/users/loan_officers/{loan_officer_id}/app_shares":
    post:
      tags:
      - Loan Officer App Shares
      operationId: loan_officer_app_shares-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: App link shared
          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':
          description: Invalid request body
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '404':
          "$ref": "#/components/responses/NotFoundError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint shares
        a <<glossary:loan officer>>'s app link with a recipient by email and/or SMS.\nWhen
        a `partner_id` is supplied, the share is co-branded with the partner."
      summary: "\U0001F6A7 Share a loan officer's app link (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AppSharePostBody"
  "/users/loan_officers/{loan_officer_id}/assignments":
    post:
      tags:
      - Loan Officer Assignments
      operationId: loan_officer_assignments-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created loan officer assignment
          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: Assignment already exists or super resource already grants
            access
          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: This endpoint will create a <<glossary:loan officer>> <<glossary:assignment>>.
      summary: Create a loan officer assignment
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AccountAssignmentCreateBody"
    get:
      tags:
      - Loan Officer Assignments
      operationId: loan_officer_assignments-index
      parameters:
      - name: assignment_type
        description: Assignment type enum key by which to filter assignments (i.e.
          all <<glossary:branch>>es to which a loan officer may be assigned).
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/AccountAssignmentType"
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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/AccountAssignmentPagination"
          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: This endpoint will retrieve <<glossary:loan officer>> <<glossary:assignment>>s.
      summary: Retrieve loan officer assignments
  "/users/loan_officers/{loan_officer_id}/available_assignments/{assignment_type}":
    get:
      tags:
      - Loan Officer Assignments
      operationId: loan_officer_assignments-index_available
      parameters:
      - name: assignment_type
        description: Assignment type enum key by which to filter available assignments
          (i.e. all available <<glossary:branch>>es to which a loan officer may be
          assigned).
        required: true
        in: path
        schema:
          "$ref": "#/components/schemas/AccountAssignmentType"
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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: Available assignments
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/AvailableAssignmentPagination"
          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: "This endpoint will list available <<glossary:assignment>>s for
        a <<glossary:loan officer>>.\n\nAssigning a loan officer to another resource,
        provides them access to that resource's loans and the ability to interact
        with those loans.\n\n> \U0001F647 Heads up!\n**Assignments are restricted
        by the loan officer’s placement within the organization and possible setting
        configuration.**"
      summary: List available assignments for a loan officer
  "/users/loan_officers/{loan_officer_id}/assignments/{account_assignment_id}":
    get:
      tags:
      - Loan Officer Assignments
      operationId: loan_officer_assignments-show
      parameters:
      - name: account_assignment_id
        description: Assignment ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer 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/AccountAssignment"
          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: This endpoint will retrieve a <<glossary:loan officer>> <<glossary:assignment>>.
      summary: Retrieve a loan officer assignment
    delete:
      tags:
      - Loan Officer Assignments
      operationId: loan_officer_assignments-destroy
      parameters:
      - name: account_assignment_id
        description: Assignment ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: This endpoint will delete a <<glossary:loan officer>> <<glossary:assignment>>.
      summary: Delete a loan officer assignment
  "/users/loan_officers/{loan_officer_id}/images/{image_key}":
    put:
      tags:
      - Loan Officer Images
      operationId: loan_officer_images-update
      parameters:
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
          - header
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: "This endpoint will upload images for a <<glossary:loan officer>>.
        Supported images with their corresponding image_keys, file types and dimensions
        are listed in the table below.\n\n> \U0001F647 Heads up!\n**All image file
        uploads should be base64 encoded.**\n<table border=1px cellpadding=5px>\n\t<tr>\n\t\t<th>Image
        Key</th>\n\t\t<th>Supported File Types</th>\n\t\t<th>Image Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>profile</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>192x192</td>\n\t</tr>\n\t<tr>\n\t\t<td>header</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>640x200</td>\n\t</tr>\n</table>"
      summary: Update a loan officer's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Loan Officer Images
      operationId: loan_officer_images-destroy
      parameters:
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
          - header
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: This endpoint will delete a <<glossary:loan officer>>'s image.
      summary: Delete a loan officer's image
  "/users/loan_officers/{loan_officer_id}/links":
    post:
      tags:
      - Loan Officer Links
      operationId: loan_officer_links-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created link
          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: URL already taken for a loan officer link
          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: This endpoint will create a <<glossary:loan officer>> <<glossary:link>>.
      summary: Create a loan officer link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkCreateBody"
    get:
      tags:
      - Loan Officer Links
      operationId: loan_officer_links-index
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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/LinkPagination"
          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: This endpoint will retrieve <<glossary:loan officer>> <<glossary:link>>s.
      summary: Retrieve loan officer links
  "/users/loan_officers/{loan_officer_id}/links/{link_id}":
    patch:
      tags:
      - Loan Officer Links
      operationId: loan_officer_links-update
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Updated link
          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: URL already taken for a loan officer link
          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: This endpoint will update a <<glossary:loan officer>> <<glossary:link>>.
      summary: Update a loan officer link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkUpdateBody"
    get:
      tags:
      - Loan Officer Links
      operationId: loan_officer_links-show
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer 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/Link"
          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: This endpoint will retrieve a <<glossary:loan officer>> <<glossary:link>>.
      summary: Retrieve a loan officer link
    delete:
      tags:
      - Loan Officer Links
      operationId: loan_officer_links-destroy
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Deleted link
          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: This endpoint will delete a <<glossary:loan officer>> <<glossary:link>>.
      summary: Delete a loan officer link
  "/users/loan_officers/{loan_officer_id}/loan_doc_tasks":
    get:
      tags:
      - Loan Officer Loan Doc Tasks
      operationId: loan_officer_loan_doc_tasks-index
      parameters:
      - name: closing_date_end
        description: Only include tasks whose parent loan closes on or before this
          date.
        required: false
        in: query
        schema:
          type: string
          format: date
      - name: closing_date_start
        description: Only include tasks whose parent loan closes on or after this
          date.
        required: false
        in: query
        schema:
          type: string
          format: date
      - name: doc_type
        description: Doc type by which to filter loan doc tasks.
        required: false
        in: query
        schema:
          type: string
      - name: loan_borrower_id
        description: Loan Borrower ID by which to filter loan doc tasks.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: resolved
        description: Filter by completion status. `true` returns completed tasks,
          `false` returns unresolved tasks.
        required: false
        in: query
        schema:
          type: boolean
      - "$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/LoanOfficerLoanDocTaskPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieves all loan doc
        <<glossary:task>>s across loans the <<glossary:loan officer>> owns."
      summary: "\U0001F6A7 Retrieve all loan doc tasks across a loan officer's loans
        (BETA)"
  "/users/loan_officers/{loan_officer_id}/partners":
    post:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created partner
          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: Partner already exists for the given email
          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: This endpoint will create a <<glossary:partner>> for a <<glossary:loan
        officer>>.
      summary: Create a partner record for a loan officer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PartnerPostBody"
    get:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-index
      parameters:
      - name: accepted_invite
        description: Accepted invite status by which to filter partners.
        required: false
        in: query
        schema:
          type: boolean
      - name: email
        description: Email by which to filter partners.
        required: false
        in: query
        schema:
          type: string
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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/PartnerPagination"
          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: This endpoint will retrieve all <<glossary:partner>>s for a <<glossary:loan
        officer>>.
      summary: Retrieve all partners for a loan officer
  "/users/loan_officers/{loan_officer_id}/partners/{partner_id}":
    get:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-show
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner 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/Partner"
          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: This endpoint will retrieve a <<glossary:loan officer>>'s <<glossary:partner>>.
      summary: Retrieve a loan officer's partner
    patch:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-update
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated partner
          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: "This endpoint will updates a <<glossary:loan officer>>'s <<glossary:partner>>
        record. Only partners can update their email address.\n\n> \U0001F647 Heads
        up!\n**In order to update their email address, please have the partner log
        into the nCino Mortgage application and update their profile.**"
      summary: Update a loan officer's partner
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PartnerPatchBody"
    delete:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-destroy
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted loan officer's partner
          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: This endpoint will delete a <<glossary:loan officer>>'s <<glossary:partner>>.
      summary: Delete a loan officer's partner
  "/users/loan_officers/{loan_officer_id}/partners/{partner_id}/actions":
    post:
      tags:
      - Loan Officer Partners
      operationId: loan_officer_partners-actions
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '412':
          description: Action cannot be performed because the data 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: "This endpoint allows a variety of actions to be taken on a <<glossary:partner>>.\n\n>
        \U0001F4CC Available actions\n  **SEND_INVITE** - Send an invite to a partner\n
        \ **ENABLE** - Enable partner\n  **DISABLE** - Disable partner"
      summary: Perform action on a loan officer's partner
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/SendInvitePartner"
              - "$ref": "#/components/schemas/EnablePartner"
              - "$ref": "#/components/schemas/DisablePartner"
              discriminator:
                propertyName: action
                mapping:
                  SEND_INVITE: "#/components/schemas/SendInvitePartner"
                  ENABLE: "#/components/schemas/EnablePartner"
                  DISABLE: "#/components/schemas/DisablePartner"
  "/users/loan_officers/{loan_officer_id}/prospects":
    post:
      tags:
      - Loan Officer Prospects
      operationId: loan_officer_prospects-create
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created prospect
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ErrorSet"
          headers:
            X-Api-Version:
              "$ref": "#/components/headers/ApiVersionResponseHeader"
            X-Api-Supported-Versions:
              "$ref": "#/components/headers/ApiSupportedVersionsResponseHeader"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '403':
          "$ref": "#/components/responses/ForbiddenError"
        '404':
          "$ref": "#/components/responses/NotFoundError"
        '500':
          "$ref": "#/components/responses/InternalServerError"
      description: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nThis endpoint will create
        a prospect for a <<glossary:loan officer>>. At least one of email or cell_phone
        must be supplied."
      summary: "\U0001F6A7 Create a loan officer prospect (BETA)"
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProspectPostBody"
    get:
      tags:
      - Loan Officer Prospects
      operationId: loan_officer_prospects-index
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        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/ProspectPagination"
          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: This endpoint will retrieve all of a <<glossary:loan officer>>'s
        prospects.
      summary: Retrieve all of a loan officer's prospects
  "/users/loan_officers/{loan_officer_id}/prospects/{prospect_id}":
    get:
      tags:
      - Loan Officer Prospects
      operationId: loan_officer_prospects-show
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: prospect_id
        description: Prospect 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/Prospect"
          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: This endpoint will retrieve a <<glossary:loan officer>> prospect.
      summary: Retrieve a loan officer prospect
  "/users/loan_officers":
    post:
      tags:
      - Loan Officers
      operationId: loan_officers-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created loan officer
          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 officer already exists for the given email
          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: This endpoint will create a <<glossary:loan officer>> record.
      summary: Create a loan officer record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanOfficerPostBody"
    get:
      tags:
      - Loan Officers
      operationId: loan_officers-index
      parameters:
      - name: email
        description: Email by which to filter loan officers.
        required: false
        in: query
        schema:
          type: string
      - name: is_active
        description: Active status by which to filter loan officers.
        required: false
        in: query
        schema:
          type: boolean
      - name: is_admin
        description: Admin status by which to filter loan officers.
        required: false
        in: query
        schema:
          type: boolean
      - name: org_id
        description: Organization (<<glossary:company>>, <<glossary:region>>, or <<glossary:branch>>)
          ID by which to filter loan officers.
        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/LoanOfficerPagination"
          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: This endpoint will retrieve all <<glossary:loan officer>>s.
      summary: Retrieve all loan officers
  "/users/loan_officers/{loan_officer_id}":
    get:
      tags:
      - Loan Officers
      operationId: loan_officers-show
      parameters:
      - name: loan_officer_id
        description: Loan officer 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/LoanOfficer"
          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: This endpoint will retrieve a <<glossary:loan officer>>.
      summary: Retrieve a loan officer
    patch:
      tags:
      - Loan Officers
      operationId: loan_officers-update
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated loan officer
          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: Loan officer already exists for the given email
          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: This endpoint will update a <<glossary:loan officer>>.
      summary: Update a loan officer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoanOfficerPatchBody"
  "/users/loan_officers/{loan_officer_id}/actions":
    post:
      tags:
      - Loan Officers
      operationId: loan_officers-actions
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '201':
          description: Created <<glossary:asynchronous job>> to process action
          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: Action cannot be performed due to an ongoing asynchronous job
          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"
        '423':
          description: Action cannot be performed due to an ongoing loan officer operation
          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: "This endpoint allows a variety of actions to be taken on a <<glossary:loan
        officer>>.\n\n> \U0001F4CC Available actions\n  **PROMOTE** - Promote loan
        officer to organization admin\n  **DEMOTE** - Demote loan officer from organization
        admin\n  **ENABLE** - Activate loan officer\n  **DISABLE** - Deactivate loan
        officer\n  **SEND_WELCOME_EMAIL** - Send a welcome email to loan officer\n
        \ **CHANGE_ORG** - Move loan officer to a different organization"
      summary: Perform action on a loan officer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/PromoteLoanOfficer"
              - "$ref": "#/components/schemas/DemoteLoanOfficer"
              - "$ref": "#/components/schemas/EnableLoanOfficer"
              - "$ref": "#/components/schemas/DisableLoanOfficer"
              - "$ref": "#/components/schemas/SendWelcomeEmailLoanOfficer"
              - "$ref": "#/components/schemas/ChangeOrgLoanOfficer"
              discriminator:
                propertyName: action
                mapping:
                  PROMOTE: "#/components/schemas/PromoteLoanOfficer"
                  DEMOTE: "#/components/schemas/DemoteLoanOfficer"
                  ENABLE: "#/components/schemas/EnableLoanOfficer"
                  DISABLE: "#/components/schemas/DisableLoanOfficer"
                  SEND_WELCOME_EMAIL: "#/components/schemas/SendWelcomeEmailLoanOfficer"
                  CHANGE_ORG: "#/components/schemas/ChangeOrgLoanOfficer"
  "/users/loan_officers/{loan_officer_id}/state_licenses":
    post:
      tags:
      - Loan Officer State Licenses
      operationId: loan_officer_state_licenses-create
      parameters:
      - name: loan_officer_id
        description: "<<glossary:Loan officer>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Successfully created state license
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/ResourceCreated"
          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: This endpoint will create a <<glossary:loan officer>> <<glossary:state
        license>>.
      summary: Create a loan officer state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseCreateBody"
    get:
      tags:
      - Loan Officer State Licenses
      operationId: loan_officer_state_licenses-index
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state
        description: State by which to filter state licenses.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/StateCode"
      - "$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/StateLicensePagination"
          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: This endpoint will retrieve <<glossary:loan officer>> <<glossary:state
        license>>s.
      summary: Retrieve loan officer state licenses
  "/users/loan_officers/{loan_officer_id}/state_licenses/{state_license_id}":
    patch:
      tags:
      - Loan Officer State Licenses
      operationId: loan_officer_state_licenses-update
      parameters:
      - name: loan_officer_id
        description: "<<glossary:Loan officer>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: "<<glossary:State license>> ID."
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated state license
          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: This endpoint will update a <<glossary:loan officer>> <<glossary:state
        license>>.
      summary: Update a loan officer state license
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StateLicenseUpdateBody"
    get:
      tags:
      - Loan Officer State Licenses
      operationId: loan_officer_state_licenses-show
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license 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/StateLicense"
          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: This endpoint will retrieve a <<glossary:loan officer>> <<glossary:state
        license>>.
      summary: Retrieve a loan officer state license
    delete:
      tags:
      - Loan Officer State Licenses
      operationId: loan_officer_state_licenses-destroy
      parameters:
      - name: loan_officer_id
        description: Loan officer ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: state_license_id
        description: State license ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted state license
          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: This endpoint will delete a <<glossary:loan officer>> <<glossary:state
        license>>.
      summary: Delete a loan officer state license
  "/users/partners/{partner_id}/images/{image_key}":
    put:
      tags:
      - Partner Images
      operationId: partner_images-update
      parameters:
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
          - header
      - name: loan_officer_id
        description: Loan officer ID.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated partner image
          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: "Uploads a <<glossary:partner>> Image. Available image_keys, along
        with the supported file types and sizes are in the table below.\n<table border=1px
        cellpadding=5px>\n\t<tr>\n\t\t<th>Image Key</th>\n\t\t<th>Supported File Types</th>\n\t\t<th>Image
        Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>profile</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>192x192</td>\n\t</tr>\n\t<tr>\n\t\t<td>header</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>640x200</td>\n\t</tr>\n</table>"
      summary: Update a partner's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Partner Images
      operationId: partner_images-destroy
      parameters:
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
          - header
      - name: loan_officer_id
        description: Loan officer ID.
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted partner image
          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: This endpoint will delete a <<glossary:partner>>'s image.
      summary: Delete a partner's image
  "/users/partners/{partner_id}/links":
    post:
      tags:
      - Partner Links
      operationId: partner_links-create
      parameters:
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created link
          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: URL already taken for a partner link
          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: This endpoint will create a <<glossary:partner>> <<glossary:link>>.
      summary: Create a partner link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkCreateBody"
    get:
      tags:
      - Partner Links
      operationId: partner_links-index
      parameters:
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        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/LinkPagination"
          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: This endpoint will retrieve <<glossary:partner>> <<glossary:link>>s.
      summary: Retrieve partner links
  "/users/partners/{partner_id}/links/{link_id}":
    patch:
      tags:
      - Partner Links
      operationId: partner_links-update
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated partner link
          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: URL already taken for a partner link
          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: This endpoint will update a <<glossary:partner>> <<glossary:link>>.
      summary: Update a partner link
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LinkUpdateBody"
    delete:
      tags:
      - Partner Links
      operationId: partner_links-destroy
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted partner link
          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: This endpoint will delete a <<glossary:partner>> <<glossary:link>>.
      summary: Delete a partner link
    get:
      tags:
      - Partner Links
      operationId: partner_links-show
      parameters:
      - name: link_id
        description: Link ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: partner_id
        description: Partner 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/Link"
          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: This endpoint will retrieve a <<glossary:partner>>'s <<glossary:link>>s.
      summary: Retrieve a partner's link
  "/users/{user_id}/permissions":
    get:
      tags:
      - User Permissions
      operationId: user_permissions-index
      parameters:
      - name: user_id
        description: User ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/UserPermissionPagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nReturns the union of
        permissions across every role assigned to the user,\ndeduplicated and sorted,
        as an array of permission key strings."
      summary: "\U0001F6A7 Retrieve all permissions held by a user, resolved across
        all assigned roles. (BETA)"
  "/users/{user_id}/permissions/{permission_key}":
    get:
      tags:
      - User Permissions
      operationId: user_permissions-show
      parameters:
      - name: permission_key
        description: The permission key to check (e.g. "manage_users").
        required: true
        in: path
        schema:
          type: string
      - name: user_id
        description: User 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/UserPermissionGranted"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nReturns +{ \"granted\":
        true }+ if the permission is held by any of the\nuser's assigned roles; +{
        \"granted\": false }+ otherwise. Never 404s on\nthe permission key itself
        — only on a missing user."
      summary: "\U0001F6A7 Check whether a user has a specific permission. (BETA)"
  "/users/{user_id}/roles":
    get:
      tags:
      - User Roles
      operationId: user_roles-index
      parameters:
      - name: user_id
        description: User ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/Page"
      - "$ref": "#/components/parameters/PageSize"
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/UserRolePagination"
          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: "> \U0001F6A7 Under construction\n> **This endpoint is in beta.**
        Functionality may change without notice, support is limited, and use in production
        is not recommended. Your feedback is appreciated.\n\nRetrieve all roles assigned
        to a user"
      summary: "\U0001F6A7 Retrieve all roles assigned to a user (BETA)"
  "/users/team_members/{team_member_id}/assignments":
    post:
      tags:
      - Team Member Assignments
      operationId: team_member_assignments-create
      parameters:
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created team member assignment
          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: Assignment already exists or super resource already grants
            access
          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: This endpoint will create a <<glossary:team member>> assignment.
      summary: Create a team member assignment
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AccountAssignmentCreateBody"
    get:
      tags:
      - Team Member Assignments
      operationId: team_member_assignments-index
      parameters:
      - name: assignment_type
        description: Assignment type enum key by which to filter assignments (i.e.
          all branches to which a team member may be assigned).
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/AccountAssignmentType"
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        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/AccountAssignmentPagination"
          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: This endpoint will retrieve <<glossary:team member>> assignments.
      summary: Retrieve team member assignments
  "/users/team_members/{team_member_id}/available_assignments/{assignment_type}":
    get:
      tags:
      - Team Member Assignments
      operationId: team_member_assignments-index_available
      parameters:
      - name: assignment_type
        description: Assignment type enum key by which to filter available assignments
          (i.e. all available branches to which a team member may be assigned).
        required: true
        in: path
        schema:
          "$ref": "#/components/schemas/AccountAssignmentType"
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        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/AvailableAssignmentPagination"
          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: |-
        This endpoint will list available assignments for a <<glossary:team member>>. Assigning a team member to another resource provides them access to that resource's loans and the ability to interact with those <<glossary:loan>>s.
        Assignments are restricted by the team member's placement within the organization and possible setting configuration.
      summary: List available assignments for a team member
  "/users/team_members/{team_member_id}/assignments/{account_assignment_id}":
    get:
      tags:
      - Team Member Assignments
      operationId: team_member_assignments-show
      parameters:
      - name: account_assignment_id
        description: Assignment ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: team_member_id
        description: Team member 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/AccountAssignment"
          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: This endpoint will retrieve a <<glossary:team member>> assignment.
      summary: Retrieve a team member assignment
    delete:
      tags:
      - Team Member Assignments
      operationId: team_member_assignments-destroy
      parameters:
      - name: account_assignment_id
        description: Assignment ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted team member assignment
          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: This endpoint will delete a <<glossary:team member>> assignment.
      summary: Delete a team member assignment
  "/users/team_members/{team_member_id}/images/{image_key}":
    put:
      tags:
      - Team Member Images
      operationId: team_member_images-update
      parameters:
      - name: image_key
        description: Image to be updated.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated team member image
          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: "Uploads a <<glossary:team member>> Profile Image. Available image_keys,
        along with the supported file types and sizes are in the table below.\n\n>
        \U0001F647 Heads up!\n**All image file uploads should be base64 encoded.**\n<table
        border=1px cellpadding=5px>\n\t<tr>\n\t\t<th>Image Key</th>\n\t\t<th>Supported
        File Types</th>\n\t\t<th>Image Dimensions</th>\n\t</tr>\n\t<tr>\n\t\t<td>profile</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>192x192</td>\n\t</tr>\n\t<tr>\n\t\t<td>header</td>\n\t\t<td>\n\t\t\t<ul>\n\t\t\t\t<li>.jpeg</li>\n\t\t\t\t<li>.jpg</li>\n\t\t\t\t<li>.png</li>\n\t\t\t</ul>\n\t\t</td>\n\t\t<td>640x200</td>\n\t</tr>\n</table>"
      summary: Update a team member's image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImageUpdateBody"
    delete:
      tags:
      - Team Member Images
      operationId: team_member_images-destroy
      parameters:
      - name: image_key
        description: Image to be deleted.
        required: true
        in: path
        schema:
          type: string
          enum:
          - profile
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted team member image
          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: This endpoint will delete a <<glossary:team member>>'s image.
      summary: Delete a team member's image
  "/users/team_members":
    post:
      tags:
      - Team Members
      operationId: team_members-create
      parameters:
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '201':
          description: Created team member
          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: Team member already exists for the given email
          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: This endpoint will create a <<glossary:team member>> record.
      summary: Create a team member record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/TeamMemberPostBody"
    get:
      tags:
      - Team Members
      operationId: team_members-index
      parameters:
      - name: email
        description: Email by which to filter team members.
        required: false
        in: query
        schema:
          type: string
      - name: is_active
        description: Active status by which to filter team members.
        required: false
        in: query
        schema:
          type: boolean
      - name: role
        description: Role type enum key by which to filter team members.
        required: false
        in: query
        schema:
          "$ref": "#/components/schemas/TeamMemberRoleType"
      - "$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/TeamMemberPagination"
          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: This endpoint will retrieve all <<glossary:team member>>s.
      summary: Retrieve all team members
  "/users/team_members/{team_member_id}":
    get:
      tags:
      - Team Members
      operationId: team_members-show
      parameters:
      - name: team_member_id
        description: Team member 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/TeamMember"
          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: This endpoint will retrieve a <<glossary:team member>>.
      summary: Retrieve a team member
    patch:
      tags:
      - Team Members
      operationId: team_members-update
      parameters:
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully updated team member
          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: Team member already exists for the given email or los_username
          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: This endpoint will update a <<glossary:team member>>.
      summary: Update a team member
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/TeamMemberPatchBody"
    delete:
      tags:
      - Team Members
      operationId: team_members-destroy
      parameters:
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '204':
          description: Successfully deleted team member
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/NoContent"
          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: "This endpoint will delete a <<glossary:team member>>.\n> \U0001F647
        Heads up!\n**This action is irreversible.**"
      summary: Delete a team member
  "/users/team_members/{team_member_id}/actions":
    post:
      tags:
      - Team Members
      operationId: team_members-actions
      parameters:
      - name: team_member_id
        description: Team member ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - "$ref": "#/components/parameters/ApiVersionHeader"
      responses:
        '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"
        '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: "Performs action on a <<glossary:team member>> account.\n\n> \U0001F4CC
        Available actions\n  **ENABLE** - Activate team member\n  **DISABLE** - Deactivate
        team member\n  **SEND_WELCOME_EMAIL** - Send a welcome email to team member\n
        \ **CHANGE_ORG** - Change team member's organization"
      summary: Perform action on a team member account
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - "$ref": "#/components/schemas/EnableTeamMember"
              - "$ref": "#/components/schemas/DisableTeamMember"
              - "$ref": "#/components/schemas/SendWelcomeEmailTeamMember"
              - "$ref": "#/components/schemas/ChangeOrgTeamMember"
              discriminator:
                propertyName: action
                mapping:
                  ENABLE: "#/components/schemas/EnableTeamMember"
                  DISABLE: "#/components/schemas/DisableTeamMember"
                  SEND_WELCOME_EMAIL: "#/components/schemas/SendWelcomeEmailTeamMember"
                  CHANGE_ORG: "#/components/schemas/ChangeOrgTeamMember"
tags:
- name: Account Assignment Webhooks
  description: Webhook events pertaining to account assignment records
- name: Authentication
  description: Authentication endpoints using OAuth 2.0
- name: Authorization
  description: Authorization endpoints using OAuth 2.0
- name: Automated Underwriting Findings
  description: Endpoints for <<glossary:Automated Underwriting System>> (AUS) findings
    for a <<glossary:loan>>.
- name: Borrower Task Reminders
  description: Endpoints pertaining to borrower task reminders
- name: Borrowers
  description: Endpoints pertaining to <<glossary:borrower account>>s in the nCino
    Mortgage platform
- name: Branch Images
  description: Endpoints pertaining to <<glossary:branch>> images
- name: Branch Links
  description: Endpoints pertaining to <<glossary:branch>> links
- name: Branch Reports
  description: Endpoints pertaining to <<glossary:branch>> reports
- name: Branch State Licenses
  description: Endpoints pertaining to <<glossary:branch>> <<glossary:state license>>s
- name: Companies
  description: Endpoints pertaining to <<glossary:company>> records
- name: Company Images
  description: Endpoints pertaining to <<glossary:company>> images
- name: Company Links
  description: Endpoints pertaining to <<glossary:company>> <<glossary:link>>s
- name: Company Milestones
  description: Endpoints pertaining to company milestones
- name: Company Regions
  description: Endpoints pertaining to <<glossary:company>> regions
- name: Company Reports
  description: Endpoints pertaining to <<glossary:company>> reports
- name: Company State License Templates
  description: Endpoints pertaining to company state license templates
- name: Company State Licenses
  description: Endpoints pertaining to <<glossary:company>> state licenses
- name: Custom Form Requests
  description: Endpoints pertaining to custom form requests (e.g. econsent, credit
    auth)
- name: Developer Info
  description: Endpoints pertaining to developer info
- name: Doc Package Orders
  description: Endpoints pertaining to doc package orders
- name: Document Webhooks
  description: Webhook events pertaining to loan document changes
- name: Inquiry Tasks
  description: Endpoints pertaining to inquiry <<glossary:task>>s
- name: Job Webhooks
  description: Webhook events pertaining to jobs
- name: Jobs
  description: Endpoints pertaining to jobs
- name: Links
  description: Endpoints pertaining to links
- name: Loan App Borrower Task Reminders
  description: Endpoints pertaining to borrower task reminders
- name: Loan App Custom Form Requests
  description: Endpoints pertaining to custom form requests (e.g. econsent, credit
    auth)
- name: Loan App Doc Tasks
  description: Endpoints pertaining to loan doc <<glossary:task>>s
- name: Loan App Inquiry Tasks
  description: Endpoints pertaining to inquiry <<glossary:task>>s
- name: Loan Application (Nested)
  description: Endpoints pertaining to a loan application in nested format.
- name: Loan Application (Nested) Assets
  description: "Endpoints pertaining to a loan application's assets.\n\n> \U0001F6A7
    Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime
    of the loan\napplication's current field ordering. A persisted, stable identifier
    is\nplanned as future work."
- name: Loan Application (Nested) Borrower Incomes
  description: "Endpoints pertaining to a loan application's borrower's income sources.\n\n>
    \U0001F6A7 Interim identifier scheme\n`_id` is an opaque string, stable only for
    the lifetime of the loan\napplication's current field ordering. A persisted, stable
    identifier is\nplanned as future work."
- name: Loan Application (Nested) Co-borrower Incomes
  description: "Endpoints pertaining to a loan application's co-borrower's income
    sources.\n\n> \U0001F6A7 Interim identifier scheme\n`_id` is an opaque string,
    stable only for the lifetime of the loan\napplication's current field ordering.
    A persisted, stable identifier is\nplanned as future work."
- name: Loan Application (Nested) Expenses
  description: "Endpoints pertaining to a loan application's expenses.\n\n> \U0001F6A7
    Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime
    of the loan\napplication's current field ordering. A persisted, stable identifier
    is\nplanned as future work."
- name: Loan Application (Nested) Liabilities
  description: "Endpoints pertaining to a loan application's liabilities.\n\n> \U0001F6A7
    Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime
    of the loan\napplication's current field ordering. A persisted, stable identifier
    is\nplanned as future work."
- name: Loan Application Borrowers
  description: Endpoints pertaining to loan application borrowers
- name: Loan Application Webhooks
  description: Webhook events pertaining to loan applications
- name: Loan Applications
  description: Endpoints pertaining to loan applications
- name: Loan Borrower Verifications
  description: Endpoints pertaining to <<glossary:loan borrower>> <<glossary:verification>>s
- name: Loan Borrowers
  description: Endpoints pertaining to <<glossary:loan borrower>>s
- name: Loan Doc Tasks
  description: Endpoints pertaining to loan doc <<glossary:task>>s
- name: Loan Documents
  description: Endpoints for retrieving documents uploaded to a loan.
- name: Loan Milestone Webhooks
  description: Webhook events pertaining to loan milestone status changes
- name: Loan Milestones
  description: |-
    Endpoints pertaining to loan milestone instances on a specific loan.
    These represent the completion status of milestones, not milestone definitions.
- name: Loan Officer Aliases
  description: Endpoints pertaining to <<glossary:loan officer>> <<glossary:alias>>es
- name: Loan Officer App Shares
  description: Endpoints pertaining to sharing a <<glossary:loan officer>>'s app link
- name: Loan Officer Assignments
  description: Endpoints pertaining to <<glossary:loan officer>> <<glossary:assignment>>s
- name: Loan Officer Images
  description: Endpoints pertaining to <<glossary:loan officer>> images
- name: Loan Officer Links
  description: Endpoints pertaining to <<glossary:loan officer>> links
- name: Loan Officer Loan Doc Tasks
  description: Endpoints pertaining to loan doc <<glossary:task>>s aggregated at the
    <<glossary:loan officer>> level
- name: Loan Officer Partners
  description: Endpoints pertaining to a <<glossary:loan officer>>s' <<glossary:partner>>s
- name: Loan Officer Prospects
  description: Endpoints pertaining to <<glossary:loan officer>> prospects
- name: Loan Officer State Licenses
  description: Endpoints pertaining to <<glossary:loan officer>> <<glossary:state
    license>>s
- name: Loan Officer Webhooks
  description: Webhook events pertaining to <<glossary:loan officer>>s
- name: Loan Officers
  description: Endpoints pertaining to <<glossary:loan officer>>s
- name: Loan Webhooks
  description: Webhook events pertaining to loans
- name: Loans
  description: Endpoints for loans
- name: Milestone Webhooks
  description: Webhook events pertaining to milestone records
- name: Organization Webhooks
  description: Webhook events pertaining to organization records (i.e. companies,
    regions, and branches)
- name: Partner Images
  description: Endpoints pertaining to partners
- name: Partner Links
  description: Endpoints pertaining to partner links
- name: Permissions
  description: Endpoints pertaining to permissions
- name: Readme
  description: Endpoints pertaining to Readme
- name: Region Branches
  description: Endpoints pertaining to a region's <<glossary:branch>>es
- name: Region Images
  description: Endpoints pertaining to region images
- name: Region Links
  description: Endpoints pertaining to region links
- name: Region Reports
  description: Endpoints pertaining to region reports
- name: Region State Licenses
  description: Endpoints pertaining to region state licenses
- name: Role Permissions
  description: |-
    Endpoints for managing the <<glossary:permission>>s assigned to a
    <<glossary:role>>.

    Permissions are identified by their string *key* (e.g. `manage_roles`).
    Requests are scoped to the authenticated token's company: a role that
    does not exist, or is owned by another company, returns a 404.
- name: Role Users
  description: Endpoints for managing user assignments on a <<glossary:role>>.
- name: Roles
  description: Endpoints pertaining to <<glossary:role>>s
- name: State License Webhooks
  description: Webhook events pertaining to state license records
- name: State Licenses
  description: Endpoints pertaining to <<glossary:State license>>s
- name: Subscriptions
  description: Endpoints pertaining to webhook subscriptions
- name: Team Member Assignments
  description: Endpoints pertaining to team member assignments
- name: Team Member Images
  description: Endpoints pertaining to team member images
- name: Team Members
  description: Endpoints pertaining to team members
- name: User Permissions
  description: |-
    Endpoints for querying a user's effective permissions, resolved across
    all of their assigned roles.
- name: User Roles
  description: Endpoints for inspecting role assignments on a user.
- name: User Webhooks
  description: Webhook events pertaining to user records
- name: Verification Webhooks
  description: Webhook events pertaining to verification report records
- name: Verifications
  description: Endpoints pertaining to <<glossary:verification>>s
- name: Webhooks
  description: Endpoints pertaining to webhooks
components:
  parameters:
    Page:
      name: page
      description: The page to retrieve.
      required: false
      in: query
      schema:
        type: integer
    PageSize:
      name: page_size
      description: The number of records returned in each page.
      required: false
      in: query
      schema:
        type: integer
    CreatedAfter:
      name: created_after
      description: The date which a resource must be created after to be returned.
      required: false
      in: query
      schema:
        type: string
        format: date-time
    CreatedBefore:
      name: created_before
      description: The date which a resource must be created before to be returned.
      required: false
      in: query
      schema:
        type: string
        format: date-time
    UpdatedAfter:
      name: updated_after
      description: The date which a resource must be updated after to be returned.
      required: false
      in: query
      schema:
        type: string
        format: date-time
    UpdatedBefore:
      name: updated_before
      description: The date which a resource must be updated before to be returned.
      required: false
      in: query
      schema:
        type: string
        format: date-time
    ApiVersionHeader:
      name: X-Api-Version
      description: Specify API version, for example '1.0'. By default, the version
        configured in the company settings is used.
      required: false
      in: header
      schema:
        type: string
  responses:
    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"
    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"
    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"
    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"
    NotImplementedError:
      description: Not implemented 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"
    WebhookResponse:
      description: Return a 200 status to indicate that the data was received successfully
      content: {}
  headers:
    ContentDispositionResponseHeader:
      description: Additional information about response payload.
      schema:
        type: string
    ApiVersionResponseHeader:
      description: API version.
      schema:
        type: string
    ApiSupportedVersionsResponseHeader:
      description: API supported versions for endpoint.
      schema:
        type: string
    LocationResponseHeader:
      description: URL to redirect.
      schema:
        type: string
  schemas:
    OAuthAuthorizeBody:
      type: object
      properties:
        response_type:
          type: string
          enum:
          - code
          description: Response type.
        response_mode:
          type: string
          enum:
          - query
          - fragment
          - form_post
          description: 'Response mode (default: query).'
        client_id:
          type: string
          description: Client ID.
        redirect_uri:
          type: string
          description: Absolute redirect URI
        scope:
          type: string
          description: Scope of the access request
      required:
      - response_type
      - client_id
      additionalProperties: false
    OAuthAuthorize:
      type: object
      properties:
        status:
          type: string
          enum:
          - redirect
          - post
          description: Response status.
        redirect_uri:
          type: string
          description: Absolute redirect URI
        body:
          type: object
          properties:
            code:
              type: string
            state:
              type: string
      required:
      - status
      additionalProperties: false
    OAuthTokenBody:
      type: object
      properties:
        grant_type:
          type: string
          enum:
          - client_credentials
          - refresh_token
          - authorization_code
          description: Grant type.
        client_id:
          type: string
          description: Client ID.
        client_secret:
          type: string
          description: Client secret.
      required:
      - grant_type
      - client_id
      - client_secret
      description: Available properties for obtaining an access token
      additionalProperties: false
    OAuthTokenClientBody:
      allOf:
      - "$ref": "#/components/schemas/OAuthTokenBody"
      - type: object
        properties:
          scope:
            type: string
            description: Requested scope(s).
        additionalProperties: false
      description: Available properties for obtaining an access token
    OAuthTokenRefreshBody:
      allOf:
      - "$ref": "#/components/schemas/OAuthTokenBody"
      - type: object
        properties:
          refresh_token:
            type: string
            description: Refresh token.
          scope:
            type: string
            description: Requested scope(s).
        required:
        - refresh_token
        additionalProperties: false
      description: Available properties for refreshing an access token
    OAuthTokenCodeBody:
      allOf:
      - "$ref": "#/components/schemas/OAuthTokenBody"
      - type: object
        properties:
          code:
            type: string
            description: Authorization Code.
          redirect_uri:
            type: string
            description: Redirect URL.
        required:
        - code
        - redirect_uri
        additionalProperties: false
      description: Available properties for obtaining an access token
    OAuthActionBody:
      type: object
      properties:
        action:
          type: string
          enum:
          - REVOKE
          - INTROSPECT
          description: Action to perform.
        client_id:
          type: string
          description: Client ID.
        client_secret:
          type: string
          description: Client secret.
        token:
          type: string
          description: Access or refresh token.
        token_type_hint:
          type: string
          enum:
          - access_token
          - refresh_token
          description: Type of token.
      required:
      - client_id
      - client_secret
      - token
      description: Available properties for access token actions
      additionalProperties: false
    OAuthToken:
      type: object
      properties:
        access_token:
          type: string
          description: Access token issued.
        refresh_token:
          type: string
          description: Refresh token issued.
        token_type:
          type: string
          enum:
          - Bearer
          description: Type of token.
        expires_in:
          type: integer
          description: Duration of time the access token is granted for (seconds).
        scope:
          type: string
          description: Scopes granted.
        created_at:
          type: integer
          description: Timestamp when access token was issued.
      required:
      - access_token
      - token_type
      - expires_in
      - created_at
      description: OAuth 2.0 Access Token.
      example:
        access_token: MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3
        refresh_token: 3IjZmZGNjZTZ1EDN2MTO5QmZkJjN0QTM
        token_type: Bearer
        expires_in: 900
        scope: external
    OAuthTokenInfo:
      type: object
      properties:
        expires_in:
          type: integer
          description: Duration of time the access token is granted for (seconds).
        scope:
          type: array
          items:
            type: string
          description: Scopes granted.
        created_at:
          type: integer
          description: Timestamp when access token was issued.
        credential:
          type: object
          properties:
            client_id:
              type: string
          description: Organization credential associated with access token.
      required:
      - expires_in
      - created_at
      - credential
      description: OAuth 2.0 Access Token information.
      example:
        scope:
        - external
        expires_in: 900
        credential:
          client_id: MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3
        created_at: 171216788
    OAuthTokenIntrospect:
      type: object
      properties:
        active:
          type: boolean
          description: Indicates whether access token is active.
        scope:
          type: string
          description: Scopes granted.
        client_id:
          type: string
          description: Client ID of the organization credential associated with the
            access token.
        token_type:
          type: string
          description: Type of access token ("Bearer").
        exp:
          type: integer
          description: Access token expiration timestamp.
        iat:
          type: integer
          description: Access token issued at timestamp.
      required:
      - active
      description: OAuth 2.0 Access Token introspect information.
      example: |-
        { "active" : true, "scope": "external", "client_id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", "token_type":"Bearer", "exp":1712271294, "iat":1712270394 }
        { "active" : false }
    OAuthError:
      type: object
      properties:
        error:
          type: string
          enum:
          - invalid_request
          - invalid_client
          - invalid_grant
          - invalid_scope
          - unauthorized_client
          - unsupported_grant_type
          description: Error code.
        error_description:
          type: string
          description: Error description.
      required:
      - error
      description: OAuth 2.0 Error.
      example:
        error: invalid_client
        error_description: Client auth failed due to unknown client, no client auth
          included, or unsupported auth method.
    Error:
      type: object
      properties:
        id:
          type: string
          description: A unique ID (useful as a reference when debugging an error
            with support)
        status:
          type: integer
          description: The HTTP status code
        title:
          type: string
          description: A generic title
        detail:
          type: string
          description: A detailed message
        _links:
          type: object
          description: A list of relevant links
      required:
      - id
      - status
      - title
      example:
        id: 123abc
        status: 400
        title: Generic title for the error
        detail: Detailed message for the error
        _links:
          resource: contextual resource if applicable
    ErrorSet:
      type: object
      properties:
        errors:
          type: array
          items:
            "$ref": "#/components/schemas/Error"
      required:
      - errors
      example:
        errors:
        - id: 123abc
          status: 400
          title: Generic title for the error
          detail: Detailed message for the error
          _links:
            resource: contextual resource if applicable
    AbstractCollection:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          contents:
            type: array
            items:
              type: object
            description: The contents for the collection.
        required:
        - contents
        additionalProperties: false
    AbstractModel:
      type: object
      properties:
        _self:
          type: string
          description: The model's resource link to itself.
        _type:
          type: string
          description: The model's type.
        _links:
          type: object
          description: A list of links for the model's associations.
      required:
      - _self
      - _type
      additionalProperties: false
    AbstractPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractCollection"
      - type: object
        properties:
          total_pages:
            type: integer
            description: The total number of pages in the collection.
          total:
            type: integer
            description: The total number of items in the collection.
        additionalProperties: false
    AbstractResourceModel:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          id:
            type: string
            format: uuid
            description: Unique identifier for the record.
        required:
        - id
        additionalProperties: false
    NoContent:
      type: object
      properties: {}
      additionalProperties: false
    ResourceCollectionCreated:
      allOf:
      - "$ref": "#/components/schemas/AbstractCollection"
      - type: object
        properties:
          contents:
            type: array
            items:
              type: object
            description: Array of created resources.
        required:
        - contents
        additionalProperties: false
      description: |-
        Generic base class for returning multiple created resources with their full
        representations. Extend this class and specify the item type via cattr_reader,
        similar to AbstractPagination.
    ResourceCreated:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      description: Resource created model
    Webhook:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Webhook's name.
          url:
            type: string
            format: http_uri
            description: URL called when a webhook event has occurred.
          version:
            type: string
            description: API version to be used when webhook request is rendered.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Webhook's created at timestamp.
            nullable: true
        additionalProperties: false
      description: Webhook record
    WebhookPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Webhook"
        required:
        - contents
    WebhookPostBody:
      type: object
      properties:
        url:
          type: string
          format: http_uri
          description: Webhook's callback URL.
        name:
          type: string
          description: Webhook's name.
        version:
          type: string
          description: API version to be used when webhook request is rendered.
          nullable: true
      required:
      - url
      - name
      description: Available properties for creating a webhook.
      additionalProperties: false
    WebhookPatchBody:
      type: object
      properties:
        name:
          type: string
          description: Webhook's name.
        version:
          type: string
          description: API version to be used when webhook request is rendered.
          nullable: true
      description: Available properties for updating a webhook.
      additionalProperties: false
      minProperties: 1
    WebhookAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - ENABLE
          - DISABLE
          - TEST
          - CHANGE_URL
          description: Action to perform.
      required:
      - action
      description: Available properties for a webhook action. Validation requests
        are performed against the URL when enabling.
      additionalProperties: false
    ChangeUrlAction:
      allOf:
      - "$ref": "#/components/schemas/WebhookAction"
      - type: object
        properties:
          url:
            type: string
            format: http_uri
            description: Webhook's new callback URL.
        required:
        - url
        additionalProperties: false
      description: Available properties for the change webhook URL action. Validation
        requests are performed against the new URL if the webhook is enabled.
    WebhookSubscription:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          event:
            allOf:
            - "$ref": "#/components/schemas/WebhookEventName"
            description: Event that the webhook is subscribed to.
        required:
        - event
        additionalProperties: false
      description: Webhook subscription record
    WebhookSubscriptionPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/WebhookSubscription"
        required:
        - contents
    WebhookSubscriptionSaveBody:
      type: object
      properties:
        event:
          allOf:
          - "$ref": "#/components/schemas/WebhookEventName"
          description: Event being subscribed to.
      required:
      - event
      description: Available properties for creating or updating a webhook's subscription.
      additionalProperties: false
      minProperties: 1
    WebhookTestResponse:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          code:
            type: integer
            description: Webhook response's status code.
          body:
            type: string
            description: Webhook response's body.
        required:
        - code
        - body
        additionalProperties: false
      description: Webhook test response
    Address:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          street1:
            type: string
            description: Street line 1.
            nullable: true
          street2:
            type: string
            description: Street line 2.
            nullable: true
          city:
            type: string
            description: City.
            nullable: true
          state:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: State.
            nullable: true
          zip:
            type: string
            description: Zip code.
            nullable: true
        additionalProperties: false
      description: Address model
    InputAddress:
      type: object
      properties:
        street1:
          type: string
          minLength: 1
          maxLength: 255
          description: Street line 1
          nullable: true
        street2:
          type: string
          maxLength: 255
          description: Street line 2
          nullable: true
        city:
          type: string
          minLength: 1
          maxLength: 255
          description: City
          nullable: true
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: State
          nullable: true
        zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip code
          nullable: true
      additionalProperties: false
    AppSharePostBody:
      type: object
      properties:
        email:
          type: string
          format: email
          maxLength: 255
          description: Email address to send the app link to.
          nullable: true
        phone:
          type: string
          minLength: 1
          maxLength: 32
          description: Phone number to send the app link to. Formatting characters
            are stripped; must resolve to 10 digits.
          nullable: true
        destination_name:
          type: string
          minLength: 1
          maxLength: 255
          description: Recipient's name, used to personalize the email.
          nullable: true
        partner_id:
          type: string
          format: uuid
          description: Partner ID. When supplied, the share is co-branded with the
            partner.
          nullable: true
      description: Available properties for sharing a loan officer's app link. At
        least one of email or phone must be supplied.
      additionalProperties: false
    AusOrderBody:
      type: object
      properties:
        loan_application_id:
          type: string
          format: uuid
          description: "<<glossary:Loan Application>> GUID. If provided, runs AUS
            directly on this loan application without requiring a loan lookup."
        loan_guid:
          type: string
          format: uuid
          description: "<<glossary:Loan>> GUID."
        loan_number:
          type: string
          description: "<<glossary:Loan>> number."
        loan_id:
          type: integer
          description: "<<glossary:Loan>> integer ID."
        provider:
          type: string
          enum:
          - du
          - lpa
          description: Automated Underwriting provider. Defaults to "du".
      description: Request body for ordering an <<glossary:Automated Underwriting
        System>> run.
      additionalProperties: false
    AusFindingList:
      type: object
      properties:
        loan_id:
          type: integer
          description: "<<glossary:Loan>> ID."
        loan_number:
          type: string
          description: "<<glossary:Loan>> number."
        total_findings:
          type: integer
          description: Total number of findings.
        findings:
          type: array
          items:
            "$ref": "#/components/schemas/AusFinding"
          description: List of Automated Underwriting findings.
      description: "<<glossary:Automated Underwriting System>> findings list response."
      additionalProperties: false
    AusFinding:
      type: object
      properties:
        guid:
          type: string
          format: uuid
          description: Finding GUID.
        submitted_in:
          type: string
          description: Where the run was submitted (POS or LOS).
        provider:
          type: string
          description: Automated Underwriting provider (DU or LPA).
        status:
          type: string
          description: Finding status (not_run, running, complete, error).
        risk_assessment:
          type: string
          description: Risk assessment result.
          nullable: true
        recommendation:
          type: string
          description: Raw recommendation description.
          nullable: true
        submission_date:
          type: string
          format: date-time
          description: When the finding was submitted.
          nullable: true
        submission_number:
          type: integer
          description: Submission number.
          nullable: true
        submitted_by:
          type: string
          description: Name of user who submitted.
          nullable: true
        is_auto_run:
          type: boolean
          description: Whether this was an automatic run.
        is_dual_run:
          type: boolean
          description: Whether this was a dual run.
        ratios:
          type: object
          description: DTI and LTV ratios.
          nullable: true
        errors:
          type: array
          items:
            type: object
          description: Finding errors if any.
          nullable: true
      description: An individual <<glossary:Automated Underwriting System>> finding
        record.
      additionalProperties: false
    AusOrderResult:
      type: object
      properties:
        status:
          type: string
          description: Order status.
        finding_guid:
          type: string
          format: uuid
          description: GUID of the created finding record.
        provider:
          type: string
          description: Automated Underwriting provider used.
        loan_id:
          type: integer
          description: "<<glossary:Loan>> ID."
        loan_number:
          type: string
          description: "<<glossary:Loan>> number."
        message:
          type: string
          description: Human-readable status message.
      description: Result of ordering an <<glossary:Automated Underwriting System>>
        run.
      additionalProperties: false
    BorrowerTaskReminderPostBody:
      type: object
      properties:
        loan_borrower_id:
          type: string
          format: uuid
          description: ID of the loan borrower to remind.
        custom_message_text:
          type: string
          minLength: 1
          maxLength: 1000
          description: Custom message to include in the reminder.
          nullable: true
      required:
      - loan_borrower_id
      description: Available properties for sending a borrower task reminder.
      additionalProperties: false
    BorrowerAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - ORDER_VERIFICATION
          - DISCONNECT_BORROWER
          - SEND_VERIFICATION_REMINDER
          - SET_PRIMARY_BORROWER
          - LINK_BORROWER
          description: Action to perform.
      required:
      - action
      description: Available properties for a borrower action
      additionalProperties: false
    OrderVerification:
      allOf:
      - "$ref": "#/components/schemas/BorrowerAction"
      - type: object
        properties:
          order_type:
            allOf:
            - "$ref": "#/components/schemas/VerificationOrderType"
            description: Type of verification(s) to order for a borrower.
        required:
        - order_type
        additionalProperties: false
      description: Available properties for ordering a verification for a borrower
    DisconnectBorrower:
      allOf:
      - "$ref": "#/components/schemas/BorrowerAction"
      description: Available properties for disconnecting a borrower from verification
        vendors
    SendVerificationReminder:
      allOf:
      - "$ref": "#/components/schemas/BorrowerAction"
      description: Available properties for sending a reminder to a borrower to complete
        the verification experience.
    SetPrimaryBorrower:
      allOf:
      - "$ref": "#/components/schemas/BorrowerAction"
      description: Available properties for setting a borrower as the primary borrower.
    LinkBorrower:
      allOf:
      - "$ref": "#/components/schemas/BorrowerAction"
      - type: object
        properties:
          user_borrower_id:
            type: string
            format: uuid
            description: ID of the user borrower to link the loan borrower to
        required:
        - user_borrower_id
        additionalProperties: false
      description: Available properties for linking a borrower to a loan.
    Borrower:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          pair_index:
            type: integer
            description: Index (order) of the borrower pair that the borrower belongs
              to.
          email:
            type: string
            description: Borrower's email.
            nullable: true
          role:
            type: string
            description: Borrower's role type on the loan.
        additionalProperties: false
      description: Borrower model
    BorrowerPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Borrower.Preview"
        required:
        - contents
    Branch:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Branch's name.
          nmls:
            type: string
            description: Branch's NMLS ID.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the branch was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the branch was last updated.
            nullable: true
          logo_url:
            type: string
            description: Branch's logo URL.
            nullable: true
          app_icon_url:
            type: string
            description: Branch's app icon URL.
            nullable: true
          address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Branch's address.
          website_url:
            type: string
            format: http_uri
            description: Branch's website.
            nullable: true
          rss_feed_url:
            type: string
            format: http_uri
            description: Branch's RSS URL.
            nullable: true
          installation_base_url:
            type: string
            format: http_uri
            description: URL to install the branch's app.
            nullable: true
          privacy_policy_url:
            type: string
            format: http_uri
            description: Branch's privacy policy URL.
            nullable: true
          borrower_base_url:
            type: string
            format: http_uri
            description: Branch's borrower base URL.
            nullable: true
          terms_of_use_url:
            type: string
            format: http_uri
            description: Branch's terms of use URL.
            nullable: true
          custom_short_base_url:
            type: string
            format: http_uri
            description: Branch's custom URL.
            nullable: true
          consumer_access_url:
            type: string
            format: http_uri
            description: Branch's consumer access URL.
            nullable: true
        additionalProperties: false
      description: Branch model
    BranchPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Branch"
        required:
        - contents
    BranchPostBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Branch's name.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Branch's address.
        nmls:
          type: string
          minLength: 1
          maxLength: 255
          description: Branch's NMLS ID.
          nullable: true
      required:
      - name
      description: Available properties for creating a branch
      additionalProperties: false
    BranchPatchBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Branch's name.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Branch's address.
        nmls:
          type: string
          minLength: 1
          maxLength: 255
          description: Branch's NMLS ID.
          nullable: true
      description: Available properties for updating a branch
      additionalProperties: false
      minProperties: 1
    Company:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Company's name.
          nmls:
            type: string
            description: Company's NMLS id.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the company was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the company was last updated.
            nullable: true
          address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Company's address.
          logo_url:
            type: string
            description: Company's logo URL.
            nullable: true
          app_icon_url:
            type: string
            description: Company's app icon URL.
            nullable: true
          support_email:
            type: string
            description: Company's support email.
          tech_contact_email:
            type: string
            description: Company's tech contact email.
          internal_phone:
            type: string
            description: Company's internal phone.
          mobile_homepage_logo_url:
            type: string
            description: Company's mobile home logo URL.
            nullable: true
          apple_store_url:
            type: string
            format: http_uri
            description: Company's Apple Store URL.
            nullable: true
          google_play_store_url:
            type: string
            format: http_uri
            description: Company's Google Play store URL.
            nullable: true
        additionalProperties: false
      description: Company record
    CompanyPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Company"
        required:
        - contents
    CompanyCreateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Company's name.
      description: Available properties for creating a <<glossary:company>>.
      additionalProperties: false
    CompanyUpdateBody:
      type: object
      properties:
        street1:
          type: string
          minLength: 1
          description: Company's street1.
        street2:
          type: string
          description: Company's street2.
        city:
          type: string
          minLength: 1
          description: Company's city.
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: Company's state.
        zip:
          type: string
          minLength: 1
          description: Company's zip code.
        support_email:
          type: string
          format: email
          description: Company's support email.
        tech_contact_email:
          type: string
          format: email
          description: Company's tech support email.
        internal_phone:
          type: string
          format: phone
          description: Company's internal phone.
      description: Available properties for updating a <<glossary:company>>.
      additionalProperties: false
      minProperties: 1
    CompanyAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - reorder_milestones
          description: Action to perform.
      required:
      - action
      description: Available properties for a <<glossary:company>> action.
      additionalProperties: false
    ReorderMilestonesCompanyAction:
      allOf:
      - "$ref": "#/components/schemas/CompanyAction"
      - type: object
        properties:
          order:
            type: array
            items:
              type: string
              format: uuid
            minItems: 2
            description: Ordered list of milestone IDs. All company milestones must
              be provided.
        required:
        - order
        additionalProperties: false
      description: Available properties for reordering a <<glossary:company>>'s milestones.
        Reordering milestones will only apply to loans moving forward. Loan records
        that have already been established within nCino Mortgage will not be affected.
    CustomFormRequestPostBody:
      type: object
      properties:
        form_type:
          allOf:
          - "$ref": "#/components/schemas/CustomFormRequestTypes"
          description: Type of custom form request to create.
        loan_borrower_id:
          type: string
          format: uuid
          description: ID of the loan borrower to assign the request to.
      required:
      - form_type
      - loan_borrower_id
      description: Available properties for creating a custom form request.
      additionalProperties: false
    ImageUpdateBody:
      type: object
      properties:
        file:
          type: string
          format: byte
          description: Base64-encoded image data without metadata with a file type
            of [jpg, jpeg, png].
      required:
      - file
      description: Available properties for updating an image.
      additionalProperties: false
      minProperties: 1
    InquiryTaskPostBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Inquiry task's title.
        question:
          type: string
          minLength: 1
          maxLength: 1000
          description: Question presented to the borrower.
        checkbox_required:
          type: boolean
          description: Whether the borrower must check a confirmation checkbox to
            complete the task.
        checkbox_label:
          type: string
          minLength: 1
          maxLength: 255
          description: Label for the confirmation checkbox.
          nullable: true
        loan_borrower_id:
          type: string
          format: uuid
          description: ID of the loan borrower to assign the task to.
      required:
      - name
      - question
      - loan_borrower_id
      description: Available properties for creating an inquiry task.
      additionalProperties: false
    Job:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          job_type:
            allOf:
            - "$ref": "#/components/schemas/JobType"
            description: Job's type.
          job_description:
            type: string
            description: Job's description.
            nullable: true
          status:
            allOf:
            - "$ref": "#/components/schemas/JobStatus"
            description: Jobs's status.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the job was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the job was updated.
          started_at:
            type: string
            format: date-time
            description: Timestamp of when the job was started.
            nullable: true
          finished_at:
            type: string
            format: date-time
            description: Timestamp of when the job was finished.
            nullable: true
          message:
            type: string
            description: Message about the job.
            nullable: true
        additionalProperties: false
      description: Job record
    JobStatusChangedEventInfo:
      type: object
      properties:
        job_type:
          allOf:
          - "$ref": "#/components/schemas/JobType"
          description: Type of job that was changed.
        job_description:
          type: string
          description: Job's description.
          nullable: true
        from_status:
          allOf:
          - "$ref": "#/components/schemas/NullableJobStatus"
          description: Job's status prior to the change. If the job was just created,
            this will be nil.
        to_status:
          allOf:
          - "$ref": "#/components/schemas/JobStatus"
          description: Job's status after the change.
        changed_at:
          type: string
          format: date-time
          description: When the job's status changed.
      description: The event info particular to the job_status_changed event.
    Link:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          link_type:
            allOf:
            - "$ref": "#/components/schemas/LinkType"
            description: Link type enum key.
            nullable: true
          link_text:
            type: string
            description: Link's text.
            nullable: true
          url:
            type: string
            format: http_uri
            description: Link's URL.
          is_social:
            type: boolean
            description: Whether the link is social.
          is_private:
            type: boolean
            description: Whether the link is private.
          launch_browser:
            type: boolean
            description: Whether the link should launch a browser when clicked.
        required:
        - url
        additionalProperties: false
      description: Link record
    LinkPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Link"
        required:
        - contents
    LinkCreateBody:
      type: object
      properties:
        link_type:
          allOf:
          - "$ref": "#/components/schemas/LinkType"
          description: Link type enum key.
        link_text:
          type: string
          minLength: 1
          maxLength: 255
          description: Link's text.
        url:
          type: string
          format: http_uri
          maxLength: 700
          description: Link's URL.
        is_private:
          type: boolean
          description: Whether the link is private (default is false).
        launch_browser:
          type: boolean
          description: Whether the link should launch a browser when clicked (default
            is false).
      required:
      - link_type
      - link_text
      - url
      description: Available properties for creating a link
      additionalProperties: false
    LinkUpdateBody:
      type: object
      properties:
        link_type:
          allOf:
          - "$ref": "#/components/schemas/LinkType"
          description: Link type enum key.
        link_text:
          type: string
          minLength: 1
          maxLength: 255
          description: Link's text.
        url:
          type: string
          format: http_uri
          maxLength: 700
          description: Link's URL.
        is_private:
          type: boolean
          description: Whether the link is private (default is false).
        launch_browser:
          type: boolean
          description: Whether the link should launch a browser when clicked (default
            is false).
      description: Available properties for updating a link
      additionalProperties: false
      minProperties: 1
    LoanApplication:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          first_name:
            type: string
            description: Borrower's first name.
            nullable: true
          last_name:
            type: string
            description: Borrower's last name.
            nullable: true
          email:
            type: string
            description: Borrower's email.
            nullable: true
          loan_officer_name:
            type: string
            description: "<<glossary:Loan officer>>'s name."
            nullable: true
          loan_officer_email:
            type: string
            description: "<<glossary:Loan officer>>'s email."
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the loan application was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the loan application was last modified.
          is_active:
            type: boolean
            description: Whether the loan application is active.
          is_submitted:
            type: boolean
            description: Whether the loan application has been submitted.
          address:
            type: string
            description: Borrower's street.
            nullable: true
          borrower_external_customer_identifier:
            type: string
            maxLength: 255
            description: External customer identifier for the borrower, supplied by
              an enterprise integrator (e.g. FI Customer Number). No format validation
              is applied.
            nullable: true
          city:
            type: string
            description: Borrower's city.
            nullable: true
          coborrower_external_customer_identifier:
            type: string
            maxLength: 255
            description: External customer identifier for the coborrower, supplied
              by an enterprise integrator. No format validation is applied.
            nullable: true
          dob:
            type: string
            description: Borrower's date of birth.
            nullable: true
          marital_status:
            type: string
            description: Borrower’s marital status.
            nullable: true
          occupancy_type:
            type: string
            description: Occupancy type for the property.
            nullable: true
          property_city:
            type: string
            description: City where the property is located.
            nullable: true
          property_state:
            type: string
            description: State where the property is located.
            nullable: true
          property_street:
            type: string
            description: Street address of the property.
            nullable: true
          property_type:
            type: string
            description: Type of property.
            nullable: true
          property_unit_number:
            type: string
            description: Unit number of the property.
            nullable: true
          property_zip:
            type: string
            description: Zip code of the property.
            nullable: true
          purchase_price:
            type: integer
            description: Purchase price of the property
            nullable: true
          state:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state where borrower resides.
            nullable: true
          suffix:
            type: string
            description: Borrower’s name suffix.
            nullable: true
          unit_number:
            type: string
            description: Unit number of the property.
            nullable: true
          zip:
            type: string
            description: Borrower’s zip code.
            nullable: true
      description: Loan application model
    LoanApplicationPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanApplication.Preview"
        required:
        - contents
    LoanApplicationBody:
      type: object
      properties:
        first_name:
          type: string
          maxLength: 100
          description: Borrower's first name. Including first_name and last_name enables
            prospect creation and CRM sync.
          nullable: true
        last_name:
          type: string
          maxLength: 100
          description: Borrower's last name. Including first_name and last_name enables
            prospect creation and CRM sync.
          nullable: true
        additional_real_estate_owned:
          type: boolean
          description: Whether additional real estate is owned.
          nullable: true
        address:
          type: string
          maxLength: 255
          description: Borrower's street.
          nullable: true
        alimony_amount:
          type: integer
          description: Amount of alimony paid by the borrower.
          nullable: true
        asian_origin_other:
          type: string
          maxLength: 100
          description: Specifies other Asian origin if applicable.
          nullable: true
        assets1:
          type: integer
          description: Checking and savings account(s) amount.
          nullable: true
        assets2:
          type: integer
          description: Additional asset(s) amount.
          nullable: true
        assets_retirement:
          type: integer
          description: Borrower's retirement assets amount.
          nullable: true
        borrower_bankruptcy_types:
          type: array
          items:
            "$ref": "#/components/schemas/BankruptcyTypes"
          description: Types of bankruptcies declared by the borrower.
          nullable: true
        borrower_cell_phone:
          type: string
          format: phone
          description: Borrower's cell phone number.
          nullable: true
        borrower_citizenship_country:
          type: string
          maxLength: 100
          description: Borrower's country of citizenship.
          nullable: true
        borrower_citizenship_status:
          allOf:
          - "$ref": "#/components/schemas/CitizenshipTypes"
          description: Borrower's citizenship status.
          nullable: true
        borrower_contact_work_phone:
          type: string
          format: phone
          description: Borrower's work phone number.
          nullable: true
        borrower_conveyed_title_in_lieu_of_forclosure:
          type: boolean
          description: Whether the borrower has conveyed a title in lieu of foreclosure.
          nullable: true
        borrower_domestic_relationship_other:
          type: string
          maxLength: 100
          description: Specifies other domestic relationships for the borrower.
          nullable: true
        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.
          nullable: true
        borrower_domestic_relationship_type:
          allOf:
          - "$ref": "#/components/schemas/DomesticRelationshipTypes"
          description: Type of domestic relationship.
          nullable: true
        borrower_external_customer_identifier:
          type: string
          maxLength: 255
          description: External customer identifier for the borrower, persisted on
            the borrower's own AppUser record.
          nullable: true
        borrower_family_or_business_affiliation_with_seller:
          type: boolean
          description: Whether borrower has a family or business relationship with
            the seller.
          nullable: true
        borrower_home_phone:
          type: string
          format: phone
          description: Borrower's home phone number.
          nullable: true
        borrower_military_details:
          type: array
          items:
            "$ref": "#/components/schemas/MilitaryDetailTypes"
          description: Details about the borrower's military service (e.g. currently
            on active duty, surviving spouse).
          nullable: true
        borrower_military_service:
          type: boolean
          description: Whether the borrower has military service history.
          nullable: true
        borrower_military_service_expiration:
          type: string
          format: date
          description: Expiration date of borrower's military service if on active
            duty.
          nullable: true
        borrower_mobile_phone:
          type: string
          format: phone
          description: Borrower's mobile phone number.
          nullable: true
        borrower_non_spouse_property_rights:
          type: boolean
          description: Whether the borrower has property rights with a non-spouse.
          nullable: true
        borrower_other_obtained_or_borrowed_money_amount:
          type: integer
          description: Amount of money borrowed or obtained from another source.
          nullable: true
        borrower_other_property_lien:
          type: boolean
          description: Whether borrower has a lien on another property.
          nullable: true
        borrower_other_undisclosed_mortgage_closing_on_or_before:
          type: boolean
          description: Whether borrower has an undisclosed mortgage closing on or
            before a certain date.
          nullable: true
        borrower_other_undisclosed_new_credit:
          type: boolean
          description: Whether borrower has undisclosed new credit.
          nullable: true
        borrower_pre_forclosure_or_short_sale:
          type: boolean
          description: Whether borrower has undergone pre-foreclosure or a short sale.
          nullable: true
        borrower_second_employer_still_employed:
          type: boolean
          description: Whether borrower is still employed at their second employer.
          nullable: true
        borrower_share_info_authorization:
          type: boolean
          description: Authorization for borrower information sharing.
          nullable: true
        borrower_two_years_at_current_address:
          type: integer
          description: How long the borrower has lived at the current address.
          nullable: true
        borrower_voe_employment_is_self_employed_1:
          type: boolean
          description: Whether borrower is self-employed in VOE employment.
          nullable: true
        branch_of_service:
          allOf:
          - "$ref": "#/components/schemas/ServiceBranchTypes"
          description: Borrower's branch of military service.
          nullable: true
        charm_acknowledgments:
          type: boolean
          description: Whether CHARM acknowledgments are signed (e.g. have they received
            a booklet?).
          nullable: true
        city:
          type: string
          maxLength: 100
          description: Borrower's city.
          nullable: true
        co_borrower_verification_of_income_and_employment:
          type: boolean
          description: Whether coborrower’s income and employment verification is
            complete.
          nullable: true
        coborrower_address:
          type: string
          description: Coborrower's street.
          nullable: true
        coborrower_address_same_as_borrower:
          type: boolean
          description: Whether coborrower's address is the same as borrower's.
          nullable: true
        coborrower_asian_origin_other:
          allOf:
          - "$ref": "#/components/schemas/AsianOriginTypes"
          description: Specifies other Asian origin for coborrower.
          nullable: true
        coborrower_bankruptcy_types:
          type: array
          items:
            "$ref": "#/components/schemas/BankruptcyTypes"
          description: Types of bankruptcies declared by the coborrower.
          nullable: true
        coborrower_branch_of_service:
          allOf:
          - "$ref": "#/components/schemas/ServiceBranchTypes"
          description: Coborrower’s branch of military service.
          nullable: true
        coborrower_cell_phone:
          type: string
          format: phone
          description: Coborrower’s cell phone number.
          nullable: true
        coborrower_citizenship_country:
          type: string
          maxLength: 100
          description: Coborrower’s country of citizenship.
          nullable: true
        coborrower_citizenship_status:
          allOf:
          - "$ref": "#/components/schemas/CitizenshipTypes"
          description: Coborrower’s citizenship status.
          nullable: true
        coborrower_city:
          type: string
          maxLength: 100
          description: Coborrower’s city.
          nullable: true
        coborrower_contact_work_phone:
          type: string
          format: phone
          description: Coborrower’s work phone number.
          nullable: true
        coborrower_conveyed_title_in_lieu_of_forclosure:
          type: boolean
          description: Whether coborrower has conveyed title in lieu of foreclosure.
          nullable: true
        coborrower_credit_authorization:
          type: boolean
          description: Whether coborrower has authorized credit checks.
          nullable: true
        coborrower_dependents_age:
          type: string
          maxLength: 20
          description: Ages of coborrower’s dependents.
          nullable: true
        coborrower_dob:
          type: string
          maxLength: 10
          description: Coborrower’s date of birth (MM-DD-YYYY).
          nullable: true
        coborrower_domestic_relationship_other:
          type: string
          maxLength: 100
          description: Specifies other domestic relationships for coborrower.
          nullable: true
        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.
          nullable: true
        coborrower_domestic_relationship_type:
          allOf:
          - "$ref": "#/components/schemas/DomesticRelationshipTypes"
          description: Type of domestic relationship for coborrower (e.g. Civil Union,
            Domestic Partnership).
          nullable: true
        coborrower_econsent:
          type: boolean
          description: Whether coborrower has provided eConsent.
          nullable: true
        coborrower_email:
          type: string
          format: email
          maxLength: 255
          description: Coborrower’s email address.
          nullable: true
        coborrower_employer_name:
          type: string
          maxLength: 255
          description: Coborrower’s employer name.
          nullable: true
        coborrower_employer_years:
          type: integer
          description: Number of years coborrower has been with current employer.
          nullable: true
        coborrower_employment_status:
          allOf:
          - "$ref": "#/components/schemas/EmploymentStatusTypes"
          description: Coborrower’s employment status.
          nullable: true
        coborrower_ethnicity:
          allOf:
          - "$ref": "#/components/schemas/EthnicityTypes"
          description: Coborrower’s ethnicity.
          nullable: true
        coborrower_ethnicity_latino:
          allOf:
          - "$ref": "#/components/schemas/LatinEthnicityTypes"
          description: Coborrower's type of Hispanic or Latino origin.
          nullable: true
        coborrower_external_customer_identifier:
          type: string
          maxLength: 255
          description: External customer identifier for the coborrower, persisted
            on the coborrower's own AppUser record.
          nullable: true
        coborrower_family_or_business_affiliation_with_seller:
          type: boolean
          description: Whether coborrower has an affiliation with the seller.
          nullable: true
        coborrower_first_name:
          type: string
          maxLength: 100
          description: Coborrower’s first name.
          nullable: true
        coborrower_gender:
          allOf:
          - "$ref": "#/components/schemas/GenderTypes"
          description: Coborrower’s gender.
          nullable: true
        coborrower_has_alimony:
          type: boolean
          description: Whether coborrower pays alimony.
          nullable: true
        coborrower_has_bankruptcy:
          type: boolean
          description: Whether coborrower has declared bankruptcy.
          nullable: true
        coborrower_has_delinquent_debt:
          type: boolean
          description: Whether coborrower has delinquent debt.
          nullable: true
        coborrower_has_foreclosure:
          type: boolean
          description: Whether coborrower has had a foreclosure.
          nullable: true
        coborrower_has_obligations:
          type: boolean
          description: Whether coborrower has financial obligations.
          nullable: true
        coborrower_has_outstanding_judgements:
          type: boolean
          description: Whether coborrower has outstanding judgments.
          nullable: true
        coborrower_has_ownership_interest:
          type: boolean
          description: Whether coborrower has ownership interest in a property.
          nullable: true
        coborrower_is_comaker_or_endorser:
          type: boolean
          description: Whether coborrower is a co-maker or endorser on a loan.
          nullable: true
        coborrower_is_down_payment_borrowed:
          type: boolean
          description: Whether coborrower’s down payment is borrowed.
          nullable: true
        coborrower_is_firsttimer:
          type: boolean
          description: Whether coborrower is a first-time homebuyer.
          nullable: true
        coborrower_is_permanent_resident:
          type: boolean
          description: Whether coborrower is a permanent resident.
          nullable: true
        coborrower_is_primary_residence:
          type: boolean
          description: Whether the coborrower will occupy the property as a primary
            residence.
          nullable: true
        coborrower_is_self_employed:
          type: boolean
          description: Whether coborrower is self-employed.
          nullable: true
        coborrower_is_us_citizen:
          type: boolean
          description: Whether coborrower is a U.S. citizen.
          nullable: true
        coborrower_language_preference:
          allOf:
          - "$ref": "#/components/schemas/Languages"
          description: Coborrower’s preferred language.
          nullable: true
        coborrower_language_preference_other:
          type: string
          maxLength: 100
          description: Other language preference specified by coborrower.
          nullable: true
        coborrower_last_name:
          type: string
          maxLength: 100
          description: Coborrower’s last name.
          nullable: true
        coborrower_mailing_address:
          type: string
          maxLength: 255
          description: Coborrower’s mailing street.
          nullable: true
        coborrower_mailing_city:
          type: string
          maxLength: 100
          description: Coborrower’s mailing city.
          nullable: true
        coborrower_mailing_same_as_current:
          type: boolean
          description: Whether coborrower’s mailing address is the same as current.
          nullable: true
        coborrower_mailing_state:
          type: string
          maxLength: 100
          description: Coborrower’s mailing state.
          nullable: true
        coborrower_mailing_unit_number:
          type: string
          maxLength: 50
          description: Coborrower’s mailing unit number.
          nullable: true
        coborrower_mailing_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Coborrower’s mailing zip code.
          nullable: true
        coborrower_marital_status:
          allOf:
          - "$ref": "#/components/schemas/MartialStatuses"
          description: Coborrower’s marital status.
          nullable: true
        coborrower_middle_name:
          type: string
          maxLength: 100
          description: Coborrower’s middle name.
          nullable: true
        coborrower_military_details:
          type: array
          items:
            "$ref": "#/components/schemas/MilitaryDetailTypes"
          description: Details regarding coborrower’s military service.
          nullable: true
        coborrower_military_service:
          type: boolean
          description: Whether coborrower has military service history.
          nullable: true
        coborrower_military_service_expiration:
          type: string
          format: date
          description: Expiration date of coborrower’s military service if on active
            duty.
          nullable: true
        coborrower_monthly_income:
          type: integer
          description: Coborrower’s monthly income.
          nullable: true
        coborrower_non_spouse_property_rights:
          type: boolean
          description: Whether coborrower has property rights with a non-spouse.
          nullable: true
        coborrower_number_dependents:
          type: integer
          description: Number of dependents of the coborrower.
          nullable: true
        coborrower_other_hispanic_or_latino_origin:
          type: string
          maxLength: 100
          description: Specifies other Hispanic or Latino origin for coborrower.
          nullable: true
        coborrower_other_obtained_or_borrowed_money_amount:
          type: integer
          description: Amount of money borrowed or obtained from another source by
            coborrower.
          nullable: true
        coborrower_other_property_lien:
          type: boolean
          description: Whether coborrower has a lien on another property.
          nullable: true
        coborrower_other_undisclosed_mortgage_closing_on_or_before:
          type: boolean
          description: Whether coborrower has an undisclosed mortgage closing on or
            before a certain date.
          nullable: true
        coborrower_other_undisclosed_new_credit:
          type: boolean
          description: Whether coborrower has undisclosed new credit.
          nullable: true
        coborrower_pacific_islander:
          allOf:
          - "$ref": "#/components/schemas/PacificIslanderOriginTypes"
          description: Type of Pacific Islander coborrower identifies as.
          nullable: true
        coborrower_pacific_islander_other:
          type: string
          maxLength: 100
          description: Specifies other Pacific Islander origin for coborrower.
          nullable: true
        coborrower_party_to_lawsuit:
          type: boolean
          description: Whether coborrower is a party to a lawsuit.
          nullable: true
        coborrower_pre_forclosure_or_short_sale:
          type: boolean
          description: Whether coborrower has undergone pre-foreclosure or a short
            sale.
          nullable: true
        coborrower_previous_property_title_declaration:
          allOf:
          - "$ref": "#/components/schemas/TitleDeclarationTypes"
          description: Previous property title declaration for coborrower.
          nullable: true
        coborrower_previous_property_type_declaration:
          allOf:
          - "$ref": "#/components/schemas/PropertyDeclarationTypes"
          description: Previous property type declaration for coborrower.
          nullable: true
        coborrower_property_months:
          type: integer
          description: Number of months coborrower has owned the property.
          nullable: true
        coborrower_property_own:
          allOf:
          - "$ref": "#/components/schemas/OwnResidenceTypes"
          description: How the coborrower owns the property.
          nullable: true
        coborrower_property_years:
          type: integer
          description: Number of years coborrower has owned the property.
          nullable: true
        coborrower_race:
          allOf:
          - "$ref": "#/components/schemas/RaceTypes"
          description: Coborrower’s race.
          nullable: true
        coborrower_race_american_indian_other:
          type: string
          maxLength: 100
          description: Specifies other American Indian origin for coborrower.
          nullable: true
        coborrower_race_asian:
          allOf:
          - "$ref": "#/components/schemas/AsianOriginTypes"
          description: Type of Asian origin the coborrower identifies as.
          nullable: true
        coborrower_rent_payment:
          type: integer
          description: Monthly rent payment by coborrower.
          nullable: true
        coborrower_share_info_authorization:
          type: boolean
          description: Authorization for coborrower’s information sharing.
          nullable: true
        coborrower_ssn:
          type: string
          format: ssn
          description: Coborrower’s Social Security Number.
          nullable: true
        coborrower_state:
          type: string
          maxLength: 100
          description: Coborrower’s state of residence.
          nullable: true
        coborrower_suffix:
          allOf:
          - "$ref": "#/components/schemas/Suffixes"
          description: Coborrower’s name suffix.
          nullable: true
        coborrower_time_same_as_borrower:
          type: boolean
          description: Whether coborrower has the same time at the current address
            as borrower.
          nullable: true
        coborrower_two_years_at_current_address:
          type: integer
          description: How long the coborrower has lived at the current address.
          nullable: true
        coborrower_type_of_service:
          allOf:
          - "$ref": "#/components/schemas/MilitaryServiceTypes"
          description: Type of military service in which the coborrower is involved.
          nullable: true
        coborrower_unit_number:
          type: string
          maxLength: 50
          description: Coborrower’s unit number.
          nullable: true
        coborrower_voe_employment_is_self_employed_1:
          type: boolean
          description: Whether coborrower is self-employed in VOE employment.
          nullable: true
        coborrower_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Coborrower’s zip code.
          nullable: true
        credit_auth_method:
          allOf:
          - "$ref": "#/components/schemas/CreditAuthMethods"
          description: Method of credit authorization.
          nullable: true
        credit_authorization:
          type: boolean
          description: Authorization for credit check.
          nullable: true
        dependents_age:
          type: string
          maxLength: 20
          description: Ages of dependents.
          nullable: true
        desired_monthly_payment:
          type: integer
          description: Desired monthly payment.
          nullable: true
        dob:
          type: string
          maxLength: 10
          description: Borrower's date of birth (MM-DD-YYYY).
          nullable: true
        down_payment:
          type: integer
          description: Down payment amount.
          nullable: true
        down_payment_amount:
          type: integer
          description: Exact down payment amount.
          nullable: true
        down_payment_pct:
          type: integer
          description: Percentage of down payment.
          nullable: true
        down_payment_source:
          allOf:
          - "$ref": "#/components/schemas/DownPaymentSources"
          description: Source of down payment.
          nullable: true
        econsent:
          type: boolean
          description: Borrower’s electronic consent.
          nullable: true
        employer_address:
          type: string
          maxLength: 255
          description: Employer's street.
          nullable: true
        employer_city:
          type: string
          maxLength: 100
          description: Employer's city.
          nullable: true
        employer_name:
          type: string
          maxLength: 100
          description: Name of employer.
          nullable: true
        employer_state:
          type: string
          maxLength: 100
          description: Employer's state.
          nullable: true
        employer_years:
          type: integer
          description: Years employed at current employer.
          nullable: true
        employer_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Employer's zip code.
          nullable: true
        employment_status:
          allOf:
          - "$ref": "#/components/schemas/EmploymentStatusTypes"
          description: Borrower’s employment status.
          nullable: true
        estimated_property_value:
          type: integer
          description: Estimated value of the property.
          nullable: true
        ethnicity:
          allOf:
          - "$ref": "#/components/schemas/EthnicityTypes"
          description: Borrower’s ethnicity.
          nullable: true
        ethnicity_latino:
          allOf:
          - "$ref": "#/components/schemas/LatinEthnicityTypes"
          description: Borrower's type of Hispanic or Latino origin.
          nullable: true
        gender:
          allOf:
          - "$ref": "#/components/schemas/GenderTypes"
          description: Borrower’s gender.
          nullable: true
        has_alimony:
          type: boolean
          description: Whether borrower pays alimony.
          nullable: true
        has_bankruptcy:
          type: boolean
          description: Whether borrower has declared bankruptcy.
          nullable: true
        has_coborrower:
          type: boolean
          description: Whether application has a coborrower.
          nullable: true
        has_delinquent_debt:
          type: boolean
          description: Whether borrower has delinquent debt.
          nullable: true
        has_foreclosure:
          type: boolean
          description: Whether borrower has had a foreclosure.
          nullable: true
        has_obligations:
          type: boolean
          description: Whether borrower has other financial obligations.
          nullable: true
        has_outstanding_judgements:
          type: boolean
          description: Whether borrower has outstanding judgments.
          nullable: true
        has_ownership_interest:
          type: boolean
          description: Whether borrower has ownership interest in a property.
          nullable: true
        is_comaker_or_endorser:
          type: boolean
          description: Whether borrower is a co-maker or endorser.
          nullable: true
        is_down_payment_borrowed:
          type: boolean
          description: Whether down payment is borrowed.
          nullable: true
        is_firsttimer:
          type: boolean
          description: Whether borrower is a first-time homebuyer.
          nullable: true
        is_permanent_resident:
          type: boolean
          description: Whether borrower is a permanent resident.
          nullable: true
        is_primary_residence:
          type: boolean
          description: Whether the borrower will occupy the property as a primary
            residence.
          nullable: true
        is_self_employed:
          type: boolean
          description: Whether borrower is self-employed.
          nullable: true
        is_us_citizen:
          type: boolean
          description: Whether borrower is a U.S. citizen.
          nullable: true
        is_veteran:
          type: boolean
          description: Whether borrower has veteran status.
          nullable: true
        language_preference:
          allOf:
          - "$ref": "#/components/schemas/Languages"
          description: Borrower’s preferred language.
          nullable: true
        language_preference_other:
          type: string
          maxLength: 100
          description: Other language preference specified by borrower.
          nullable: true
        loan_amount:
          type: integer
          description: Loan amount requested.
          nullable: true
        loan_property_info__refinance_info:
          type: string
          maxLength: 100
          description: Loan and refinance information.
          nullable: true
        loan_purpose:
          allOf:
          - "$ref": "#/components/schemas/LoanPurposeTypes"
          description: Purpose of the loan.
          nullable: true
        mailing_address:
          type: string
          maxLength: 255
          description: Borrower’s mailing address.
          nullable: true
        mailing_city:
          type: string
          maxLength: 100
          description: Borrower’s mailing city.
          nullable: true
        mailing_same_as_current:
          type: boolean
          description: Whether mailing address is the same as current.
          nullable: true
        mailing_state:
          type: string
          maxLength: 100
          description: Borrower’s mailing state.
          nullable: true
        mailing_unit_number:
          type: string
          maxLength: 50
          description: Borrower’s mailing unit number.
          nullable: true
        mailing_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Borrower’s mailing zip code.
          nullable: true
        marital_status:
          allOf:
          - "$ref": "#/components/schemas/MartialStatuses"
          description: Borrower’s marital status.
          nullable: true
        middle_name:
          type: string
          maxLength: 100
          description: Borrower’s middle name.
          nullable: true
        monthly_income:
          type: integer
          description: Borrower’s monthly income.
          nullable: true
        monthly_liabilities:
          type: integer
          description: Borrower’s monthly liabilities.
          nullable: true
        number_dependents:
          type: integer
          description: Number of dependents of the borrower.
          nullable: true
        occupancy_type:
          allOf:
          - "$ref": "#/components/schemas/OccupancyTypes"
          description: Occupancy type for the property.
          nullable: true
        other_hispanic_or_latino_origin:
          type: string
          maxLength: 100
          description: Specifies other Hispanic or Latino origin.
          nullable: true
        owns_other_property:
          type: boolean
          description: Whether borrower owns another property.
          nullable: true
        pacific_islander:
          allOf:
          - "$ref": "#/components/schemas/PacificIslanderOriginTypes"
          description: Type of Pacific Islander a borrower identifies as.
          nullable: true
        pacific_islander_other:
          type: string
          maxLength: 100
          description: Specifies other Pacific Islander origin.
          nullable: true
        party_to_lawsuit:
          type: boolean
          description: Whether borrower is a party to a lawsuit.
          nullable: true
        previous_property_title_declaration:
          allOf:
          - "$ref": "#/components/schemas/TitleDeclarationTypes"
          description: Previous property title declaration.
          nullable: true
        previous_property_type_declaration:
          allOf:
          - "$ref": "#/components/schemas/PropertyDeclarationTypes"
          description: Previous property type declaration.
          nullable: true
        property_city:
          type: string
          maxLength: 100
          description: City where the property is located.
          nullable: true
        property_months:
          type: integer
          description: Number of months borrower has owned the property.
          nullable: true
        property_own:
          allOf:
          - "$ref": "#/components/schemas/OwnResidenceTypes"
          description: How the borrower owns the property.
          nullable: true
        property_state:
          type: string
          maxLength: 100
          description: State where the property is located.
          nullable: true
        property_street:
          type: string
          maxLength: 255
          description: Street address of the property.
          nullable: true
        property_type:
          allOf:
          - "$ref": "#/components/schemas/PropertyTypes"
          description: Type of property.
          nullable: true
        property_unit_number:
          type: string
          maxLength: 50
          description: Unit number of the property.
          nullable: true
        property_years:
          type: integer
          description: Number of years borrower has owned the property.
          nullable: true
        property_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip code of the property.
          nullable: true
        purchase_price:
          type: integer
          description: Purchase price of the property.
          nullable: true
        race:
          allOf:
          - "$ref": "#/components/schemas/RaceTypes"
          description: Borrower’s race.
          nullable: true
        race_american_indian_other:
          type: string
          maxLength: 100
          description: Specifies other American Indian origin.
          nullable: true
        race_asian:
          allOf:
          - "$ref": "#/components/schemas/AsianOriginTypes"
          description: Type of Asian origin the borrower identifies as.
          nullable: true
        referral_company_name:
          type: string
          maxLength: 255
          description: Name of the referral company.
          nullable: true
        referral_name:
          allOf:
          - "$ref": "#/components/schemas/ReferralTypes"
          description: Type of the referral person.
          nullable: true
        refinance_current_address:
          type: string
          maxLength: 255
          description: Current address for refinance.
          nullable: true
        refinance_purpose:
          allOf:
          - "$ref": "#/components/schemas/RefinancePurposeTypes"
          description: Purpose of refinancing.
          nullable: true
        rent_payment:
          type: integer
          description: Monthly rent payment.
          nullable: true
        rental_property_city:
          type: string
          maxLength: 100
          description: City of the rental property.
          nullable: true
        rental_property_state:
          type: string
          maxLength: 100
          description: State of the rental property.
          nullable: true
        rental_property_street:
          type: string
          maxLength: 255
          description: Street address of the rental property.
          nullable: true
        rental_property_unit_number:
          type: string
          maxLength: 50
          description: Unit number of the rental property.
          nullable: true
        rental_property_zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip code of the rental property.
          nullable: true
        school_years:
          type: integer
          description: Number of years borrower attended school.
          nullable: true
        servicer_credit_authorization:
          type: boolean
          description: Whether servicer credit authorization is provided.
          nullable: true
        ssn:
          type: string
          format: ssn
          description: Borrower’s Social Security Number.
          nullable: true
        state:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state where borrower resides.
          nullable: true
        suffix:
          allOf:
          - "$ref": "#/components/schemas/Suffixes"
          description: Borrower’s name suffix.
          nullable: true
        type_of_credit:
          allOf:
          - "$ref": "#/components/schemas/CreditTypes"
          description: Type of credit requested.
          nullable: true
        type_of_property:
          allOf:
          - "$ref": "#/components/schemas/PropertyIntendedUseTypes"
          description: Type of property being purchased or refinanced.
          nullable: true
        type_of_service:
          allOf:
          - "$ref": "#/components/schemas/MilitaryServiceTypes"
          description: Type of military service in which the borrower is involved.
          nullable: true
        under_contract:
          type: boolean
          description: Whether property is under contract.
          nullable: true
        unit_number:
          type: string
          maxLength: 50
          description: Unit number of the property.
          nullable: true
        verification_of_assets:
          type: boolean
          description: Whether borrower’s assets have been verified.
          nullable: true
        verification_of_income_and_employment:
          type: boolean
          description: Whether borrower’s income and employment have been verified.
          nullable: true
        zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Borrower’s zip code.
          nullable: true
        borrower_voe_employment_category_INDEX:
          allOf:
          - "$ref": "#/components/schemas/EmploymentTypes"
          description: Type of employment being verified on the borrower (e.g. Self-employed,
            Employed by a business).
          nullable: true
        borrower_voe_employment_ownership_INDEX:
          allOf:
          - "$ref": "#/components/schemas/EmploymentOwnershipTypes"
          description: Declaration of ownership for employment being verified on the
            borrower (e.g. I have a share of 25%).
          nullable: true
        borrower_voe_to_name_INDEX:
          type: string
          maxLength: 100
          description: Name of employer being verified on borrower.
          nullable: true
        borrower_voe_to_address_INDEX:
          type: string
          maxLength: 100
          description: Street of borrower's employer's address.
          nullable: true
        borrower_voe_to_unit_type_INDEX:
          allOf:
          - "$ref": "#/components/schemas/UnitTypes"
          description: Unit type of borrower's employer's address.
          nullable: true
        borrower_voe_to_unit_number_INDEX:
          type: string
          maxLength: 20
          description: Unit number of borrower's employer's address.
          nullable: true
        borrower_voe_to_city_INDEX:
          type: string
          maxLength: 100
          description: City borrower's employer resides in.
          nullable: true
        borrower_voe_to_state_INDEX:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state borrower's employer resides in.
          nullable: true
        borrower_voe_to_zip_INDEX:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip code borrower's employer resides in.
          nullable: true
        borrower_voe_to_phone_INDEX:
          type: string
          format: phone
          description: Phone number for the borrower's employer.
          nullable: true
        borrower_voe_employer_type_INDEX:
          type: string
          maxLength: 100
          description: Position or title borrower holds/held at employer.
          nullable: true
        borrower_voe_employment_date_hired_INDEX:
          type: string
          format: date
          description: Date the borrower was employed at employer.
          nullable: true
        borrower_voe_employment_is_current_INDEX:
          type: boolean
          description: Whether the borrower is still employer at employer.
          nullable: true
        borrower_voe_employment_date_terminated_INDEX:
          type: string
          format: date
          description: Date the borrower finished working for employer.
          nullable: true
        borrower_voe_self_employment_monthly_income_INDEX:
          type: integer
          description: Income borrower reports if self-employed.
          nullable: true
        borrower_voe_income_base_pay_INDEX:
          type: integer
          description: Amount of base pay from borrower's employer.
          nullable: true
        borrower_voe_income_base_pay_INDEX_hours:
          type: integer
          description: Amount of base pay hours from borrower's employer.
          nullable: true
        borrower_additional_income_INDEX:
          type: integer
          description: Additional income amount from borrower's employer.
          nullable: true
        borrower_voe_income_overtime_INDEX:
          type: integer
          description: Overtime amount from borrower's employer.
          nullable: true
        borrower_voe_income_commissions_INDEX:
          type: integer
          description: Commissions amount from borrower's employer.
          nullable: true
        borrower_voe_income_bonus_INDEX:
          type: integer
          description: Bonus amount from borrower's employer.
          nullable: true
        borrower_voe_employment_line_of_work_years_INDEX:
          type: integer
          description: Number of years borrower has been in line of work.
          nullable: true
        borrower_voe_employment_line_of_work_months_INDEX:
          type: integer
          description: Number of months borrower has been in line of work.
          nullable: true
        borrower_vor_residence_address_INDEX:
          type: string
          maxLength: 100
          description: Street of residence being verified on borrower.
          nullable: true
        borrower_vor_residence_unit_number_INDEX:
          type: string
          maxLength: 20
          description: Unit number of residence being verified on borrower.
          nullable: true
        borrower_vor_residence_city_INDEX:
          type: string
          maxLength: 100
          description: City of residence being verified on borrower.
          nullable: true
        borrower_vor_residence_state_INDEX:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state of residence being verified on borrower.
          nullable: true
        borrower_vor_residence_zip_INDEX:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip of residence being verified on borrower.
          nullable: true
        borrower_vor_residence_years_INDEX:
          type: integer
          description: Number of years at residence being verified on borrower.
          nullable: true
        borrower_vor_residence_months_INDEX:
          type: integer
          description: Number of months at residence being verified on borrower.
          nullable: true
        borrower_vor_residence_own_INDEX:
          allOf:
          - "$ref": "#/components/schemas/OwnResidenceTypes"
          description: Ownership status of residence being verified on borrower (e.g.
            Own, Rent).
          nullable: true
        coborrower_voe_employment_category_INDEX:
          allOf:
          - "$ref": "#/components/schemas/EmploymentTypes"
          description: Type of employment being verified on the coborrower (e.g. Self-employed,
            Employed by a business).
          nullable: true
        coborrower_voe_employment_ownership_INDEX:
          allOf:
          - "$ref": "#/components/schemas/EmploymentOwnershipTypes"
          description: Declaration of ownership for employment being verified on the
            coborrower (e.g. I have a share of 25%).
          nullable: true
        coborrower_voe_to_name_INDEX:
          type: string
          maxLength: 100
          description: Name of employer being verified on coborrower.
          nullable: true
        coborrower_voe_to_address_INDEX:
          type: string
          maxLength: 100
          description: Street of coborrower's employer's address.
          nullable: true
        coborrower_voe_to_unit_type_INDEX:
          allOf:
          - "$ref": "#/components/schemas/UnitTypes"
          description: Unit type of coborrower's employer's address.
          nullable: true
        coborrower_voe_to_unit_number_INDEX:
          type: string
          maxLength: 20
          description: Unit number of coborrower's employer's address.
          nullable: true
        coborrower_voe_to_city_INDEX:
          type: string
          maxLength: 100
          description: City coborrower's employer resides in.
          nullable: true
        coborrower_voe_to_state_INDEX:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state coborrower's employer resides in.
          nullable: true
        coborrower_voe_to_zip_INDEX:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip code coborrower's employer resides in.
          nullable: true
        coborrower_voe_to_phone_INDEX:
          type: string
          format: phone
          description: Phone number for the coborrower's employer.
          nullable: true
        coborrower_voe_employer_type_INDEX:
          type: string
          maxLength: 100
          description: Position or title coborrower holds/held at employer.
          nullable: true
        coborrower_voe_employment_date_hired_INDEX:
          type: string
          format: date
          description: Date the coborrower was employed at employer.
          nullable: true
        coborrower_voe_employment_is_current_INDEX:
          type: boolean
          description: Whether the coborrower is still employer at employer.
          nullable: true
        coborrower_voe_employment_date_terminated_INDEX:
          type: string
          format: date
          description: Date the coborrower finished working for employer.
          nullable: true
        coborrower_voe_self_employment_monthly_income_INDEX:
          type: integer
          description: Income coborrower reports if self-employed.
          nullable: true
        coborrower_voe_income_base_pay_INDEX:
          type: integer
          description: Amount of base pay from coborrower's employer.
          nullable: true
        coborrower_voe_income_base_pay_INDEX_hours:
          type: integer
          description: Amount of base pay hours from coborrower's employer.
          nullable: true
        coborrower_additional_income_INDEX:
          type: integer
          description: Additional income amount from coborrower's employer.
          nullable: true
        coborrower_voe_income_overtime_INDEX:
          type: integer
          description: Overtime amount from coborrower's employer.
          nullable: true
        coborrower_voe_income_commissions_INDEX:
          type: integer
          description: Commissions amount from coborrower's employer.
          nullable: true
        coborrower_voe_income_bonus_INDEX:
          type: integer
          description: Bonus amount from coborrower's employer.
          nullable: true
        coborrower_line_of_work_info_INDEX:
          type: string
          maxLength: 100
          description: Details about coborrower's line of work.
          nullable: true
        coborrower_voe_employment_line_of_work_years_INDEX:
          type: integer
          description: Number of years coborrower has been in line of work.
          nullable: true
        coborrower_voe_employment_line_of_work_months_INDEX:
          type: integer
          description: Number of years coborrower has been in line of work.
          nullable: true
        coborrower_vor_residence_address_INDEX:
          type: string
          maxLength: 100
          description: Street of residence being verified on coborrower.
          nullable: true
        coborrower_vor_residence_unit_number_INDEX:
          type: string
          maxLength: 20
          description: Unit number of residence being verified on coborrower.
          nullable: true
        coborrower_vor_residence_city_INDEX:
          type: string
          maxLength: 100
          description: City of residence being verified on coborrower.
          nullable: true
        coborrower_vor_residence_state_INDEX:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state of residence being verified on coborrower.
          nullable: true
        coborrower_vor_residence_zip_INDEX:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip of residence being verified on coborrower.
          nullable: true
        coborrower_vor_residence_years_INDEX:
          type: integer
          description: Number of years at residence being verified on borrower.
          nullable: true
        coborrower_vor_residence_months_INDEX:
          type: integer
          description: Number of months at residence being verified on borrower.
          nullable: true
        coborrower_vor_residence_own_INDEX:
          allOf:
          - "$ref": "#/components/schemas/OwnResidenceTypes"
          description: Ownership status of residence being verified on coborrower.
          nullable: true
        vod_to_name_INDEX:
          type: string
          maxLength: 100
          description: Financial institution name.
          nullable: true
        vod_for_INDEX:
          allOf:
          - "$ref": "#/components/schemas/ApplicantTypes"
          description: Who is on the account at the financial institution.
          nullable: true
        vogg_gift_asset_type_INDEX:
          allOf:
          - "$ref": "#/components/schemas/GiftTypes"
          description: Type of gift (e.g. Gift of cash, grant).
          nullable: true
        vogg_gift_applicant_INDEX:
          allOf:
          - "$ref": "#/components/schemas/ApplicantTypes"
          description: Applicant tied to gift.
          nullable: true
        vogg_gift_deposited_INDEX:
          type: boolean
          description: Whether the gift has been deposited.
          nullable: true
        vogg_gift_amount_INDEX:
          type: integer
          description: Amount of the gift.
          nullable: true
        vogg_gift_source_INDEX:
          allOf:
          - "$ref": "#/components/schemas/GiftSourceTypes"
          description: Source of the gift.
          nullable: true
        other_assets_and_credits_type_INDEX:
          allOf:
          - "$ref": "#/components/schemas/AdditionalAssetTypes"
          description: Type of another asset.
          nullable: true
        other_assets_and_credits_value_INDEX:
          type: integer
          description: Value of another asset.
          nullable: true
        other_assets_and_credits_owner_INDEX:
          allOf:
          - "$ref": "#/components/schemas/ApplicantTypes"
          description: Owner of another asset.
          nullable: true
        other_liabilities_and_expenses_type_INDEX:
          allOf:
          - "$ref": "#/components/schemas/AdditionalLiabilityTypes"
          description: Type of other liability (e.g. Alimony, Child Support).
          nullable: true
        other_liabilities_and_expenses_amount_INDEX:
          type: integer
          description: Amount of other liability.
          nullable: true
        other_liabilities_and_expenses_applicant_INDEX:
          allOf:
          - "$ref": "#/components/schemas/ApplicantTypes"
          description: Applicant tied to liability (e.g. Borrower, Coborrower).
          nullable: true
        vom_address_INDEX:
          type: string
          maxLength: 100
          description: Street of mortgage being verified.
          nullable: true
        vom_unit_number_INDEX:
          type: string
          maxLength: 20
          description: Unit number of mortgage being verified.
          nullable: true
        vom_city_INDEX:
          type: string
          maxLength: 100
          description: City of mortgage being verified.
          nullable: true
        vom_state_INDEX:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/EmptyString"
          description: U.S. state of mortgage being verified.
          nullable: true
        vom_zip_INDEX:
          type: string
          minLength: 5
          maxLength: 10
          description: Zip of mortgage being verified.
          nullable: true
        vom_market_value_INDEX:
          type: string
          maxLength: 100
          description: Market value of mortgage being verified.
          nullable: true
        vom_mortgage_balance_INDEX:
          type: integer
          description: Balance of mortgage being verified.
          nullable: true
        vom_type_of_property_INDEX:
          allOf:
          - "$ref": "#/components/schemas/MortgagePropertyTypes"
          description: Type of property tied to mortgage being verified.
          nullable: true
        vom_date_acquired_INDEX:
          type: string
          format: date
          description: Date acquired for mortgage being verified.
          nullable: true
        vom_mortgage_loan_INDEX:
          type: string
          maxLength: 100
          description: Loan amount of mortgage being verified.
          nullable: true
        vom_mortgage_payment_INDEX:
          type: integer
          description: Payment of mortgage being verified.
          nullable: true
        vom_property_used_as_INDEX:
          allOf:
          - "$ref": "#/components/schemas/MortgagePropertyUsedAsTypes"
          description: Purpose property is used as for mortgage being verified (e.g.
            Primary Residence, Investment Property).
          nullable: true
        vom_rental_income_INDEX:
          type: integer
          description: Income from property if rented of mortgage being verified.
          nullable: true
      description: The available properties for creating and modifying a loan application
        record
    LoanApplicationPostBody:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationBody"
      - type: object
        properties:
          email:
            type: string
            maxLength: 255
            description: Borrower's email.
          loan_officer_id:
            type: string
            format: uuid
            description: "<<glossary:Loan officer>> ID."
            nullable: true
        required:
        - email
      description: The available properties for creating a loan application record.
        To enable prospect creation and CRM sync, include first_name and last_name
        along with email.
    LoanApplicationPatchBody:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationBody"
      description: The available properties for updating a loan application record
      minProperties: 1
    LoanApplicationAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - SHARE_APP
          - DEACTIVATE
          - ACTIVATE
          - SUBMIT
          - REJECT
          - REASSIGN_LO
          - CONVERT_TO_LOAN
          description: Action to perform
      required:
      - action
      description: Available properties for a loan application action.
      additionalProperties: false
    DeactivateLoanApplication:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      description: Available properties for deactivating a loan application.
    ActivateLoanApplication:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      description: Available properties for activating a loan application.
    ShareApp:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      description: Available properties for sharing app.
    SubmitLoanApplication:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      description: Available properties for submitting a loan application.
    RejectLoanApplication:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      - type: object
        properties:
          message:
            type: string
            description: message to send to loan application user.
        additionalProperties: false
      description: Available properties for rejecting loan application.
    ReassignLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      - type: object
        properties:
          loan_officer_id:
            type: string
            format: uuid
            description: new <<glossary:loan officer>> guid to assign loan application
              to.
        required:
        - loan_officer_id
        additionalProperties: false
      description: Available properties for assigning new <<glossary:loan officer>>
        to loan application.
    ConvertToLoan:
      allOf:
      - "$ref": "#/components/schemas/LoanApplicationAction"
      - type: object
        properties:
          loan_number:
            type: string
            minLength: 1
            maxLength: 255
            description: Loan number to set on the created loan.
        required:
        - loan_number
        additionalProperties: false
      description: Available properties for converting a loan application to a loan.
    LoanApplicationEventInfo:
      type: object
      properties:
        borrower_name:
          type: string
          description: Borrower name.
      description: The event info particular to the loan application webhook group
        events.
    AssetCollection:
      allOf:
      - "$ref": "#/components/schemas/ResourceCollectionCreated"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Asset"
            description: Array of created asset records.
        required:
        - contents
        additionalProperties: false
      description: Collection of asset records. Returned when creating multiple records.
    AssetCollectionCreateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/AssetCreateBody"
          description: Array of records to create.
      required:
      - records
      description: Body for creating multiple asset records.
      additionalProperties: false
    AssetCreateBody:
      type: object
      properties:
        type:
          type: string
          description: This asset's type.
        value:
          type: integer
          description: This asset's estimated value.
        owner:
          type: string
          description: 'The owner(s) of this asset: "Borrower", "Co-borrower", or
            "Both".'
      description: |-
        Body for creating a new asset record. Beyond the standard fields, a
        company's form may declare FI-custom asset fields (each a form
        `category_key`); pass those as additional properties. Every key is
        validated against the form when the request is processed, so an unknown
        key is rejected.
    AssetCollectionUpdateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/AssetItemUpdateBody"
          description: Array of records to update.
      required:
      - records
      description: Body for updating multiple asset records.
      additionalProperties: false
    AssetItemUpdateBody:
      allOf:
      - "$ref": "#/components/schemas/AssetUpdateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: Body for updating an asset record. Aside from the ID, pass only
        the fields to update.
      minProperties: 2
    Asset:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque, interim item identifier (not a uuid — see class description).
          type:
            type: string
            description: This asset's type.
            nullable: true
          value:
            type: string
            description: This asset's estimated value.
            nullable: true
          owner:
            type: string
            description: 'The owner(s) of this asset: "Borrower", "Co-borrower", or
              "Both".'
            nullable: true
        required:
        - _id
      description: |-
        A single asset record. Beyond the form's standard fields (`type`,
        `value`, `owner`), a company's form may declare FI-custom fields, so
        additional properties are permitted. `_id` is an opaque string
        identifier, stable only for the lifetime of the loan application's
        current field ordering. A persisted, stable identifier is planned as
        future work. It uses the underscore-prefixed namespace reserved for API
        meta fields (alongside `_self`/`_type`/`_links`), so a data field can
        never overwrite it.
    AssetPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Asset"
        required:
        - contents
        additionalProperties: false
    AssetUpdateBody:
      type: object
      properties:
        type:
          type: string
          description: This asset's type.
        value:
          type: integer
          description: This asset's estimated value.
        owner:
          type: string
          description: 'The owner(s) of this asset: "Borrower", "Co-borrower", or
            "Both".'
      description: Body for updating an asset record. Pass only the fields to update.
      minProperties: 1
    ExpenseCollection:
      allOf:
      - "$ref": "#/components/schemas/ResourceCollectionCreated"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Expense"
            description: Array of created expense records.
        required:
        - contents
        additionalProperties: false
      description: Collection of expense records. Returned when creating multiple
        records.
    ExpenseCollectionCreateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/ExpenseCreateBody"
          description: Array of records to create.
      required:
      - records
      description: Body for creating multiple expense records.
      additionalProperties: false
    ExpenseCreateBody:
      type: object
      properties:
        type:
          type: string
          description: This expense's type.
        category:
          type: string
          description: This expense's category.
        amount:
          type: integer
          description: The amount paid to this expense.
        frequency:
          type: string
          description: The frequency at which this expense is paid.
      description: Body for creating a new expense record.
    ExpenseCollectionUpdateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/ExpenseItemUpdateBody"
          description: Array of records to update.
      required:
      - records
      description: Body for updating multiple expense records.
      additionalProperties: false
    ExpenseItemUpdateBody:
      allOf:
      - "$ref": "#/components/schemas/ExpenseUpdateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: Body for updating an expense record. Aside from the ID, pass only
        the fields to update.
      minProperties: 2
    Expense:
      allOf:
      - "$ref": "#/components/schemas/ExpenseCreateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: A single expense record.
    ExpensePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Expense"
        required:
        - contents
    ExpenseUpdateBody:
      type: object
      properties:
        type:
          type: string
          description: This expense's type.
        category:
          type: string
          description: This expense's category.
        amount:
          type: integer
          description: The amount paid to this expense.
        frequency:
          type: string
          description: The frequency at which this expense is paid.
      description: Body for updating an expense record. Pass only the fields to update.
      minProperties: 1
    IncomeCollection:
      allOf:
      - "$ref": "#/components/schemas/ResourceCollectionCreated"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Income"
            description: Array of created income records.
        required:
        - contents
        additionalProperties: false
      description: Collection of income records. Returned when creating multiple records.
    IncomeCollectionCreateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/IncomeCreateBody"
          description: Array of records to create.
      required:
      - records
      description: Body for creating multiple income records.
      additionalProperties: false
    IncomeCreateBody:
      type: object
      properties:
        owner:
          type: string
          description: 'The borrower who receives this income source: "Borrower",
            or "Co-borrower". This cannot be updated.'
        type:
          type: string
          description: This income source's type.
        amount:
          type: integer
          description: The amount of income from this source.
        frequency:
          type: string
          description: The frequency at which this income is earned.
      required:
      - owner
      description: Body for creating a new income record.
    IncomeCollectionUpdateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/IncomeItemUpdateBody"
          description: Array of records to update.
      required:
      - records
      description: Body for updating multiple income records.
      additionalProperties: false
    IncomeItemUpdateBody:
      allOf:
      - "$ref": "#/components/schemas/IncomeUpdateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: Body for updating a income record. Aside from the ID, pass only
        the fields to update.
      minProperties: 2
    Income:
      allOf:
      - "$ref": "#/components/schemas/IncomeCreateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
          owner:
            type: string
            description: 'The borrower who receives this income source: "Borrower",
              or "Co-borrower". This cannot be updated.'
        required:
        - _id
        - owner
      description: A single income record.
    IncomePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Income"
        required:
        - contents
    IncomeUpdateBody:
      type: object
      properties:
        type:
          type: string
          description: This income source's type.
        amount:
          type: integer
          description: The amount of income from this source.
        frequency:
          type: string
          description: The frequency at which this income is earned.
      description: Body for updating a income record. Pass only the fields to update.
      minProperties: 1
    LiabilityCollection:
      allOf:
      - "$ref": "#/components/schemas/ResourceCollectionCreated"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Liability"
            description: Array of created liability records.
        required:
        - contents
        additionalProperties: false
      description: Collection of liability records. Returned when creating multiple
        records.
    LiabilityCollectionCreateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/LiabilityCreateBody"
          description: Array of records to create.
      required:
      - records
      description: Body for creating multiple liability records.
      additionalProperties: false
    LiabilityCreateBody:
      type: object
      properties:
        type:
          type: string
          description: This liability's type.
        balance:
          type: integer
          description: This liability's balance.
        owner:
          type: string
          description: 'The borrower responsible for this liability: "Borrower", "Co-borrower",
            or "Both".'
      description: Body for creating a new liability record.
    LiabilityCollectionUpdateBody:
      type: object
      properties:
        records:
          type: array
          items:
            "$ref": "#/components/schemas/LiabilityItemUpdateBody"
          description: Array of records to update.
      required:
      - records
      description: Body for updating multiple liability records.
      additionalProperties: false
    LiabilityItemUpdateBody:
      allOf:
      - "$ref": "#/components/schemas/LiabilityUpdateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: Body for updating a liability record. Aside from the ID, pass only
        the fields to update.
      minProperties: 2
    Liability:
      allOf:
      - "$ref": "#/components/schemas/LiabilityCreateBody"
      - type: object
        properties:
          _id:
            type: string
            description: Opaque string identifier, stable only for the lifetime of
              the loan application's current field ordering.
        required:
        - _id
      description: A single liability record.
    LiabilityPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Liability"
        required:
        - contents
    LiabilityUpdateBody:
      type: object
      properties:
        type:
          type: string
          description: This liability's type.
        balance:
          type: integer
          description: This liability's balance.
        owner:
          type: string
          description: 'The borrower responsible for this liability: "Borrower", "Co-borrower",
            or "Both".'
      description: Body for updating a liability record. Pass only the fields to update.
      minProperties: 1
    LoanApplicationNested:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          assets:
            type: array
            items:
              "$ref": "#/components/schemas/Asset"
            description: The borrower's and coborrower's assets.
          borrower_incomes:
            type: array
            items:
              "$ref": "#/components/schemas/Income"
            description: The borrower's sources of income.
          coborrower_incomes:
            type: array
            items:
              "$ref": "#/components/schemas/Income"
            description: The coborrower's sources of income.
          expenses:
            type: array
            items:
              "$ref": "#/components/schemas/Expense"
            description: The borrower's and coborrower's expenses.
          liabilities:
            type: array
            items:
              "$ref": "#/components/schemas/Liability"
            description: The borrower's and coborrower's liabilities.
      description: A loan application in nested format.
    LoanDocTaskPostBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan doc task's name.
        description:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan doc task's description.
          nullable: true
        doc_type:
          allOf:
          - "$ref": "#/components/schemas/LoanDocDefinitionTypes"
          description: Type of loan doc definition to create.
        loan_borrower_id:
          type: string
          format: uuid
          description: ID of the loan borrower to assign the task to.
      required:
      - name
      - doc_type
      - loan_borrower_id
      description: Available properties for creating a loan doc task.
      additionalProperties: false
    LoanDocTaskUpdateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan doc task's name.
      description: Available properties for updating a loan doc task.
      additionalProperties: false
      minProperties: 1
    LoanDocTaskAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - MARK_AS_COMPLETE
          description: Action to perform.
      required:
      - action
      description: Available properties for a loan doc task action.
      additionalProperties: false
    MarkAsCompleteLoanDocTask:
      allOf:
      - "$ref": "#/components/schemas/LoanDocTaskAction"
      description: Available properties for marking a loan doc task as complete.
    LoanDocTask:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Task title
          description:
            type: string
            description: Task description.
            nullable: true
          current_state:
            type: string
            description: Current state.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the task record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the task record was last updated.
        additionalProperties: false
      description: Loan doc task model
    LoanDocTaskPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanDocTask"
        required:
        - contents
    LoanBorrowerPatchBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 255
          description: Borrower's first name.
        middle_name:
          type: string
          maxLength: 30
          description: Borrower's middle name.
          nullable: true
        last_name:
          type: string
          minLength: 1
          maxLength: 255
          description: Borrower's last name.
        suffix:
          type: string
          maxLength: 255
          description: Borrower's suffix.
          nullable: true
        email:
          type: string
          format: email
          maxLength: 255
          description: Borrower's email.
          nullable: true
        marital_status:
          allOf:
          - "$ref": "#/components/schemas/MaritalStatus"
          description: Borrower's marital status.
          nullable: true
        dob:
          type: string
          format: date
          description: Borrower's date of birth.
          nullable: true
        cell_phone:
          type: string
          format: phone
          description: Borrower's cell phone.
          nullable: true
        work_phone:
          type: string
          format: phone
          description: Borrower's work phone.
          nullable: true
        home_phone:
          type: string
          format: phone
          description: Borrower's home phone.
          nullable: true
        ssn:
          type: string
          format: ssn
          description: Borrower's SSN.
          nullable: true
        current_address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Borrower's current address.
          nullable: true
        mailing_address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Borrower's mailing address.
          nullable: true
      description: Available properties for updating a loan borrower record
      additionalProperties: false
      minProperties: 1
    LoanBorrowerPostBody:
      allOf:
      - "$ref": "#/components/schemas/LoanBorrowerPatchBody"
      - type: object
        properties:
          first_name:
            type: string
            minLength: 1
            maxLength: 255
            description: Borrower's first name.
          last_name:
            type: string
            minLength: 1
            maxLength: 255
            description: Borrower's last name.
        required:
        - first_name
        - last_name
        additionalProperties: false
      description: Available properties for creating a loan borrower record
    LoanBorrowerVerification:
      allOf:
      - "$ref": "#/components/schemas/AbstractVerification"
      description: Loan borrower verification model
    LoanBorrowerVerificationPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanBorrowerVerification"
        required:
        - contents
    DocPackageOrder:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          status:
            type: string
            description: The status of the doc package order.
          error:
            type: string
            description: Error message if the order failed.
            nullable: true
          audit_failures:
            type: array
            items:
              "$ref": "#/components/schemas/DocPackageOrderAuditFailure"
            description: Field-level audit failures when the order failed a data audit.
              Null for non-audit failures and orders that have not failed.
            nullable: true
          doc_vendor_order_id:
            type: string
            description: The vendor's order ID.
            nullable: true
          doc_vendor:
            type: string
            description: The document vendor.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the order was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the order was last modified.
        additionalProperties: false
      description: Doc package order model
    DocPackageOrderAuditFailure:
      type: object
      properties:
        description:
          type: string
          description: Human-readable description of the failed audit rule.
        field_ids:
          type: array
          items:
            type: string
          description: Encompass field IDs associated with the failure. May be empty.
        severity:
          type: string
          description: Severity of the rule, e.g. "Required" or "Recommended".
      description: A single field-level audit rule failure from the Encompass data
        audit.
      additionalProperties: false
    DocPackageOrderPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/DocPackageOrder"
        required:
        - contents
    DocPackageOrderPostBody:
      type: object
      properties:
        doc_vendor:
          allOf:
          - "$ref": "#/components/schemas/DocVendor"
          description: The document vendor. Defaults to 'encompass'.
        order_type:
          allOf:
          - "$ref": "#/components/schemas/OrderType"
          description: The order type. Defaults to 'opening'.
        recipients:
          type: array
          items:
            "$ref": "#/components/schemas/DocPackageOrderRecipient"
          description: The list of additional recipients to be added to the package.
            Defaults to an empty array.
        package_type:
          allOf:
          - "$ref": "#/components/schemas/PackageType"
          description: The disclosure package type. For 'closing' orders, one of 'closing'/'hybrid'/'hybrid_ron'
            (subject to servicer eClosing settings); for 'forms' orders, the package
            type to file the generated forms under (e.g. 'sent_docs'). Required for
            'closing' and 'forms' order types; ignored for 'opening'.
        final_package:
          type: boolean
          description: Indicates if this is a final or draft package. Only applicable
            when order type is 'closing'. Defaults to 'false'.
        include_enote:
          type: boolean
          description: Indicates if an eNote should be added to the package. Only
            applicable when order type is 'closing'. Defaults to 'false'.
        use_existing_enote:
          type: boolean
          description: Indicates if a previously existing eNote should be used instead
            of creating a new eNote. Only applicable when order type is 'closing'.
            Defaults to 'false'.
        borrower_pair_ids:
          type: array
          items:
            type: string
          description: Optional list of borrower pair IDs to create orders for. Only
            valid pair IDs associated with the loan will be processed. Ignored when
            order_type is "closing".
          nullable: true
        closing_docs_to_remove:
          type: array
          items:
            "$ref": "#/components/schemas/ClosingDocToRemove"
          description: The list of documents to remove from a closing package. Only
            applicable when order type is 'closing'. Defaults to an empty array.
        ron_jurisdiction_info:
          allOf:
          - "$ref": "#/components/schemas/RonJurisdictionInfo"
          description: The RON jurisdiction used to determine where to create the
            RON transaction. Only applicable when package type is 'hybrid_ron'. Defaults
            to nil.
        templates:
          type: array
          items:
            type: string
          description: The list of Encompass form/template names to generate (e.g.
            "Loan Estimate"). Required when order type is 'forms'; ignored otherwise.
      description: Available properties for creating doc package orders
      additionalProperties: false
    DocPackageOrderPatchBody:
      type: object
      properties:
        order_group_id:
          type: string
          format: uuid
          description: The order group ID returned by the create endpoint.
        doc_package_order_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Optional subset of doc package order IDs to retry. When omitted,
            all failed orders in the group are retried.
          nullable: true
      required:
      - order_group_id
      description: Available properties for retrying failed doc package orders
      additionalProperties: false
    DocPackageOrderAccepted:
      type: object
      properties:
        order_group_id:
          type: string
          format: uuid
          description: Shared identifier for all orders created by this request.
        message:
          type: string
          description: Description of how to poll for status.
      required:
      - order_group_id
      - message
      description: |-
        Response returned when doc package orders have been accepted for async processing.
        Poll GET /loans/{loan_id}/doc_package_orders?order_group_id={order_group_id} to track status.
      additionalProperties: false
    RonJurisdictionInfo:
      type: object
      properties:
        ron_jurisdiction_id:
          type: string
          description: Recording jurisdiction identifier from the RON vendor.
        ron_title_agency_id:
          type: string
          description: Title agency identifier from the RON vendor.
        ron_title_underwriter_id:
          type: string
          description: Underwriter identifier from the RON vendor.
      required:
      - ron_jurisdiction_id
      - ron_title_agency_id
      - ron_title_underwriter_id
      description: |-
        The RON jurisdiction, title agency, and underwriter used to determine where to create
        the RON transaction. Only applicable when closing package type is 'HybridRON'.
      additionalProperties: false
    ClosingDocToRemove:
      type: object
      properties:
        name:
          type: string
          description: The document name. Use 'ENOTE' to target the eNote.
        guid:
          type: string
          description: The document GUID to remove from the package.
      required:
      - name
      - guid
      description: |-
        A document to remove from a closing package. The document is matched by `guid`;
        `name` is used to detect the eNote. Only applicable when order type is 'closing'.
      additionalProperties: false
    DocPackageOrderRecipient:
      type: object
      properties:
        role:
          allOf:
          - "$ref": "#/components/schemas/RecipientRoleType"
          description: The recipient's role.
          nullable: true
        email:
          type: string
          description: The recipient's email address.
          nullable: true
        phone:
          type: string
          description: The recipient's phone number. (###-###-####)
          nullable: true
        full_name:
          type: string
          description: The recipient's full name.
          nullable: true
      description: An additional recipient to be added to the package.
      additionalProperties: false
    LoanDocument:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Document filename.
          doc_type:
            type: string
            description: Document type classification.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the document record was created.
          uploaded_at:
            type: string
            format: date-time
            description: Timestamp of when the file was uploaded.
            nullable: true
          loan_borrower_id:
            type: string
            format: uuid
            description: ID of the loan borrower who uploaded the document.
            nullable: true
        additionalProperties: false
      description: A document uploaded to a loan.
    LoanDocumentPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanDocument"
        required:
        - contents
    DocumentUploadedEventInfo:
      type: object
      properties:
        document_name:
          type: string
          description: Name of the uploaded document.
        doc_type:
          type: string
          description: Document type classification.
          nullable: true
        task_name:
          type: string
          description: Name of the associated task.
          nullable: true
        loan_number:
          type: string
          description: Loan number.
          nullable: true
        uploaded_by:
          type: string
          description: Who uploaded the document (borrower or servicer).
      required:
      - document_name
      - uploaded_by
      description: The event info for the document_uploaded event.
    DocumentCreatedEventInfo:
      type: object
      properties:
        document_name:
          type: string
          description: Name of the created document.
        doc_type:
          type: string
          description: Document type classification.
          nullable: true
        task_name:
          type: string
          description: Name of the associated task.
          nullable: true
        loan_number:
          type: string
          description: Loan number.
          nullable: true
      required:
      - document_name
      description: The event info for the document_created event.
    DocumentUpdatedEventInfo:
      type: object
      properties:
        document_name:
          type: string
          description: Name of the updated document.
        doc_type:
          type: string
          description: Document type classification.
          nullable: true
        task_name:
          type: string
          description: Name of the associated task.
          nullable: true
        loan_number:
          type: string
          description: Loan number.
          nullable: true
      required:
      - document_name
      description: The event info for the document_updated event.
    LoanMilestone:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Milestone name (from definition).
          remote_name:
            type: array
            items:
              type: string
            description: LOS-specific milestone name(s).
          status:
            type: string
            enum:
            - complete
            - incomplete
            description: Current status of the milestone.
          completed:
            type: boolean
            description: Whether the milestone is completed.
          completed_at:
            type: string
            format: date-time
            description: Timestamp of when the milestone was completed.
            nullable: true
          notes:
            type: string
            description: Notes on the milestone.
            nullable: true
          milestone_definition_id:
            type: string
            format: uuid
            description: ID of the milestone definition.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the milestone was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the milestone was last updated.
        additionalProperties: false
      description: A milestone instance on a specific loan, tracking completion status.
    LoanMilestonePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanMilestone"
        required:
        - contents
    LoanMilestonePatchBody:
      type: object
      properties:
        completed:
          type: boolean
          description: Whether the milestone is completed.
        notes:
          type: string
          maxLength: 65536
          description: Notes on the milestone.
          nullable: true
      description: Available properties for updating a loan milestone.
      additionalProperties: false
      minProperties: 1
    LoanMilestoneAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - CASCADE_STATUS
          description: Action to perform.
      required:
      - action
      description: Available properties for a loan milestone action.
      additionalProperties: false
    CascadeStatusLoanMilestone:
      allOf:
      - "$ref": "#/components/schemas/LoanMilestoneAction"
      - type: object
        properties:
          completed:
            type: boolean
            description: The target completion status.
        required:
        - completed
        additionalProperties: false
      description: |-
        Cascade the completion status of this milestone forward or backward.
        When completed is true: marks this and all preceding milestones as complete, all subsequent as incomplete.
        When completed is false: marks this and all subsequent milestones as incomplete.
    LoanMilestoneUpdatedEventInfo:
      type: object
      properties:
        milestone_name:
          type: string
          description: Name of the milestone.
        status:
          type: string
          description: Current status of the milestone.
        loan_number:
          type: string
          description: Loan number.
      required:
      - milestone_name
      - status
      - loan_number
      description: The event info for the loan_milestone_updated event.
    LoanMilestoneCompletedEventInfo:
      type: object
      properties:
        milestone_name:
          type: string
          description: Name of the milestone.
        loan_number:
          type: string
          description: Loan number.
      required:
      - milestone_name
      - loan_number
      description: The event info for the loan_milestone_completed event.
    Loan:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          loan_officer_name:
            type: string
            description: "<<glossary:Loan officer>>'s name."
            nullable: true
          loan_officer_email:
            type: string
            description: "<<glossary:Loan officer>>'s email."
            nullable: true
          loan_number:
            type: string
            description: Loan's loan number.
            nullable: true
          property:
            anyOf:
            - "$ref": "#/components/schemas/Property"
            - "$ref": "#/components/schemas/Property.Detail"
            description: Loan's property information.
          is_active:
            type: boolean
            description: Whether the loan is active.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the loan was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the loan was last modified.
          type:
            type: string
            description: Loan type.
            nullable: true
          purpose:
            type: string
            description: Loan purpose.
            nullable: true
          amount:
            type: number
            format: float
            description: Loan amount.
            nullable: true
          closing_date:
            type: string
            format: date
            description: Date on which the loan plans to close.
            nullable: true
        additionalProperties: false
      description: Loan model
    LoanPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Loan.Preview"
        required:
        - contents
    LoanInputAddress:
      type: object
      properties:
        street:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan's property street.
          nullable: true
        city:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan's property city.
          nullable: true
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: Loan's state.
          nullable: true
        zip:
          type: string
          minLength: 5
          maxLength: 10
          description: Loan's property zip code.
          nullable: true
        county:
          type: string
          minLength: 1
          maxLength: 255
          description: Loan's property county.
          nullable: true
        appraised_value:
          type: integer
          description: Loan's property appraised value.
          nullable: true
        purchase_price:
          type: integer
          description: Loan's property purchase price.
          nullable: true
        estimated_value:
          type: integer
          description: Loan's property estimated value.
          nullable: true
        num_of_stories:
          type: integer
          description: Loan's property number of stories.
          nullable: true
        num_of_units:
          type: integer
          description: Loan's property number of units.
          nullable: true
      description: Available properties for a loan's address.
      additionalProperties: false
    LoanPostBody:
      allOf:
      - "$ref": "#/components/schemas/LoanPatchBody"
      - type: object
        properties:
          loan_officer_id:
            type: string
            format: uuid
            description: "<<glossary:Loan officer>> ID."
          loan_number:
            type: string
            minLength: 1
            maxLength: 255
            description: Loan number.
        required:
        - loan_officer_id
        - loan_number
        additionalProperties: false
      description: Available properties for creating a loan record
    LoanPatchBody:
      type: object
      properties:
        type:
          type: string
          description: Loan type.
          nullable: true
        purpose:
          type: string
          description: Loan purpose.
          nullable: true
        amount:
          type: number
          format: float
          description: Loan amount.
          nullable: true
        closing_date:
          type: string
          format: date
          description: Date on which the loan plans to close.
          nullable: true
        additional_comments:
          type: string
          description: Additional comments on the loan record.
          nullable: true
        amortization_type:
          type: string
          description: Loan's amortization type.
          nullable: true
        amount_base:
          type: number
          format: float
          description: Loan's base amount.
          nullable: true
        amount_total:
          type: number
          format: float
          description: Loan's total amount.
          nullable: true
        approved_date:
          type: string
          format: date
          description: Date on which the loan was approved.
          nullable: true
        apr:
          type: number
          format: float
          description: Loan's annual percentage rate.
          nullable: true
        debt_to_income_ratio:
          type: number
          format: float
          description: Loan's debt-to-income ratio.
          nullable: true
        doc_signing_date:
          type: string
          format: date
          description: Date on which loan documents are signed.
          nullable: true
        down_payment_amount:
          type: number
          format: float
          description: Loan's down payment dollar amount.
          nullable: true
        down_payment_pct:
          type: number
          format: float
          description: Loan's down payment percentage of loan amount.
          nullable: true
        dti_high:
          type: number
          format: float
          description: Loan's debt-to-income ratio high.
          nullable: true
        dti_low:
          type: number
          format: float
          description: Loan's debt-to-income ratio low.
          nullable: true
        first_payment_date:
          type: string
          format: date
          description: Date on which the loan's first payment is due.
          nullable: true
        first_time_buyer:
          type: boolean
          description: Whether the loan is for a first-time buyer.
          nullable: true
        funding_date:
          type: string
          format: date
          description: Date on which the loan intends to be funded.
          nullable: true
        intent_to_proceed_at:
          type: string
          format: date
          description: Date on which the intent to proceed was acknowledged.
          nullable: true
        intent_to_proceed_letter_sent_date:
          type: string
          format: date
          description: Date on which the intent to proceed letter was sent.
          nullable: true
        interest_rate_lock_expires_at:
          type: string
          format: date
          description: Datetime at which the loan's interest rate lock expires.
          nullable: true
        interest_rate:
          type: number
          format: float
          description: Loan's interest rate.
          nullable: true
        lien_position:
          type: string
          description: Loan's lien position.
          nullable: true
        loan_term_months:
          type: integer
          description: Loan's term in months.
          nullable: true
        maturity_date:
          type: string
          format: date
          description: Date on which the loan reaches maturity.
          nullable: true
        occupancy_status:
          type: string
          description: Loan's occupancy status.
          nullable: true
        p_and_i_payment_amount:
          type: number
          format: float
          description: Loan's principal plus interest payment amount.
          nullable: true
        payment_frequency:
          type: string
          description: Loan's payment frequency.
          nullable: true
        preapproval_amount:
          type: number
          format: float
          description: Loan's preapproval amount.
          nullable: true
        preapproval_notes:
          type: string
          description: Notes on the loan's preapproval.
          nullable: true
        processor_email:
          type: string
          description: Loan processor's email.
          nullable: true
        program:
          type: string
          description: Loan's program.
          nullable: true
        rate_expires_at:
          type: string
          format: date
          description: Datetime at which the loan's rate expires.
          nullable: true
        rate_locked:
          type: boolean
          description: Whether the loan's rate is locked.
          nullable: true
        total_monthly_payment_amount:
          type: number
          format: float
          description: Loan's total monthly payment amount.
          nullable: true
        property:
          allOf:
          - "$ref": "#/components/schemas/LoanInputAddress"
          description: Loan's property information.
      description: Available properties for updating a loan record
      additionalProperties: false
      minProperties: 1
    LoanAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - DEACTIVATE
          - ACTIVATE
          - REORDER_BORROWERS
          - REASSIGN_LO
          - ASSIGN_TEAM_MEMBER
          - UNASSIGN_TEAM_MEMBER
          description: Action to perform.
      required:
      - action
      description: Available properties for a loan action.
      additionalProperties: false
    DeactivateLoan:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      description: Available properties for deactivating a loan.
    ActivateLoan:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      description: Available properties for activating a loan.
    BorrowerPair:
      type: object
      properties:
        borrower_id:
          type: string
          format: uuid
          description: ID of the borrower on the pair
        co_borrower_id:
          type: string
          format: uuid
          description: ID of the coborrower on the pair
        is_title_only:
          type: boolean
          description: Whether the borrower is a title-only borrower. Defaults to
            false if not provided.
      required:
      - borrower_id
      description: Available properties for denoting a borrower pair on a loan.
      additionalProperties: false
    ReorderBorrowers:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      - type: object
        properties:
          pairs:
            type: array
            items:
              "$ref": "#/components/schemas/BorrowerPair"
            minItems: 1
            description: List of borrower pairs on the loan. All borrower guids must
              be provided.
        required:
        - pairs
        additionalProperties: false
      description: Available properties for reordering borrowers on a loan.
    ReassignLo:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      - type: object
        properties:
          loan_officer_id:
            type: string
            format: uuid
            description: ID of the loan officer to reassign the loan to.
        required:
        - loan_officer_id
        additionalProperties: false
      description: Available properties for reassigning a loan's loan officer.
    AssignTeamMember:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      - type: object
        properties:
          team_member_id:
            type: string
            format: uuid
            description: ID of the team member to assign to the loan.
        required:
        - team_member_id
        additionalProperties: false
      description: Available properties for assigning a team member to a loan.
    UnassignTeamMember:
      allOf:
      - "$ref": "#/components/schemas/LoanAction"
      - type: object
        properties:
          team_member_id:
            type: string
            format: uuid
            description: ID of the team member to unassign from the loan.
        required:
        - team_member_id
        additionalProperties: false
      description: Available properties for unassigning a team member from a loan.
    RonEligibility:
      type: object
      properties:
        is_ron_eligible:
          type: boolean
          description: Whether the loan is eligible for RON based on its property's
            recording jurisdiction.
        message:
          type: string
          description: Human-readable explanation when the loan is not eligible or
            RON is not configured.
          nullable: true
        ron_vendor:
          type: string
          description: The RON vendor evaluated for eligibility.
          nullable: true
        jurisdictions:
          type: array
          items:
            "$ref": "#/components/schemas/RonJurisdiction"
          description: Recording jurisdictions evaluated for eligibility.
      description: Remote Online Notarization (RON) eligibility result for a <<glossary:loan>>.
      additionalProperties: false
    RonJurisdiction:
      type: object
      properties:
        id:
          type: string
          description: Jurisdiction identifier from the RON vendor.
          nullable: true
        name:
          type: string
          description: Jurisdiction (county or city) name.
          nullable: true
        state:
          type: string
          description: Jurisdiction state code.
          nullable: true
        supported:
          type: boolean
          description: Whether the jurisdiction is supported by the vendor.
          nullable: true
        recording_type:
          type: string
          description: The recording type for the jurisdiction.
          nullable: true
        eligible:
          type: boolean
          description: Whether the jurisdiction is eligible for RON.
          nullable: true
        eligible_title_agencies:
          type: array
          items:
            "$ref": "#/components/schemas/RonTitleAgency"
          description: Title agencies eligible to record in this jurisdiction.
      description: A recording jurisdiction evaluated for Remote Online Notarization
        (RON) eligibility.
      additionalProperties: false
    RonTitleAgency:
      type: object
      properties:
        id:
          type: string
          description: Title agency identifier from the RON vendor.
          nullable: true
        name:
          type: string
          description: Title agency name.
          nullable: true
        alta_id:
          type: string
          description: Title agency ALTA ID.
          nullable: true
        address:
          allOf:
          - "$ref": "#/components/schemas/RonTitleAgencyAddress"
          description: Title agency address.
          nullable: true
        eligible_underwriters:
          type: array
          items:
            "$ref": "#/components/schemas/RonUnderwriter"
          description: Underwriters eligible through this title agency.
      description: A title agency eligible to record in a RON jurisdiction.
      additionalProperties: false
    RonTitleAgencyAddress:
      type: object
      properties:
        street_line_1:
          type: string
          description: Street line 1.
          nullable: true
        street_line_2:
          type: string
          description: Street line 2.
          nullable: true
        city:
          type: string
          description: City.
          nullable: true
        state:
          type: string
          description: State code.
          nullable: true
        postal_code:
          type: string
          description: Postal code.
          nullable: true
        country:
          type: string
          description: Country code.
          nullable: true
      description: Address for a RON title agency.
      additionalProperties: false
    RonUnderwriter:
      type: object
      properties:
        id:
          type: string
          description: Underwriter identifier from the RON vendor.
          nullable: true
        name:
          type: string
          description: Underwriter name.
          nullable: true
      description: An underwriter eligible through a RON title agency.
      additionalProperties: false
    LoanEventInfo:
      type: object
      properties:
        loan_number:
          type: string
          description: Loan number.
      required:
      - loan_number
      description: The event info particular to the loan webhook group events.
    MilestoneCreateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Milestone name.
        description:
          type: string
          minLength: 1
          maxLength: 65536
          description: Milestone description.
        remote_name:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 30
          minItems: 1
          description: Milestone remote name(s).
        messages:
          allOf:
          - "$ref": "#/components/schemas/MilestoneMessagesRequestBody"
          description: Milestone message templates.
        document_uploads_allowed:
          type: boolean
          description: Whether document uploads are allowed for milestone (defaults
            to true).
        is_viewable:
          type: boolean
          description: Whether the milestone is viewable in the LOS (defaults to true).
        notify_borrower:
          type: boolean
          description: Whether the borrower is notified for loan changes in milestone
            (defaults to false).
      required:
      - name
      - description
      - remote_name
      description: Available properties for creating a milestone
      additionalProperties: false
    MilestoneUpdateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Milestone name.
        description:
          type: string
          minLength: 1
          maxLength: 65536
          description: Milestone description.
        remote_name:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 30
          minItems: 1
          description: Milestone remote name(s).
        messages:
          allOf:
          - "$ref": "#/components/schemas/MilestoneMessagesRequestBody"
          description: Milestone message templates.
        document_uploads_allowed:
          type: boolean
          description: Whether document uploads are allowed for milestone (defaults
            to true).
        is_viewable:
          type: boolean
          description: Whether the milestone is viewable in the LOS (defaults to true).
        notify_borrower:
          type: boolean
          description: Whether the borrower is notified for loan changes in milestone
            (defaults to false).
      description: Available properties for updating a milestone
      additionalProperties: false
      minProperties: 1
    MilestoneMessagesRequestBody:
      type: object
      properties:
        partner:
          type: string
          minLength: 1
          maxLength: 255
          description: Partner message template.
        client:
          type: string
          minLength: 1
          maxLength: 255
          description: Client message template.
        originator:
          type: string
          minLength: 1
          maxLength: 255
          description: Originator message template.
      description: Properties available for a milestone's messages.
      additionalProperties: false
    MilestoneMessages:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          partner:
            type: string
            description: Partner message template.
            nullable: true
          client:
            type: string
            description: Client message template.
            nullable: true
          originator:
            type: string
            description: Originator message template.
            nullable: true
        additionalProperties: false
      description: Milestone message templates model
    Milestone:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Milestone name.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the milestone was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the milestone was last updated.
            nullable: true
          description:
            type: string
            description: Milestone description.
          remote_name:
            type: array
            items:
              type: string
            description: Milestone remote name(s).
          messages:
            allOf:
            - "$ref": "#/components/schemas/MilestoneMessages"
            description: Milestone message templates.
          document_uploads_allowed:
            type: boolean
            description: Whether document uploads are allowed for milestone.
          is_viewable:
            type: boolean
            description: Whether the milestone is viewable in the LOS.
          notify_borrower:
            type: boolean
            description: Whether the borrower is notified for loan changes in milestone.
        required:
        - name
        additionalProperties: false
      description: Milestone model
    MilestonePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Milestone"
        required:
        - contents
    MilestonesReorderedEventInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the organization.
      required:
      - name
      description: The event info particular to the milestones_reordered event.
    MilestoneCreatedEventInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the milestone.
      required:
      - name
      description: The event info particular to the milestone_created event.
    MilestoneDeletedEventInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the organization.
      required:
      - name
      description: The event info particular to the milestone_deleted event.
    OrganizationCreatedEventInfo:
      type: object
      properties:
        org_type:
          type: string
          enum:
          - REGION
          - BRANCH
          description: Type of organization (REGION or BRANCH).
        name:
          type: string
          description: Name of the organization created.
      required:
      - org_type
      - name
      description: The event info particular to the organization_created event.
    OrganizationDeletedEventInfo:
      type: object
      properties:
        org_type:
          type: string
          enum:
          - REGION
          - BRANCH
          description: Type of organization (REGION or BRANCH).
        name:
          type: string
          description: Name of the organization deleted.
      required:
      - org_type
      - name
      description: The event info particular to the organization_deleted event
    PropertyAddress:
      allOf:
      - "$ref": "#/components/schemas/Address"
      - type: object
        properties:
          county:
            type: string
            description: County.
            nullable: true
        additionalProperties: false
      description: PropertyAddress model
    Property:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          address:
            allOf:
            - "$ref": "#/components/schemas/PropertyAddress"
            description: Property's address.
            nullable: true
          type:
            type: string
            description: Property type.
            nullable: true
        additionalProperties: false
      description: Property model
    Permission:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          key:
            type: string
            description: The permission's stable key — the external identifier used
              when granting it to a <<glossary:role>>.
          description:
            type: string
            description: Human-readable description of what the permission allows.
            nullable: true
          group_key:
            type: string
            description: The category (permission group) the permission belongs to.
          dependents:
            type: array
            items:
              type: string
            description: Keys of dependent <<glossary:permission>>s that are only
              meaningful when this permission is granted. Only present when the permission
              has dependents.
        required:
        - key
        - description
        - group_key
        additionalProperties: false
      description: |-
        An available permission that can be granted to a <<glossary:role>>.

        Permission definitions are in-memory config objects (no DB record / guid),
        so this is a plain model keyed by its string `key` rather than a uuid-backed
        resource model.
    PermissionPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Permission"
        required:
        - contents
        additionalProperties: false
    PermissionTemplate:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          template_key:
            type: string
            description: The template identifier.
          permissions:
            type: array
            items:
              type: string
            description: Permission keys enabled in this template.
        required:
        - template_key
        - permissions
        additionalProperties: false
      description: The permissions included in a default role template.
    Role:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: The role's name.
          description:
            type: string
            description: The role's description.
          user_count:
            type: integer
            description: Number of users assigned to the role.
        required:
        - name
        - description
        - user_count
        additionalProperties: false
      description: Role model
    RolePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Role"
        required:
        - contents
        additionalProperties: false
    RolePermissionsBody:
      type: object
      properties:
        permission_keys:
          type: array
          items:
            type: string
          description: Permission keys. On POST they are added to the role, on DELETE
            they are removed, and on PUT they replace the role's entire permission
            set.
      required:
      - permission_keys
      description: The permission keys to apply to a role.
      additionalProperties: false
    RolePermissionsResult:
      type: object
      properties:
        permission_keys:
          type: array
          items:
            type: string
          description: Current permission keys enabled on the role.
      required:
      - permission_keys
      description: The permission keys enabled on the role after the operation.
      additionalProperties: false
    RolePostBody:
      type: object
      properties:
        name:
          type: string
          description: The <<glossary:role>>'s name.
        description:
          type: string
          description: The <<glossary:role>>'s description.
        template:
          type: string
          enum:
          - branch_admin
          - company_admin
          - loan_officer
          - region_admin
          - support_admin
          - team_member
          description: Pre-populate the role with permissions from this template.
      required:
      - name
      description: The available properties for creating a <<glossary:role>> record.
      additionalProperties: false
    RolePatchBody:
      type: object
      properties:
        name:
          type: string
          description: The <<glossary:role>>'s name.
        description:
          type: string
          description: The <<glossary:role>>'s description.
      description: The available properties for updating a <<glossary:role>> record.
      additionalProperties: false
      minProperties: 1
    RoleAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - DUPLICATE
          description: Action to perform.
      required:
      - action
      description: Available properties for a role action.
      additionalProperties: false
    DuplicateRoleAction:
      allOf:
      - "$ref": "#/components/schemas/RoleAction"
      - type: object
        properties:
          name:
            type: string
            description: The new role's name. Defaults to the source role's name with
              " (Copy)" appended.
          description:
            type: string
            description: The new role's description. Defaults to the source role's
              description.
        additionalProperties: false
      description: Available properties for duplicating a <<glossary:role>>.
    RoleUser:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: User's full name.
          email:
            type: string
            description: User's email address.
        required:
        - name
        - email
        additionalProperties: false
      description: A user assigned to a role.
    RoleUserPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/RoleUser"
        required:
        - contents
        additionalProperties: false
    RoleUserPostBody:
      type: object
      properties:
        user_ids:
          type: array
          items:
            type: string
            format: uuid
          description: GUIDs of users to assign.
      required:
      - user_ids
      description: User IDs to assign to the role.
      additionalProperties: false
    RoleUserDeleteBody:
      type: object
      properties:
        user_ids:
          type: array
          items:
            type: string
            format: uuid
          description: GUIDs of users to remove.
      required:
      - user_ids
      description: User IDs to remove from the role.
      additionalProperties: false
    RoleUserAssignmentResult:
      type: object
      properties:
        user_ids:
          type: array
          items:
            type: string
          description: Current user IDs assigned to the role.
      required:
      - user_ids
      description: The updated set of user IDs assigned to the role after the operation.
      additionalProperties: false
    Region:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Region's name.
          nmls:
            type: string
            description: Region's NMLS ID.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the region was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the region was last updated.
            nullable: true
          address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Region's address.
          logo_url:
            type: string
            description: Region's logo URL.
            nullable: true
          app_icon_url:
            type: string
            description: Region's app icon URL.
            nullable: true
          website_url:
            type: string
            format: http_uri
            description: Region's website.
            nullable: true
          rss_feed_url:
            type: string
            format: http_uri
            description: Region's RSS URL.
            nullable: true
          installation_base_url:
            type: string
            format: http_uri
            description: URL to install the region's app.
            nullable: true
          privacy_policy_url:
            type: string
            format: http_uri
            description: Region's privacy policy URL.
            nullable: true
          borrower_base_url:
            type: string
            format: http_uri
            description: Region's borrower base URL.
            nullable: true
          terms_of_use_url:
            type: string
            format: http_uri
            description: Region's terms of use URL.
            nullable: true
          custom_short_base_url:
            type: string
            format: http_uri
            description: Region's custom URL.
            nullable: true
          consumer_access_url:
            type: string
            format: http_uri
            description: Region's consumer access URL.
            nullable: true
        additionalProperties: false
      description: Region model
    RegionPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Region"
        required:
        - contents
    RegionPostBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Region's name.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Region's address.
        nmls:
          type: string
          minLength: 1
          maxLength: 255
          description: Region's NMLS ID.
          nullable: true
      required:
      - name
      description: Available properties for creating a region.
      additionalProperties: false
    RegionUpdateBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Region's name.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Region's address.
        nmls:
          type: string
          minLength: 1
          maxLength: 255
          description: Region's NMLS ID.
          nullable: true
      description: Available properties for updating a region.
      additionalProperties: false
      minProperties: 1
    ReportPostBody:
      type: object
      properties:
        report_type:
          type: string
          enum:
          - CO_BRANDED_APPS
          - DOCUSIGN_ENVELOPES
          - LOAN_APP_DETAILS
          - LOAN_APPS_COUNT
          - LO_ACTIVITY
          - NPS_FEEDBACK
          - PACKAGE_TRACKER
          - PROSPECTS
          - QR_CODES
          - VERIFICATION_OF_ASSETS_ORDERS
          description: Report type to generate
      required:
      - report_type
      description: Available properties for generating a report.
      additionalProperties: false
    TimeBoundReportPostBody:
      allOf:
      - "$ref": "#/components/schemas/ReportPostBody"
      - type: object
        properties:
          start_date:
            type: string
            format: date
            description: Start date for including records into report
          end_date:
            type: string
            format: date
            description: End date for including records into report
        required:
        - start_date
        - end_date
        additionalProperties: false
      description: |-
        Available properties for generating a time-scoped report.
        Start and end dates can span a time range as large as a year and default to a range covering the last day if both dates aren't provided.
    Report:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          report_type:
            type: string
            description: The report's type.
          report_parameters:
            type: object
            description: The parameters used to generate the report's data.
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the report was created.
        required:
        - report_type
        - report_parameters
        - created_at
        additionalProperties: false
      description: Report model
    Verification:
      allOf:
      - "$ref": "#/components/schemas/AbstractVerification"
      description: Verification model
    VerificationPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Verification"
        required:
        - contents
    VerificationAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - REFRESH_VERIFICATION
          description: Action to perform.
      required:
      - action
      description: Available properties for a verification action
      additionalProperties: false
    RefreshVerification:
      allOf:
      - "$ref": "#/components/schemas/VerificationAction"
      - type: object
        properties:
          days_back:
            type: integer
            description: |-
              Number of days back for which the report will verify.
              Valid values include: 30, 60, 90, 180, 360, 720
        required:
        - days_back
        additionalProperties: false
      description: Available properties for refreshing a verification for a loan borrower.
    StateLicenseTemplateCreateBody:
      type: object
      properties:
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: State license's state.
        message_template:
          type: string
          minLength: 1
          maxLength: 65536
          description: Message template applied to the state license when it is displayed
            to the end user. This field can only be manipulated for company-owned
            templates. Available template placeholders include "{{ license }}", "{{
            license_holder_name }}", "{{ phone }}", "{{ street }}", "{{ city }}",
            "{{ license_state }}", and "{{ state }}".
          example: "{{ license_holder_name }}, {{ street }}, {{ city }}, {{ state
            }} {{ zip }}, Licensed Mortgage Banker NYS Banking Department; {{ license
            }}"
      required:
      - state
      - message_template
      description: Available properties for creating a state license template.
      additionalProperties: false
    StateLicenseTemplateUpdateBody:
      type: object
      properties:
        message_template:
          type: string
          minLength: 1
          maxLength: 65536
          description: Message template applied to the state license when it is displayed
            to the end user. This field can only be manipulated for company-owned
            templates. Available template placeholders include "{{ license }}", "{{
            license_holder_name }}", "{{ phone }}", "{{ street }}", "{{ city }}",
            "{{ license_state }}", and "{{ state }}".
          example: "{{ license_holder_name }}, {{ street }}, {{ city }}, {{ state
            }} {{ zip }}, Licensed Mortgage Banker NYS Banking Department; {{ license
            }}"
        is_active:
          type: boolean
          description: Whether the template is active.
      description: Available properties for updating a state license template.
      additionalProperties: false
      minProperties: 1
    StateLicenseTemplate:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the state license template was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the state license template was last updated.
            nullable: true
          state:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/NationwideCode"
            description: State license's state. If it's "US", the state license is
              considered nationwide.
          message_template:
            type: string
            description: Message template applied to the state license when it is
              displayed to the end user.
            nullable: true
          is_active:
            type: boolean
            description: Whether the template is active.
        additionalProperties: false
      description: State license template record
    StateLicenseTemplatePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/StateLicenseTemplate"
        required:
        - contents
    StateLicense:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the state license was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the state license was last updated.
            nullable: true
          state:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/NationwideCode"
            description: License's state. If it's "US", the state license is considered
              nationwide.
          license_number:
            type: string
            description: State license's number.
          license_message:
            type: string
            description: State license's message when displayed in UI.
            nullable: true
        additionalProperties: false
      description: State license record
    StateLicensePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/StateLicense"
        required:
        - contents
    StateLicenseCreateBody:
      type: object
      properties:
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: State license's state.
        license_number:
          type: string
          minLength: 1
          maxLength: 30
          description: State license's number.
        state_license_template_id:
          type: string
          format: uuid
          description: State license's template ID. IDs can be found by retrieving
            a list of state license templates using the Company State License Template
            endpoints.
      required:
      - state
      - license_number
      description: Available properties for creating a state license.
      additionalProperties: false
    StateLicenseUpdateBody:
      type: object
      properties:
        license_number:
          type: string
          minLength: 1
          maxLength: 30
          description: State license's number.
        state_license_template_id:
          type: string
          format: uuid
          description: State license's template ID. IDs can be found by retrieving
            a list of state license templates using the Company State License Template
            endpoints.
      description: Available properties for updating a state license.
      additionalProperties: false
      minProperties: 1
    LimitedStateLicenseCreateBody:
      type: object
      properties:
        state:
          allOf:
          - "$ref": "#/components/schemas/StateCode"
          description: State license's state.
        license_number:
          type: string
          minLength: 1
          maxLength: 30
          description: State license's number.
      required:
      - state
      - license_number
      description: The limited available properties for creating a state license.
      additionalProperties: false
    LimitedStateLicenseUpdateBody:
      type: object
      properties:
        license_number:
          type: string
          minLength: 1
          maxLength: 30
          description: State license's number.
      description: The limited available properties for updating a state license.
      additionalProperties: false
      minProperties: 1
    StateLicenseEventInfo:
      type: object
      properties:
        state:
          oneOf:
          - "$ref": "#/components/schemas/StateCode"
          - "$ref": "#/components/schemas/NationwideCode"
          description: State license's state.
      required:
      - state
      description: The event info particular to the state license events.
    Alias:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          alias:
            type: string
            description: "<<glossary:Loan officer>>'s <<glossary:alias>>."
        additionalProperties: false
      description: "<<glossary:Alias>> record"
    AliasPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Alias"
        required:
        - contents
    AccountAssignment:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          assignor_type:
            allOf:
            - "$ref": "#/components/schemas/AccountAssignmentType"
            description: Type of entity the relevant account has access to.
          assignor_name:
            type: string
            description: Name of the entity the relevant account has access to.
          assignor_id:
            type: string
            format: uuid
            description: ID of the entity the relevant account has access to.
        required:
        - assignor_type
        - assignor_name
        - assignor_id
        additionalProperties: false
      description: User <<glossary:assignment>> record
    AccountAssignmentPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/AccountAssignment"
        required:
        - contents
    AccountAssignmentCreateBody:
      type: object
      properties:
        assignor_type:
          allOf:
          - "$ref": "#/components/schemas/AccountAssignmentType"
          description: Type of entity the relevant account will have access to.
        assignor_id:
          type: string
          format: uuid
          description: ID of the entity the relevant account will have access to.
      required:
      - assignor_type
      - assignor_id
      description: Available properties for creating an account assignment.
      additionalProperties: false
    AccountAssignmentEventInfo:
      type: object
      properties:
        assignee_type:
          type: string
          description: Type of the account that owns the assignment.
        assignee_name:
          type: string
          description: Name of the account that owns the assignment.
        assignor_type:
          type: string
          description: Type of entity the relevant account has access to.
        assignor_name:
          type: string
          description: Name of the entity the relevant account has access to.
      required:
      - assignee_type
      - assignee_name
      - assignor_type
      - assignor_name
      description: The event info particular to the account assignment events.
    AvailableAssignment:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          assignment_type:
            allOf:
            - "$ref": "#/components/schemas/AccountAssignmentType"
            description: Assignment's type.
          name:
            type: string
            description: Assignment's name.
        additionalProperties: false
      description: Available <<glossary:assignment>> record
    AvailableAssignmentPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/AvailableAssignment"
        required:
        - contents
    UserBorrower:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the borrower record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the borrower record was last updated.
          first_name:
            type: string
            description: Borrower's first name.
          last_name:
            type: string
            description: Borrower's last name.
          email:
            type: string
            description: Borrower's email.
          phone:
            type: string
            description: Borrower's phone.
            nullable: true
          is_active:
            type: boolean
            description: Whether the borrower is active in the system.
          custom_consent:
            type: boolean
            description: Whether the borrower has given custom consent.
        required:
        - first_name
        - last_name
        - email
        additionalProperties: false
      description: Borrower model
    UserBorrowerPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/UserBorrower"
        required:
        - contents
    UserBorrowerPostBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Borrower's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Borrower's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Borrower's email.
        phone:
          type: string
          format: phone
          description: Borrower's phone.
        loan_officer_id:
          type: string
          format: uuid
          description: Loan officer's ID to which the borrower account will be assigned.
            Required unless the "Optional Loan Officer on Borrower Creation" feature
            setting is enabled, in which case the default LO profile will be used
            if it is omitted.
        partner_id:
          type: string
          format: uuid
          description: Partner's ID to which the borrower account will be assigned.
      required:
      - first_name
      - last_name
      - email
      description: Available properties for creating a borrower account.
      additionalProperties: false
    UserBorrowerPatchBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Borrower's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Borrower's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Borrower's email.
        phone:
          type: string
          format: phone
          description: Borrower's phone.
        custom_consent:
          type: boolean
          description: Whether the borrower has opted in to custom consent.
      description: Available properties for updating a borrower account.
      additionalProperties: false
      minProperties: 1
    UserBorrowerAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - SEND_WELCOME_EMAIL
          - REASSIGN_LO
          - ASSIGN_PARTNER
          - REMOVE_PARTNER
          description: Action to perform.
      required:
      - action
      description: Available properties for a borrower account action.
      additionalProperties: false
    SendWelcomeEmailUserBorrower:
      allOf:
      - "$ref": "#/components/schemas/UserBorrowerAction"
      description: Available properties for sending a welcome email to a borrower.
    ReassignLoUserBorrower:
      allOf:
      - "$ref": "#/components/schemas/UserBorrowerAction"
      - type: object
        properties:
          loan_officer_id:
            type: string
            format: uuid
            description: Loan officer's ID to which the borrower account will be reassigned.
          reassign_apps:
            type: boolean
            description: Whether to reassign all existing loan applications to the
              provided loan officer (default is false).
        required:
        - loan_officer_id
        additionalProperties: false
      description: Available properties for reassigning an LO to a borrower account.
    AssignPartnerUserBorrower:
      allOf:
      - "$ref": "#/components/schemas/UserBorrowerAction"
      - type: object
        properties:
          partner_id:
            type: string
            format: uuid
            description: Partner's ID to which the borrower account will be assigned.
        required:
        - partner_id
        additionalProperties: false
      description: Available properties for assigning a partner to a borrower account.
    RemovePartnerUserBorrower:
      allOf:
      - "$ref": "#/components/schemas/UserBorrowerAction"
      description: Available properties for removing a partner from a borrower account.
    AliasCreateBody:
      type: object
      properties:
        alias:
          type: string
          maxLength: 255
          description: Alias value.
      required:
      - alias
      description: Available properties for creating a loan officer alias.
      additionalProperties: false
    LoanOfficerLoanDocTask:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: Task title.
          description:
            type: string
            description: Task description.
            nullable: true
          current_state:
            type: string
            description: Current state.
          loan_id:
            type: string
            format: uuid
            description: ID of the parent loan the task belongs to.
          loan_number:
            type: string
            description: Loan number of the parent loan.
            nullable: true
          borrower_name:
            type: string
            description: Name of the loan borrower the task is assigned to.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the task record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the task record was last updated.
        additionalProperties: false
      description: Loan doc task aggregated at the loan officer level, including parent
        loan context.
    LoanOfficerLoanDocTaskPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanOfficerLoanDocTask"
        required:
        - contents
    LoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the loan officer record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the loan officer record was last updated.
          first_name:
            type: string
            description: Loan officer's first name.
          last_name:
            type: string
            description: Loan officer's last name.
          email:
            type: string
            description: Loan officer's email.
          phone:
            type: string
            description: Loan officer's phone.
            nullable: true
          website:
            type: string
            format: http_uri
            description: Loan officer's website URL (e.g. http://mydomain.com).
            nullable: true
          address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Loan officer's address.
          is_active:
            type: boolean
            description: Whether the loan officer is active in the system.
          nmls:
            type: string
            description: Loan officer's NMLS ID.
            nullable: true
          cost_center:
            type: string
            description: Cost center identifier.
            nullable: true
          is_admin:
            type: boolean
            description: Whether the loan officer is also an org admin.
          third_party:
            allOf:
            - "$ref": "#/components/schemas/ThirdParty"
            description: Loan officer's third party integration information.
          title:
            type: string
            description: Loan officer's title.
            nullable: true
          office_phone:
            type: string
            description: Loan officer's office phone.
            nullable: true
          bio:
            type: string
            description: Loan officer's bio.
            nullable: true
          mobile_url:
            type: string
            format: http_uri
            description: Loan officer's mobile URL.
            nullable: true
          nm_url:
            type: string
            format: http_uri
            description: Loan officer's nCino Mortgage URL.
            nullable: true
          profile_url:
            type: string
            format: http_uri
            description: Loan officer's profile URL.
            nullable: true
          header_url:
            type: string
            format: http_uri
            description: Loan officer's header URL.
            nullable: true
          is_discoverable:
            type: boolean
            description: Whether the Loan officer can be billed.
        required:
        - first_name
        - last_name
        - email
        - address
        additionalProperties: false
      description: Loan officer model
    LoanOfficerPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/LoanOfficer"
        required:
        - contents
    PartnerPostBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Partner's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Partner's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Partner's email.
        mobile_phone:
          type: string
          format: phone
          description: Partner's phone.
          nullable: true
        type:
          type: string
          enum:
          - AGENT
          description: Partner's role type.
        professional_title:
          type: string
          maxLength: 80
          description: Partner's professional title.
          nullable: true
        list_partner_first:
          type: boolean
          description: Whether the partner is listed first.
        is_cobranded:
          type: boolean
          description: Whether the partner is cobranded.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Partner's address.
      required:
      - first_name
      - last_name
      - email
      description: Available properties for creating a <<glossary:loan officer>>'s
        <<glossary:partner>> record.
      additionalProperties: false
    PartnerPatchBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Partner's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Partner's last name.
        mobile_phone:
          type: string
          format: phone
          description: Partner's phone.
          nullable: true
        type:
          type: string
          enum:
          - AGENT
          description: Partner's role type.
        professional_title:
          type: string
          maxLength: 80
          description: Partner's professional title.
          nullable: true
        list_partner_first:
          type: boolean
          description: Whether the partner is listed first.
        is_cobranded:
          type: boolean
          description: Whether the partner is cobranded.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Partner's address.
      description: Available properties for updating a <<glossary:loan officer>>'s
        <<glossary:partner>> record.
      additionalProperties: false
      minProperties: 1
    PartnerAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - SEND_INVITE
          - ENABLE
          - DISABLE
          description: Action to perform.
      required:
      - action
      description: Available properties for a partner action.
      additionalProperties: false
    SendInvitePartner:
      allOf:
      - "$ref": "#/components/schemas/PartnerAction"
      description: Available properties for sending an invite to a partner.
    EnablePartner:
      allOf:
      - "$ref": "#/components/schemas/PartnerAction"
      description: Available properties for enabling a partner.
    DisablePartner:
      allOf:
      - "$ref": "#/components/schemas/PartnerAction"
      description: Available properties for disabling a partner.
    ProspectPostBody:
      type: object
      properties:
        first_name:
          type: string
          maxLength: 100
          description: Prospect's first name.
          nullable: true
        last_name:
          type: string
          maxLength: 100
          description: Prospect's last name.
          nullable: true
        email:
          type: string
          format: email
          maxLength: 255
          description: Prospect's email.
          nullable: true
        cell_phone:
          type: string
          format: phone
          description: Prospect's cell phone.
          nullable: true
        note:
          type: string
          maxLength: 1000
          description: A note regarding the prospect.
          nullable: true
      description: Available properties for creating a <<glossary:loan officer>>'s
        prospect. At least one of email or cell_phone must be supplied.
      additionalProperties: false
    LoanOfficerPostBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Loan officer's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Loan officer's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Loan officer's email.
        phone:
          type: string
          format: phone
          description: Loan officer's phone.
        website:
          type: string
          format: http_uri
          maxLength: 700
          description: Loan officers website URL (e.g. http://mydomain.com).
        address:
          allOf:
          - "$ref": "#/components/schemas/LoanOfficerInputAddress"
          description: Loan officer's address.
        nmls:
          type: string
          maxLength: 255
          description: Loan officer's NMLS ID.
          nullable: true
        cost_center:
          type: string
          maxLength: 255
          description: Cost center identifier.
          nullable: true
        title:
          type: string
          description: Loan officer's title.
          nullable: true
        office_phone:
          type: string
          format: phone
          description: Loan officer's office phone.
          nullable: true
        bio:
          type: string
          maxLength: 700
          description: Loan officer's bio.
          nullable: true
        is_discoverable:
          type: boolean
          description: Whether the loan officer can be billed.
      required:
      - first_name
      - last_name
      - email
      - phone
      - website
      - address
      description: Available properties for creating a <<glossary:loan officer>> record.
      additionalProperties: false
    LoanOfficerPatchBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Loan officer's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Loan officer's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Loan officer's email.
        phone:
          type: string
          format: phone
          description: Loan officer's phone.
        office_phone:
          type: string
          format: phone
          description: Loan officer's office phone.
          nullable: true
        website:
          type: string
          format: http_uri
          maxLength: 700
          description: Loan officer's website URL (e.g. http://mydomain.com).
        nmls:
          type: string
          maxLength: 255
          description: Loan officer's NMLS ID.
          nullable: true
        cost_center:
          type: string
          maxLength: 255
          description: Cost center identifier.
          nullable: true
        title:
          type: string
          description: Loan officer's title.
          nullable: true
        bio:
          type: string
          maxLength: 700
          description: Loan officer's bio.
          nullable: true
        is_discoverable:
          type: boolean
          description: Whether the loan officer can be billed.
        address:
          allOf:
          - "$ref": "#/components/schemas/InputAddress"
          description: Loan officer's address.
        third_party:
          allOf:
          - "$ref": "#/components/schemas/InputThirdParty"
          description: Loan officer's third party integration information.
      description: Available properties for updating a <<glossary:loan officer>> record.
      additionalProperties: false
      minProperties: 1
    LoanOfficerInputAddress:
      allOf:
      - "$ref": "#/components/schemas/InputAddress"
      - type: object
        properties:
          state:
            allOf:
            - "$ref": "#/components/schemas/StateCode"
            description: Loan officer's state.
        required:
        - state
        additionalProperties: false
      description: Available properties for a loan officer's address.
    LoanOfficerAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - PROMOTE
          - DEMOTE
          - ENABLE
          - DISABLE
          - SEND_WELCOME_EMAIL
          - CHANGE_ORG
          description: Action to perform.
      required:
      - action
      description: Available properties for a loan officer action.
      additionalProperties: false
    PromoteLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      description: Available properties for promoting a loan officer.
    DemoteLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      description: Available properties for demoting a loan officer.
    EnableLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      description: Available properties for enabling a loan officer.
    DisableLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      - type: object
        properties:
          borrower_LO_reassignment:
            type: string
            format: uuid
            description: Loan officer's ID to which existing <<glossary:borrower account>>s
              will be reassigned. Default loan officer is used if no ID is provided.
          partner_LO_reassignment:
            type: string
            format: uuid
            description: Loan officer's ID to which existing <<glossary:partner>>s
              will be reassigned. Default loan officer is used if no ID is provided.
        additionalProperties: false
      description: Available properties for disabling a loan officer.
    SendWelcomeEmailLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      description: Available properties for sending a welcome email to a loan officer.
    ChangeOrgLoanOfficer:
      allOf:
      - "$ref": "#/components/schemas/LoanOfficerAction"
      - type: object
        properties:
          org_type:
            type: string
            enum:
            - COMPANY
            - REGION
            - BRANCH
            description: Organization type (<<glossary:COMPANY>>, <<glossary:REGION>>,
              <<glossary:BRANCH>>).
          org_id:
            type: string
            format: uuid
            description: Organization ID.
        required:
        - org_type
        - org_id
        additionalProperties: false
      description: Available properties for changing a loan officer's organization.
    LoanOfficerAdminChangeEventInfo:
      type: object
      properties:
        admin_type:
          type: string
          enum:
          - COMPANY_ADMIN
          - REGION_ADMIN
          - BRANCH_ADMIN
          description: Type of admin to which the loan officer was promoted or from
            which the loan officer was demoted.
        name:
          type: string
          description: Name of the loan officer.
      required:
      - admin_type
      - name
      description: The event info particular to the loan_officer_promoted and loan_officer_demoted
        events.
    Partner:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the partner record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the partner record was last updated.
          first_name:
            type: string
            description: Partner's first name.
          last_name:
            type: string
            description: Partner's last name.
            nullable: true
          email:
            type: string
            maxLength: 255
            description: Partner's email.
          mobile_phone:
            type: string
            description: Partner's phone.
            nullable: true
          address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Partner's address.
          type:
            type: string
            enum:
            - AGENT
            description: Partner's type.
          professional_title:
            type: string
            description: Partner's professional title.
            nullable: true
          list_partner_first:
            type: boolean
            description: Whether the partner is listed first.
          is_cobranded:
            type: boolean
            description: Whether the partner is cobranded.
          photo_url:
            type: string
            description: Partner's photo url.
            nullable: true
          logo_url:
            type: string
            description: Partner's logo url.
            nullable: true
          cobranded_url:
            type: string
            description: Partner's cobranded url.
            nullable: true
          accepted_invite:
            type: boolean
            description: Whether the partner accepted invite.
            nullable: true
        required:
        - first_name
        - email
        additionalProperties: false
      description: Partner model
    PartnerPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Partner"
        required:
        - contents
    UserPermission:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          key:
            type: string
            description: The permission's stable key.
        required:
        - key
        additionalProperties: false
      description: A permission key held by a user, resolved across all of their assigned
        roles.
    UserPermissionPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/UserPermission"
        required:
        - contents
        additionalProperties: false
    UserPermissionGranted:
      type: object
      properties:
        granted:
          type: boolean
          description: "+true+ if the user has the permission across any assigned
            role, +false+ otherwise."
      required:
      - granted
      description: The result of checking whether a user holds a specific permission.
      additionalProperties: false
    Prospect:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          first_name:
            type: string
            description: Prospect's first name.
            nullable: true
          last_name:
            type: string
            description: Prospect's last name.
            nullable: true
          email:
            type: string
            description: Prospect's email.
            nullable: true
          phone:
            type: string
            description: Prospect's phone.
            nullable: true
          sharer_name:
            type: string
            description: Name of the person who shared the prospect.
          note:
            type: string
            description: A note regarding the prospect.
            nullable: true
          is_active:
            type: boolean
            description: Whether or not the prospect record is active.
          created_at:
            type: string
            format: date-time
            description: When the prospect record was created.
            nullable: true
          updated_at:
            type: string
            format: date-time
            description: When the prospect record was last updated.
            nullable: true
        required:
        - first_name
        - last_name
        - email
        - phone
        - sharer_name
        - note
        - is_active
        additionalProperties: false
      description: Prospect model
    ProspectPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/Prospect"
        required:
        - contents
    UserRole:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          name:
            type: string
            description: The role's name.
          description:
            type: string
            description: The role's description.
        required:
        - name
        - description
        additionalProperties: false
      description: A role assigned to a user.
    UserRolePagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/UserRole"
        required:
        - contents
        additionalProperties: false
    TeamMember:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the team member record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the team member record was last updated.
          first_name:
            type: string
            description: Team member's first name.
          last_name:
            type: string
            description: Team member's last name.
          email:
            type: string
            description: Team member's email.
          role:
            allOf:
            - "$ref": "#/components/schemas/TeamMemberRoleType"
            description: Team member's role.
            nullable: true
          phone:
            type: string
            description: Team member's phone.
            nullable: true
          nmls:
            type: string
            description: Team member's NMLS ID.
            nullable: true
          third_party:
            allOf:
            - "$ref": "#/components/schemas/ThirdParty"
            description: Team member's third party integration information.
          is_active:
            type: boolean
            description: Whether the team member is active in the system.
        required:
        - first_name
        - last_name
        - email
        additionalProperties: false
      description: Team member model
    TeamMemberPagination:
      allOf:
      - "$ref": "#/components/schemas/AbstractPagination"
      - type: object
        properties:
          contents:
            type: array
            items:
              "$ref": "#/components/schemas/TeamMember"
        required:
        - contents
    TeamMemberPatchBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Team member's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Team member's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Team member's email.
        phone:
          type: string
          format: phone
          description: Team member's phone.
        role:
          allOf:
          - "$ref": "#/components/schemas/TeamMemberRoleType"
          description: Team member's role type.
        nmls:
          type: string
          maxLength: 255
          description: Team member's NMLS ID.
          nullable: true
        third_party:
          allOf:
          - "$ref": "#/components/schemas/LimitedInputThirdParty"
          description: Team member's third party integration information.
      description: Available properties for updating a team member record.
      additionalProperties: false
      minProperties: 1
    TeamMemberAction:
      type: object
      properties:
        action:
          type: string
          enum:
          - ENABLE
          - DISABLE
          - SEND_WELCOME_EMAIL
          - CHANGE_ORG
          description: Action to perform.
      required:
      - action
      description: Available properties for a team member action.
      additionalProperties: false
    EnableTeamMember:
      allOf:
      - "$ref": "#/components/schemas/TeamMemberAction"
      description: Available properties for enabling a team member.
    DisableTeamMember:
      allOf:
      - "$ref": "#/components/schemas/TeamMemberAction"
      description: Available properties for disabling a team member.
    SendWelcomeEmailTeamMember:
      allOf:
      - "$ref": "#/components/schemas/TeamMemberAction"
      description: Available properties for sending a welcome email to a team member.
    TeamMemberPostBody:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Team member's first name.
        last_name:
          type: string
          minLength: 1
          maxLength: 30
          description: Team member's last name.
        email:
          type: string
          format: email
          maxLength: 255
          description: Team member's email.
        role:
          allOf:
          - "$ref": "#/components/schemas/TeamMemberRoleType"
          description: Team member's role enum key.
        phone:
          type: string
          format: phone
          description: Team member's phone.
          nullable: true
        nmls:
          type: string
          maxLength: 255
          description: Team member's NMLS ID.
          nullable: true
      required:
      - first_name
      - last_name
      - email
      - role
      description: Available properties for creating a team member record.
      additionalProperties: false
    ChangeOrgTeamMember:
      allOf:
      - "$ref": "#/components/schemas/TeamMemberAction"
      - type: object
        properties:
          org_type:
            type: string
            enum:
            - COMPANY
            - REGION
            - BRANCH
            description: Organization type (COMPANY, REGION, BRANCH).
          org_id:
            type: string
            format: uuid
            description: Organization ID.
        required:
        - org_type
        - org_id
        additionalProperties: false
      description: Available properties for changing a team member's organization.
    ThirdParty:
      allOf:
      - "$ref": "#/components/schemas/AbstractModel"
      - type: object
        properties:
          credit_user_id:
            type: string
            description: External user ID for credit orders.
            nullable: true
          los_username:
            type: string
            description: External LOS username.
            nullable: true
          crm_user_id:
            type: string
            description: External user ID for CRM.
            nullable: true
          crm_user_type:
            type: string
            description: External user type for CRM.
            nullable: true
        required:
        - credit_user_id
        - los_username
        additionalProperties: false
      description: Third party data for user
    InputThirdParty:
      type: object
      properties:
        credit_user_id:
          type: string
          maxLength: 255
          description: External user ID for credit orders.
          nullable: true
        los_username:
          type: string
          maxLength: 255
          description: External LOS username.
          nullable: true
        crm_user_id:
          type: string
          maxLength: 255
          description: External user ID for CRM.
          nullable: true
        crm_user_type:
          type: string
          maxLength: 255
          description: External user type for CRM.
          nullable: true
      description: Third party integration data for <<glossary:loan officer>>.
      additionalProperties: false
    LimitedInputThirdParty:
      type: object
      properties:
        credit_user_id:
          type: string
          maxLength: 255
          description: External user ID for credit orders.
          nullable: true
        los_username:
          type: string
          maxLength: 255
          description: External LOS username.
          nullable: true
      description: Third party integration data for team member.
      additionalProperties: false
    UserEventInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of user.
        user_type:
          type: string
          enum:
          - USER_BORROWER
          - COMPANY_ADMIN
          - REGION_ADMIN
          - BRANCH_ADMIN
          - LOAN_OFFICER
          - TEAM_MEMBER
          - PARTNER
          description: Type of user.
      description: The event info shared between user events.
    UserCreatedEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      - type: object
        properties:
          user_borrower:
            type: string
            description: Borrower's name.
      description: The event info particular to the user_created event.
    UserUpdatedEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      description: The event info particular to the user_updated event.
    UserEnabledEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      description: The event info particular to the user_enabled event.
    UserDisabledEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      description: The event info particular to the user_disabled event.
    UserDeletedEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      description: The event info particular to the user_deleted event.
    UserFirstLoginEventInfo:
      allOf:
      - "$ref": "#/components/schemas/UserEventInfo"
      description: The event info particular to the user_first_login event.
    AbstractVerification:
      allOf:
      - "$ref": "#/components/schemas/AbstractResourceModel"
      - type: object
        properties:
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the verification report record was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the verification report record was last
              updated.
          completed_at:
            type: string
            format: date-time
            description: Timestamp of when the verification report was completed.
            nullable: true
          report_type:
            type: string
            description: Verification report's type.
        required:
        - created_at
        - report_type
        additionalProperties: false
      description: Abstract verification model
    VerificationAvailableEventInfo:
      type: object
      properties:
        report_type:
          allOf:
          - "$ref": "#/components/schemas/VerificationReportType"
          description: Type of the report that is available.
      required:
      - report_type
      description: The event info particular to the verification_complete event.
    EmptyString:
      type: string
      enum:
      - ''
      description: An empty string.
    StateCode:
      type: string
      enum:
      - AA
      - AE
      - AK
      - AL
      - AP
      - AR
      - AS
      - AZ
      - CA
      - CO
      - CT
      - DC
      - DE
      - FL
      - FM
      - GA
      - GU
      - HI
      - IA
      - ID
      - IL
      - IN
      - KS
      - KY
      - LA
      - MA
      - MD
      - ME
      - MH
      - MI
      - MN
      - MO
      - MP
      - MS
      - MT
      - NC
      - ND
      - NE
      - NH
      - NJ
      - NM
      - NV
      - NY
      - OH
      - OK
      - OR
      - PA
      - PR
      - PW
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VA
      - VI
      - VT
      - WA
      - WI
      - WV
      - WY
      description: State abbreviated code.
    NationwideCode:
      type: string
      enum:
      - US
      description: Nationwide code.
    LinkType:
      type: string
      enum:
      - FACEBOOK
      - LINKEDIN
      - TWITTER
      - YELP
      - YOUTUBE
      - WEBSITE
      - BLOG
      - HOME_SEARCH
      - LOCAL_DISCOUNTS
      - TRULIA
      - ZILLOW
      - PINTEREST
      - INSTAGRAM
      - PATH_2_OWN
      - PREFLIGHT
      - GET_PREAPPROVED
      - LICENSING
      - INCOME_ANALYSIS
      - LOAN_STATUS
      - LOAN_STATUS_FOR_REALTORS
      - HOME_SEARCH_HOME_SCOUTING
      - FAIRWAY_AMERICAN_WARRIOR_INITIATIVE
      - FAIRWAY_CORE_VALUES_VIDEO
      - FAIRWAY_LOAN_PROGRAMS
      - GET_PREQUALIFIED
      - INFORMATION_ON_THE_LOAN_PROCESS
      - LANCASTER_HOME_GIVEAWAY_VIDEO
      - RAV_ESTIMATE
      - COMPANY_WEBSITE
      - CLIENT_LOGIN
      - APPLY_NOW
      - HOME_INSPECTION
      - PREFERRED_BUILDER
      - CURRENT_RATES
      - MORTGAGE_MARKET_UPDATE
      - DOS_AND_DONTS
      - RD_PROPERTY_ELIGIBILITY
      - DOCUMENT_CHECKLIST
      - ANGIES_LIST
      - STALWART_INSURANCE
      - HOME_VALUE
      - PREFERRED_INSURANCE
      - GET_A_RATE_QUOTE
      - HOUSING_BUZZ_BLOG
      - MY_REVIEWS
      - PREFERRED_MOVING_COMPANY
      - OPEN_HOUSE
      - FIND_A_SCHOOL
      - VIEW_HOMEBUYER_GUIDEBOOK
      - HOME_SEARCH_APP
      - HOME_SEARCH_WEB
      - JOIN_OUR_TEAM
      - MY_LISTINGS
      - SEMINAR_REGISTRATION
      - ABOUT_US
      - WHAT_MY_CLIENTS_ARE_SAYING
      - FEE_NAVIGATOR
      - HOME_SCOUTING_SMARTPHONE_APP
      - PREQUALIFY_NOW
      - HOME_SERVICE_DIRECTORY
      - SATISFACTION_SURVEY
      - OWNING_A_HOME_CFPB
      - PARTNERSHIP_BENEFITS
      - MORTGAGE_REVIEW
      - REFER_A_FRIEND
      - ASK_ME_A_QUESTION
      - LEGAL
      - THE_HOME_BUYING_PROCESS_EXPLAINED
      - WHY_CHOOSE_US
      - ASSET_VERIFICATION
      - HOME_SEARCH_HOME_SCOUT
      - MORTGAGE_COACH
      - IDX_DASHBOARD
      - AGENT_ACCESS_HOME_SEARCH_IDX
      - SCAT_MAN
      - PODCAST
      description: Link type enum key.
    AccountAssignmentType:
      type: string
      enum:
      - BRANCH
      - COMPANY
      - LOAN_OFFICER
      - REGION
      description: Assignment type enum key.
    TeamMemberRoleType:
      type: string
      enum:
      - CLOSER
      - PROCESSOR
      - LOA
      - DISCLOSURE_DESK
      - FUNDER
      - SHIPPER
      - POST_CLOSER
      - ACCOUNT_EXECUTIVE
      description: Team member's role type enum key.
    VerificationReportType:
      type: string
      enum:
      - BOTH
      - DOC_VOI_MORTGAGE
      - DVOE
      - VOA
      - VOAI
      - VOA_HISTORY
      - VOE
      - VOE_MORTGAGE
      - VOE_PAYROLL
      - VOE_TRANSACTIONS
      - VOI
      - VOIE
      - VOIE_MORTGAGE
      - VOIE_PAYROLL
      - VOIE_TX_VERIFY
      description: Types of verification reports.
    VerificationOrderType:
      type: string
      enum:
      - ALL
      - ASSETS
      - EMPLOYMENT
      description: Types of verification orders.
    BankruptcyTypes:
      type: string
      enum:
      - Chapter 7
      - Chapter 11
      - Chapter 12
      - Chapter 13
      description: Types of bankruptcy a borrower declares on an application.
    CitizenshipTypes:
      type: string
      enum:
      - ''
      - U.S. Citizen
      - Permanent Resident Alien
      - Non Permanent Resident Alien
      description: Types of citizenship a borrower declares on an application.
    DomesticRelationshipTypes:
      type: string
      enum:
      - ''
      - Civil Union
      - Domestic Partnership
      - Registered Reciprocal Beneficiary Relationship
      - Other
      description: Types of domestic relationship a borrower declares on an application.
    EmploymentTypes:
      type: string
      enum:
      - ''
      - Self-employed
      - Employed by a business
      - Independent contractor
      description: Types of employment a borrower declares on an application.
    EmploymentStatusTypes:
      type: string
      enum:
      - ''
      - Currently employed
      - Retired
      - Not currently employed
      description: Types of employment status a borrower declares on an application.
    EmploymentOwnershipTypes:
      type: string
      enum:
      - ''
      - I have an ownership share of 25% or more
      - I have an ownership share of less than 25%
      description: Types of employment ownership a borrower declares on an application.
    UnitTypes:
      type: string
      enum:
      - ''
      - Apartment
      - Basement
      - Building
      - Condo
      - Department
      - Floor
      - Front
      - Hangar
      - Key
      - Lobby
      - Lot
      - Lower
      - Office
      - Penthouse
      - Pier
      - Rear
      - Room
      - Side
      - Space
      - Stop
      - Suite
      - Trailer
      - Unit
      - Upper
      description: Types of residence units a borrower declares on an application.
    MilitaryDetailTypes:
      type: string
      enum:
      - Currently serving on active duty
      - Currently retired, discharged, or separated from service
      - Only period of service was a non-activated member of the Reserve or National
        Guard
      - Surviving spouse
      description: Types of military details a borrower declares on an application.
    MilitaryServiceTypes:
      type: string
      enum:
      - ''
      - Regular Military
      - Reserves
      - National Guard
      description: Types of military service a borrower declares on an application.
    OwnResidenceTypes:
      type: string
      enum:
      - ''
      - Own
      - Rent
      - Do not currently pay rent
      description: Types of residential ownership a borrower declares on an application.
    ServiceBranchTypes:
      type: string
      enum:
      - ''
      - Air Force
      - Army
      - Coast Guard
      - Marine
      - Navy
      - Other
      description: Types of service branches a borrower declares on an application.
    EthnicityTypes:
      type: string
      enum:
      - Not Hispanic or Latino
      - Hispanic or Latino
      - Information not provided
      description: Types of ethnicity a borrower declares on an application.
    LatinEthnicityTypes:
      type: string
      enum:
      - Mexican
      - Puerto Rican
      - Cuban
      - Other Hispanic or Latino
      description: Types of latin ethnicity a borrower declares on an application.
    GenderTypes:
      type: string
      enum:
      - Male
      - Female
      - I do not wish to provide this information
      description: Types of gender a borrower declares on an application.
    Languages:
      type: string
      enum:
      - ''
      - English
      - Chinese
      - Korean
      - Spanish
      - Tagalog
      - Vietnamese
      - Other
      - I do not wish to respond
      description: Languages a borrower declares on an application.
    MartialStatuses:
      type: string
      enum:
      - ''
      - Married
      - Separated
      - Unmarried
      description: Martial statuses a borrower declares on an application.
    PacificIslanderOriginTypes:
      type: string
      enum:
      - Native Hawaiian
      - Guamanian or Chamorro
      - Samoan
      - Other Pacific Islander
      description: Types of Pacific Islander origin a borrower declares on an application.
    TitleDeclarationTypes:
      type: string
      enum:
      - ''
      - Sole Ownership
      - Joint With Spouse
      - Joint With Other Than Spouse
      description: Types of title declaration a borrower declares on an application.
    PropertyDeclarationTypes:
      type: string
      enum:
      - ''
      - Sole Ownership
      - Joint With Spouse
      - Joint With Other Than Spouse
      description: Types of property declaration a borrower declares on an application.
    RaceTypes:
      type: string
      enum:
      - American Indian or Alaska Native
      - Asian
      - Black or African American
      - Native Hawaiian or Other Pacific Islander
      - White
      - I do not wish to provide this information
      description: Types of race a borrower declares on an application.
    AsianOriginTypes:
      type: string
      enum:
      - Asian Indian
      - Chinese
      - Filipino
      - Japanese
      - Korean
      - Vietnamese
      - Other Asian
      description: Types of Asian origin a borrower declares on an application.
    Suffixes:
      type: string
      enum:
      - ''
      - Jr.
      - Sr.
      - II
      - III
      - IV
      - V
      description: Suffixes a borrower declares on an application.
    CreditAuthMethods:
      type: string
      enum:
      - ''
      - Phone
      - Face to Face
      - Internet
      - Mail
      description: Methods in which a borrower gives credit authorization on an application.
    DownPaymentSources:
      type: string
      enum:
      - ''
      - Checking/Savings
      - Retirement Funds
      - Gift Funds
      - Stocks And Bonds
      - Net Proceeds From Sale
      - Earnest Money
      - Equity On Subject Property
      - Other Type Of Down Payment
      description: Down payment sources a borrower declares on an application.
    ApplicantTypes:
      type: string
      enum:
      - ''
      - Borrower
      - Co-Borrower
      - Both
      description: Applicant types of a borrower on an application.
    GiftTypes:
      type: string
      enum:
      - ''
      - Gift of Cash
      - Gift of Property Equity
      - Grant
      description: Types of gifts a borrower declares on an application.
    GiftSourceTypes:
      type: string
      enum:
      - ''
      - Community Nonprofit
      - Employer
      - Federal Agency
      - Institutional
      - Lender
      - Local Agency
      - Non Parent Relative
      - Parent
      - Relative
      - Religious Nonprofit
      - State Agency
      - Unrelated Friend
      - Unmarried Partner
      - Other
      description: Sources of gifts a borrower declares on an application.
    LoanPurposeTypes:
      type: string
      enum:
      - ''
      - Purchase
      - Refinance
      - Cash-Out Refinance
      - Construction
      - Home Equity Line of Credit
      - Home Equity Loan
      description: Types of loan purposes a borrower declares on an application.
    OccupancyTypes:
      type: string
      enum:
      - Owner Occupied
      - Non-Owner Occupied
      description: Types of occupancy a borrower declares on an application.
    AdditionalAssetTypes:
      type: string
      enum:
      - ''
      - Automobile (FHA/VA)
      - Boat (FHA/VA)
      - Cash On Hand
      - Net Worth Of Business Owned (FHA/VA)
      - Pending Net Sale Proceeds From Real Estate Assets
      - Proceeds From Sale Of Non Real Estate Asset
      - Proceeds From Secured Loan
      - Proceeds From Unsecured Loan
      - Recreational Vehicle (FHA/VA)
      - Severance Package (FHA/VA)
      - Other
      description: Types of additional assets a borrower declares on an application.
    AdditionalLiabilityTypes:
      type: string
      enum:
      - ''
      - Alimony
      - Child Support
      - Job Related Expenses
      - Separate Maintenance Expense
      - Other
      description: Types of additional liabilities a borrower declares on an application.
    PropertyTypes:
      type: string
      enum:
      - ''
      - Single Family
      - Condo
      - Multi-Unit Property
      - Townhome
      - Cooperative
      - Detached Condo
      - PUD
      - Manufactured Home
      - High Rise Condominium
      description: Types of properties a borrower declares on an application.
    MortgagePropertyTypes:
      type: string
      enum:
      - ''
      - Single Family
      - Condominium
      - Townhouse
      - Cooperative
      - 2 to 4 Units
      - Multi Family
      - Mobile Home
      - Commercial
      - Home And Business Combined
      - Mixed Use
      - Farm
      - Land
      description: Types of mortgage properties a borrower declares on an application.
    MortgagePropertyUsedAsTypes:
      type: string
      enum:
      - ''
      - Primary Residence
      - Second Home
      - Investment Property
      description: How a borrower uses a mortgage property.
    ReferralTypes:
      type: string
      enum:
      - ''
      - Builder
      - Family
      - Friends
      - Internet
      - Realtor
      - Other
      description: Types of referral a borrower declares on an application.
    RefinancePurposeTypes:
      type: string
      enum:
      - ''
      - Cash-Out Debt Consolidation
      - Cash-Out Home Improvement
      - Cash-Out Limited
      - Cash-Out Other
      - Cash-Out Original Lender
      - Change In Rate/Term
      - No Cash-Out Other
      - No Cash-Out FHA Streamlined Refinance
      - No Cash-Out Streamlined Refinance
      - No Cash-Out Original Lender
      description: Types of refinance purposes a borrower declares on an application.
    CreditTypes:
      type: string
      enum:
      - ''
      - Individual Credit
      - Joint Credit
      description: Types of credit a borrower declares on an application.
    PropertyIntendedUseTypes:
      type: string
      enum:
      - ''
      - Primary Residence
      - Secondary Residence
      - Investment
      description: Types of properties a borrower declares they intend to use it for
        on an application.
    CustomFormRequestTypes:
      type: string
      enum:
      - econsent_request
      - credit_auth_request
      - share_info_request
      description: Types of custom form requests.
    LoanDocDefinitionTypes:
      type: string
      enum:
      - null_doc
      - other
      - w2
      - drivers_license
      - paystub
      - bank_statement
      - federal_tax_return
      - divorce_decree
      - '1099'
      - social_security_card
      - dd214
      - k1
      - passport
      - certificate_of_housing_counseling
      description: Types of loan doc definitions.
    DocVendor:
      type: string
      enum:
      - encompass
      description: Doc vendor type enum key.
    OrderType:
      type: string
      enum:
      - opening
      - closing
      - forms
      description: Order type enum key.
    PackageType:
      type: string
      enum:
      - initial
      - closing
      - pre_closing
      - requested_docs
      - sent_docs
      - post_consummation
      - hybrid
      - hybrid_ron
      description: Disclosure package type enum key.
    RecipientRoleType:
      type: string
      enum:
      - additional_contact
      - Appointment of Designee
      - Borrower
      - Builder
      - Buyer's Agent
      - Buyer's Attorney
      - Closer
      - CoBorrower
      - Doc Prep By
      - Escrow Agent
      - Escrow Company
      - Loan Officer
      - Loan Processor
      - One off Doc Recipient
      - Seller's Agent
      - Seller's Attorney
      - Settlement Agent
      - Title Company
      description: Recipient role type enum key.
    JobType:
      type: string
      enum:
      - SYNC_LOAN_APPS
      - VALIDATE_WEBHOOK_URL
      - GENERATE_ORGANIZATION_REPORT
      - DELETE_REGION_BRANCH
      - ORDER_VERIFICATION_REPORT
      - REFRESH_VERIFICATION_REPORTS
      - DISCONNECT_BORROWER
      - SEND_VERIFICATION_REMINDER
      - DELETE_LOAN
      - REASSIGN_BORROWERS_PARTNERS_LOAN_APPS
    JobStatus:
      type: string
      enum:
      - QUEUED
      - STARTED
      - QUEUED_FOR_RETRY
      - COMPLETED
      - FAILED
    NullableJobStatus:
      type: string
      enum:
      - QUEUED
      - STARTED
      - QUEUED_FOR_RETRY
      - COMPLETED
      - FAILED
      -
      nullable: true
    MaritalStatus:
      type: string
      enum:
      - MARRIED
      - SEPARATED
      - UNMARRIED
      - OTHER
      description: Marital status codes.
    WebhookEventName:
      type: string
      enum:
      - account_assignment_created
      - account_assignment_deleted
      - document_created
      - document_updated
      - document_uploaded
      - job_status_changed
      - loan_activated
      - loan_app_abandoned
      - loan_app_imported
      - loan_app_started
      - loan_app_submitted
      - loan_app_updated
      - loan_created
      - loan_deactivated
      - loan_deleted
      - loan_milestone_completed
      - loan_milestone_updated
      - loan_officer_demoted
      - loan_officer_promoted
      - loan_updated
      - milestone_created
      - milestone_deleted
      - milestones_reordered
      - organization_created
      - organization_deleted
      - state_license_created
      - state_license_deleted
      - state_license_updated
      - user_created
      - user_deleted
      - user_disabled
      - user_enabled
      - user_first_login
      - user_updated
      - verification_available
      description: Webhook event name.
    Webhook.Detail:
      allOf:
      - "$ref": "#/components/schemas/Webhook"
      - type: object
        properties:
          secret:
            type: string
            description: Secret used to verify a request made to the webhook URL is
              from a valid source (nCino Mortgage).
      description: Webhook record (Detail)
    Borrower.Preview:
      allOf:
      - "$ref": "#/components/schemas/Borrower"
      - type: object
        properties:
          full_name:
            type: string
            description: Borrower's name.
      description: Borrower model (Preview)
    Borrower.Detail:
      allOf:
      - "$ref": "#/components/schemas/Borrower"
      - type: object
        properties:
          first_name:
            type: string
            description: Borrower's first name.
          middle_name:
            type: string
            description: Borrower's middle name.
            nullable: true
          last_name:
            type: string
            description: Borrower's last name.
          suffix:
            type: string
            description: Borrower's suffix.
            nullable: true
          marital_status:
            allOf:
            - "$ref": "#/components/schemas/MaritalStatus"
            description: Borrower's marital status.
            nullable: true
          dob:
            type: string
            format: date
            description: Borrower's date of birth.
            nullable: true
          cell_phone:
            type: string
            format: phone
            description: Borrower's cell phone.
            nullable: true
          work_phone:
            type: string
            format: phone
            description: Borrower's work phone.
            nullable: true
          home_phone:
            type: string
            format: phone
            description: Borrower's home phone.
            nullable: true
          ssn:
            type: string
            format: ssn
            description: Borrower's SSN.
            nullable: true
          current_address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Borrower's current address.
            nullable: true
          mailing_address:
            allOf:
            - "$ref": "#/components/schemas/Address"
            description: Borrower's mailing address.
            nullable: true
          created_at:
            type: string
            format: date-time
            description: Timestamp of when the borrower was created.
          updated_at:
            type: string
            format: date-time
            description: Timestamp of when the borrower was last updated.
      description: Borrower model (Detail)
    LoanApplication.Detail:
      allOf:
      - "$ref": "#/components/schemas/LoanApplication"
      - type: object
        properties:
          alimony_amount:
            type: integer
            description: Amount of alimony paid by the borrower.
            nullable: true
          asian_origin:
            type: string
            description: Type of Asian origin borrower identifies as.
            nullable: true
          asian_origin_other:
            type: string
            description: Specifies other Asian origin if applicable.
            nullable: true
          assets1:
            type: integer
            description: Checking and savings account(s) amount.
            nullable: true
          assets2:
            type: integer
            description: Additional asset(s) amount.
            nullable: true
          assets_retirement:
            type: integer
            description: Borrower's retirement assets amount.
            nullable: true
          borrower_bankruptcy_types:
            type: array
            items:
              type: string
            description: Types of bankruptcies declared by the borrower.
            nullable: true
          borrower_cell_phone:
            type: string
            format: phone
            description: Borrower's cell phone number.
            nullable: true
          borrower_citizenship_country:
            type: string
            description: Borrower's country of citizenship.
            nullable: true
          borrower_citizenship_status:
            type: string
            description: Borrower's citizenship status.
            nullable: true
          borrower_contact_work_phone:
            type: string
            format: phone
            description: Borrower's work phone number.
            nullable: true
          borrower_conveyed_title_in_lieu_of_forclosure:
            type: boolean
            description: Whether the borrower has conveyed a title in lieu of foreclosure.
            nullable: true
          borrower_domestic_relationship_other:
            type: string
            description: Specifies other domestic relationships for the borrower.
            nullable: true
          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.
            nullable: true
          borrower_domestic_relationship_type:
            type: string
            description: Type of domestic relationship.
            nullable: true
          borrower_family_or_business_affiliation_with_seller:
            type: boolean
            description: Whether borrower has a family or business relationship with
              the seller.
            nullable: true
          borrower_home_phone:
            type: string
            format: phone
            description: Borrower's home phone number.
            nullable: true
          borrower_military_details:
            type: array
            items:
              type: string
            description: Details about the borrower's military service.
            nullable: true
          borrower_military_service:
            type: boolean
            description: Whether the borrower has military service history.
            nullable: true
          borrower_military_service_expiration:
            type: string
            description: Expiration date of borrower's military service if on active
              duty.
            nullable: true
          borrower_mobile_phone:
            type: string
            format: phone
            description: Borrower's mobile phone number.
            nullable: true
          borrower_non_spouse_property_rights:
            type: boolean
            description: Whether the borrower has property rights with a non-spouse.
            nullable: true
          borrower_other_obtained_or_borrowed_money_amount:
            type: integer
            description: Amount of money borrowed or obtained from another source.
            nullable: true
          borrower_other_property_lien:
            type: boolean
            description: Whether borrower has a lien on another property.
            nullable: true
          borrower_other_undisclosed_mortgage_closing_on_or_before:
            type: boolean
            description: Whether borrower has an undisclosed mortgage closing on or
              before a certain date.
            nullable: true
          borrower_other_undisclosed_new_credit:
            type: boolean
            description: Whether borrower has undisclosed new credit.
            nullable: true
          borrower_pre_forclosure_or_short_sale:
            type: boolean
            description: Whether borrower has undergone pre-foreclosure or a short
              sale.
            nullable: true
          borrower_second_employer_still_employed:
            type: boolean
            description: Whether borrower is still employed at their second employer.
            nullable: true
          borrower_share_info_authorization:
            type: boolean
            description: Authorization for borrower information sharing.
            nullable: true
          borrower_two_years_at_current_address:
            type: integer
            description: How long the borrower has lived at the current address.
            nullable: true
          borrower_voe_employment_is_self_employed_1:
            type: boolean
            description: Whether borrower is self-employed in VOE employment.
            nullable: true
          branch_of_service:
            type: string
            description: Borrower's branch of military service.
            nullable: true
          charm_acknowledgments:
            type: boolean
            description: Whether CHARM acknowledgments are signed (e.g. have they
              received a booklet?).
            nullable: true
          co_borrower_verification_of_income_and_employment:
            type: boolean
            description: Whether coborrower’s income and employment verification is
              complete.
            nullable: true
          coborrower_address:
            type: string
            description: Coborrower's address.
            nullable: true
          coborrower_address_same_as_borrower:
            type: boolean
            description: Whether coborrower's address is the same as borrower's.
            nullable: true
          coborrower_asian_origin:
            type: string
            description: Type of Asian origin coborrower identifies as.
            nullable: true
          coborrower_asian_origin_other:
            type: string
            description: Specifies other Asian origin for coborrower.
            nullable: true
          coborrower_bankruptcy_types:
            type: array
            items:
              type: string
            description: "] Types of bankruptcies declared by the coborrower."
            nullable: true
          coborrower_branch_of_service:
            type: string
            description: Coborrower’s branch of military service.
            nullable: true
          coborrower_cell_phone:
            type: string
            format: phone
            description: Coborrower’s cell phone number.
            nullable: true
          coborrower_citizenship_country:
            type: string
            description: Coborrower’s country of citizenship.
            nullable: true
          coborrower_citizenship_status:
            type: string
            description: Coborrower’s citizenship status.
            nullable: true
          coborrower_city:
            type: string
            description: Coborrower’s city.
            nullable: true
          coborrower_contact_work_phone:
            type: string
            format: phone
            description: Coborrower’s work phone number.
            nullable: true
          coborrower_conveyed_title_in_lieu_of_forclosure:
            type: boolean
            description: Whether coborrower has conveyed title in lieu of foreclosure.
            nullable: true
          coborrower_credit_authorization:
            type: boolean
            description: Whether coborrower has authorized credit checks.
            nullable: true
          coborrower_dependents_age:
            type: string
            description: Ages of coborrower’s dependents.
            nullable: true
          coborrower_dob:
            type: string
            description: Coborrower’s date of birth.
            nullable: true
          coborrower_domestic_relationship_other:
            type: string
            description: Specifies other domestic relationships for coborrower.
            nullable: true
          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.
            nullable: true
          coborrower_domestic_relationship_type:
            type: string
            description: Type of domestic relationship for coborrower.
            nullable: true
          coborrower_econsent:
            type: boolean
            description: Whether coborrower has provided eConsent.
            nullable: true
          coborrower_email:
            type: string
            format: email
            description: Coborrower’s email address.
            nullable: true
          coborrower_employer_name:
            type: string
            description: Coborrower’s employer name.
            nullable: true
          coborrower_employer_years:
            type: integer
            description: Number of years coborrower has been with current employer.
            nullable: true
          coborrower_employment_status:
            type: string
            description: Coborrower’s employment status.
            nullable: true
          coborrower_ethnicity:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Coborrower’s ethnicity.
            nullable: true
          coborrower_ethnicity_latino:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Coborrower's type of Hispanic or Latino origin.
            nullable: true
          coborrower_family_or_business_affiliation_with_seller:
            type: boolean
            description: Whether coborrower has an affiliation with the seller.
            nullable: true
          coborrower_first_name:
            type: string
            description: Coborrower’s first name.
            nullable: true
          coborrower_gender:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Coborrower’s gender.
            nullable: true
          coborrower_has_alimony:
            type: boolean
            description: Whether coborrower pays alimony.
            nullable: true
          coborrower_has_bankruptcy:
            type: boolean
            description: Whether coborrower has declared bankruptcy.
            nullable: true
          coborrower_has_delinquent_debt:
            type: boolean
            description: Whether coborrower has delinquent debt.
            nullable: true
          coborrower_has_foreclosure:
            type: boolean
            description: Whether coborrower has had a foreclosure.
            nullable: true
          coborrower_has_obligations:
            type: boolean
            description: Whether coborrower has financial obligations.
            nullable: true
          coborrower_has_outstanding_judgements:
            type: boolean
            description: Whether coborrower has outstanding judgments.
            nullable: true
          coborrower_has_ownership_interest:
            type: boolean
            description: Whether coborrower has ownership interest in a property.
            nullable: true
          coborrower_is_comaker_or_endorser:
            type: boolean
            description: Whether coborrower is a co-maker or endorser on a loan.
            nullable: true
          coborrower_is_down_payment_borrowed:
            type: boolean
            description: Whether coborrower’s down payment is borrowed.
            nullable: true
          coborrower_is_firsttimer:
            type: boolean
            description: Whether coborrower is a first-time homebuyer.
            nullable: true
          coborrower_is_permanent_resident:
            type: boolean
            description: Whether coborrower is a permanent resident.
            nullable: true
          coborrower_is_primary_residence:
            type: boolean
            description: Whether the coborrower will occupy the property as a primary
              residence.
            nullable: true
          coborrower_is_self_employed:
            type: boolean
            description: Whether coborrower is self-employed.
            nullable: true
          coborrower_is_us_citizen:
            type: boolean
            description: Whether coborrower is a U.S. citizen.
            nullable: true
          coborrower_language_preference:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Coborrower’s preferred language.
            nullable: true
          coborrower_language_preference_other:
            type: string
            description: Other language preference specified by coborrower.
            nullable: true
          coborrower_last_name:
            type: string
            description: Coborrower’s last name.
            nullable: true
          coborrower_mailing_address:
            type: string
            description: Coborrower’s mailing street.
            nullable: true
          coborrower_mailing_city:
            type: string
            description: Coborrower’s mailing city.
            nullable: true
          coborrower_mailing_same_as_current:
            type: boolean
            description: Whether coborrower’s mailing address is the same as current.
            nullable: true
          coborrower_mailing_state:
            type: string
            description: Coborrower’s mailing state.
            nullable: true
          coborrower_mailing_unit_number:
            type: string
            description: Coborrower’s mailing unit number.
            nullable: true
          coborrower_mailing_zip:
            type: string
            description: Coborrower’s mailing zip code.
            nullable: true
          coborrower_marital_status:
            type: string
            description: Coborrower’s marital status.
            nullable: true
          coborrower_middle_name:
            type: string
            description: Coborrower’s middle name.
            nullable: true
          coborrower_military_details:
            type: array
            items:
              type: string
            description: Details regarding coborrower’s military service.
            nullable: true
          coborrower_military_service:
            type: boolean
            description: Whether coborrower has military service history.
            nullable: true
          coborrower_military_service_expiration:
            type: string
            description: Expiration date of coborrower’s military service if on active
              duty.
            nullable: true
          coborrower_monthly_income:
            type: integer
            description: Coborrower’s monthly income.
            nullable: true
          coborrower_non_spouse_property_rights:
            type: boolean
            description: Whether coborrower has property rights with a non-spouse.
            nullable: true
          coborrower_number_dependents:
            type: integer
            description: Number of dependents of the coborrower.
            nullable: true
          coborrower_other_hispanic_or_latino_origin:
            type: string
            description: Specifies other Hispanic or Latino origin for coborrower.
            nullable: true
          coborrower_other_obtained_or_borrowed_money_amount:
            type: integer
            description: Amount of money borrowed or obtained from another source
              by coborrower.
            nullable: true
          coborrower_other_property_lien:
            type: boolean
            description: Whether coborrower has a lien on another property.
            nullable: true
          coborrower_other_undisclosed_mortgage_closing_on_or_before:
            type: boolean
            description: Whether coborrower has an undisclosed mortgage closing on
              or before a certain date.
            nullable: true
          coborrower_other_undisclosed_new_credit:
            type: boolean
            description: Whether coborrower has undisclosed new credit.
            nullable: true
          coborrower_pacific_islander:
            type: string
            description: Type of Pacific Islander origin coborrower identifies as.
            nullable: true
          coborrower_pacific_islander_other:
            type: string
            description: Specifies other Pacific Islander origin for coborrower.
            nullable: true
          coborrower_party_to_lawsuit:
            type: boolean
            description: Whether coborrower is a party to a lawsuit.
            nullable: true
          coborrower_pre_forclosure_or_short_sale:
            type: boolean
            description: Whether coborrower has undergone pre-foreclosure or a short
              sale.
            nullable: true
          coborrower_previous_property_title_declaration:
            type: string
            description: Previous property title declaration for coborrower.
            nullable: true
          coborrower_previous_property_type_declaration:
            type: string
            description: Previous property type declaration for coborrower.
            nullable: true
          coborrower_property_months:
            type: integer
            description: Number of months coborrower has owned the property.
            nullable: true
          coborrower_property_own:
            type: string
            description: How the coborrower owns the property.
            nullable: true
          coborrower_property_years:
            type: integer
            description: Number of years coborrower has owned the property.
            nullable: true
          coborrower_provide_demographics:
            type: boolean
            description: Whether the coborrower consented to provide demographic information.
            nullable: true
          coborrower_race:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Coborrower’s race.
            nullable: true
          coborrower_race_asian:
            type: string
            description: Type of Asian origin the coborrower identifies as.
            nullable: true
          coborrower_race_american_indian_other:
            type: string
            description: Specifies other American Indian origin for coborrower.
            nullable: true
          coborrower_rent_payment:
            type: integer
            description: Monthly rent payment by coborrower.
            nullable: true
          coborrower_share_info_authorization:
            type: boolean
            description: Authorization for coborrower’s information sharing.
            nullable: true
          coborrower_ssn:
            type: string
            format: ssn
            description: Coborrower’s Social Security Number.
            nullable: true
          coborrower_state:
            type: string
            description: Coborrower’s state of residence.
            nullable: true
          coborrower_suffix:
            type: string
            description: Coborrower’s name suffix.
            nullable: true
          coborrower_time_same_as_borrower:
            type: boolean
            description: Whether coborrower has the same time at the current address
              as borrower.
            nullable: true
          coborrower_two_years_at_current_address:
            type: integer
            description: How long the coborrower has lived at the current address.
            nullable: true
          coborrower_type_of_service:
            type: string
            description: Type of military service in which the coborrower is involved.
            nullable: true
          coborrower_unit_number:
            type: string
            description: Coborrower’s unit number.
            nullable: true
          coborrower_voe_employment_is_self_employed_1:
            type: boolean
            description: Whether coborrower is self-employed in VOE employment.
            nullable: true
          coborrower_zip:
            type: string
            description: Coborrower’s zip code.
            nullable: true
          credit_auth_method:
            type: string
            description: Method of credit authorization.
            nullable: true
          credit_authorization:
            type: boolean
            description: Authorization for credit check.
            nullable: true
          dependents_age:
            type: string
            description: Ages of dependents.
            nullable: true
          desired_monthly_payment:
            type: integer
            description: Desired monthly payment.
            nullable: true
          down_payment:
            type: integer
            description: Down payment amount.
            nullable: true
          down_payment_amount:
            type: integer
            description: Exact down payment amount.
            nullable: true
          down_payment_pct:
            type: integer
            description: Percentage of down payment.
            nullable: true
          down_payment_source:
            type: string
            description: Source of down payment.
            nullable: true
          econsent:
            type: boolean
            description: Borrower’s electronic consent.
            nullable: true
          employer_address:
            type: string
            description: Employer's street.
            nullable: true
          employer_city:
            type: string
            description: Employer's city.
            nullable: true
          employer_name:
            type: string
            description: Name of employer.
            nullable: true
          employer_state:
            type: string
            description: Employer's state.
            nullable: true
          employer_years:
            type: integer
            description: Years employed at current employer.
            nullable: true
          employer_zip:
            type: string
            description: Employer's zip code.
            nullable: true
          employment_status:
            type: string
            description: Borrower’s employment status.
            nullable: true
          estimated_property_value:
            type: integer
            description: Estimated value of the property.
            nullable: true
          ethnicity:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Borrower’s ethnicity.
            nullable: true
          ethnicity_latino:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Borrower's type of Hispanic or Latino origin.
            nullable: true
          gender:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Borrower’s gender.
            nullable: true
          has_alimony:
            type: boolean
            description: Whether borrower pays alimony.
            nullable: true
          has_bankruptcy:
            type: boolean
            description: Whether borrower has declared bankruptcy.
            nullable: true
          has_delinquent_debt:
            type: boolean
            description: Whether borrower has delinquent debt.
            nullable: true
          has_foreclosure:
            type: boolean
            description: Whether borrower has had a foreclosure.
            nullable: true
          has_obligations:
            type: boolean
            description: Whether borrower has other financial obligations.
            nullable: true
          has_outstanding_judgements:
            type: boolean
            description: Whether borrower has outstanding judgments.
            nullable: true
          has_ownership_interest:
            type: boolean
            description: Whether borrower has ownership interest in a property.
            nullable: true
          is_comaker_or_endorser:
            type: boolean
            description: Whether borrower is a co-maker or endorser.
            nullable: true
          is_down_payment_borrowed:
            type: boolean
            description: Whether down payment is borrowed.
            nullable: true
          is_firsttimer:
            type: boolean
            description: Whether borrower is a first-time homebuyer.
            nullable: true
          is_permanent_resident:
            type: boolean
            description: Whether borrower is a permanent resident.
            nullable: true
          is_primary_residence:
            type: boolean
            description: Whether the borrower will occupy the property as a primary
              residence.
            nullable: true
          is_self_employed:
            type: boolean
            description: Whether borrower is self-employed.
            nullable: true
          is_us_citizen:
            type: boolean
            description: Whether borrower is a U.S. citizen.
            nullable: true
          is_veteran:
            type: boolean
            description: Whether borrower has veteran status.
            nullable: true
          language_preference:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Borrower’s preferred language.
            nullable: true
          language_preference_other:
            type: string
            description: Other language preference specified by borrower.
            nullable: true
          loan_property_info__refinance_info:
            type: string
            description: Loan and refinance information.
            nullable: true
          loan_purpose:
            type: string
            description: Purpose of the loan.
            nullable: true
          mailing_address:
            type: string
            description: Borrower’s mailing address.
            nullable: true
          mailing_city:
            type: string
            description: Borrower’s mailing city.
            nullable: true
          mailing_same_as_current:
            type: boolean
            description: Whether mailing address is the same as current.
            nullable: true
          mailing_state:
            type: string
            description: Borrower’s mailing state.
            nullable: true
          mailing_unit_number:
            type: string
            description: Borrower’s mailing unit number.
            nullable: true
          mailing_zip:
            type: string
            description: Borrower’s mailing zip code.
            nullable: true
          middle_name:
            type: string
            description: Borrower’s middle name.
            nullable: true
          monthly_income:
            type: integer
            description: Borrower’s monthly income.
            nullable: true
          monthly_liabilities:
            type: integer
            description: Borrower’s monthly liabilities.
            nullable: true
          number_dependents:
            type: integer
            description: Number of dependents of the borrower.
            nullable: true
          other_hispanic_or_latino_origin:
            type: string
            description: Specifies other Hispanic or Latino origin.
            nullable: true
          owns_other_property:
            type: boolean
            description: Whether borrower owns another property.
            nullable: true
          pacific_islander:
            type: string
            description: Type of Pacific Islander origin borrower identifies as.
            nullable: true
          pacific_islander_other:
            type: string
            description: Specifies other Pacific Islander origin.
            nullable: true
          party_to_lawsuit:
            type: boolean
            description: Whether borrower is a party to a lawsuit.
            nullable: true
          previous_property_title_declaration:
            type: string
            description: Previous property title declaration.
            nullable: true
          previous_property_type_declaration:
            type: string
            description: Previous property type declaration.
            nullable: true
          property_months:
            type: integer
            description: Number of months borrower has owned the property.
            nullable: true
          property_own:
            type: string
            description: How the borrower owns the property.
            nullable: true
          property_years:
            type: integer
            description: Number of years borrower has owned the property.
            nullable: true
          provide_demographics:
            type: boolean
            description: Whether the borrower consented to provide demographic information.
            nullable: true
          race:
            oneOf:
            - type: string
            - type: array
              items:
                type: string
            description: Borrower’s race.
            nullable: true
          race_asian:
            type: string
            description: Type of Asian origin the borrower identifies as.
            nullable: true
          race_american_indian_other:
            type: string
            description: Specifies other American Indian origin.
            nullable: true
          referral_company_name:
            type: string
            description: Name of the referral company.
            nullable: true
          referral_name:
            type: string
            description: Type of the referral person.
            nullable: true
          refinance_current_address:
            type: string
            description: Current address for refinance.
            nullable: true
          refinance_purpose:
            type: string
            description: Purpose of refinancing.
            nullable: true
          rent_payment:
            type: integer
            description: Monthly rent payment.
            nullable: true
          rental_property_city:
            type: string
            description: City of the rental property.
            nullable: true
          rental_property_state:
            type: string
            description: State of the rental property.
            nullable: true
          rental_property_street:
            type: string
            description: Street address of the rental property.
            nullable: true
          rental_property_unit_number:
            type: string
            description: Unit number of the rental property.
            nullable: true
          rental_property_zip:
            type: string
            description: Zip code of the rental property.
            nullable: true
          school_years:
            type: integer
            description: Number of years borrower attended school.
            nullable: true
          servicer_credit_authorization:
            type: boolean
            description: Whether servicer credit authorization is provided.
            nullable: true
          ssn:
            type: string
            format: ssn
            description: Borrower’s Social Security Number.
            nullable: true
          type_of_credit:
            type: string
            description: Type of credit requested.
            nullable: true
          type_of_property:
            type: string
            description: Type of property being purchased or refinanced.
            nullable: true
          type_of_service:
            type: string
            description: Type of military service in which the borrower is involved.
            nullable: true
          under_contract:
            type: boolean
            description: Whether property is under contract.
            nullable: true
          verification_of_assets:
            type: boolean
            description: Whether borrower’s assets have been verified.
            nullable: true
          verification_of_income_and_employment:
            type: boolean
            description: Whether borrower’s income and employment have been verified.
            nullable: true
          borrower_voe_employment_category_INDEX:
            type: string
            description: Type of employment being verified on the borrower.
            nullable: true
          borrower_voe_employment_ownership_INDEX:
            type: string
            description: Declaration of ownership for employment being verified on
              the borrower.
            nullable: true
          borrower_voe_to_name_INDEX:
            type: string
            description: Name of employer being verified on borrower.
            nullable: true
          borrower_voe_to_address_INDEX:
            type: string
            description: Street of borrower's employer's address.
            nullable: true
          borrower_voe_to_unit_type_INDEX:
            type: string
            description: Unit type of borrower's employer's address.
            nullable: true
          borrower_voe_to_unit_number_INDEX:
            type: string
            description: Unit number of borrower's employer's address.
            nullable: true
          borrower_voe_to_city_INDEX:
            type: string
            description: City borrower's employer resides in.
            nullable: true
          borrower_voe_to_state_INDEX:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state borrower's employer resides in.
            nullable: true
          borrower_voe_to_zip_INDEX:
            type: string
            description: Zip code borrower's employer resides in.
            nullable: true
          borrower_voe_to_phone_INDEX:
            type: string
            format: phone
            description: Phone number for the borrower's employer.
            nullable: true
          borrower_voe_employer_type_INDEX:
            type: string
            description: Position or title borrower holds/held at employer.
            nullable: true
          borrower_voe_employment_date_hired_INDEX:
            type: string
            description: Date the borrower was employed at employer.
            nullable: true
          borrower_voe_employment_is_current_INDEX:
            type: boolean
            description: Whether the borrower is still employer at employer.
            nullable: true
          borrower_voe_employment_date_terminated_INDEX:
            type: string
            description: Date the borrower finished working for employer.
            nullable: true
          borrower_voe_self_employment_monthly_income_INDEX:
            type: integer
            description: Income borrower reports if self-employed.
            nullable: true
          borrower_voe_income_base_pay_INDEX:
            type: integer
            description: Amount of base pay from borrower's employer.
            nullable: true
          borrower_voe_income_base_pay_INDEX_hours:
            type: integer
            description: Amount of base pay hours from borrower's employer.
            nullable: true
          borrower_additional_income_INDEX:
            type: integer
            description: Additional income amount from borrower's employer.
            nullable: true
          borrower_voe_income_overtime_INDEX:
            type: integer
            description: Overtime amount from borrower's employer.
            nullable: true
          borrower_voe_income_commissions_INDEX:
            type: integer
            description: Commissions amount from borrower's employer.
            nullable: true
          borrower_voe_income_bonus_INDEX:
            type: integer
            description: Bonus amount from borrower's employer.
            nullable: true
          borrower_voe_employment_line_of_work_years_INDEX:
            type: integer
            description: Number of years borrower has been in line of work.
            nullable: true
          borrower_voe_employment_line_of_work_months_INDEX:
            type: integer
            description: Number of months borrower has been in line of work.
            nullable: true
          borrower_vor_residence_address_INDEX:
            type: string
            description: Street of residence being verified on borrower.
            nullable: true
          borrower_vor_residence_unit_number_INDEX:
            type: string
            description: Unit number of residence being verified on borrower.
            nullable: true
          borrower_vor_residence_city_INDEX:
            type: string
            description: City of residence being verified on borrower.
            nullable: true
          borrower_vor_residence_state_INDEX:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state of residence being verified on borrower.
            nullable: true
          borrower_vor_residence_zip_INDEX:
            type: string
            description: Zip of residence being verified on borrower.
            nullable: true
          borrower_vor_residence_years_INDEX:
            type: integer
            description: Number of years at residence being verified on borrower.
            nullable: true
          borrower_vor_residence_months_INDEX:
            type: integer
            description: Number of months at residence being verified on borrower.
            nullable: true
          borrower_vor_residence_own_INDEX:
            type: string
            description: Ownership status of residence being verified on borrower.
            nullable: true
          coborrower_voe_employment_category_INDEX:
            type: string
            description: Type of employment being verified on the coborrower.
            nullable: true
          coborrower_voe_employment_ownership_INDEX:
            type: string
            description: Declaration of ownership for employment being verified on
              the coborrower.
            nullable: true
          coborrower_voe_to_name_INDEX:
            type: string
            description: Name of employer being verified on coborrower.
            nullable: true
          coborrower_voe_to_address_INDEX:
            type: string
            description: Street of coborrower's employer's address.
            nullable: true
          coborrower_voe_to_unit_type_INDEX:
            type: string
            description: Unit type of coborrower's employer's address.
            nullable: true
          coborrower_voe_to_unit_number_INDEX:
            type: string
            description: Unit number of coborrower's employer's address.
            nullable: true
          coborrower_voe_to_city_INDEX:
            type: string
            description: City coborrower's employer resides in.
            nullable: true
          coborrower_voe_to_state_INDEX:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state coborrower's employer resides in.
            nullable: true
          coborrower_voe_to_zip_INDEX:
            type: string
            description: Zip code coborrower's employer resides in.
            nullable: true
          coborrower_voe_to_phone_INDEX:
            type: string
            format: phone
            description: Phone number for the coborrower's employer.
            nullable: true
          coborrower_voe_employer_type_INDEX:
            type: string
            description: Position or title coborrower holds/held at employer.
            nullable: true
          coborrower_voe_employment_date_hired_INDEX:
            type: string
            description: Date the coborrower was employed at employer.
            nullable: true
          coborrower_voe_employment_is_current_INDEX:
            type: boolean
            description: Whether the coborrower is still employer at employer.
            nullable: true
          coborrower_voe_employment_date_terminated_INDEX:
            type: string
            description: Date the coborrower finished working for employer.
            nullable: true
          coborrower_voe_self_employment_monthly_income_INDEX:
            type: integer
            description: Income coborrower reports if self-employed.
            nullable: true
          coborrower_voe_income_base_pay_INDEX:
            type: integer
            description: Amount of base pay from coborrower's employer.
            nullable: true
          coborrower_voe_income_base_pay_INDEX_hours:
            type: integer
            description: Amount of base pay hours from coborrower's employer.
            nullable: true
          coborrower_additional_income_INDEX:
            type: integer
            description: Additional income amount from coborrower's employer.
            nullable: true
          coborrower_voe_income_overtime_INDEX:
            type: integer
            description: Overtime amount from coborrower's employer.
            nullable: true
          coborrower_voe_income_commissions_INDEX:
            type: integer
            description: Commissions amount from coborrower's employer.
            nullable: true
          coborrower_voe_income_bonus_INDEX:
            type: integer
            description: Bonus amount from coborrower's employer.
            nullable: true
          coborrower_line_of_work_info_INDEX:
            type: string
            description: Details about coborrower's line of work.
            nullable: true
          coborrower_voe_employment_line_of_work_years_INDEX:
            type: integer
            description: Number of years coborrower has been in line of work.
            nullable: true
          coborrower_voe_employment_line_of_work_months_INDEX:
            type: integer
            description: Number of years coborrower has been in line of work.
            nullable: true
          coborrower_vor_residence_address_INDEX:
            type: string
            description: Street of residence being verified on coborrower.
            nullable: true
          coborrower_vor_residence_unit_number_INDEX:
            type: string
            description: Unit number of residence being verified on coborrower.
            nullable: true
          coborrower_vor_residence_city_INDEX:
            type: string
            description: City of residence being verified on coborrower.
            nullable: true
          coborrower_vor_residence_state_INDEX:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state of residence being verified on coborrower.
            nullable: true
          coborrower_vor_residence_zip_INDEX:
            type: string
            description: Zip of residence being verified on coborrower.
            nullable: true
          coborrower_vor_residence_years_INDEX:
            type: integer
            description: Number of years at residence being verified on borrower.
            nullable: true
          coborrower_vor_residence_months_INDEX:
            type: integer
            description: Number of months at residence being verified on borrower.
            nullable: true
          coborrower_vor_residence_own_INDEX:
            type: string
            description: Ownership status of residence being verified on coborrower.
            nullable: true
          detailed_other_income_INDEX_description:
            type: string
            description: Source of additional income.
            nullable: true
          vod_to_name_INDEX:
            type: string
            description: Financial institution name.
            nullable: true
          vod_for_INDEX:
            type: string
            description: Who is on the account at the financial institution.
            nullable: true
          vod_account_one_type_INDEX:
            type: string
            description: Type of account to be verified.
            nullable: true
          vod_account_one_number_INDEX:
            type: string
            description: Account number to be verified.
            nullable: true
          vod_account_one_market_value_INDEX:
            type: integer
            description: Value of account to be verified.
            nullable: true
          vod_account_two_type_INDEX:
            type: string
            description: Type of account to be verified.
            nullable: true
          vod_account_two_number_INDEX:
            type: string
            description: Account number to be verified.
            nullable: true
          vod_account_two_market_value_INDEX:
            type: integer
            description: Value of account to be verified.
            nullable: true
          vod_account_three_type_INDEX:
            type: string
            description: Type of account to be verified.
            nullable: true
          vod_account_three_number_INDEX:
            type: string
            description: Account number to be verified.
            nullable: true
          vod_account_three_market_value_INDEX:
            type: integer
            description: Value of account to be verified.
            nullable: true
          vod_account_four_type_INDEX:
            type: string
            description: Type of account to be verified.
            nullable: true
          vod_account_four_number_INDEX:
            type: string
            description: Account number to be verified.
            nullable: true
          vod_account_four_market_value_INDEX:
            type: integer
            description: Value of account to be verified.
            nullable: true
          vogg_gift_asset_type_INDEX:
            type: string
            description: Type of gift.
            nullable: true
          vogg_gift_applicant_INDEX:
            type: string
            description: Applicant tied to gift.
            nullable: true
          vogg_gift_deposited_INDEX:
            type: boolean
            description: Whether the gift has been deposited.
            nullable: true
          vogg_gift_amount_INDEX:
            type: integer
            description: Amount of the gift.
            nullable: true
          vogg_gift_source_INDEX:
            type: string
            description: Source of the gift.
            nullable: true
          other_assets_and_credits_type_INDEX:
            type: string
            description: Type of another asset.
            nullable: true
          other_assets_and_credits_value_INDEX:
            type: integer
            description: Value of another asset.
            nullable: true
          other_assets_and_credits_owner_INDEX:
            type: string
            description: Owner of another asset.
            nullable: true
          other_liabilities_and_expenses_type_INDEX:
            type: string
            description: Type of other liability (e.g. Alimony, Child Support).
            nullable: true
          other_liabilities_and_expenses_amount_INDEX:
            type: integer
            description: Amount of other liability.
            nullable: true
          other_liabilities_and_expenses_applicant_INDEX:
            type: string
            description: Applicant tied to liability (e.g. Borrower, Coborrower).
            nullable: true
          vom_address_INDEX:
            type: string
            description: Street of mortgage being verified.
            nullable: true
          vom_unit_number_INDEX:
            type: string
            description: Unit number of mortgage being verified.
            nullable: true
          vom_city_INDEX:
            type: string
            description: City of mortgage being verified.
            nullable: true
          vom_state_INDEX:
            oneOf:
            - "$ref": "#/components/schemas/StateCode"
            - "$ref": "#/components/schemas/EmptyString"
            description: U.S. state of mortgage being verified.
            nullable: true
          vom_zip_INDEX:
            type: string
            description: Zip of mortgage being verified.
            nullable: true
          vom_market_value_INDEX:
            type: integer
            description: Market value of mortgage being verified.
            nullable: true
          vom_mortgage_balance_INDEX:
            type: integer
            description: Balance of mortgage being verified.
            nullable: true
          vom_type_of_property_INDEX:
            type: string
            description: Type of property tied to mortgage being verified.
            nullable: true
          vom_date_acquired_INDEX:
            type: string
            description: Date acquired for mortgage being verified.
            nullable: true
          vom_mortgage_loan_INDEX:
            type: integer
            description: Loan amount of mortgage being verified.
            nullable: true
          vom_mortgage_payment_INDEX:
            type: integer
            description: Payment of mortgage being verified.
            nullable: true
          vom_property_used_as_INDEX:
            type: string
            description: Purpose property is used as for mortgage being verified (e.g.
              Primary Residence, Investment Property).
            nullable: true
          vom_rental_income_INDEX:
            type: integer
            description: Income from property if rented of mortgage being verified.
            nullable: true
          custom_fields:
            type: object
            description: Additional custom fields that are not defined in the standard
              loan application schema.
            nullable: true
      description: Loan application model (Detail)
    LoanApplication.Preview:
      allOf:
      - "$ref": "#/components/schemas/LoanApplication"
      - type: object
        properties:
          has_coborrower:
            type: boolean
            description: Whether application has a coborrower.
            nullable: true
      description: Loan application model (Preview)
    Loan.Preview:
      allOf:
      - "$ref": "#/components/schemas/Loan"
      - type: object
        properties:
          primary_borrower_name:
            type: string
            description: Primary borrower's name.
            nullable: true
          primary_borrower_email:
            type: string
            description: Primary borrower's email.
            nullable: true
      description: Loan model (Preview)
    Loan.Detail:
      allOf:
      - "$ref": "#/components/schemas/Loan"
      - type: object
        properties:
          additional_comments:
            type: string
            description: Additional comments on the loan record.
            nullable: true
          amortization_type:
            type: string
            description: Loan's amortization type.
            nullable: true
          amount_base:
            type: number
            format: float
            description: Loan's base amount.
            nullable: true
          amount_total:
            type: number
            format: float
            description: Loan's total amount.
            nullable: true
          approved_date:
            type: string
            format: date-time
            description: Date on which the loan was approved.
            nullable: true
          apr:
            type: number
            format: float
            description: Loan's annual percentage rate.
            nullable: true
          borrowers:
            type: array
            items:
              "$ref": "#/components/schemas/Borrower.Preview"
            description: List of borrowers on the loan record.
            nullable: true
          debt_to_income_ratio:
            type: number
            format: float
            description: Loan's debt-to-income ratio.
            nullable: true
          doc_signing_date:
            type: string
            format: date-time
            description: Date on which loan documents are signed.
            nullable: true
          down_payment_amount:
            type: number
            format: float
            description: Loan's down payment dollar amount.
            nullable: true
          down_payment_pct:
            type: number
            format: float
            description: Loan's down payment percentage of loan amount.
            nullable: true
          dti_high:
            type: number
            format: float
            description: Loan's debt-to-income ratio high.
            nullable: true
          dti_low:
            type: number
            format: float
            description: Loan's debt-to-income ratio low.
            nullable: true
          first_payment_date:
            type: string
            format: date
            description: Date on which the loan's first payment is due.
            nullable: true
          first_time_buyer:
            type: boolean
            description: Whether the loan is for a first-time buyer.
            nullable: true
          funding_date:
            type: string
            format: date-time
            description: Date on which the loan intends to be funded.
            nullable: true
          intent_to_proceed_at:
            type: string
            format: date-time
            description: Date on which the intent to proceed was acknowledged.
            nullable: true
          intent_to_proceed_letter_sent_date:
            type: string
            format: date-time
            description: Date on which the intent to proceed letter was sent.
            nullable: true
          interest_rate_lock_expires_at:
            type: string
            format: date
            description: Datetime at which the loan's interest rate lock expires.
            nullable: true
          interest_rate:
            type: number
            format: float
            description: Loan's interest rate.
            nullable: true
          lien_position:
            type: string
            description: Loan's lien position.
            nullable: true
          loan_applications:
            type: array
            items:
              "$ref": "#/components/schemas/LoanApplication.Preview"
            description: List of loan applications on the loan record.
            nullable: true
          loan_term_months:
            type: integer
            description: Loan's term in months.
            nullable: true
          maturity_date:
            type: string
            format: date
            description: Date on which the loan reaches maturity.
            nullable: true
          occupancy_status:
            type: string
            description: Loan's occupancy status.
            nullable: true
          p_and_i_payment_amount:
            type: number
            format: float
            description: Loan's principal plus interest payment amount.
            nullable: true
          payment_frequency:
            type: string
            description: Loan's payment frequency.
            nullable: true
          preapproval_amount:
            type: number
            format: float
            description: Loan's preapproval amount.
            nullable: true
          preapproval_notes:
            type: string
            description: Notes on the loan's preapproval.
            nullable: true
          processor_email:
            type: string
            description: Loan processor's email.
            nullable: true
          program:
            type: string
            description: Loan's program.
            nullable: true
          rate_expires_at:
            type: string
            format: date-time
            description: Datetime at which the loan's rate expires.
            nullable: true
          rate_locked:
            type: boolean
            description: Whether the loan's rate is locked.
            nullable: true
          total_monthly_payment_amount:
            type: number
            format: float
            description: Loan's total monthly payment amount.
            nullable: true
      description: Loan model (Detail)
    Property.Detail:
      allOf:
      - "$ref": "#/components/schemas/Property"
      - type: object
        properties:
          appraised_value:
            type: number
            format: float
            description: Property's appraised value.
            nullable: true
          estimated_value:
            type: number
            format: float
            description: Property's estimated value.
            nullable: true
          purchase_price:
            type: number
            format: float
            description: Property's purchase price.
            nullable: true
          number_of_units:
            type: integer
            description: Number of units at property.
            nullable: true
          number_of_stories:
            type: integer
            description: Number of stories at property.
            nullable: true
      description: Property model (Detail)
    Role.Detail:
      allOf:
      - "$ref": "#/components/schemas/Role"
      - type: object
        properties:
          permissions:
            type: array
            items:
              type: string
            description: List of permission keys enabled on the role.
        required:
        - permissions
      description: Role model (Detail)
    JobStatusChangedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              job:
                type: string
            required:
            - job
            example:
              job: "/fake/path/to/job"
          event:
            type: string
            enum:
            - job_status_changed
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/JobStatusChangedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanAppStartedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_application:
                type: string
            required:
            - loan_application
            example:
              loan_application: "/fake/path/to/loan_application"
          event:
            type: string
            enum:
            - loan_app_started
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanApplicationEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanAppUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_application:
                type: string
            required:
            - loan_application
            example:
              loan_application: "/fake/path/to/loan_application"
          event:
            type: string
            enum:
            - loan_app_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanApplicationEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanAppSubmittedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_application:
                type: string
            required:
            - loan_application
            example:
              loan_application: "/fake/path/to/loan_application"
          event:
            type: string
            enum:
            - loan_app_submitted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanApplicationEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanAppImportedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_application:
                type: string
            required:
            - loan_application
            example:
              loan_application: "/fake/path/to/loan_application"
          event:
            type: string
            enum:
            - loan_app_imported
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanApplicationEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanAppAbandonedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_application:
                type: string
            required:
            - loan_application
            example:
              loan_application: "/fake/path/to/loan_application"
          event:
            type: string
            enum:
            - loan_app_abandoned
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanApplicationEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    DocumentUploadedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - document_uploaded
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/DocumentUploadedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    DocumentCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - document_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/DocumentCreatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    DocumentUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - document_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/DocumentUpdatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanMilestoneUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_milestone:
                type: string
            required:
            - loan_milestone
            example:
              loan_milestone: "/fake/path/to/loan_milestone"
          event:
            type: string
            enum:
            - loan_milestone_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanMilestoneUpdatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanMilestoneCompletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_milestone:
                type: string
            required:
            - loan_milestone
            example:
              loan_milestone: "/fake/path/to/loan_milestone"
          event:
            type: string
            enum:
            - loan_milestone_completed
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanMilestoneCompletedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - loan_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - loan_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loans:
                type: string
            required:
            - loans
            example:
              loans: "/fake/path/to/loans"
          event:
            type: string
            enum:
            - loan_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanActivatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - loan_activated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanDeactivatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan:
                type: string
            required:
            - loan
            example:
              loan: "/fake/path/to/loan"
          event:
            type: string
            enum:
            - loan_deactivated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    MilestonesReorderedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              milestones:
                type: string
            required:
            - milestones
            example:
              milestones: "/fake/path/to/milestones"
          event:
            type: string
            enum:
            - milestones_reordered
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/MilestonesReorderedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    MilestoneCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              milestone:
                type: string
            required:
            - milestone
            example:
              milestone: "/fake/path/to/milestone"
          event:
            type: string
            enum:
            - milestone_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/MilestoneCreatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    MilestoneDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              milestones:
                type: string
            required:
            - milestones
            example:
              milestones: "/fake/path/to/milestones"
          event:
            type: string
            enum:
            - milestone_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/MilestoneDeletedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    OrganizationCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              organization:
                type: string
            required:
            - organization
            example:
              organization: "/fake/path/to/organization"
          event:
            type: string
            enum:
            - organization_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/OrganizationCreatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    OrganizationDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              parent_organization:
                type: string
            required:
            - parent_organization
            example:
              parent_organization: "/fake/path/to/parent_organization"
          event:
            type: string
            enum:
            - organization_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/OrganizationDeletedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    StateLicenseCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              state_license:
                type: string
            required:
            - state_license
            example:
              state_license: "/fake/path/to/state_license"
          event:
            type: string
            enum:
            - state_license_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/StateLicenseEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    StateLicenseUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              state_license:
                type: string
            required:
            - state_license
            example:
              state_license: "/fake/path/to/state_license"
          event:
            type: string
            enum:
            - state_license_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/StateLicenseEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    StateLicenseDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              state_licenses:
                type: string
            required:
            - state_licenses
            example:
              state_licenses: "/fake/path/to/state_licenses"
          event:
            type: string
            enum:
            - state_license_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/StateLicenseEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    AccountAssignmentCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              assignment:
                type: string
            required:
            - assignment
            example:
              assignment: "/fake/path/to/assignment"
          event:
            type: string
            enum:
            - account_assignment_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/AccountAssignmentEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    AccountAssignmentDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              assignments:
                type: string
            required:
            - assignments
            example:
              assignments: "/fake/path/to/assignments"
          event:
            type: string
            enum:
            - account_assignment_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/AccountAssignmentEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanOfficerPromotedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_officer:
                type: string
            required:
            - loan_officer
            example:
              loan_officer: "/fake/path/to/loan_officer"
          event:
            type: string
            enum:
            - loan_officer_promoted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanOfficerAdminChangeEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    LoanOfficerDemotedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_officer:
                type: string
            required:
            - loan_officer
            example:
              loan_officer: "/fake/path/to/loan_officer"
          event:
            type: string
            enum:
            - loan_officer_demoted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/LoanOfficerAdminChangeEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserCreatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              user:
                type: string
            required:
            - user
            example:
              user: "/fake/path/to/user"
          event:
            type: string
            enum:
            - user_created
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserCreatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserUpdatedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              user:
                type: string
            required:
            - user
            example:
              user: "/fake/path/to/user"
          event:
            type: string
            enum:
            - user_updated
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserUpdatedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserEnabledWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              user:
                type: string
            required:
            - user
            example:
              user: "/fake/path/to/user"
          event:
            type: string
            enum:
            - user_enabled
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserEnabledEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserDisabledWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              user:
                type: string
            required:
            - user
            example:
              user: "/fake/path/to/user"
          event:
            type: string
            enum:
            - user_disabled
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserDisabledEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserFirstLoginWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              user:
                type: string
            required:
            - user
            example:
              user: "/fake/path/to/user"
          event:
            type: string
            enum:
            - user_first_login
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserFirstLoginEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    UserDeletedWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              loan_officer:
                type: string
            required:
            - loan_officer
            example:
              loan_officer: "/fake/path/to/loan_officer"
          event:
            type: string
            enum:
            - user_deleted
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/UserDeletedEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    VerificationAvailableWebhookRequestBody0:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          _links:
            type: object
            properties:
              verification:
                type: string
            required:
            - verification
            example:
              verification: "/fake/path/to/verification"
          event:
            type: string
            enum:
            - verification_available
            description: Event that triggered the webhook.
          event_info:
            allOf:
            - "$ref": "#/components/schemas/VerificationAvailableEventInfo"
        required:
        - _links
        - event
        - event_info
        additionalProperties: false
    BaseWebhookRequestBody:
      type: object
      properties:
        _id:
          type: string
          format: uuid
          description: Unique identifier for the webhook event.
          example: 00000000-0000-0000-0000-000000000000
        _timestamp:
          type: string
          format: date-time
          description: Timestamp for when the webhook event was triggered.
          example: '1989-08-23T00:00:00+00:00'
      required:
      - _id
      - _timestamp
      additionalProperties: false
    WebhookRequestEvent:
      type: object
      properties: {}
      discriminator:
        propertyName: event
        mapping:
          job_status_changed: "#/components/schemas/JobStatusChangedWebhookRequestBody0"
          loan_app_started: "#/components/schemas/LoanAppStartedWebhookRequestBody0"
          loan_app_updated: "#/components/schemas/LoanAppUpdatedWebhookRequestBody0"
          loan_app_submitted: "#/components/schemas/LoanAppSubmittedWebhookRequestBody0"
          loan_app_imported: "#/components/schemas/LoanAppImportedWebhookRequestBody0"
          loan_app_abandoned: "#/components/schemas/LoanAppAbandonedWebhookRequestBody0"
          document_uploaded: "#/components/schemas/DocumentUploadedWebhookRequestBody0"
          document_created: "#/components/schemas/DocumentCreatedWebhookRequestBody0"
          document_updated: "#/components/schemas/DocumentUpdatedWebhookRequestBody0"
          loan_milestone_updated: "#/components/schemas/LoanMilestoneUpdatedWebhookRequestBody0"
          loan_milestone_completed: "#/components/schemas/LoanMilestoneCompletedWebhookRequestBody0"
          loan_created: "#/components/schemas/LoanCreatedWebhookRequestBody0"
          loan_updated: "#/components/schemas/LoanUpdatedWebhookRequestBody0"
          loan_deleted: "#/components/schemas/LoanDeletedWebhookRequestBody0"
          loan_activated: "#/components/schemas/LoanActivatedWebhookRequestBody0"
          loan_deactivated: "#/components/schemas/LoanDeactivatedWebhookRequestBody0"
          milestones_reordered: "#/components/schemas/MilestonesReorderedWebhookRequestBody0"
          milestone_created: "#/components/schemas/MilestoneCreatedWebhookRequestBody0"
          milestone_deleted: "#/components/schemas/MilestoneDeletedWebhookRequestBody0"
          organization_created: "#/components/schemas/OrganizationCreatedWebhookRequestBody0"
          organization_deleted: "#/components/schemas/OrganizationDeletedWebhookRequestBody0"
          state_license_created: "#/components/schemas/StateLicenseCreatedWebhookRequestBody0"
          state_license_updated: "#/components/schemas/StateLicenseUpdatedWebhookRequestBody0"
          state_license_deleted: "#/components/schemas/StateLicenseDeletedWebhookRequestBody0"
          account_assignment_created: "#/components/schemas/AccountAssignmentCreatedWebhookRequestBody0"
          account_assignment_deleted: "#/components/schemas/AccountAssignmentDeletedWebhookRequestBody0"
          loan_officer_promoted: "#/components/schemas/LoanOfficerPromotedWebhookRequestBody0"
          loan_officer_demoted: "#/components/schemas/LoanOfficerDemotedWebhookRequestBody0"
          user_created: "#/components/schemas/UserCreatedWebhookRequestBody0"
          user_updated: "#/components/schemas/UserUpdatedWebhookRequestBody0"
          user_enabled: "#/components/schemas/UserEnabledWebhookRequestBody0"
          user_disabled: "#/components/schemas/UserDisabledWebhookRequestBody0"
          user_first_login: "#/components/schemas/UserFirstLoginWebhookRequestBody0"
          user_deleted: "#/components/schemas/UserDeletedWebhookRequestBody0"
          verification_available: "#/components/schemas/VerificationAvailableWebhookRequestBody0"
      oneOf:
      - "$ref": "#/components/schemas/JobStatusChangedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanAppStartedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanAppUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanAppSubmittedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanAppImportedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanAppAbandonedWebhookRequestBody0"
      - "$ref": "#/components/schemas/DocumentUploadedWebhookRequestBody0"
      - "$ref": "#/components/schemas/DocumentCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/DocumentUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanMilestoneUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanMilestoneCompletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanActivatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanDeactivatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/MilestonesReorderedWebhookRequestBody0"
      - "$ref": "#/components/schemas/MilestoneCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/MilestoneDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/OrganizationCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/OrganizationDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/StateLicenseCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/StateLicenseUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/StateLicenseDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/AccountAssignmentCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/AccountAssignmentDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanOfficerPromotedWebhookRequestBody0"
      - "$ref": "#/components/schemas/LoanOfficerDemotedWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserCreatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserUpdatedWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserEnabledWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserDisabledWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserFirstLoginWebhookRequestBody0"
      - "$ref": "#/components/schemas/UserDeletedWebhookRequestBody0"
      - "$ref": "#/components/schemas/VerificationAvailableWebhookRequestBody0"
      additionalProperties: false
    WebhookRequestBody:
      allOf:
      - "$ref": "#/components/schemas/BaseWebhookRequestBody"
      - type: object
        properties:
          events:
            type: array
            items:
              "$ref": "#/components/schemas/WebhookRequestEvent"
            minItems: 1
            description: An array of events that have been triggered.
        required:
        - events
        additionalProperties: false
    JobStatusChangedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - job_status_changed
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/JobStatusChangedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'job_status_changed' event.
      additionalProperties: false
    LoanAppStartedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_started
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanApplicationEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_started' event.
      additionalProperties: false
    LoanAppUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanApplicationEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_updated' event.
      additionalProperties: false
    LoanAppSubmittedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_submitted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanApplicationEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_submitted' event.
      additionalProperties: false
    LoanAppImportedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_imported
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanApplicationEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_imported' event.
      additionalProperties: false
    LoanAppAbandonedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_abandoned
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanApplicationEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_abandoned' event.
      additionalProperties: false
    DocumentUploadedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - document_uploaded
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/DocumentUploadedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'document_uploaded' event.
      additionalProperties: false
    DocumentCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - document_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/DocumentCreatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'document_created' event.
      additionalProperties: false
    DocumentUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - document_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/DocumentUpdatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'document_updated' event.
      additionalProperties: false
    LoanMilestoneUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_milestone_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanMilestoneUpdatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_milestone_updated' event.
      additionalProperties: false
    LoanMilestoneCompletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_milestone_completed
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanMilestoneCompletedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_milestone_completed' event.
      additionalProperties: false
    LoanCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_created' event.
      additionalProperties: false
    LoanUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_updated' event.
      additionalProperties: false
    LoanDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_deleted' event.
      additionalProperties: false
    LoanActivatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_activated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_activated' event.
      additionalProperties: false
    LoanDeactivatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_deactivated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_deactivated' event.
      additionalProperties: false
    MilestonesReorderedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - milestones_reordered
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/MilestonesReorderedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'milestones_reordered' event.
      additionalProperties: false
    MilestoneCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - milestone_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/MilestoneCreatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'milestone_created' event.
      additionalProperties: false
    MilestoneDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - milestone_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/MilestoneDeletedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'milestone_deleted' event.
      additionalProperties: false
    OrganizationCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - organization_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/OrganizationCreatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'organization_created' event.
      additionalProperties: false
    OrganizationDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - organization_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/OrganizationDeletedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'organization_deleted' event.
      additionalProperties: false
    StateLicenseCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - state_license_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/StateLicenseEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'state_license_created' event.
      additionalProperties: false
    StateLicenseUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - state_license_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/StateLicenseEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'state_license_updated' event.
      additionalProperties: false
    StateLicenseDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - state_license_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/StateLicenseEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'state_license_deleted' event.
      additionalProperties: false
    AccountAssignmentCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - account_assignment_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/AccountAssignmentEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'account_assignment_created'
        event.
      additionalProperties: false
    AccountAssignmentDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - account_assignment_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/AccountAssignmentEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'account_assignment_deleted'
        event.
      additionalProperties: false
    LoanOfficerPromotedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_officer_promoted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanOfficerAdminChangeEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_officer_promoted' event.
      additionalProperties: false
    LoanOfficerDemotedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_officer_demoted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/LoanOfficerAdminChangeEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_officer_demoted' event.
      additionalProperties: false
    UserCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserCreatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_created' event.
      additionalProperties: false
    UserUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserUpdatedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_updated' event.
      additionalProperties: false
    UserEnabledTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_enabled
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserEnabledEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_enabled' event.
      additionalProperties: false
    UserDisabledTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_disabled
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserDisabledEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_disabled' event.
      additionalProperties: false
    UserFirstLoginTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_first_login
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserFirstLoginEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_first_login' event.
      additionalProperties: false
    UserDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/UserDeletedEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_deleted' event.
      additionalProperties: false
    VerificationAvailableTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - verification_available
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - "$ref": "#/components/schemas/VerificationAvailableEventInfo"
      required:
      - event
      - event_info
      description: Available properties for testing a 'verification_available' event.
      additionalProperties: false
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 Access Token (Default)
      flows:
        clientCredentials:
          tokenUrl: "/oauth/token"
          scopes: {}