This request allows you to create new Source Companies.
General
Source Companies are used by lenders to categorize loans by company. Some users use Source Companies for tracking business referrals, while others use them as a way to assign loans to a brick-and-mortar locations. Here's what you need to know about this request:
- This request is sent through the
SourceCompany
endpoint, which is how all Source Company information is created, stored, and updated. - Since Source Companies can be used in different ways, some information within this request may not be applicable to your business. For example, you may not choose to use the
Employees
object, which assigns your own personnel to the Source Company. You may decide not to set a primary contact for the company as well. - The following Source Company information cannot be altered via the API:
- Notes and Documents
- Vault information
- Cash Drawers
- Terminal Numbers
- Notifications
For an example of how creating a Source Company works within the UI, take a look at our Create a New Source Company article on our help site.
Database
For information on Source Company database tables, see the following articles:
- Database – Source Company Entity (source_company_entity)
- Database – Source Company Users (source_company__users)
- Database – Source Company Physical Check Account (source_company_physical_check_account_entity)
- Database – Source Company Document (source_company_document_entity)
{
"companyName": "Loan Rangers",
"contactPhone": "8005594776",
"Address": {
"country": "company.country.usa",
"state": "geo.state.UT",
"address1": "164 W Promontory",
"zipcode": 84025,
"city": "Farmington"
},
"PrimaryContact": {
"__id": 10107
},
"Employees": {
"results": [
{
"userId": 10107
}
]
},
"active": 1
}
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is a bit different.
We can’t provide sample values that will work for multiple users. But, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.
To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.