Companies
Branch locations for this company
x-api-key<token>
In: header
Path Parameters
nmlsId*string
Company NMLS ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/companies/string/branches" \ -H "Content-Type: application/json" \ -d '{}'{
"cursor": "string",
"data": [
{
"branchNmlsId": "string",
"city": "string",
"companyName": "string",
"companyNmlsId": "string",
"id": "string",
"isAuthorized": true,
"licensedStates": [
"string"
],
"location": {
"lat": 0,
"lon": 0
},
"managers": null,
"name": "string",
"postalCode": "string",
"state": "string",
"street": "string",
"tradeNames": [
"string"
]
}
],
"locationNormalizations": [
{
"candidates": [
"string"
],
"confidence": "normalized",
"displayName": "Saint Louis, MO",
"field": "city",
"id": "city_mo_saint-louis",
"normalized": "Saint Louis",
"original": "St. Louis",
"variants": [
"string"
]
}
],
"total": 0
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"limit": 0,
"size": 0
}