Skip to main content
GET
Get Borrower

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

fields
string

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.

Response

Response for status 200

id
string
required
name
string

Present unless the request's fields leaves it out.

taxId
string

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

addresses
object[]

Present unless the request's fields leaves it out.

emails
object[]

Present unless the request's fields leaves it out.

phones
object[]

Present unless the request's fields leaves it out.

bio
any

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

nameFirst
string | null

Present unless the request's fields leaves it out.

nameMiddle
string | null

Present unless the request's fields leaves it out.

nameLast
string | null

Present unless the request's fields leaves it out.

nameSuffix
string | null

Present unless the request's fields leaves it out.

dateOfBirth
string | null

Present unless the request's fields leaves it out.

citizenshipType
string | null

Present unless the request's fields leaves it out.

maritalStatus
string | null

Present unless the request's fields leaves it out.

dependentCount
number | null

Present unless the request's fields leaves it out.

creditType
string | null

Present unless the request's fields leaves it out.

jointBorrowerCount
number | null

Present unless the request's fields leaves it out.

dependentAges
number[] | null

Present unless the request's fields leaves it out.

alternateNames
object[] | null

Present unless the request's fields leaves it out.

residences
object[] | null

Present unless the request's fields leaves it out.

employment
object[] | null

Present unless the request's fields leaves it out.

otherIncomeSources
object[] | null

Present unless the request's fields leaves it out.

declarations
object | null

Present unless the request's fields leaves it out.

militaryService
object | null

Present unless the request's fields leaves it out.

demographics
object | null

Present unless the request's fields leaves it out.

unmarriedAddendum
object | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.