See who you are signed in as

Describes the credential on this request. Call it when you need to know
which company your calls act for, or who a connection belongs to.

Every call acts for one company. companyId and companyName name
it. You only ever see that company's data, and this endpoint only ever
describes it.

A person, or a machine. principalType is person when someone
signed in, and api-key, oauth-client or legacy-token for a
machine credential. For a machine credential every person field
(userId, role, employeeRole, email, signedInAt) is null.

Which loan files you can reach. accessScope says it. ⚠️ Whether
this API limits people by branch is a deployment switch: while it is
off, every credential reads company; once it is on, a person can read
branches or none. Read the value; do not assume either.

  • company: every loan file in the company. A machine credential
    always reads this, and so does a Super or Sales user, whom
    LendingWise lets open any file of the company.
  • branches: only the loan files in the branches listed in
    assignedBranches, as LendingWise limits that employee.
    branchRestrictionsEnforced is then true. A loan file in any other
    branch answers as if it did not exist. An empty list here means no
    loan file is visible: every branch the employee is assigned to
    belongs to another company.
  • none: no loan file. This person can still sign in here, but this
    API does not serve them loan or borrower data and takes no change
    from them (403 on those calls): they can no longer sign in to
    LendingWise, their company is inactive, or their role cannot be
    limited to branches. Use a company API key instead.

For a back-office employee assignedBranches lists the branches they
are assigned to; with accessScope company it is information only.

Nothing here can be changed, and the reply never includes sign-in
settings, two-factor settings or permissions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json