Agent skill
AiPrise Webhooks Skill
Receive and verify AiPrise webhooks (callbacks). Use when setting up AiPrise identity/KYC/KYB callback handlers, debugging X-HMAC-SIGNATURE verification, or handling verification results like APPROVED, DECLINED, REVIEW, and UNKNOWN.
Install this skill
npx skills add hookdeck/webhook-skills --skill aiprise-webhooks
AiPrise is an identity verification (KYC/KYB) platform. It notifies your server of verification outcomes and business-profile changes via callbacks — signed HTTP POST webhooks.
When to Use This Skill
- How do I receive AiPrise webhooks (callbacks)?
- How do I verify the AiPrise
X-HMAC-SIGNATUREheader? - How do I handle
APPROVED,DECLINED,REVIEW, orUNKNOWNverification results? - Why is my AiPrise webhook signature verification failing?
- How do I correlate a callback with a verification session?
Verification (core)
AiPrise signs every callback with HMAC-SHA256 over the raw request body, lowercase hex, in the X-HMAC-SIGNATURE header. The HMAC key is your AiPrise API private key directly (e.g. abcdef12-pqrs-...) — there is no separate signing or endpoint secret, and this is not Standard Webhooks. Verify against the exact raw body bytes; re-serializing the JSON changes bytes and breaks the signature.
const crypto = require('crypto');
function verifyAiPriseWebhook(rawBody, signatureHeader, apiKey) {
if (!signatureHeader) return false;
const expected = crypto
.createHmac('sha256', apiKey)
.update(rawBody) // Buffer/string of the raw HTTP body — do NOT JSON.parse first
.digest('hex')
.toLowerCase();
try {
return crypto.timingSafeEqual(
Buffer.from(signatureHeader.toLowerCase(), 'hex'),
Buffer.from(expected, 'hex')
);
} catch {
return false; // length mismatch / malformed hex
}
}
For complete handlers with route wiring, event dispatch, and tests, see:
Verification Results
There is no rich typed-event system — the outcome is the aiprise_summary.verification_result value:
verification_result | Meaning | Typical action |
|---|---|---|
APPROVED | Verification passed | Provision access / mark verified |
DECLINED | Verification failed | Block / request resubmission |
REVIEW | Needs manual review | Queue for an analyst |
UNKNOWN | Result indeterminate | Retry / investigate |
Callbacks also carry a process status (COMPLETED, PENDING, FAILED, ...). Correlate to your records with verification_session_id and the optional client_reference_id.
There are two callback destinations, both signed the same way:
callback_url— verification result callbacks (aiprise_summary.verification_result)events_callback_url— business-profile change events
Environment Variables
AIPRISE_API_KEY=abcdef12-pqrs-abcd-pqrs-abcde0123456 # Your AiPrise API private key — also the HMAC signing key
Local Development
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 aiprise --path /webhooks/aiprise
Reference Materials
- references/overview.md - AiPrise webhook concepts and results
- references/setup.md - Template/dashboard configuration
- references/verification.md - Signature verification details and gotchas