Skip to content

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.

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 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_notary_journals_get_notary_journals(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.countstringOptional
query.search_textstringOptional
query.start_positionstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets notary jurisdictions for a user — response body

Referenced models: Gets notary jurisdictions for a user — response body

Gets notary jurisdictions for a user — response body
FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
notaryJournalsarrayOptional
notaryJournals[]ModelEach itemExpand Gets notary jurisdictions for a user — response body — notary Journals item
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
createdDatestringOptionalThe creation date of the account in UTC timedate format.
documentNamestringOptionalThe name of the document.
jurisdictionModelOptionalExpand Creates a jurisdiction object — response body — jurisdiction
The notary's jurisdiction.
notaryJournalIdstringOptionalA unique GUID for this journal entry.
notaryJournalMetaDataModelOptionalExpand 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.
signerNamestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootDescribes the jurisdiction of a notary.
This is read-only object.
allowSystemCreatedSealstringOptionalWhen **true,** the seal can be generated by the platform.
allowUserUploadedSealstringOptionalWhen **true,** the seal can be uploaded by the user.
commissionIdInSealstringOptionalWhen **true,** the notary's `comissionId` appears in the seal.
countystringOptionalThe county of the jurisdiction.
countyInSealstringOptionalWhen **true,** the county name appears in the seal.
enabledstringOptionalWhen **true,** this jurisdiction is enabled.
jurisdictionIdstringOptionalThe 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`
namestringOptionalThe name of the jurisdiction. Typically the state name.
notaryPublicInSealstringOptionalWhen **true,** the name of the notary appears in the seal.
stateNameInSealstringOptionalWhen **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
FieldTypePresenceDescription and constraints
$objectRoot
commentstringOptionalA freeform comment that the notary can add to the journal entry.
credibleWitnessesarrayOptionalAn array of witnesses.
credibleWitnesses[]ModelEach itemExpand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
signatureImagestringOptionalA base64-encoded image of the signature.
signerIdTypestringOptionalA 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
FieldTypePresenceDescription and constraints
$objectRoot
addressstringOptionalThe address of the witness.
namestringOptionalThe name of the witness.
signatureImagestringOptionalA base64-encoded image of the signature.

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.

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.