Branches

Loan officers on this branch's current roster

POST
/v1/branches/{nmlsId}/roster

The loan officers currently registered to this branch location who hold an active sponsorship or registration — one row per person, with current employer, tenure, years in the industry, manager flags and collected contact info. This is the LICENSING roster; for the loan officers whose loans public record attributes to the branch, use branchOriginators.

Authorization

x-api-key<token>

In: header

Path Parameters

nmlsId*string

Branch 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/branches/string/roster" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "city": "string",
      "companyName": "string",
      "companyNmlsId": "string",
      "companyStartDate": "string",
      "contact": {
        "cellPhone": "string",
        "employerAddress": "string",
        "employerCity": "string",
        "employerCompany": "string",
        "employerCompanyId": "string",
        "employerState": "string",
        "employerType": "string",
        "employerWebsite": "string",
        "employerZip": "string",
        "facebook": "string",
        "linkedin": "string",
        "officePhone": "string",
        "officePhoneExt": "string",
        "personalEmail": "string",
        "twitter": "string",
        "website": "string",
        "workEmail": "string"
      },
      "firstName": "string",
      "id": "string",
      "isBranchManager": true,
      "isWorking": true,
      "lastName": "string",
      "managesThisBranch": true,
      "name": "string",
      "nmlsId": "string",
      "state": "string",
      "tenureMonths": 0,
      "yearsInIndustry": 0
    }
  ],
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Loan officers who wrote this branch's loans POST

Ranks the loan officers whose loans public record attributes to this branch, by volume. Each label is the LO's NMLS ID, so it chains straight into `GET /v1/originators/{nmlsId}`. This is the branch's RECORDED roster, not its licensing roster: it answers who actually wrote loans here in the period, which is narrower than everyone registered to the branch and can include someone who has since moved. For the licensed managers on file, read `managers` on `GET /v1/branches/{nmlsId}`.

State volume breakdown across this branch's loans POST

Ranks the states this branch's loans were secured in, by volume. Labels are two-letter state abbreviations. This is where the branch actually transacted, which is narrower than where it is licensed — licensed states are returned by `GET /v1/branches/{nmlsId}`.