module:api/NotaryApi

new module:api/NotaryApi(apiClient)

Source:

api/NotaryApi.js, line 41

Constructs a new NotaryApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createNotary(optsOrCallback, callback)

Source:

api/NotaryApi.js, line 70

Add a notary to the system
Registers the current user as a notary.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`notary`	module:model/Notary

callback

module:api/NotaryApi~createNotaryCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Notary

createNotaryJurisdictions(optsOrCallback, callback)

Source:

api/NotaryApi.js, line 124

Add a notary jurisdiction to the system
Creates a jurisdiction object.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`notaryJurisdiction`	module:model/NotaryJurisdiction

callback

module:api/NotaryApi~createNotaryJurisdictionsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotaryJurisdiction

deleteNotaryJurisdiction(jurisdictionId, callback)

Source:

api/NotaryApi.js, line 176

Delete a notary jurisdiction a specified user.
Deletes the specified jurisdiction.

Parameters:

Name	Type	Description
`jurisdictionId`	String
`callback`	module:api/NotaryApi~deleteNotaryJurisdictionCallback	The callback function, accepting three arguments: error, data, response

getNotary(optsOrCallback, callback)

Source:

api/NotaryApi.js, line 230

Get notary settings for a user
Gets settings for a notary user.
The current user must be a notary.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`includeJurisdictions`	String

callback

module:api/NotaryApi~getNotaryCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotaryResult

getNotaryJurisdiction(jurisdictionId, callback)

Source:

api/NotaryApi.js, line 288

Get notary a jurisdiction for a user
Gets a jurisdiction object for the current user. The following restrictions apply:

The current user must be a notary.
The jurisdictionId must be a jurisdiction that the notary is registered for.

Parameters:

Name	Type	Description
`jurisdictionId`	String
`callback`	module:api/NotaryApi~getNotaryJurisdictionCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/NotaryJurisdiction`

getNotaryJurisdictions(callback)

Source:

api/NotaryApi.js, line 391

Get notary jurisdictions for a user
Returns a list of jurisdictions that the notary is registered in.
The current user must be a notary.

Parameters:

Name	Type	Description
`callback`	module:api/NotaryApi~getNotaryJurisdictionsCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/NotaryJurisdictionList`

getNotaryJurisdictionSeal(jurisdictionId, callback)

Source:

api/NotaryApi.js, line 339

Get notary seal for a jurisdiction

Parameters:

Name	Type	Description
`jurisdictionId`	String
`callback`	module:api/NotaryApi~getNotaryJurisdictionSealCallback	The callback function, accepting three arguments: error, data, response

listNotaryJournals(optsOrCallback, callback)

Source:

api/NotaryApi.js, line 440

Get notary jurisdictions for a user

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`count`	String
`searchText`	String
`startPosition`	String

callback

module:api/NotaryApi~listNotaryJournalsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotaryJournalList

updateNotary(optsOrCallback, callback)

Source:

api/NotaryApi.js, line 497

Update a notary
Updates notary information for the current user.

Parameters:

Name Type Description

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`notary`	module:model/Notary

callback

module:api/NotaryApi~updateNotaryCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Notary

updateNotaryJurisdiction(jurisdictionId, optsOrCallback, callback)

Source:

api/NotaryApi.js, line 610

Update a 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"
}

Parameters:

Name Type Description

jurisdictionId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`notaryJurisdiction`	module:model/NotaryJurisdiction

callback

module:api/NotaryApi~updateNotaryJurisdictionCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotaryJurisdiction

Type Definitions

createNotaryCallback(error, data, If)

Source:

api/NotaryApi.js, line 54

(Optional) Callback function to receive the result of the createNotary operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/Notary	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createNotaryJurisdictionsCallback(error, data, If)

Source:

api/NotaryApi.js, line 108

(Optional) Callback function to receive the result of the createNotaryJurisdictions operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryJurisdiction	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteNotaryJurisdictionCallback(error, data, If)

Source:

api/NotaryApi.js, line 162

(Optional) Callback function to receive the result of the deleteNotaryJurisdiction operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotaryCallback(error, data, If)

Source:

api/NotaryApi.js, line 213

(Optional) Callback function to receive the result of the getNotary operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryResult	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotaryJurisdictionCallback(error, data, If)

Source:

api/NotaryApi.js, line 269

(Optional) Callback function to receive the result of the getNotaryJurisdiction operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryJurisdiction	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotaryJurisdictionsCallback(error, data, If)

Source:

api/NotaryApi.js, line 376

(Optional) Callback function to receive the result of the getNotaryJurisdictions operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryJurisdictionList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotaryJurisdictionSealCallback(error, data, If)

Source:

api/NotaryApi.js, line 325

(Optional) Callback function to receive the result of the getNotaryJurisdictionSeal operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listNotaryJournalsCallback(error, data, If)

Source:

api/NotaryApi.js, line 422

(Optional) Callback function to receive the result of the listNotaryJournals operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryJournalList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateNotaryCallback(error, data, If)

Source:

api/NotaryApi.js, line 481

(Optional) Callback function to receive the result of the updateNotary operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/Notary	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateNotaryJurisdictionCallback(error, data, If)

Source:

api/NotaryApi.js, line 535

(Optional) Callback function to receive the result of the updateNotaryJurisdiction operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NotaryJurisdiction	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.