PApayna
Individuals

List regulated individuals

Returns a paginated list of all regulated individuals (loan officers, insurance adjusters, etc.) for your company. Use ?type=mlo to filter to loan officers, ?type=adjuster for adjusters, or omit type to list all regulated persons regardless of vertical. Filter further by employment_status to surface only active or terminated individuals.

get/individuals

Request

  • Base URL
    https://app.payna.com/api/v1
  • URL
    https://app.payna.com/api/v1/individuals
  • Auth
    HTTP bearer

Query parameters

typestring

Vertical filter. Examples: mlo, adjuster. Omit to return all individual types.

employment_status'active' | 'inactive' | 'terminated' | 'pending'

Filter by employment/sponsorship status.

pageinteger
limitinteger

Response

Paginated list of individuals.

Example response

{
  "data": [
    {
      "individual_type": "mlo",
      "full_name": "Jane Smith",
      "work_email": "jane@company.com",
      "nmls_id": "1234567"
    }
  ],
  "meta": {
    "total": 18,
    "page": 1,
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.