{"info":{"_postman_id":"e596dd42-f448-469d-b73d-5626e472ecb9","name":"BridgeFi API","description":"

These are the API endpoints available to Bridgeway. This is the collection post migration to Aiden.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38796327","collectionId":"e596dd42-f448-469d-b73d-5626e472ecb9","publishedId":"2sAYBYgqXW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-03T18:31:13.000Z"},"item":[{"name":"/customer","item":[{"name":"/search","id":"7ffdd202-ff7b-4d37-876e-09a8fc178d44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page_size\": 10,\n \"page\": 1,\n \"search\": \"9376049444\"\n}"},"url":"{{url}}/api/v1/customer/search","description":"

Returns paged results of customers that fit the provided seach parameters

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
search	string	see below	no, if omitted all loans will be included in return
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)

'Search' Details

'search' works as a string input from any ONE of the following:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data type	Example
loan number	OEL-008306158
phone number (no dashes)	9376813025
customer number	837778589
first_name	Will
last_name	Stevens
email	wstevens@bridgefi.com
ssn last four	1234
first name and last name broken by space	Will Stevens

","urlObject":{"path":["api","v1","customer","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ffdd202-ff7b-4d37-876e-09a8fc178d44"},{"name":"/search_by","id":"39444860-9f42-4b02-a8b6-763983efb5b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page_size\": 10,\n \"page\": 1,\n \"birthdate\": \"1980-01-01\",\n \"ssn_last_four\": \"1234\"\n}"},"url":"{{url}}/api/v1/customer/search_by","description":"

Returns maximum 20 result of customers that fit the provided parameters

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
ssn_last_four	string	last 4 of social	no
first_name	string	customer first name	no
last_name	string	customer last name	no
birthdate	string formatted YYYY-MM-DD	customer date of birth	no
phone_number	string no dashes	customers phone number	no

No parameters submitted will return empty result.

\n","urlObject":{"path":["api","v1","customer","search_by"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"39444860-9f42-4b02-a8b6-763983efb5b8"},{"name":"/info","id":"88a737bf-4655-4b44-a605-85c82c37bdaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4f9a2808-7aa1-42a6-bf74-4b36c574910b\", \"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/info","description":"

Returns a specific customer's info when given customer uuid

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"88a737bf-4655-4b44-a605-85c82c37bdaa"},{"name":"/address","id":"02ef0d31-df4d-43ef-9533-7d5b440b2a3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/address","description":"

Returns customer address information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","address"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02ef0d31-df4d-43ef-9533-7d5b440b2a3e"},{"name":"/employer","id":"5e976f8c-55b8-463c-9c68-c640412cef68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/employer","description":"

Returns customer employer information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","employer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e976f8c-55b8-463c-9c68-c640412cef68"},{"name":"/identification","id":"6554e04c-71bd-43e1-9850-efa7c35e3ed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/identification","description":"

Returns customer identification information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","identification"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6554e04c-71bd-43e1-9850-efa7c35e3ed8"},{"name":"/phone","id":"fcfc86d7-0261-4cc5-b322-27cab6d564cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/phone","description":"

Returns customer phone number information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","phone"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fcfc86d7-0261-4cc5-b322-27cab6d564cf"},{"name":"/bank","id":"27ec1865-7a98-489a-a118-636225b713f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/bank","description":"

Returns customer bank account information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","bank"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"27ec1865-7a98-489a-a118-636225b713f5"},{"name":"/reference","id":"c6f98e51-a400-4f28-a9a1-2bed3c9fc70c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/reference","description":"

Returns customer reference information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","reference"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6f98e51-a400-4f28-a9a1-2bed3c9fc70c"},{"name":"/card","id":"6e64afef-e48c-4978-8beb-9465ab8b08fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"customer\": [\"4b7f81b6-0707-49c6-9e81-d9dc0e4e08a8\"]\n}"},"url":"{{url}}/api/v1/customer/card","description":"

Returns customer payment card information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
customer	array or string (max 1000)	customer uuid	yes

","urlObject":{"path":["api","v1","customer","card"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e64afef-e48c-4978-8beb-9465ab8b08fc"},{"name":"/do-not-call","id":"08a6b41d-477a-4f0c-a9c6-78bc0562296f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"phone_number\": [\"9376049444\"]\n}"},"url":"{{url}}/api/v1/customer/donotcall","description":"

Updates all instances of submitted number as do_not_call

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
phone_number	array or string (max 10)	phone number	yes

","urlObject":{"path":["api","v1","customer","donotcall"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"08a6b41d-477a-4f0c-a9c6-78bc0562296f"},{"name":"create-customer","id":"49427c48-408a-4b3c-8bf6-1accd5b38bf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"first_name\": \"John\",\r\n \"middle_name\": \"J\",\r\n \"last_name\": \"Brown\",\r\n \"phone_number\": 4445556666,\r\n \"email\": \"brian@bridgefitest.com\",\r\n \"birthdate\": \"1988-04-12\",\r\n \"ssn\": 495995999,\r\n \"is_military\": false,\r\n \"max_loan_amount\": 1000,\r\n \"bank_account\": {\r\n \"bank_name\": \"Chase\",\r\n \"bank_account_number\": 123456789,\r\n \"bank_routing_number\": 987654321\r\n },\r\n \"addresses\": [\r\n {\r\n \"address_1\": \"1106 Chestnut St\",\r\n \"address_2\": \"\",\r\n \"city\": \"Mount Vernon\",\r\n \"state\": \"OH\",\r\n \"zip\": \"\",\r\n \"primary\": 1\r\n }\r\n ],\r\n \"identification\": {\r\n \"identification_type_id\": 2,\r\n \"identification_number\": \"RDX9932\",\r\n \"identification_state\": \"OH\",\r\n \"exp_date\": \"2025-05-01\"\r\n },\r\n \"employers\": [\r\n {\r\n \"name\": \"Joe's Crab Shack\",\r\n \"phone_number\": \"4949942949\",\r\n \"income_type_id\": 4,\r\n \"title\": \"Dishwasher\",\r\n \"net_pay\": 5000.50,\r\n \"payroll_type\": 1,\r\n \"last_pay\": \"2024-09-19\",\r\n \"next_pay\": \"2024-10-19\",\r\n \"pay_frequency_id\": 1,\r\n \"primary\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/customer/createcustomer","description":"

Create Customer

Creates a new customer with the provided information.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	Non-expired token	yes
first_name	string	Customer's first name	yes
middle_name	string	Customer's middle name	no
last_name	string	Customer's last name	yes
phone_number	int	Customer's phone number	yes
email	string	Customer's email address	yes
birthdate	date (yyyy-mm-dd)	Customer's birthdate	yes
ssn	int	Customer's social security number	yes
is_military	boolean	Indicates if the customer is in the military	yes
max_loan_amount	double	Maximum loan amount for the customer	yes

bank_account	object	Customer's bank account information	yes
bank_name	string	Name of the bank	yes
bank_account_number	int	Bank account number	yes
bank_routing_number	int	Bank routing number	yes

addresses	object	Customer's address	yes
address_1	string	Address line 1	yes
address_2	string	Address line 2	no
city	string	City Name	yes
state	string	State Abbrev.	yes
zip	string	Zip code	yes
primary	int	Indicates if the address is primary	yes

identification	object	Customer's identification information	yes
identification_type_id	int	See Identification Types	yes
identification_number	string	Identification number	yes
identification_state	string	Identification state abbrev.	no
exp_date	Date (yyyy-mm-dd)	Expiry date of the identification	yes

employers	array of objects	An object of customer's employers	yes
name	string	Employer's name	yes
phone_number	int	Employer's phone number	yes
income_type_id	int	See Income Type Ids	yes
title	string	Customer's job title	no
net_pay	double	Customer's net pay	yes
payroll_type	string	'direct_deposit' or 'check'	yes
last_pay	string	Date (yyy-mm-dd)	yes
next_pay	string	Date (yyyy-mm-dd)	yes
pay_frequency_id	int	See pay frequency ids	yes

Identification Type Ids

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Description
1	Drivers License
2	State ID
3	Passport
4	Other

Income Type Ids

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Description
1	Employed
2	Self Employed
3	SS/Disability
4	Retired/Pension
5	Child Tax Credit
6	Employment Insurance

Pay Frequency Ids

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Description
1	Monthly
2	Weekly
3	Bi-Weekly
4	Semi-Monthly
5	Monthly Same day of Week

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
success	boolean	Indicates if the request was successful
message	string	Additional information about the request
errors	array	List of errors, if any
application_uuid	string	UUID of the created customer application

You will want to keep the responses application_uuid as this will be needed to send the customer to the application page and pass this parameter into it so the customer loads into the page.

Body

{\n    \"token\": \"1000000044935454\",\n    \"first_name\": \"John\",\n    \"middle_name\": \"J\",\n    \"last_name\": \"Brown\",\n    \"phone_number\": 4445556666,\n    \"email\": \"brian@bridgefitest.com\",\n    \"birthdate\": \"1988-04-12\",\n    \"ssn\": 495995999,\n    \"is_military\": false,\n    \"max_loan_amount\": 1000,\n    \"bank_account\": {\n        \"bank_name\": \"Chase\",\n        \"bank_account_number\": 123456789,\n        \"bank_routing_number\": 987654321\n    },\n    \"addresses\": [\n        {\n        \"address_1\": \"1106 Chestnut St\",\n        \"address_2\": \"\",\n        \"city\": \"Mount Vernon\",\n        \"state\": \"OH\",\n        \"zip\": \"\",\n        \"primary\": 1\n        }\n    ],\n    \"identification\": {\n        \"identification_type_id\": 2,\n        \"identification_number\": \"RDX9932\",\n        \"identification_state\": \"OH\",\n        \"exp_date\": \"2025-05-01\"\n    },\n    \"employers\": [\n        {\n        \"name\": \"Joe's Crab Shack\",\n        \"phone_number\": \"4949942949\",\n        \"income_type_id\": 4,\n        \"title\": \"Dishwasher\",\n        \"net_pay\": 5000.50,\n        \"payroll_type\": 1,\n        \"last_pay\": \"2024-09-19\",\n        \"next_pay\": \"2024-10-19\",\n        \"pay_frequency_id\": 1,\n        \"primary\": 1\n        }\n    ]\n}\n

","urlObject":{"path":["api","v1","customer","createcustomer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49427c48-408a-4b3c-8bf6-1accd5b38bf6"}],"id":"06c3e24f-c066-45c3-9395-9dce5b56fc39","_postman_id":"06c3e24f-c066-45c3-9395-9dce5b56fc39","description":""},{"name":"/loan","item":[{"name":"/search","id":"dd32f166-2b2b-43a0-afc7-125a3faade6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page\": 1,\n \"page_size\": 10,\n \"loan_status\": 12,\n \"loan_status_date\": \"2019-07-26\", \n \"auto_bill_pay\": false\n}"},"url":"{{url}}/api/v1/loan/search","description":"

Returns paged results of loans that fit the provided seach parameters

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
loan	array or string (max 1000)	loan uuid	no
customer	array or string (max 1000)	customer uuid	no
loan_status	int	loan status id	no
loan_status_date	date (YYYY-MM-DD)	day of status id change	no
date_status_date_range	object	object of from:to date range	no (default today's date)
date_status_date_range.from	date (YYYY-MM-DD)	start of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
date_status_date_range.to	date (YYYY-MM-DD)	end of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no

","urlObject":{"path":["api","v1","loan","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd32f166-2b2b-43a0-afc7-125a3faade6b"},{"name":"/info","id":"f81fa5ed-1a60-4400-a2ec-fed22763e1ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"loan\": \"0011aaba-75f4-42c6-ac68-6628b44aa3fa\"\n}"},"url":"{{url}}/api/v1/loan/info","description":"

Returns a specific loan's info when given loan uuid

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes

","urlObject":{"path":["api","v1","loan","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f81fa5ed-1a60-4400-a2ec-fed22763e1ae"},{"name":"/update","id":"dcf25726-723b-47a0-9753-6aaf5bd09629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n\t\"loan\": \"11821ef8-6ced-4a4e-b042-1604ba08ad47\",\r\n\t\"loan_status\": 3\r\n}"},"url":"{{url}}/api/v1/loan/update","description":"

Updates the given loan's status id to the id that is passed

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
loan_status	int	loan status id	yes

Loan Status ID Values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Value
1	Active
2	Held
3	Default
4	Paid
5	Dormant
6	Closed
7	Deliquent
8	Locked - Pending Payment
9	Locked - Awaiting Final Payment
10	Void
11	Closed - Pending
12	Locked - Past Due
13	Rescinded
14	Default - Settled

","urlObject":{"path":["api","v1","loan","update"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcf25726-723b-47a0-9753-6aaf5bd09629"},{"name":"/default","id":"4ec55d59-7aa0-4c6d-9084-a455dd11fb5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n\t\"loan\": [\"00000000-0000-0000-0000-000000000000\", \"00000000-0000-0000-0000-000000000000\"]\r\n}"},"url":"{{url}}/api/v1/loan/default","description":"

Given one or more loan uuid's, checks each given loan to see if loans status should be default, Loans that pass the check will have status updated to default. Returns success or failure for each given loan uuid.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	array or string (max 1000)	loan uuid	yes

","urlObject":{"path":["api","v1","loan","default"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ec55d59-7aa0-4c6d-9084-a455dd11fb5c"},{"name":"/record_prenote","id":"4c6dfc2c-6e6a-452f-ad52-1c3f12651177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n\t\"loan\": \"00000000-0000-0000-0000-000000000000\",\r\n\t\"transaction_type\": \"credit\"\r\n}"},"url":"{{url}}/api/v1/loan/record_prenote","description":"

Add a payment for a loan

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
transaction_type	string	credit or debit	yes

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Return Value	Description	Sucess
status	'processed' or 'failed'	both
error	error reason explained	no

","urlObject":{"path":["api","v1","loan","record_prenote"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c6dfc2c-6e6a-452f-ad52-1c3f12651177"},{"name":"/record_return","id":"4e749d56-c129-47e2-a94b-76e65333a367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n \"transaction_group_uuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"return_code\": 14\r\n}"},"url":"{{url}}/api/v1/loan/record_return","description":"

Add a payment for a loan

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
transaction_group_uuid	string	uuid of transaction to return	yes
return_code	string	return reason code to associate with return transaction	yes

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Return Value	Description	Success
customer_loan_uuid	uuid of loan which recieved the return	yes
error	error reason explained

","urlObject":{"path":["api","v1","loan","record_return"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e749d56-c129-47e2-a94b-76e65333a367"},{"name":"/record_ach_payment","id":"7e7d701c-0594-4013-888a-610148c3e576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n\t\"loan\": \"00000000-0000-0000-0000-000000000000\",\r\n\t\"payment\": 504.64\r\n}"},"url":"{{url}}/api/v1/loan/record_ach_payment","description":"

Record an ach payment to a loan

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
payment	float	amount of the payment	yes

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Return Value	Description	Success
transaction_group_uuid	group uuid of successful payment	yes
error	error reason explained	no

","urlObject":{"path":["api","v1","loan","record_ach_payment"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e7d701c-0594-4013-888a-610148c3e576"},{"name":"/due","id":"8b27df45-11ce-4a16-a9f3-981665ee055d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"loan\": [\"00000000-0000-0000-0000-000000000000\"]\n}"},"url":"{{url}}/api/v1/loan/due","description":"

Returns a specific loan's amount due information

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	array or string (max 1000)	loan uuid	yes

","urlObject":{"path":["api","v1","loan","due"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b27df45-11ce-4a16-a9f3-981665ee055d"}],"id":"77dcaed5-aa9d-4d5a-87a2-3c6f98719610","_postman_id":"77dcaed5-aa9d-4d5a-87a2-3c6f98719610","description":""},{"name":"/transaction","item":[{"name":"/search","id":"0868507d-8e38-4000-9626-bd6fc386694b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page\": 1,\n \"page_size\": 100\n}"},"url":"{{url}}/api/v1/transaction/search","description":"

Search all transactions based on given parameters

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
loan	array or string (max 1000)	loan uuid's	no
transaction	array or string (max 1000)	transaction id's	no
transaction_group_uuid	array or string (max 1000)	transaction group uuid's	no
user_uuid	array or string (max 1000)	user_uuid associated with transaction(s)	no
category_id	array or int	transaction category id	no
transaction_type	array or string	transaction types	no
date_range	object	object of from:to date range	no (default today's date)
date_range.from	date (YYYY-MM-DD)	start of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
date_range.to	date (YYYY-MM-DD)	end of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
show_deleted	boolean	wether or not to show deleted transactions	no (default false)

","urlObject":{"path":["api","v1","transaction","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0868507d-8e38-4000-9626-bd6fc386694b"},{"name":"/info","id":"89079db6-cd46-4dff-8e0d-28c94257c7a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"transaction\": 1\n}"},"url":"{{url}}/api/v1/transaction/info","description":"

Returns info on a specific transaction when given a transaction id

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
transaction	string (max 1)	transaction id	yes

","urlObject":{"path":["api","v1","transaction","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"89079db6-cd46-4dff-8e0d-28c94257c7a9"}],"id":"3b01828b-ede2-451a-8f4e-76cd6675d432","_postman_id":"3b01828b-ede2-451a-8f4e-76cd6675d432","description":""},{"name":"/help","item":[{"name":"/filter-parameters","id":"785d1bb4-8078-451e-946b-9377d1797cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\"\n}"},"url":"{{url}}/api/v1/help/filter-parameters?test=test","description":"

Returns detailed list of parameters used in various endpoints with examples

\n","urlObject":{"path":["api","v1","help","filter-parameters"],"host":["{{url}}"],"query":[{"key":"test","value":"test"}],"variable":[]}},"response":[],"_postman_id":"785d1bb4-8078-451e-946b-9377d1797cc0"},{"name":"/rate-limits","id":"2e1dcc40-bcb8-4df4-8e20-38ad71061eff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\"\n}"},"url":"{{url}}/api/v1/help/rate-limits","description":"

Returns a specific list of rate limits per endpoint

\n","urlObject":{"path":["api","v1","help","rate-limits"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e1dcc40-bcb8-4df4-8e20-38ad71061eff"}],"id":"09edce28-6a51-4e43-978d-ec2cc071e563","_postman_id":"09edce28-6a51-4e43-978d-ec2cc071e563","description":""},{"name":"/pay-date","item":[{"name":"/search","id":"e26d95a8-b736-4b32-9962-8ee262831e61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"page\": 1,\r\n \"page_size\": 10,\r\n \"date_range\": {\r\n \t\"from\": \"2019-08-16\",\r\n \t\"to\": \"2019-08-17\"\r\n }\r\n}"},"url":"{{url}}/api/v1/pay-date/search","description":"

Returns paged results of customer employer pay dates

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
customer	array or string (max 1000)	customer uuid	no
date_range	object	objet of from:to date range	no (default today's date)
date_range.from	date (YYYY-MM-DD)	start of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
date_range.to	date (YYYY-MM-DD)	end of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
auto_bill_pay	boolean	query loans by auto bill payment authorization	no

","urlObject":{"path":["api","v1","pay-date","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e26d95a8-b736-4b32-9962-8ee262831e61"}],"id":"792f317e-3f1a-484e-a11e-c551493d0226","_postman_id":"792f317e-3f1a-484e-a11e-c551493d0226","description":""},{"name":"/due-date","item":[{"name":"/search","id":"4b1f9c44-c091-40e4-adbb-18074bf8c7bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"page\": 1,\r\n \"page_size\": 10,\r\n \"date_range\": {\r\n \t\"from\": \"2019-08-16\",\r\n \t\"to\": \"2019-08-17\"\r\n }\r\n}"},"url":"{{url}}/api/v1/due-date/search","description":"

Returns paged results of payment dates

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
loan	array or string (max 1000)	loan uuid	no
date_range	object	objet of from:to date range	no (default today's date)
date_range.from	date (YYYY-MM-DD)	start of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no
date_range.to	date (YYYY-MM-DD)	end of date range [Optional] Time as (YYYY-MM-DD HH:MM:SS)	no

","urlObject":{"path":["api","v1","due-date","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b1f9c44-c091-40e4-adbb-18074bf8c7bd"}],"id":"295edd5e-d2ca-4f00-81a8-aca5bac5474b","_postman_id":"295edd5e-d2ca-4f00-81a8-aca5bac5474b","description":""},{"name":"/underwriting","item":[{"name":"Lender Loan Calculation","id":"08c0ddd8-f110-40e5-8de6-661aeb13d331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://business.com/api/lender-underwriting","description":"

Follow the Request/Response on the right side.

Customer information will be sent to the underwriting API url to be used in the loan calculation.

\n","urlObject":{"protocol":"https","path":["api","lender-underwriting"],"host":["business","com"],"query":[],"variable":[]}},"response":[{"id":"ba4346d3-fe5a-4cb0-b7da-a213dc4b06ae","name":"Loan Calculation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Basic username:password","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer_uuid\": \"7cf6074f-4b10-41f5-b157-6d434a5057c0\",\r\n \"customer_number\": \"421335655\",\r\n \"customer_status\": \"Active\",\r\n \"customer_status_id\": \"1\",\r\n \"first_name\": \"Theodore\",\r\n \"middle_name\": \"A\",\r\n \"last_name\": \"Kitson\",\r\n \"suffix\": \"\",\r\n \"email\": \"theodore.kitson@testing.com\",\r\n \"ssn_last_four\": \"7872\",\r\n \"birthdate\": \"1980-01-02\",\r\n \"language\": \"\",\r\n \"location_id\": null,\r\n \"created_at\": \"2019-08-21 09:20:33\",\r\n \"collateral\": \"0.00\",\r\n \"requested_loan_amount\": \"0.00\",\r\n \"optin_telemarketing\": \"0\",\r\n \"collections_customer_id\": null,\r\n \"added_to_collections\": \"0000-00-00 00:00:00\",\r\n \"birthday\": \"\\/\\/\",\r\n \"ID_Expires\": null,\r\n \"ssn\": \"111223333\",\r\n \"addresses\": [\r\n {\r\n \"id\": \"107\",\r\n \"type\": \"Home\",\r\n \"ownership\": \"\",\r\n \"monthly\": \"0\",\r\n \"address_1\": \"1001 North Pole St.\",\r\n \"address_2\": \"\",\r\n \"city\": \"North\",\r\n \"state\": \"OH\",\r\n \"zip\": \"44077\",\r\n \"active\": \"1\",\r\n \"primary\": \"0\"\r\n }\r\n ],\r\n \"employers\": [\r\n {\r\n \"id\": \"110\",\r\n \"name\": \"Circuit City\",\r\n \"title\": \"Sales Associate\",\r\n \"phone_number\": \"5534244571\",\r\n \"extension\": \"\",\r\n \"active\": \"1\",\r\n \"primary\": \"1\",\r\n \"pay\": {\r\n \"net_pay\": \"1400\",\r\n \"frequency\": \"Bi-Weekly\",\r\n \"monthly_pay\": \"3033.33\",\r\n \"last_pay_date\": \"2019-08-23\",\r\n \"next_pay_date\": \"2019-09-06\"\r\n }\r\n }\r\n ]\r\n}"},"url":"https://business.com/api/lender-underwriting"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"collateral_amount\": \"777.77\",\r\n\t\"loan_amount_offered\": \"1202.02\"\r\n}"}],"_postman_id":"08c0ddd8-f110-40e5-8de6-661aeb13d331"},{"name":"Customer Existing Debt/Tagging","id":"325edd11-1720-495a-87d8-3397175e99df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://business.com/api/customer-underwriting","description":"

Follow the Request/Response on the right side.

Customer information will be sent to the underwriting API url to be used to determine if the customer can proceed in opening an account.

\n","urlObject":{"protocol":"https","path":["api","customer-underwriting"],"host":["business","com"],"query":[],"variable":[]}},"response":[{"id":"cacc379e-0015-4356-96a8-ad0fa54a0dfa","name":"Existing Debt / Tagging","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"Authorization","value":"Basic username:password","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer_uuid\": \"7cf6074f-4b10-41f5-b157-6d434a5057c0\",\r\n \"customer_number\": \"421335655\",\r\n \"customer_status\": \"Active\",\r\n \"customer_status_id\": \"1\",\r\n \"first_name\": \"Theodore\",\r\n \"middle_name\": \"A\",\r\n \"last_name\": \"Kitson\",\r\n \"suffix\": \"\",\r\n \"email\": \"theodore.kitson@testing.com\",\r\n \"ssn_last_four\": \"7872\",\r\n \"birthdate\": \"1980-01-02\",\r\n \"language\": \"\",\r\n \"location_id\": null,\r\n \"created_at\": \"2019-08-21 09:20:33\",\r\n \"collateral\": \"0.00\",\r\n \"requested_loan_amount\": \"0.00\",\r\n \"optin_telemarketing\": \"0\",\r\n \"collections_customer_id\": null,\r\n \"added_to_collections\": \"0000-00-00 00:00:00\",\r\n \"birthday\": \"\\/\\/\",\r\n \"ID_Expires\": null,\r\n \"ssn\": \"111223333\",\r\n \"addresses\": [\r\n {\r\n \"id\": \"107\",\r\n \"type\": \"Home\",\r\n \"ownership\": \"\",\r\n \"monthly\": \"0\",\r\n \"address_1\": \"1001 North Pole St.\",\r\n \"address_2\": \"\",\r\n \"city\": \"North\",\r\n \"state\": \"OH\",\r\n \"zip\": \"44077\",\r\n \"active\": \"1\",\r\n \"primary\": \"0\"\r\n }\r\n ],\r\n \"employers\": [\r\n {\r\n \"id\": \"110\",\r\n \"name\": \"Circuit City\",\r\n \"title\": \"Sales Associate\",\r\n \"phone_number\": \"5534244571\",\r\n \"extension\": \"\",\r\n \"active\": \"1\",\r\n \"primary\": \"1\",\r\n \"pay\": {\r\n \"net_pay\": \"1400\",\r\n \"frequency\": \"Bi-Weekly\",\r\n \"monthly_pay\": \"3033.33\",\r\n \"last_pay_date\": \"2019-08-23\",\r\n \"next_pay_date\": \"2019-09-06\"\r\n }\r\n }\r\n ]\r\n}"},"url":"https://business.com/api/customer-underwriting"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"proceed\": true,\n\t\"bankruptcies\": false,\n\t\"open_debt\": false,\n\t\"tags\": [\"product_1\", \"product_3\", \"affiliate_8\"]\n}"}],"_postman_id":"325edd11-1720-495a-87d8-3397175e99df"}],"id":"c338076c-bf2d-450a-8ec5-c9e19d460e25","_postman_id":"c338076c-bf2d-450a-8ec5-c9e19d460e25","description":""},{"name":"/location","item":[{"name":"/search","id":"2877c9cd-4080-4828-a2ff-2ec2efd0c094","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page\": 5,\n \"page_size\": 100\n}"},"url":"{{url}}/api/v1/location/search","description":"

Returns paged results of locations

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
location_id	array or string (max 1000)	location ID	no

","urlObject":{"path":["api","v1","location","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2877c9cd-4080-4828-a2ff-2ec2efd0c094"},{"name":"/info","id":"894945bc-e074-4346-9106-527577f08015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"location_id\": 132\n}"},"url":"{{url}}/api/v1/location/info","description":"

Returns bulk result of locations

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
location_id	array or string (max 1000)	location ID	no

","urlObject":{"path":["api","v1","location","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"894945bc-e074-4346-9106-527577f08015"}],"id":"2ee680d2-832a-4d8c-863d-96db389a634d","_postman_id":"2ee680d2-832a-4d8c-863d-96db389a634d","description":""},{"name":"/user","item":[{"name":"/search","id":"8c7112ec-8dda-4f82-9368-928a12468db0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"page\": 1,\n \"page_size\": 10\n}"},"url":"{{url}}/api/v1/user/search","description":"

Returns paged results of users

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
email	string	user email address	no
first_name	string	user first name	no
last_name	string	user last name	no

","urlObject":{"path":["api","v1","user","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c7112ec-8dda-4f82-9368-928a12468db0"},{"name":"/info","id":"f6896793-d416-4e67-ba25-5f04fec9d8ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"user_uuid\": \"09676272-e8cb-4ce2-9b79-77c9aab09811\"\n}"},"url":"{{url}}/api/v1/user/info","description":"

Returns bulk result of users

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
user_uuid	array or string (max 1000)	User UUID	no

","urlObject":{"path":["api","v1","user","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6896793-d416-4e67-ba25-5f04fec9d8ad"}],"id":"6d8e520b-53b7-40a3-9820-510724f07fcb","_postman_id":"6d8e520b-53b7-40a3-9820-510724f07fcb","description":""},{"name":"/station","item":[{"name":"/search","id":"d5d49d8f-d7f4-4c59-8eda-7071236b644f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"location_id\": 499\n}"},"url":"{{url}}/api/v1/station/search","description":"

Returns paged results of stations

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
page_size	int	number of results per page (max 1000)	no (default 10)
page	int	page to return	no (default 1)
station_id	array or string (max 1000)	station ID	no
location_id	array or string (max 1000)	location ID	no

","urlObject":{"path":["api","v1","station","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5d49d8f-d7f4-4c59-8eda-7071236b644f"},{"name":"/info","id":"46a2a51e-0052-4295-9b39-a5c43286b3ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"location_id\": 499\n}"},"url":"{{url}}/api/v1/station/info","description":"

Returns bulk result of stations

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
station_id	array or string (max 1000)	station ID	no
location_id	array or string (max 1000)	location ID	no

","urlObject":{"path":["api","v1","station","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46a2a51e-0052-4295-9b39-a5c43286b3ed"}],"id":"d798f67d-4637-48a3-9da7-2849e2ec58db","_postman_id":"d798f67d-4637-48a3-9da7-2849e2ec58db","description":""},{"name":"/document","item":[{"name":"/info","id":"686b253c-6a8d-48c1-9201-d78b16a1257a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\", \r\n \"loan\": \"9e5c140e-1302-46e6-b91e-35cf07f5ac5e\",\r\n \"document\": \"3acece34-c3cb-43d8-ba85-9561e58b06e2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/document/info","description":"

Returns the body along with details about the document assigned to the document requested

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string	loan uuid	yes
document	string	document uuid	yes

","urlObject":{"path":["api","v1","document","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"686b253c-6a8d-48c1-9201-d78b16a1257a"},{"name":"/search","id":"c8532f12-1045-4866-859b-8f822c63ef75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\", \r\n \"loan\": \"9e5c140e-1302-46e6-b91e-35cf07f5ac5e\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/document/search","description":"

Returns all documents associated with a loan

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string	loan uuid	yes

","urlObject":{"path":["api","v1","document","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8532f12-1045-4866-859b-8f822c63ef75"}],"id":"ec274f43-2630-40f2-b15e-9ab53c33a28f","_postman_id":"ec274f43-2630-40f2-b15e-9ab53c33a28f","description":""},{"name":"/levlpay","item":[{"name":"/customers","id":"2379f262-41ed-48ca-bcb0-88328e1c45db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\", \r\n \"loan\": \"9e5c140e-1302-46e6-b91e-35cf07f5ac5e\",\r\n \"document\": \"3acece34-c3cb-43d8-ba85-9561e58b06e2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/document/info","description":"

Returns the body along with details about the document assigned to the document requested

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string	loan uuid	yes
document	string	document uuid	yes

","urlObject":{"path":["api","v1","document","info"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2379f262-41ed-48ca-bcb0-88328e1c45db"},{"name":"/transactions","id":"3278666b-27aa-4986-ba01-f653c09fe63e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\", \r\n \"customer\": \"1eeb4c4d-0306-4599-bc79-757bc100fc1d\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v1/levlpay/transactions","description":"

Returns the body along with details about the document assigned to the document requested

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string	loan uuid	yes
document	string	document uuid	yes

","urlObject":{"path":["api","v1","levlpay","transactions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3278666b-27aa-4986-ba01-f653c09fe63e"}],"id":"1beab8d2-d9f7-454a-ac01-dc255fc2f1e2","_postman_id":"1beab8d2-d9f7-454a-ac01-dc255fc2f1e2","description":""},{"name":"/ssn","item":[{"name":"/search","id":"8e99c598-badf-41aa-998a-81a84f18f216","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"customer\": [\"e8cad31f-6ff3-4d55-9b2b-918530113385\", \"6f56739e-48c3-45e4-9274-f5239a2e52c5\", \"6f56739e-48c3-45e4-9274-f5239a2e52c5\"]\r\n}\r\n"},"url":"{{url}}/api/v1/ssn/search","description":"

Returns a specific customer's social security number when provided the customer UUID.

\n","urlObject":{"path":["api","v1","ssn","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e99c598-badf-41aa-998a-81a84f18f216"}],"id":"cafb92cb-b5d2-4c03-b81f-e382245c633e","_postman_id":"cafb92cb-b5d2-4c03-b81f-e382245c633e","description":""},{"name":"/promise","item":[{"name":"/loan","id":"6ededab1-9e47-4509-9784-bfec5bae6e9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"loan\": \"3126b964-6667-4e47-8780-e570f89dfe33\"\r\n}"},"url":"{{url}}/api/v1/promise/loan","description":"

Returns a specific loan's payment promises and the notes for those promises when provided a loan UUID.

Promises returned will be split into 'TBD' and 'History' based on the current status of the promise in Bridgefi

'History' contains any promises that have been assigned a status other than the default of TBD

\n","urlObject":{"path":["api","v1","promise","loan"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ededab1-9e47-4509-9784-bfec5bae6e9d"},{"name":"/create_promise","id":"6d7162d9-113d-4bec-a052-f213dd7c6278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"loan\": \"8f6c66a1-0d66-43b8-b724-720a88895687\",\r\n \"promise_date\": \"11/30/2023\",\r\n \"promise_amount\": \"101.00\",\r\n \"user_email\": \"wstevens@iqventures.com\"\r\n}"},"url":"{{url}}/api/v1/promise/create_promise","description":"

Create a new payment promises when provided the loan UUID, date of promise, amount of promise, user_type, and user id.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
promise_date	string format \"12/31/2023\"	date of promise	yes
promise_amount	float	dollar amount	yes
user_email	string	email of user given credit for creating promise	yes

","urlObject":{"path":["api","v1","promise","create_promise"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d7162d9-113d-4bec-a052-f213dd7c6278"},{"name":"/update_promise","id":"b5d93069-231b-45fe-98ba-dad84e66a08d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"promise_uuid\": \"b6451446-9781-476f-a7ce-94457d7839a4\",\r\n \"loan\": \"8f6c66a1-0d66-43b8-b724-720a88895687\",\r\n \"promise_status\": \"2\",\r\n \"qualifying_transaction_group\": \"aaa6bbfd-4cc1-40dd-a0ee-c141ab66acab\",\r\n \"user_email\": \"wstevens@iqventures.com\"\r\n}"},"url":"{{url}}/api/v1/promise/update_promise","description":"

Update promise_date, promise_amount, or promise_status for an existing payment promise:

Note: If status is updated to 'kept' a qualifying transaction group uuid is required.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
promise_uuid	string	uuid of the promise to update	yes
user_email	string	user given credit for promise update	yes
promise_date	string format \"12/31/2023\"	date of promise	no
promise_amount	float	dollar amount	no
promise_status	int from list below	status to be updated	no
qualifying_transaction_group	uuid from transaction group	transaction group that qualifies promise as kept	only if status being set to kept

Valid Status values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Value
1	TBD
2	kept
3	not_kept
4	deleted

","urlObject":{"path":["api","v1","promise","update_promise"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5d93069-231b-45fe-98ba-dad84e66a08d"},{"name":"/create_note","id":"01fac7b7-e505-4e20-b983-87c74dff90ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"promise_uuid\": \"2af22ba7-79ed-4d98-9caa-58b255d3fcb8\",\r\n \"loan\": \"3126b964-6667-4e47-8780-e570f89dfe33\",\r\n \"note_text\" : \"This is a note for a promise\",\r\n \"user_email\": \"wstevens@iqventures.com\"\r\n}"},"url":"{{url}}/api/v1/promise/create_note","description":"

Attach a note to an existing payment promise:

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
promise_uuid	string	uuid of the promise to update	yes
user_email	string	user given credit for note	yes

","urlObject":{"path":["api","v1","promise","create_note"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"01fac7b7-e505-4e20-b983-87c74dff90ae"}],"id":"0734aabf-817f-4070-bef6-3855a9f62888","_postman_id":"0734aabf-817f-4070-bef6-3855a9f62888","description":""},{"name":"collection_dispositions","item":[{"name":"/loan","id":"593a76aa-03f7-4329-8466-29a94ee5c2b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"loan\": \"3126b964-6667-4e47-8780-e570f89dfe33\"\r\n}"},"url":"{{url}}/api/v1/collection_dispositions/loan","description":"

Returns a specific loan's collection disposition history provided a loan UUID.

\n","urlObject":{"path":["api","v1","collection_dispositions","loan"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"593a76aa-03f7-4329-8466-29a94ee5c2b5"},{"name":"/create_disposition","id":"644f8a1c-9f87-49dd-8318-51e7cfb0d475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\",\r\n \"loan\": \"3126b964-6667-4e47-8780-e570f89dfe33\",\r\n \"disposition_status\": \"378\",\r\n \"user_email\": \"wstevens@iqventures.com\"\r\n}"},"url":"{{url}}/api/v1/collection_dispositions/create_disposition","description":"

Create a new collection disposition when provided a loan UUID, disposition status, and user email.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes
loan	string (max 1)	loan uuid	yes
disposition status	integer	disposition ID	yes
user_email	string	email of user adding disposition	yes

Valid Status values

Status	Value
364	Sale Pending
365	New
366	Good Phone Number
367	No Good Phone Numbers
368	Payment Arrangement
369	Customer Contacted
370	Future Due Date
371	Effort Exhausted
372	Broken Promise
373	Deceased Pending Verification
374	Needs Management Review
375	Bankrupt Pending Verification
376	Incarcerated
377	Assigned to Attorney
378	Incarcerated Pending Verification
379	Restitution
380	Police Involvement
381	Customer involved Attorney
382	Cease and Desist
383	Disputed
384	Pending Attorney Assignment
385	Police Involvement Pending
386	Fraud Pending Verification
387	Fraud
388	Outsourced
389	Outsource Recall
390	Outsource Pending
391	Consumer Credit Counseling
395	Contact Made

","urlObject":{"path":["api","v1","collection_dispositions","create_disposition"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"644f8a1c-9f87-49dd-8318-51e7cfb0d475"},{"name":"/get_disposition_types","id":"62fb71df-6c94-4656-a5a2-7e8768010eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token}}\"\r\n}"},"url":"{{url}}/api/v1/collection_dispositions/get_disposition_types","description":"

Returns a associative list of all possible collection disposition statuses

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Required
token	string	non-expired token	yes

","urlObject":{"path":["api","v1","collection_dispositions","get_disposition_types"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62fb71df-6c94-4656-a5a2-7e8768010eb8"}],"id":"bf3be722-2c87-45e9-96d4-498ff76fe5be","_postman_id":"bf3be722-2c87-45e9-96d4-498ff76fe5be","description":""},{"name":"/token","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.token);"],"type":"text/javascript","id":"7dbac147-bb0d-4144-9597-0b54d5d52e27"}}],"id":"ee4b585b-b708-4d47-9fd6-8a2a08f5e83f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{api_secret}}\"\n}"},"url":"{{url}}/api/v1/token","description":"

Given the key/value pairs named 'key' and 'secret' returns a JWT (JSON Web Token) and expiration date. That token is used to authenticate on the rest of the api endpoints until it expires.

key value pairs:

key: a string that is your companies public api key
secret: your secret key that is generated by the website, cannot be recovered if lost only be replaced

\n","urlObject":{"path":["api","v1","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee4b585b-b708-4d47-9fd6-8a2a08f5e83f"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"404ab02e-78b4-47a1-800c-69bbb17bc700"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"476a7855-7611-4443-864e-5988baf25ef0"}}]}