> ## Documentation Index
> Fetch the complete documentation index at: https://rollout.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Borrower

> Requires `borrowers: true` in the credential's `entitiesToSync` selection and a connector that supports this operation. [Choose what data to sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout), or [fix an entity that is not configured to sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).



## OpenAPI

````yaml /openapi/los.json put /borrowers/{id}
openapi: 3.1.2
info:
  title: Universal LOS API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://los.universal.rollout.com/api
security: []
paths:
  /borrowers/{id}:
    put:
      tags:
        - Borrowers
      summary: Update Borrower
      description: >-
        Requires `borrowers: true` in the credential's `entitiesToSync`
        selection and a connector that supports this operation. [Choose what
        data to
        sync](https://rollout.com/docs/advanced-guides/controlling-which-records-sync-with-rollout),
        or [fix an entity that is not configured to
        sync](https://rollout.com/docs/troubleshooting/entity-not-configured-to-sync).
      operationId: putBorrowersById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: fields
          in: query
          required: false
          schema:
            type: string
            description: >-
              Comma-separated top-level fields to return; the parameter can also
              be repeated, once per field. `id` is always returned. Omit it, or
              pass `allFields`, to get every field, including `original`.
              Unknown names return 400.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                name:
                  type: string
                type:
                  type: string
                phones:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                addresses:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      street:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      code:
                        type: string
                      county:
                        type: string
                      country:
                        type: string
                    required:
                      - type
                      - street
                      - city
                      - state
                      - code
                      - country
                taxId:
                  type: string
                bio:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    anyOf:
                      - anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                      - type: 'null'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                name:
                  type: string
                type:
                  type: string
                phones:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                addresses:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      street:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      code:
                        type: string
                      county:
                        type: string
                      country:
                        type: string
                    required:
                      - type
                      - street
                      - city
                      - state
                      - code
                      - country
                taxId:
                  type: string
                bio:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    anyOf:
                      - anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                      - type: 'null'
          multipart/form-data:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                name:
                  type: string
                type:
                  type: string
                phones:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                        minLength: 1
                      type:
                        type: string
                      status:
                        type: string
                      isPrimary:
                        type:
                          - boolean
                          - 'null'
                    required:
                      - value
                      - type
                      - status
                      - isPrimary
                addresses:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      street:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      code:
                        type: string
                      county:
                        type: string
                      country:
                        type: string
                    required:
                      - type
                      - street
                      - city
                      - state
                      - code
                      - country
                taxId:
                  type: string
                bio:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    anyOf:
                      - anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                      - type: 'null'
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  taxId:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  type:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                  addresses:
                    description: Present unless the request's `fields` leaves it out.
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        code:
                          type: string
                        county:
                          type: string
                        country:
                          type: string
                      required:
                        - type
                        - street
                        - city
                        - state
                        - code
                        - country
                  emails:
                    description: Present unless the request's `fields` leaves it out.
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        type:
                          type: string
                        status:
                          type: string
                        isPrimary:
                          type:
                            - boolean
                            - 'null'
                        relationshipId:
                          type: number
                      required:
                        - value
                        - type
                        - status
                        - isPrimary
                  phones:
                    description: Present unless the request's `fields` leaves it out.
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        type:
                          type: string
                        status:
                          type: string
                        isPrimary:
                          type:
                            - boolean
                            - 'null'
                      required:
                        - value
                        - type
                        - status
                        - isPrimary
                  bio:
                    description: Present unless the request's `fields` leaves it out.
                  created:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                    format: date-time
                  updated:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                    format: date-time
                  nameFirst:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  nameMiddle:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  nameLast:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  nameSuffix:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  dateOfBirth:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                    format: date-time
                  citizenshipType:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  maritalStatus:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  dependentCount:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - number
                      - 'null'
                  creditType:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - string
                      - 'null'
                  jointBorrowerCount:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - number
                      - 'null'
                  dependentAges:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - array
                      - 'null'
                    items:
                      type: number
                  alternateNames:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        first:
                          type:
                            - string
                            - 'null'
                        middle:
                          type:
                            - string
                            - 'null'
                        last:
                          type:
                            - string
                            - 'null'
                        suffix:
                          type:
                            - string
                            - 'null'
                  residences:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        type:
                          type:
                            - string
                            - 'null'
                        address:
                          type:
                            - object
                            - 'null'
                          properties:
                            type:
                              type: string
                            street:
                              type: string
                            city:
                              type: string
                            state:
                              type: string
                            code:
                              type: string
                            county:
                              type: string
                            country:
                              type: string
                          required:
                            - type
                            - street
                            - city
                            - state
                            - code
                            - country
                        durationMonths:
                          type:
                            - number
                            - 'null'
                        housingType:
                          type:
                            - string
                            - 'null'
                        monthlyRent:
                          type:
                            - number
                            - 'null'
                  employment:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        employer:
                          type:
                            - string
                            - 'null'
                        position:
                          type:
                            - string
                            - 'null'
                        startDate:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        endDate:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        isCurrent:
                          type:
                            - boolean
                            - 'null'
                        selfEmployed:
                          type:
                            - boolean
                            - 'null'
                        ownershipShare:
                          type:
                            - number
                            - 'null'
                        monthlyIncome:
                          type:
                            - object
                            - 'null'
                          properties:
                            base:
                              type:
                                - number
                                - 'null'
                            overtime:
                              type:
                                - number
                                - 'null'
                            bonus:
                              type:
                                - number
                                - 'null'
                            commission:
                              type:
                                - number
                                - 'null'
                            other:
                              type:
                                - number
                                - 'null'
                  otherIncomeSources:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        source:
                          type:
                            - string
                            - 'null'
                        monthlyAmount:
                          type:
                            - number
                            - 'null'
                  declarations:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - object
                      - 'null'
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  militaryService:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - object
                      - 'null'
                    properties:
                      servedInMilitary:
                        type:
                          - boolean
                          - 'null'
                      currentlyServing:
                        type:
                          - boolean
                          - 'null'
                      status:
                        type:
                          - string
                          - 'null'
                      expirationDate:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      survivingSpouse:
                        type:
                          - boolean
                          - 'null'
                  demographics:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - object
                      - 'null'
                    properties:
                      ethnicity:
                        type:
                          - array
                          - 'null'
                        items:
                          type: string
                      hispanicOrigin:
                        type:
                          - string
                          - 'null'
                      sex:
                        type:
                          - string
                          - 'null'
                      race:
                        type:
                          - array
                          - 'null'
                        items:
                          type: string
                      raceDetail:
                        type:
                          - string
                          - 'null'
                      visualObservation:
                        type:
                          - object
                          - 'null'
                        properties:
                          ethnicity:
                            type:
                              - boolean
                              - 'null'
                          sex:
                            type:
                              - boolean
                              - 'null'
                          race:
                            type:
                              - boolean
                              - 'null'
                      collectionMethod:
                        type:
                          - string
                          - 'null'
                  unmarriedAddendum:
                    description: Present unless the request's `fields` leaves it out.
                    type:
                      - object
                      - 'null'
                    properties:
                      hasSpousalRights:
                        type:
                          - boolean
                          - 'null'
                      relationshipType:
                        type:
                          - string
                          - 'null'
                      state:
                        type:
                          - string
                          - 'null'
                      explanation:
                        type:
                          - string
                          - 'null'
                  personId:
                    description: >-
                      The universal id of the person this borrower is, when the
                      source has contacts as well as loan applications; null
                      otherwise. Present unless the request's `fields` leaves it
                      out.
                    type:
                      - string
                      - 'null'
                  rolloutUpdated:
                    description: Present unless the request's `fields` leaves it out.
                    type: string
                    format: date-time
                  originalIds:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type:
                        - number
                        - string
                  original:
                    description: Present unless the request's `fields` leaves it out.
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties: {}
                required:
                  - id
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - RESOURCE_NOT_FOUND
                      - RESOURCE_DELETED_UPSTREAM
                  errorMessage:
                    type: string
                required:
                  - code
                  - errorMessage
        '423':
          description: >-
            423 Locked — the credential is temporarily frozen by an operator.
            Reads still work; POST/PATCH/PUT/DELETE are rejected until it is
            unfrozen. Unlike 424 (invalid credential), do not re-authenticate —
            retry later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                      required:
                        - message
                required:
                  - errors
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.