Skip to main content

Retrieve Notarization Sessions

This help page will guide you through the process of retrieving notarization sessions created by the authenticated organization using the Notarization API. You'll need your API access token to proceed.

Requirements​

  1. You need to have Node.js installed on your system.
  2. You'll also need the axios library. You can install it using the following command:
npm install axios

Step 1: Retrieve Notarization Sessions​

Use the following code snippet to retrieve notarization sessions with the specified filters. Replace <accessToken> with your API access token, and modify the parameters as needed.

const axios = require('axios');&externalId=abc

const status = 'ready',
const externalId = 'string' //'This-is-an-OPTIONAL-value-you-can-use-to-search-but-you-must-first-set-it-when-creating-a-notarization.'

axios.post(`https://public-api.sandbox.notary.sh/notarizations?status={{status}}&externalId={{externalId}}`, {}, {
    headers: {
        Authorization: 'Bearer <your_access_token>',
        'Content-Type': 'application/json'
    }
}).then(response => {
    console.log(response.data);
}).catch(error => {
    console.error(error);
});

### Steps to Execute the Code Snippet

1. Create a new file named `retrieve_notarization_sessions.js`.
2. Copy and paste the code snippet provided above into the new file.
3. Replace `<accessToken>` with your API access token.
4. Save the file and open a terminal or command prompt.
5. Navigate to the folder where you saved the `retrieve_notarization_sessions.js` file.
6. Run the following command:

```bash
node retrieve_notarization_sessions.js

Notarization Status Options​

When retrieving notarization sessions, you can filter the results by notarization status. The available status options are:

  • -
  • pending_doc_upload
  • pending_verification
  • ready
  • pending_start
  • in_progress
  • pending_payment
  • complete_success
  • complete_fail
  • complete_terminated
  • canceled

Additional Resources​

For more information about the Notarization API, visit the official documentation.

If you need further assistance or have questions, feel free to reach out to our support team.