Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
authentication

Get API session details

Get details about your current API session. This includes information about the current organization ID, user ID, and MFA status of the organization.

get/v3/login/session

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get API session details response

organizationIdstring

BILL-generated ID of the current organization

userIdstring

BILL-generated ID of the current user

mfaStatus'DISABLED' | 'SETUP' | 'CHALLENGE' | 'COMPLETE' | 'UNDEFINED'

MFA status of the organization.

  • DISABLED: MFA is disabled for the organization.
  • SETUP: MFA setup is incomplete. Validate phone to complete MFA setup.
  • CHALLENGE: MFA setup is complete. MFA challenge is required for MFA sign in.
  • COMPLETE: Both MFA setup and MFA sign in steps are complete. The API session is MFA trusted.
mfaBypassboolean

This field is set as true when MFA is disabled at the developer key level. All organizations that are linked to this developer key do not require MFA.