Skip to main content
Version: 1.0.0

Propper Sign API

Propper Sign API

This service provides two API surfaces:

  1. Native Propper Sign API (/v1/sign/*) - Recommended for new integrations
  2. DocuSign-Compatible API (/restapi/v2.1/*) - For existing DocuSign integrations

Base URL​

https://api.propper.ai/v1/sign

Authentication​

OAuth 2.0 Bearer token:

Authorization: Bearer <access_token>

OAuth Scopes​

  • sign:read - Read agreements and templates
  • sign:write - Create and update agreements
  • sign:send - Send agreements for signing
  • sign:admin - Administrative operations (void, delete)

Key Endpoints​

  • GET /v1/sign/agreements - List agreements
  • POST /v1/sign/agreements - Create agreement
  • POST /v1/sign/agreements/{id}/send - Send for signing
  • GET /v1/sign/templates - List templates

DocuSign-Compatible API​

For migrating from DocuSign, simply change your base URL:

Production: https://api.propper.ai/restapi/v2.1

Entity Mapping​

  • DocuSign Envelope → Propper Agreement
  • DocuSign Recipient → Propper Recipient
  • DocuSign Tab → Propper Annotation

Implementation Status​

  • Core envelope operations
  • Recipient management
  • Document operations
  • Embedded signing views
  • Audit events
  • Template-based creation

Known Limitations (DocuSign-Compatible API)​

  • Email Delivery: Setting status to sent updates state but does not trigger SMTP emails.
  • Document Storage: documentUrl fields return internal Blob IDs, not public signed URLs.
  • Deletion: DELETE is strictly for created (draft) envelopes. Sent envelopes must be voided.
  • Page Counts: PDF page counts default to 1 pending dynamic calculation logic.

Not Yet Supported (Future Roadmap)​

  • Bulk Send: Batch sending to multiple recipients.
  • PowerForms: Self-service public signing links.
  • Advanced Auth: SMS/Phone/ID verification for recipients.
  • Document Generation: Dynamic form fields and conditional logic.

Authentication​

OAuth 2.0 Bearer token

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

Contact

Propper Support:

URL: https://propper.ai

License