v1
latestOpenAPI 3.0.12026-07-24310590875.6 KBAPI login as user
Sign in to a created organization as a created user of that organization. In the response, your API session is created and a generated sessionId is available for organization-level BILL API operations.
This endpoint is required for a specific BILL partner-level workflow.
- Sign in to your partner account with API partner login.
- Create a child BILL organization with POST /v3/partner/organizations. In the response, a BILL-generated organization id is available.
- Create a user for the child BILL organization with POST /v3/partner/users. In the response, a BILL-generated user id is available.
- Sign in to the created organization as the created user of that organization with POST /v3/partner/login-as-user. After signing in, you can perform organization-level BILL API operations, such as creating a bill or paying a vendor. All organization-level BILL API operations require a devKey and sessionId.
Note: When you create an organization and then create a user for that organization, it is important that you initiate risk verification with POST /v3/risk-verifications. See Initiate risk verification for an organization for more information.
This operation requires partner-level permissions.
- A sessionId header value generated with API partner login
- An appKey header value
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.
MFA-trusted API session
Set both rememberMeId and device as additional fields in your POST /v3/partner/login-as-user request to create an MFA-trusted API session.
Headers
API session ID generated with /v3/partner/login
Application key sent to you by BILL when you create a partner account
Request body
Example request
{
"userId": "{{partner_user_id}}",
"organizationId": "{{partner_organization_id}}"
}Response
API login as user response