DocuSign Momentum 2018DocuSign Momentum 2018

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 Authentiction 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.

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
loginAccount
nameValue
Authentication

Examples

Authentication Success Response Example
Authentication Failure Response Example
Generic JSON Response
Generic XML Response