List Borrowers
curl --request GET \
--url https://los.universal.rollout.com/api/borrowers \
--header 'Authorization: Bearer <token>' \
--header 'X-Rollout-Credential-Id: <api-key>'import requests
url = "https://los.universal.rollout.com/api/borrowers"
headers = {
"Authorization": "Bearer <token>",
"X-Rollout-Credential-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'X-Rollout-Credential-Id': '<api-key>'}
};
fetch('https://los.universal.rollout.com/api/borrowers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://los.universal.rollout.com/api/borrowers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Rollout-Credential-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://los.universal.rollout.com/api/borrowers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Rollout-Credential-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://los.universal.rollout.com/api/borrowers")
.header("Authorization", "Bearer <token>")
.header("X-Rollout-Credential-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://los.universal.rollout.com/api/borrowers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Rollout-Credential-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"collection": "borrowers",
"offset": 123,
"limit": 123,
"total": 123,
"next": "<string>",
"nextLink": "<string>"
},
"borrowers": [
{
"id": "<string>",
"name": "<string>",
"taxId": "<string>",
"type": "<string>",
"addresses": [
{
"type": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"code": "<string>",
"country": "<string>",
"county": "<string>"
}
],
"emails": [
{
"value": "<string>",
"type": "<string>",
"status": "<string>",
"isPrimary": true,
"relationshipId": 123
}
],
"phones": [
{
"value": "<string>",
"type": "<string>",
"status": "<string>",
"isPrimary": true
}
],
"bio": "<unknown>",
"created": "<string>",
"updated": "<string>",
"nameFirst": "<string>",
"nameMiddle": "<string>",
"nameLast": "<string>",
"nameSuffix": "<string>",
"dateOfBirth": "<string>",
"citizenshipType": "<string>",
"maritalStatus": "<string>",
"dependentCount": 123,
"creditType": "<string>",
"jointBorrowerCount": 123,
"dependentAges": [
123
],
"alternateNames": [
{
"first": "<string>",
"middle": "<string>",
"last": "<string>",
"suffix": "<string>"
}
],
"residences": [
{
"type": "<string>",
"address": {
"type": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"code": "<string>",
"country": "<string>",
"county": "<string>"
},
"durationMonths": 123,
"housingType": "<string>",
"monthlyRent": 123
}
],
"employment": [
{
"employer": "<string>",
"position": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"isCurrent": true,
"selfEmployed": true,
"ownershipShare": 123,
"monthlyIncome": {
"base": 123,
"overtime": 123,
"bonus": 123,
"commission": 123,
"other": 123
}
}
],
"otherIncomeSources": [
{
"source": "<string>",
"monthlyAmount": 123
}
],
"declarations": {},
"militaryService": {
"servedInMilitary": true,
"currentlyServing": true,
"status": "<string>",
"expirationDate": "<string>",
"survivingSpouse": true
},
"demographics": {
"ethnicity": [
"<string>"
],
"hispanicOrigin": "<string>",
"sex": "<string>",
"race": [
"<string>"
],
"raceDetail": "<string>",
"visualObservation": {
"ethnicity": true,
"sex": true,
"race": true
},
"collectionMethod": "<string>"
},
"unmarriedAddendum": {
"hasSpousalRights": true,
"relationshipType": "<string>",
"state": "<string>",
"explanation": "<string>"
},
"rolloutUpdated": "<string>",
"originalIds": {},
"original": {}
}
]
}{
"errorMessage": "<string>"
}{
"errorMessage": "Data for this credential is not ready yet. Please try again."
}Borrowers
List Borrowers
Requires borrowers: true in the credential’s entitiesToSync selection and a connector that supports this operation. Choose what data to sync, or fix an entity that is not configured to sync.
GET
/
borrowers
List Borrowers
curl --request GET \
--url https://los.universal.rollout.com/api/borrowers \
--header 'Authorization: Bearer <token>' \
--header 'X-Rollout-Credential-Id: <api-key>'import requests
url = "https://los.universal.rollout.com/api/borrowers"
headers = {
"Authorization": "Bearer <token>",
"X-Rollout-Credential-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'X-Rollout-Credential-Id': '<api-key>'}
};
fetch('https://los.universal.rollout.com/api/borrowers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://los.universal.rollout.com/api/borrowers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Rollout-Credential-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://los.universal.rollout.com/api/borrowers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Rollout-Credential-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://los.universal.rollout.com/api/borrowers")
.header("Authorization", "Bearer <token>")
.header("X-Rollout-Credential-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://los.universal.rollout.com/api/borrowers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Rollout-Credential-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"collection": "borrowers",
"offset": 123,
"limit": 123,
"total": 123,
"next": "<string>",
"nextLink": "<string>"
},
"borrowers": [
{
"id": "<string>",
"name": "<string>",
"taxId": "<string>",
"type": "<string>",
"addresses": [
{
"type": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"code": "<string>",
"country": "<string>",
"county": "<string>"
}
],
"emails": [
{
"value": "<string>",
"type": "<string>",
"status": "<string>",
"isPrimary": true,
"relationshipId": 123
}
],
"phones": [
{
"value": "<string>",
"type": "<string>",
"status": "<string>",
"isPrimary": true
}
],
"bio": "<unknown>",
"created": "<string>",
"updated": "<string>",
"nameFirst": "<string>",
"nameMiddle": "<string>",
"nameLast": "<string>",
"nameSuffix": "<string>",
"dateOfBirth": "<string>",
"citizenshipType": "<string>",
"maritalStatus": "<string>",
"dependentCount": 123,
"creditType": "<string>",
"jointBorrowerCount": 123,
"dependentAges": [
123
],
"alternateNames": [
{
"first": "<string>",
"middle": "<string>",
"last": "<string>",
"suffix": "<string>"
}
],
"residences": [
{
"type": "<string>",
"address": {
"type": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"code": "<string>",
"country": "<string>",
"county": "<string>"
},
"durationMonths": 123,
"housingType": "<string>",
"monthlyRent": 123
}
],
"employment": [
{
"employer": "<string>",
"position": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"isCurrent": true,
"selfEmployed": true,
"ownershipShare": 123,
"monthlyIncome": {
"base": 123,
"overtime": 123,
"bonus": 123,
"commission": 123,
"other": 123
}
}
],
"otherIncomeSources": [
{
"source": "<string>",
"monthlyAmount": 123
}
],
"declarations": {},
"militaryService": {
"servedInMilitary": true,
"currentlyServing": true,
"status": "<string>",
"expirationDate": "<string>",
"survivingSpouse": true
},
"demographics": {
"ethnicity": [
"<string>"
],
"hispanicOrigin": "<string>",
"sex": "<string>",
"race": [
"<string>"
],
"raceDetail": "<string>",
"visualObservation": {
"ethnicity": true,
"sex": true,
"race": true
},
"collectionMethod": "<string>"
},
"unmarriedAddendum": {
"hasSpousalRights": true,
"relationshipType": "<string>",
"state": "<string>",
"explanation": "<string>"
},
"rolloutUpdated": "<string>",
"originalIds": {},
"original": {}
}
]
}{
"errorMessage": "<string>"
}{
"errorMessage": "Data for this credential is not ready yet. Please try again."
}Authorizations
Consumer JWT minted by the tenant's backend
The Rollout Credential ID to use for queries/mutations
Query Parameters
Available options:
id, created, updated Cursor of the page to return, from the previous page's _metadata.next. Can't be combined with offset.
Number of records to skip, for offset paging. Defaults to 0. Can't be combined with next.
Records per page, capped at 100.
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.