Me

Get the current caller's account

GET
/v1/me

Identity, active organization + membership role, and how the caller authenticated.

Extended profile fields (nmlsId, jobRole, the contact-card block) are resolved for every caller type — session-cookie, API-key, and OAuth-bearer alike. auth.profileResolved is true on any successful read; it is retained for compatibility and no longer varies by the credential the caller presented.

Authorization

x-api-key<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me"
{
  "auth": {
    "clientId": "string",
    "method": "api-key",
    "profileResolved": true,
    "role": "string",
    "scopes": [
      "string"
    ]
  },
  "organization": {
    "id": "string",
    "role": "string"
  },
  "user": {
    "addressLine1": "string",
    "agentPhotoUrl": "string",
    "city": "string",
    "contactCardType": "string",
    "contactPhone": "string",
    "createdAt": "string",
    "email": "string",
    "emailVerified": true,
    "headline": "string",
    "id": "string",
    "image": "string",
    "jobRole": "string",
    "name": "string",
    "nmlsId": "string",
    "postalCode": "string",
    "qrBaseUrl": "string",
    "reLicenseNumber": "string",
    "reLicenseState": "string",
    "sendNewLoginEmail": true,
    "signatureImage": "string",
    "state": "string",
    "tagline": "string",
    "theme": "string"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}
{
  "error": "string"
}

Company-to-company loan officer flows GET

The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.

Get the caller's credit balance and usage GET

Balance split by bucket (cycle allowance, purchased on-demand, personal), the per-cycle allowance and on-demand unit price, and ledger totals over a window. The window defaults to the current calendar month to date (UTC). Figures are for the caller's own membership in their active organization — the same organization the API meters requests against.