Partner Integration
Partners integrate with Loyva by using API keys to authenticate server-to-server requests. Partner endpoints are scoped and isolated — you can only access resources within your organization.
Integration architecture
┌──────────────────┐ ┌──────────────────┐ ┌──────────────────┐
│ Partner Backend │ │ Loyva API │ │ Loyva Vault │
│ │ │ │ │ │
│ X-API-Key: lk_.. │────────>│ /partner/* │────────>│ Storage │
│ │<────────│ Scoped by org │<────────│ Compliance │
│ │ │ │ │ │
└──────────────────┘ └──────────────────┘ └──────────────────┘
│ │
│ Webhook events │ Embed tokens (in progress)
│<────────────────────────────│
│ │
│ ┌──────────────────┐│
│ │ User's Browser ││
│────────>│ Loyva signing │<─────────────────────
│ iframe (WIP) │ iframe
└──────────────────┘
What you get
| Feature | Endpoint | Scope required |
|---|---|---|
| Create envelopes | POST /partner/envelopes | envelopes:write |
| List envelopes | GET /partner/envelopes | envelopes:read |
| Check status | GET /partner/envelopes/:id/status | envelopes:read |
| Get signing links | GET /partner/envelopes/:id/signing-links | envelopes:read |
| Embed widgets (SDK in progress) | POST /embed/token | esign:write or vault:read |
| View vault documents | GET /partner/envelopes/:id/vault/signed-url | vault:read |
| View backup copy | GET /partner/envelopes/:id/vault/copy/signed-url | vault:read |
| Check compliance | GET /partner/envelopes/:id/compliance | compliance:read |
| Get certificates | GET /partner/envelopes/:id/vault/certificate | compliance:read |
| Receive webhooks | Outbound to your URL | Configured per key |
Getting started
- Get an API key from your Loyva point of contact (see API Keys)
- Test with the API — create an envelope, send it for signing
- Configure webhooks — get real-time updates on envelope events
- Go live — swap dev keys for production keys
info
Embedded signing and vault widgets are on the roadmap. The POST /embed/token endpoint is live (see Embed tokens), but the companion JavaScript SDK and iframe host are not yet published. Coordinate with your Loyva point of contact if you need embedded signing.