DocuSign: Gets notary jurisdictions for a user
DocuSign esignature.esignatureNotaryJournalsGetNotaryJournals: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_notaryjournals_getnotaryjournals
Provider route: GET /restapi/v2.1/current_user/notary/journals. 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"]["esignatureNotaryJournalsGetNotaryJournals"]>[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.esignatureNotaryJournalsGetNotaryJournals(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_journals_get_notary_journals(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.count | string | Optional | |
query.search_text | string | Optional | |
query.start_position | 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 notary jurisdictions for a user — response body |
Referenced models: Gets notary jurisdictions for a user — response body
Schemas
Section titled “Schemas”Gets notary jurisdictions for a user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
notaryJournals | array | Optional | |
notaryJournals[] | Model | Each item | Expand Gets notary jurisdictions for a user — response body — notary Journals item |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets notary jurisdictions for a user — response body — notary Journals item
Gets notary jurisdictions for a user — response body — notary Journals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
documentName | string | Optional | The name of the document. |
jurisdiction | Model | Optional | Expand Creates a jurisdiction object — response body — jurisdiction The notary's jurisdiction. |
notaryJournalId | string | Optional | A unique GUID for this journal entry. |
notaryJournalMetaData | Model | Optional | Expand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data Additional journal data such as the witness list and signature image. |
signerName | string | Optional | The in-person signer's full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. |
Referenced models: Creates a jurisdiction object — response body — jurisdiction, Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data
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. |
Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comment | string | Optional | A freeform comment that the notary can add to the journal entry. |
credibleWitnesses | array | Optional | An array of witnesses. |
credibleWitnesses[] | Model | Each item | Expand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item |
signatureImage | string | Optional | A base64-encoded image of the signature. |
signerIdType | string | Optional | A string that describes the ID that the signer presented. For example `drivers license` or `military ID`. |
Referenced models: Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | string | Optional | The address of the witness. |
name | string | Optional | The name of the witness. |
signatureImage | string | Optional | A base64-encoded image of the signature. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_notaryjournals_getnotaryjournals. Catalog operation: esignature:NotaryJournals_GetNotaryJournals. 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.