Request

HTTP request

GET /v2/current_user/notary/journals

Parameters

Parameter name Value Description
Optional query parameters
count string

The maximum number of results to be returned by this request.

search_text string
start_position string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Notary::listNotaryJournals

Definitions Expand All | Collapse All

NotaryJournals

createdDate string
documentName string
jurisdiction jurisdiction
notaryJournalId string
notaryJournalMetaData notaryJournalMetaData
signerName string

The in-person signer's full legal name.

Required when inPersonSigningType is inPersonSigner. For eNotary flow, use name instead.

Maximum Length: 100 characters.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

jurisdiction

commissionIdInSeal string
county string
countyInSeal string
enabled string
jurisdictionId string
name string
notaryPublicInSeal string
stateNameInSeal string

notaryJournalCredibleWitness

address string
name string
signatureImage string

notaryJournalList

endPosition string

The last position in the result set.

nextUri string

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
[NotaryJournals]
previousUri string

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

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

notaryJournalMetaData

comment string
credibleWitnesses
[notaryJournalCredibleWitness]
signatureImage string
signerIdType string

Examples

Generic JSON Response

Response

{
"notaryJournals": [
{
"notaryJournalId": "sample string 1",
"jurisdiction": {
"jurisdictionId": "sample string 1",
"name": "sample string 2",
"county": "sample string 3",
"enabled": "sample string 4",
"countyInSeal": "sample string 5",
"commissionIdInSeal": "sample string 6",
"stateNameInSeal": "sample string 7",
"notaryPublicInSeal": "sample string 8",
"allowSystemCreatedSeal": "sample string 9",
"allowUserUploadedSeal": "sample string 10"
}
,
"signerName": "sample string 2",
"documentName": "sample string 3",
"createdDate": "sample string 4",
"notaryJournalMetaData": {
"comment": "sample string 1",
"signerIdType": "sample string 2",
"signatureImage": "sample string 3",
"credibleWitnesses": [
{
"name": "sample string 1",
"address": "sample string 2",
"signatureImage": "sample string 3"
}
]
}
}
]
,
"resultSetSize": "sample string 1",
"totalSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"nextUri": "sample string 5",
"previousUri": "sample string 6"
}

Generic XML Response

Response

<notaryJournalList 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<endPosition>sample string 4</endPosition>
<nextUri>sample string 5</nextUri>
<previousUri>sample string 6</previousUri>
<resultSetSize>sample string 1</resultSetSize>
<startPosition>sample string 3</startPosition>
<totalSetSize>sample string 2</totalSetSize>
<notaryJournals>
<notaryJournal>
<createdDate>sample string 4</createdDate>
<documentName>sample string 3</documentName>
<jurisdiction>
<allowSystemCreatedSeal>sample string 9</allowSystemCreatedSeal>
<allowUserUploadedSeal>sample string 10</allowUserUploadedSeal>
<commissionIdInSeal>sample string 6</commissionIdInSeal>
<county>sample string 3</county>
<countyInSeal>sample string 5</countyInSeal>
<enabled>sample string 4</enabled>
<jurisdictionId>sample string 1</jurisdictionId>
<name>sample string 2</name>
<notaryPublicInSeal>sample string 8</notaryPublicInSeal>
<stateNameInSeal>sample string 7</stateNameInSeal>
</jurisdiction>
<notaryJournalId>sample string 1</notaryJournalId>
<notaryJournalMetaData>
<comment>sample string 1</comment>
<credibleWitnesses>
<notaryJournalCredibleWitness>
<address>sample string 2</address>
<name>sample string 1</name>
<signatureImage>sample string 3</signatureImage>
</notaryJournalCredibleWitness>
</credibleWitnesses>
<signatureImage>sample string 3</signatureImage>
<signerIdType>sample string 2</signerIdType>
</notaryJournalMetaData>
<signerName>sample string 2</signerName>
</notaryJournal>
</notaryJournals>
</notaryJournalList>