API Reference

From Safe Stamper API
Revision as of 09:49, 12 April 2021 by Admin (talk | contribs) (API operations)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Authorization API Reference

To create and manage user authorizations.

You don't need to use these operations if your API keys are already linked to your user account.

API operations

  • createauth: Create a pending authorization key that must be authorized by a user.
  • authstate: Check the status of an authkey
  • deleteauth: Delete a user authorization


Certificates API Reference

To list and manage user certificates

API operations


Static Web Page API Reference

To create static web pages certificates

API operations

  • web/stamp: Send URLs for static page certification
  • web/status: Check the status of a certification job

Callbacks

When calling web/stamp you can provide a callback URL:


Web Browsing API Reference

To create web browsing certificates

API operations


Notifications API Reference

To list and manage user notifications

API operations

API callbacks

If your API key has a callback URL, it will receive the following callback events:

  • NOTIFICATION_READ: When the notification recipient has read the notification.
  • NOTIFICATION_ANSWERED: When the notification recipient has answered the notification.

These callbacks receive the same JSON as returned by notification/get


File API Reference

To create file certificates

API operations


Signature API Reference

To send documents for signature

API operations

API callbacks

If your API client has a callback URL, it will receive the following callbacks:

  • DOCUMENT_SIGNATURE: When a signer signs the document
  • SIGNATURE_CERTIFICATE: When the document signature certificate is ready

These callbacks receive the same JSON as returned by signature/status.


Partners API

The API operations in this section are only available for designated partners.

See Partners API