docusign.notary-jurisdiction.put-notary-jurisdiction

Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The jurisdictionId path parameter must be a jurisdiction that the notary is registered for. - The jurisdictionId path parameter must match the request body's jurisdiction.jurisdictionId. The request body must have a full jurisdiction object for the jurisdiction property. The best way to do this is to use getNotaryJurisdiction to obtain the current values and update the properties you want to change. For example, assume getNotaryJurisdiction returns this: { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" }

Updates the jurisdiction information about a notary.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
jurisdictionid	string	Yes	—	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
commissionexpiration	string	No	—	The expiration date of the notary's commission in format: MM/DD/YYYY.
commissionid	string	No	—	The notary's commission identification. This varies from jurisdiction to jurisdiction.
county	string	No	—	The county that the commission is valid in.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
jurisdiction	json	No	—	Describes the jurisdiction of a notary. This is read-only object.
registeredname	string	No	—	The registered name of the notary.
sealtype	string	No	—	The seal type used for this juridiction. - not_available - system_created - user_uploaded

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
jurisdictionid	string	Yes	—	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
commissionexpiration	string	No	—	The expiration date of the notary's commission in format: MM/DD/YYYY.
commissionid	string	No	—	The notary's commission identification. This varies from jurisdiction to jurisdiction.
county	string	No	—	The county that the commission is valid in.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
jurisdiction	json	No	—	Describes the jurisdiction of a notary. This is read-only object.
registeredname	string	No	—	The registered name of the notary.
sealtype	string	No	—	The seal type used for this juridiction. - not_available - system_created - user_uploaded
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/current_user/notary/jurisdictions/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/current_user/notary/jurisdictions/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.notary-jurisdiction.put-notary-jurisdiction",
  "initial_data": {
    "base_url": "value",
    "jurisdictionid": "value"
  }
}