DocuSign: Retrieves the user profile for a specified user
DocuSign esignature.esignatureUserProfileGetProfile: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_userprofile_getprofile
Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/profile. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureUserProfileGetProfile"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureUserProfileGetProfile(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_user_profile_get_profile(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.userId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieves the user profile for a specified user — response body |
Referenced models: Retrieves the user profile for a specified user — response body
Schemas
Section titled “Schemas”9 more schemas are linked from the tables above, on the schema pages.
Retrieves the user profile for a specified user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Get credit card information — response body — address The user's address. |
authenticationMethods | array | Optional | Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. |
authenticationMethods[] | Model | Each item | Expand Retrieves the user profile for a specified user — response body — authentication Methods item |
companyName | string | Optional | The name of the user's company. |
displayOrganizationInfo | string | Optional | When **true,** the user's company and title information display on the ID card. |
displayPersonalInfo | string | Optional | When **true,** the user's address and phone number display on the ID card. |
displayProfile | string | Optional | When **true,** the user's ID card can be viewed from signed documents and envelope history. |
displayUsageHistory | string | Optional | When **true,** the user's usage information displays on the ID card. |
profileImageUri | string | Optional | The URL for retrieving the user's profile image. |
title | string | Optional | The title of the user. |
usageHistory | Model | Optional | Expand Retrieves the user profile for a specified user — response body — usage History A complex element consisting of: - `lastSentDateTime`: The date and time the user last sent an envelope. - `lastSignedDateTime`: The date and time the user last signed an envelope. - `sentCount`: The number of envelopes the user has sent. - `signedCount`: The number of envelopes the user has signed. |
userDetails | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body |
userProfileLastModifiedDate | string | Optional | The date and time that the user's profile was last modified. |
Referenced models: Get credit card information — response body — address, Retrieves the user profile for a specified user — response body — authentication Methods item, Retrieves the user profile for a specified user — response body — usage History, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Retrieves the user profile for a specified user — response body — authentication Methods item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the method used for authentication. |
authenticationType | string | Optional | Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. |
lastProvider | string | Optional | The last provider that authenticated the user. |
lastTimestamp | string | Optional | The data and time the user last used the authentication method. |
totalCount | string | Optional | The number of times the authentication method was used. |
Retrieves the user profile for a specified user — response body — usage History
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element consisting of: * lastSentDateTime - the date and time the user last sent an envelope. * lastSignedDateTime - the date and time the user last signed an envelope. * sentCount - the number of envelopes the user has sent. * signedCount - the number of envelopes the user has signed. |
lastSentDateTime | string | Optional | The date and time the user last sent an envelope. |
lastSignedDateTime | string | Optional | The date and time the user last signed an envelope. |
sentCount | string | Optional | The number of envelopes the user has sent. |
signedCount | string | Optional | The number of envelopes the user has signed. |
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
configurationtype | string | Optional | The type of custom Connect configuration being accessed. |
connectId | string | Optional | The ID of the custom Connect configuration being accessed. |
enabled | string | Optional | Boolean value that indicates whether the custom Connect configuration is enabled or not. |
hasAccess | string | Optional | |
senderSearchableItems | array | Optional | |
senderSearchableItems[] | string | Each item |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that has up to four Question/Answer pairs for forgotten password information. |
forgottenPasswordAnswer1 | string | Optional | The answer to the first forgotten password challenge question. |
forgottenPasswordAnswer2 | string | Optional | The answer to the second forgotten password challenge question. |
forgottenPasswordAnswer3 | string | Optional | The answer to the third forgotten password challenge question. |
forgottenPasswordAnswer4 | string | Optional | The answer to the fourth forgotten password challenge question. |
forgottenPasswordQuestion1 | string | Optional | The first challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion2 | string | Optional | The second challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion3 | string | Optional | The third challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion4 | string | Optional | The fourth challenge question presented to a user who has forgotten their password. |
Deletes an existing user group — response body — groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a group. |
accessType | string | Optional | |
dsGroupId | string | Optional | Reserved for Docusign. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
groupId | string | Optional | The Docusign group ID for the group. This is a read-only property. |
groupName | string | Optional | The name of the group. |
groupType | string | Optional | The group type. |
isManagedByScim | boolean | Optional | |
lastModifiedOn | string | Optional | |
permissionProfileId | string | Optional | The ID of the permission profile associated with the group. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. |
userGroupType | string | Optional | |
users | array | Optional | A list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/) |
users[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body — owner |
usersCount | string | Optional | The total number of users in the group. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Returns available seals for specified account — response body — seals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sealDisplayName | string | Optional | The user-friendly display name for a seal. |
sealName | string | Optional | The name of a seal. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_userprofile_getprofile. Catalog operation: esignature:UserProfile_GetProfile. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.