Request

HTTP request

GET /v2.1/current_user/notary/journals

Parameters

Parameter NameValueDescription
Optional Query Parameters
countstring

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

search_textstring

start_positionstring

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

CodeDescriptionReference
200

Successful response.

notaryJournalList
400

Error encountered.

errorDetails

SDK Method

Envelopes::listNotaryJournals

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

jurisdiction

allowSystemCreatedSealstring

allowUserUploadedSealstring

commissionIdInSealstring

countystring

countyInSealstring

enabledstring

jurisdictionIdstring

namestring

notaryPublicInSealstring

stateNameInSealstring

notaryJournalCredibleWitness

addressstring

The user's address.

namestring

signatureImagestring

notaryJournalList

endPositionstring

The last position in the result set.

nextUristring

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]

previousUristring

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.

resultSetSizestring

The number of results returned in this response.

startPositionstring

Starting position of the current result set.

totalSetSizestring

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

commentstring

credibleWitnesses[notaryJournalCredibleWitness]

signatureImagestring

signerIdTypestring

NotaryJournals

createdDatestring

The creation date of the account in UTC timedate format.

documentNamestring

jurisdictionjurisdiction

notaryJournalIdstring

notaryJournalMetaDatanotaryJournalMetaData

signerNamestring

The in-person signer's full legal name.

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

Maximum Length: 100 characters.

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> 
}} />