Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
authentication

API login

Sign in to your BILL developer account. In the response, your API session is created and a BILL-generated sessionId is available. Use the sessionId in all subsequent API calls to confirm that you are in a signed-in session.

To create an MFA-trusted API session, set rememberMeId and device in addition to the required fields. See MFA setup for information about the BILL MFA process.

You can sign out with POST /v3/logout. If your API session is inactive for 35 minutes, the session expires and you are automatically signed out.

See API partner login for information about the additional permissions you get with the API partner login.

Note: This section is about authentication for working with the BILL v3 API. See Authentication with Spend & Expense API token for information about authentication for the Spend & Expense API endpoints.

post/v3/login

Request body

devKeystring required

Developer key sent to you by BILL when you create a developer account

usernamestring required

Email address used to sign in to your BILL account

passwordstring

Password used to sign in to your BILL account

consoleApiTokenstring

Console API token.

As a BILL Accountant Console user, use POST /v3/login to sign in to a client organization.

  • username: Your BILL Accountant Console email address
  • consoleApiToken: Your Console API token
  • devKey: Developer key of the client organization
  • organizationId: Organization ID of the client organization

See BILL Accountant Console operations for more information.

organizationIdstring required

Organization ID

rememberMeIdstring

MFA ID. Set this field for creating an MFA-trusted API session.

This MFA ID is generated when you set rememberMe as true in your POST /v3/mfa/challenge/validate request. This value expires in 30 days.

See Validate MFA challenge for more information.

devicestring

Mobile device name. This is a nickname for your mobile device. Set this field when you set rememberMeId.

Example request

{
  "username": "{{username}}",
  "password": "{{password}}",
  "organizationId": "{{organization_id}}",
  "devKey": "{{developer_key}}"
}

Response

API login response

sessionIdstring required

API session ID. Use this value in all subsequent API calls to confirm that you are in a signed-in session.

organizationIdstring required

Organization ID associated with the signed-in user

userIdstring required

BILL-generated ID of the signed-in user

trustedboolean required

This field is set as true if the current API session is MFA-trusted

All 310 operations