Skip to main content

Frequently Asked Questions

Common questions and answers about NotaryCam API integration.

Authentication​

How long does the JWT token last?​

The token expires in 24 hours from issuance. Implement automatic token refresh in your application.

// Check token expiry and refresh if needed
if (!token || Date.now() >= tokenExpiry) {
  token = await authenticate();
  tokenExpiry = Date.now() + (23 * 60 * 60 * 1000);
}

What happens if I hit the rate limit?​

You'll receive a 429 Too Many Requests response. Implement exponential backoff and retry logic.

Users​

Can I create users without all the address fields?​

Minimum required fields:

  • departments
  • email
  • firstName
  • lastName
  • phone

Address and date of birth are optional but recommended.

How do I avoid creating duplicate users?​

Search for users before creating:

const existingUsers = await api.searchUsers({ emails: [email] });
if (existingUsers.users.length > 0) {
  userId = existingUsers.users[0]._id;
} else {
  const newUser = await api.createUser(userData);
  userId = newUser.user._id;
}

Can I update a user after creation?​

Yes, use PUT /api/v4/users/{userId} to update user details.

Transactions​

Can I activate a transaction without documents?​

No. At least one document is required before activation.

Can I deactivate a transaction after activation?​

Yes, use the deactivate endpoint, but this depends on the transaction state. Once a session starts, you may not be able to deactivate.

What happens when I activate a transaction?​

  1. Participants receive email notifications with room URLs
  2. Session becomes available at scheduled time (if scheduled)
  3. Transaction status may change to indicate readiness
  4. Webhooks start firing for transaction events

Can I add participants after activation?​

It depends on your workflow configuration and transaction state. Generally, it's best to add all participants before activation. Contact NotaryCam support for your specific workflow rules.

How do I cancel a transaction?​

Use the archive endpoint: PUT /api/v4/transactions/{transactionId}/archive

Note: This is different from cancellation during a session, which happens through the UI.

Documents​

What file formats are supported?​

Primary format: PDF

Other formats may be supported depending on your configuration. Contact NotaryCam support for details.

What's the maximum document size?​

Recommended: Up to 25MB per document
Maximum: May vary by partner agreement

For larger documents, consider:

  • Compressing the PDF
  • Splitting into multiple documents

Can I upload documents after activation?​

It depends on:

  • Current transaction state

Generally, it's best practice to upload all documents before activation.

What document types should I use?​

TypeUse When
notarizeDocument requires notarization
signSignature only (no notarization)
supportSupporting document (no signature needed)
otherOther document type

Why did my document processing fail?​

Common reasons:

  • Corrupted PDF file
  • Password-protected PDF
  • Unsupported PDF version
  • File too large

Check the documents-processed webhook for specific error details.

Metadata​

Is metadata required?​

No, metadata is optional. However, it's highly recommended for:

  • Tracking and reporting
  • Integration with your systems
  • Custom workflows
  • Compliance requirements

Contact NotaryCam support for details.

Can I update metadata after activation?​

Yes, you can update metadata at any time using PUT /api/v4/transactions/{transactionId}/metadata.

Webhooks​

Do I need to implement webhooks?​

Webhooks are highly recommended but not strictly required.

What should my webhook endpoint return?​

Return HTTP 200 for successfully processed webhooks, even if you choose to ignore that event type.

Return HTTP 500 only if processing genuinely failed.

Errors​

What does "Invalid credentials" mean?​

Your Partner ID, API Key, or API Secret is incorrect. Verify:

  • Credentials are correct
  • Using the right environment
  • No extra whitespace in credentials
  • Credentials haven't expired

Why am I getting 401 Unauthorized?​

Common causes:

  1. Token not included in Authorization header
  2. Token expired
  3. Token format incorrect (should be Bearer {token})
  4. Using wrong environment credentials

What does 429 Too Many Requests mean?​

You've exceeded the rate limit. Implement:

  • Request throttling
  • Exponential backoff
  • Request queuing

How do I handle network timeouts?​

Implement retry logic with exponential backoff.

What's the API rate limit?​

Typical limits:

  • Authentication: 10 requests/minute
  • API Calls: 50 requests/minute

Contact your account manager for custom limits.

Production​

How do I move to production?​

  1. Complete testing
  2. Request production credentials from NotaryCam
  3. Update environment variables
  4. Verify webhook endpoint is HTTPS
  5. Test with small volume first
  6. Monitor closely during rollout

How do I handle multiple signers on one transaction?​

Create multiple users and add them as participants:

const participants = [
  { user: user1Id, role: 'signer' },
  { user: user2Id, role: 'signer' },
  { user: witnessId, role: 'witness' }
];

await api.createTransaction({
  department: deptId,
  participants,
  workflow: workflowId
});

Can I customize notification emails?​

Email customization is configured at the workflow level. Contact your NotaryCam account manager to customize email templates.

Troubleshooting​

Where can I find my credentials?​

Check:

  1. NotaryCam onboarding
  2. Contact your account manager

My documents aren't processing. What should I check?​

  1. Verify PDF is valid and not corrupted
  2. Check file size is within limits
  3. Monitor documents-processed webhook for errors
  4. Check NotaryCam status page for service issues

Still Need Help?​

Documentation​

Support​

Report Documentation Issues​

Found an error in the documentation? Let us know!