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"
}

Community Lending mix of a market's originations POST

The aggregate Community Lending profile of the originations matching your filters: the share that landed in low- or moderate-income neighborhoods, the CRA-eligible share, the distribution across the four neighborhood income bands, and the majority-minority neighborhood share. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100. This is a MARKET-LEVEL view only — the underlying origination data carries no lender, loan officer or borrower identity, and no figure here is attributable to one. Every share is reported next to the count it is a share of, because the three designations have three different coverage levels; read the denominator before comparing markets.

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.