Partner API Onboarding Guide
Audience:
Technology Partners, Integration Teams, Enterprise Developers
Overview
The Pruuvn® API and Webhooks enable partners to integrate onboarding, compliance, verification, and monitoring data directly into their platforms. This guide outlines how partners get started, what to expect during integration, and best practices for building reliable, secure connections with Pruuvn®.
What Partners Can Integrate
Partners commonly use the Pruuvn® API and webhooks to:
- Sync provider onboarding and verification status
- Monitor insurance, W9, and document compliance
- Receive real-time updates when records change
- Automate downstream workflows based on compliance events
Pruuvn® supports event-driven and API-driven integration patterns.
Integration Models
API-Driven Integration
Use the API to:
- Retrieve provider and company data
- Query verification and compliance status
- Poll records as needed
Best for:
Systems that require scheduled syncs or on-demand queries.
Webhook-Driven Integration
Use webhooks to:
- Receive real-time notifications when events occur
- React immediately to compliance or verification changes
Best for:
Operational systems, dispatch platforms, and marketplaces.
Getting Access
Step 1: Partner Enablement
Your Pruuvn® contact will:
- Enable API access
- Provide authentication credentials
- Confirm supported record types and events
Step 2: Review API Documentation
All available endpoints and schemas are documented in the Pruuvn® API V3 Docs.
Partners should review:
- Supported endpoints
- Required authentication
- Response formats
Step 3: Configure Webhooks (Optional but Recommended)
Partners may configure one or more webhook endpoints to receive real-time updates.
Each webhook requires:
- A secure HTTPS endpoint
- Selected record types
- Subscribed events
Security Expectations
Pruuvn® enforces strict security requirements for all integrations.
Partners are expected to:
- Use HTTPS for all endpoints
- Secure and rotate credentials
- Validate webhook signatures using HMAC SHA-256
- Reject requests that fail verification
Webhook requests include a Signature Key and X-Webhook-Signature header for verification.
Event Handling Guidance
Webhook events notify partners when important changes occur, such as:
- Insurance verification updates
- Document status changes
- Verification completion events
Partners should:
- Process events asynchronously
- Return a 2xx HTTP response within 15 seconds
- Use idempotency controls to handle retries
Testing & Validation
Before moving to production, partners should:
- Use webhook test deliveries
- Validate signature verification logic
- Confirm event handling behavior
- Review webhook logs for delivery status
Monitoring & Troubleshooting
Pruuvn® provides webhook logs showing:
- Delivery attempts
- Response codes
- Error messages
Partners should monitor:
- Timeout errors
- Signature verification failures
- Missed or duplicate events
Support & Coordination
For integration questions, partners should work directly with their Pruuvn® contact or designated support channel.
To accelerate resolution:
- Include webhook IDs or event timestamps
- Share error responses where applicable
- Confirm endpoint availability
Integration Best Practices Summary
- Prefer webhooks for real-time workflows
- Always verify webhook signatures
- Handle retries and duplicates safely
- Keep integrations loosely coupled
- Treat compliance events as authoritative
Related Documentation
- Pruuvn® API Overview (V3)
- Authentication & Security
- Webhooks Overview
- Verifying Webhook Signatures
- Webhook Logs & Monitoring
Article Description (for Notion list view)
Guidance for partners integrating with Pruuvn® APIs and webhooks to receive real-time onboarding and compliance data.
Powered by