Advanced

Integrations and SDK Usage

Connect vAulth with your existing tools and platforms using webhooks, APIs, and the ModelBoard Distribution SDK for seamless compliance automation.

curl -X POST https://api.example.com/v1/identities/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user_123",
    "documents": ["passport.jpg"]
  }'

const response = await fetch('https://api.example.com/v1/identities/verify', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    userId: 'user_123',
    documents: ['passport.jpg']
  })
});

{
  "status": "success",
  "data": {
    "verificationId": "verif_789",
    "status": "pending",
    "userId": "user_123"
  }
}

Overview

Integrate vAulth seamlessly into your compliance workflows with webhooks, REST APIs, and the ModelBoard Distribution SDK. These tools enable real-time notifications, custom automation, and easy distribution of compliance data for creators, studios, and platforms.

Use webhooks for event-driven updates like identity verification completion. Leverage the SDK for programmatic distribution of Model Releases and consent proofs. APIs provide granular control for advanced workflows.

Webhooks

Receive real-time events without polling.

SDK

Distribute compliance artifacts easily.

APIs

Build custom compliance integrations.

Webhooks and Third-Party Integrations

Set up webhooks to get notified of events like identity.verified or agreement.signed. Configure them in your vAulth dashboard at https://dashboard.example.com/webhooks.

Create Webhook

Navigate to the Webhooks section and click "New Webhook".

Enter your endpoint URL, e.g., https://your-webhook-url.com/vaulth.

Select events: identity.verified, kyb.approved, release.signed.

Handle Payload

Implement a secure endpoint to process payloads.

Test Integration

Use the dashboard test button to simulate events.

const express = require('express');
const app = express();
app.use(express.json());

app.post('/vaulth', (req, res) => {
  const event = req.headers['x-vaulth-signature'];
  const payload = req.body;
  
  if (payload.event === 'identity.verified') {
    console.log(`User ${payload.data.userId} verified`);
    // Trigger your workflow
  }
  
  res.status(200).json({ received: true });
});

app.listen(3000);

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/vaulth', methods=['POST'])
def webhook():
    event = request.headers.get('X-Vaulth-Signature')
    payload = request.json
    
    if payload['event'] == 'identity.verified':
        print(f"User {payload['data']['userId']} verified")
        # Trigger your workflow
    
    return jsonify({'received': True}), 200

if __name__ == '__main__':
    app.run(port=3000)

Always verify webhook signatures using your secret from the dashboard to prevent tampering.

ModelBoard Distribution SDK

The ModelBoard SDK simplifies sharing compliance artifacts like Model Releases and Verifiable Credentials. Install via your package manager.

npm install @vaulth/modelboard-sdk

import { ModelBoardSDK } from '@vaulth/modelboard-sdk';

const sdk = new ModelBoardSDK({ apiKey: 'YOUR_API_KEY' });

const release = await sdk.createModelRelease({
  userId: 'user_123',
  projectId: 'proj_456',
  consent: true
});

await sdk.distributeRelease(release.id, ['studio@example.com']);

pip install vaulth-modelboard-sdk

from vaulth_modelboard import ModelBoardSDK

sdk = ModelBoardSDK(api_key='YOUR_API_KEY')

release = sdk.create_model_release(
    user_id='user_123',
    project_id='proj_456',
    consent=True
)

sdk.distribute_release(release.id, ['studio@example.com'])