Home Card

Fetches the mortgage officer configuration for a state from application submission configuration. When categoryCode is omitted, the officer assigned to the state is returned.

Fetch Mortgage Officer Configuration

get/posfinancing/rest/v2/mortgage-officers

Request

Base URL
https://devint01-api.goodleap.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/goodleap/apis/developer-api/docs/posfinancing/rest/v2/mortgage-officers/get.ts
A function with typed inputs. Its response is checked against the schema.

statestring required

The state code used to resolve mortgage officer configuration. Must be a valid ISO 3166-1 alpha-2 code.

categoryCode'Solar_TPO' | 'HVAC_LEASE' | 'BATTERY_LEASE' | 'HELOC'

Optional product category; when an override exists for this state and category, that officer is returned.

The request has been processed successfully.

Oct 29, 202630a51d431498 Revision changes
- info
  api operation id getMortgageOfficers was added
Oct 20, 2026f3b2f62c2a21 Revision changes
- warning
  changed the pattern of the query request parameter state from /^[A-Z]{2}$/ to ^[A-Z]{2}$
- info
  the /////// response's property pattern was changed from /^[A-Z]{2}$/ to ^[A-Z]{2}$ for the status
- info
  the /////// response's property pattern was changed from /^\d{5}(?:-\d{4})?$/ to ^\d{5}(?:-\d{4})?$ for the status