Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.userIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves the user profile for a specified user — response body

Referenced models: Retrieves the user profile for a specified user — response body

9 more schemas are linked from the tables above, on the schema pages.

Retrieves the user profile for a specified user — response body
FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Get credit card information — response body — address
The user's address.
authenticationMethodsarrayOptionalIndicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
authenticationMethods[]ModelEach itemExpand Retrieves the user profile for a specified user — response body — authentication Methods item
companyNamestringOptionalThe name of the user's company.
displayOrganizationInfostringOptionalWhen **true,** the user's company and title information display on the ID card.
displayPersonalInfostringOptionalWhen **true,** the user's address and phone number display on the ID card.
displayProfilestringOptionalWhen **true,** the user's ID card can be viewed from signed documents and envelope history.
displayUsageHistorystringOptionalWhen **true,** the user's usage information displays on the ID card.
profileImageUristringOptionalThe URL for retrieving the user's profile image.
titlestringOptionalThe title of the user.
usageHistoryModelOptionalExpand 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.
userDetailsModelOptionalExpand 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
userProfileLastModifiedDatestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional
Retrieves the user profile for a specified user — response body — authentication Methods item
FieldTypePresenceDescription and constraints
$objectRootContains information about the method used for authentication.
authenticationTypestringOptionalIndicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth.
lastProviderstringOptionalThe last provider that authenticated the user.
lastTimestampstringOptionalThe data and time the user last used the authentication method.
totalCountstringOptionalThe number of times the authentication method was used.
Retrieves the user profile for a specified user — response body — usage History
FieldTypePresenceDescription and constraints
$objectRootA 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.
lastSentDateTimestringOptionalThe date and time the user last sent an envelope.
lastSignedDateTimestringOptionalThe date and time the user last signed an envelope.
sentCountstringOptionalThe number of envelopes the user has sent.
signedCountstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
configurationtypestringOptionalThe type of custom Connect configuration being accessed.
connectIdstringOptionalThe ID of the custom Connect configuration being accessed.
enabledstringOptionalBoolean value that indicates whether the custom Connect configuration is enabled or not.
hasAccessstringOptional
senderSearchableItemsarrayOptional
senderSearchableItems[]stringEach item
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA 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
FieldTypePresenceDescription and constraints
$objectRootA complex element that has up to four Question/Answer pairs for forgotten password information.
forgottenPasswordAnswer1stringOptionalThe answer to the first forgotten password challenge question.
forgottenPasswordAnswer2stringOptionalThe answer to the second forgotten password challenge question.
forgottenPasswordAnswer3stringOptionalThe answer to the third forgotten password challenge question.
forgottenPasswordAnswer4stringOptionalThe answer to the fourth forgotten password challenge question.
forgottenPasswordQuestion1stringOptionalThe first challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion2stringOptionalThe second challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion3stringOptionalThe third challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion4stringOptionalThe fourth challenge question presented to a user who has forgotten their password.
Deletes an existing user group — response body — groups item
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a group.
accessTypestringOptional
dsGroupIdstringOptionalReserved for Docusign.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupIdstringOptionalThe Docusign group ID for the group.
This is a read-only property.
groupNamestringOptionalThe name of the group.
groupTypestringOptionalThe group type.
isManagedByScimbooleanOptional
lastModifiedOnstringOptional
permissionProfileIdstringOptionalThe 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.
userGroupTypestringOptional
usersarrayOptionalA 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[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
usersCountstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
sealDisplayNamestringOptionalThe user-friendly display name for a seal.
sealNamestringOptionalThe name of a seal.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.