Retrieves account information for the authenticated user. Since the API is sessionless, this method does not actually log you in. Instead, the method returns information about the account or accounts that the authenticated user has access to.

Important: This method must only be used for the Legacy Header Authentication flow. Use the AccountServer: userInfo method for the OAuth2 Authentication Code and Implicit Grant flows.

Each account has a baseUrl property, returned in the response. Use this baseUrl in all future API calls as the base of the request URL.

For each account, the baseUrl property includes the DocuSign server, the API version, and the accountId property.

It is not uncommon for an authenticated user to have access to more than one account (and more than one baseUrl). Depending on your integration's use case, your integration may choose to:

  • Use the account whose isDefault field is true.
  • List the available accounts and ask the user to choose one.
  • Enable the system administrator to set the account that should be used by your integration.

If this method returns successfully, then you also know that the user has successfully authenticated with the DocuSign Signature platform.

For more information on Authentication Login, please see our REST API Authentication Guides.

Note: Certain reference items maybe out of date and the latest information is available in the new Authentication Guides.

Request

HTTP request

GET /v2/login_information

Parameters

Parameter NameValueDescription
Optional Query Parameters
api_passwordstring

Reserved for DocuSign.

embed_account_id_guidstring

include_account_id_guidstring

When set to true, shows the account ID GUID in the response.

login_settingsstring

Determines whether login settings are returned in the response.

Valid Values:

  • all - All the login settings are returned.
  • none - no login settings are returned.

Responses

CodeDescriptionReference
200

Successful response.

Authentication
400

Error encountered.

errorDetails

SDK Method

Authentication::login

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

loginAccount

accountIdstring

The account ID associated with the envelope.

accountIdGuidstring

The GUID associated with the account ID.

baseUrlstring

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.

emailstring

The email address for the user.

isDefaultstring

This value is true if this is the default account for the user, otherwise false is returned.

loginAccountSettings[nameValue]

A list of settings on the acccount that indicate what features are available.

loginUserSettings[nameValue]

A list of user-level settings that indicate what user-specific features are available.

namestring

The name associated with the account.

siteDescriptionstring

An optional descirption of the site that hosts the account.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

userNamestring

The name of this user as defined by the account.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

Authentication

Authentication and login

apiPasswordstring

Contains a token that can be used for authentication in API calls instead of using the user name and password. Only returned if the api_password=true query string is added to the URL.

loginAccounts[loginAccount]

The list of accounts that authenticating user is a member of.

Examples

Authentication Success Response Example

This example shows a typical response to calling this method with the default parameters. Note that the name of the account may be different than the userName.

Response
{
  "loginAccounts": [
    {
      "accountId": "1703061",
      "baseUrl": "https://demo.docusign.net/restapi/v2/accounts/1703061",
      "email": "nirving@example.com",
      "isDefault": "true",
      "name": "LoanCo",
      "siteDescription": "",
      "userId": "1470ff66-f92e-4e8e-ab81-8c46f140da37",
      "userName": "Nat Irving"
    }
  ]
}
Authentication Failure Response Example

This example shows a typical response when the integrator key is invalid.

Response
{
  "errorCode": "PARTNER_AUTHENTICATION_FAILED",
  "message": "The specified Integrator Key was not found or is disabled. An Integrator key was not specified."
}
Generic JSON Response

Response
{
  "loginAccounts": [
    {
      "name": "sample string 1",
      "accountId": "sample string 2",
      "accountIdGuid": "sample string 3",
      "baseUrl": "sample string 4",
      "isDefault": "sample string 5",
      "userName": "sample string 6",
      "userId": "sample string 7",
      "email": "sample string 8",
      "siteDescription": "sample string 9",
      "loginAccountSettings": [
        {}
      ],
      "loginUserSettings": [
        {}
      ]
    }
  ],
  "apiPassword": "sample string 1"
}
Generic XML Response

Response
<loginInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <apiPassword>sample string 1</apiPassword>
  <loginAccounts>
    <loginAccount>
      <accountId>sample string 2</accountId>
      <accountIdGuid>sample string 3</accountIdGuid>
      <baseUrl>sample string 4</baseUrl>
      <email>sample string 8</email>
      <isDefault>sample string 5</isDefault>
      <loginAccountSettings>
        <nameValue />
      </loginAccountSettings>
      <loginUserSettings>
        <nameValue />
      </loginUserSettings>
      <name>sample string 1</name>
      <siteDescription>sample string 9</siteDescription>
      <userId>sample string 7</userId>
      <userName>sample string 6</userName>
    </loginAccount>
  </loginAccounts>
</loginInformation> 
}} />