Skip to main content

Prerequisites

Before you start integrating with the NotaryCam API, make sure you have everything you need.

Required Credentials​

You'll need the following credentials from NotaryCam:

1. Partner ID​

Your unique NotaryCam partner identifier.

  • Format: String (e.g., partner-abc123)
  • Where to find: Contact your NotaryCam account manager

2. API Key​

Your API authentication key.

  • Format: String
  • Security: Keep this secret - never commit to version control
  • Where to find: Contact your NotaryCam account manager

3. API Secret​

Your API authentication secret.

  • Format: String
  • Security: Store securely using environment variables
  • Where to find: Contact your NotaryCam account manager

4. Department ID​

Department ID for organizing transactions within your enterprise.

  • Format: String
  • Where to find: Contact your NotaryCam account manager
  • Note: You can have multiple departments

5. Workflow ID​

The workflow template ID for your transaction type.

  • Format: String
  • Where to find: Contact your NotaryCam account manager
  • Note: Different workflows for different transaction types

API Access​

Base URL​

Your base URL ({BASE_URL}) will be provided by the NotaryCam team during integration setup.

tip

Store your base URL in an environment variable rather than hardcoding it in your application.

Authentication Flow​

Understanding the authentication flow:

Required Knowledge​

Technical Skills​

To integrate successfully, you should be familiar with:

  • REST APIs - Making HTTP requests (GET, POST, PUT)
  • JSON - Parsing and creating JSON data
  • Authentication - JWT token handling
  • Webhooks - Receiving and processing HTTP callbacks
  • File Uploads - Multipart form data

Domain Knowledge​

Helpful to understand:

  • Notarization Process - Basic understanding of remote online notarization
  • Document Types - Different document requirements (notarize, sign, support)
  • Participant Roles - Signer, notary, witness, observer roles

Development Tools​

Security Requirements​

SSL/TLS​

  • HTTPS Required: All API endpoints require HTTPS
  • TLS 1.2+: Minimum TLS version supported
  • Webhook Endpoints: Must use HTTPS for webhook delivery

Getting Your Credentials​

If you don't have API credentials yet:

  1. Contact NotaryCam Support: support@notarycam.com
  2. Sign Partnership Agreement: Complete the onboarding process
  3. Receive Credentials: Get your Partner ID, API Keys, and IDs

Sandbox Environment​

What's Included​

The sandbox provides:

  • Full API access (same as production)
  • Test transactions (no real notarizations)
  • Webhook testing

What's Different​

Differences from production:

  • No actual notarizations occur
  • No legal validity
  • Data may be reset periodically
  • Separate credentials from production

Checklist​

Before proceeding, ensure you have:

  • Partner ID from NotaryCam
  • API Key and API Secret
  • Department ID
  • Workflow ID for your transaction type
  • Access to sandbox environment

Next Steps​

Once you have all prerequisites:

  1. Test Authentication → Authentication Guide
  2. Build First Transaction → Your First Transaction Tutorial

Need Help?​

Can't find your credentials?

  • Contact your account manager

Technical questions?