DocuSign: Gets settings for a notary user
DocuSign esignature.esignatureNotaryGetNotary: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_notary_getnotary
Provider route: GET /restapi/v2.1/current_user/notary. 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"]["esignatureNotaryGetNotary"]>[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.esignatureNotaryGetNotary(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_notary_get_notary(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.include_jurisdictions | string | Optional |
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 Gets settings for a notary user — response body |
Referenced models: Gets settings for a notary user — response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
Gets settings for a notary user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a single notary jurisdiction. |
jurisdictions | array | Optional | |
jurisdictions[] | Model | Each item | Expand Creates a jurisdiction object — response body — jurisdiction |
notary | Model | Optional | Expand Registers the current user as a notary — response body |
Referenced models: Creates a jurisdiction object — response body — jurisdiction, Registers the current user as a notary — response body
Creates a jurisdiction object — response body — jurisdiction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the jurisdiction of a notary. This is read-only object. |
allowSystemCreatedSeal | string | Optional | When **true,** the seal can be generated by the platform. |
allowUserUploadedSeal | string | Optional | When **true,** the seal can be uploaded by the user. |
commissionIdInSeal | string | Optional | When **true,** the notary's `comissionId` appears in the seal. |
county | string | Optional | The county of the jurisdiction. |
countyInSeal | string | Optional | When **true,** the county name appears in the seal. |
enabled | string | Optional | When **true,** this jurisdiction is enabled. |
jurisdictionId | string | Optional | The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds` |
name | string | Optional | The name of the jurisdiction. Typically the state name. |
notaryPublicInSeal | string | Optional | When **true,** the name of the notary appears in the seal. |
stateNameInSeal | string | Optional | When **true,** the name of the state appears in the seal. |
Registers the current user as a notary — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
enabled | string | Optional | The date the this object was created. |
searchable | string | Optional | When **true,** this notary is searchable. |
userInfo | 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 Information about the user registering to be a notary. |
Referenced models: 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 |
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
Updates an existing brand — response body — colors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A name-value pair that describes an item and provides a value for the item. |
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. |
name | string | Optional | The name of the item. |
originalValue | string | Optional | The initial value of the item. |
value | string | Optional | The current value of the item. |
Referenced models: Locks a template — response body — error Details
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_notary_getnotary. Catalog operation: esignature:Notary_GetNotary. 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.