> ## Documentation Index > Fetch the complete documentation index at: https://docs.urtentic.com/llms.txt > Use this file to discover all available pages before exploring further. # Configure Webhook Endpoint > Configures a webhook endpoint to receive verification event notifications. This allows your application to receive real-time updates when verification statuses change. ### Use Cases - Setting up real-time verification notifications - Configuring webhook endpoints for your application - Specifying which events should trigger notifications ### Notes - This endpoint requires an API key with webhook configuration permissions - The webhook URL must be publicly accessible and support HTTPS - Webhooks are signed using a secret to verify authenticity - Webhook requests will time out after 10 seconds ## OpenAPI ````yaml /api-reference/openapi.yml post /webhooks/configure openapi: 3.0.0 info: title: Urtentic API version: '1.0' description: > # Introduction The Urtentic API provides comprehensive identity verification and workflow management capabilities. It enables organizations to create customized verification workflows, perform identity checks, and manage verification processes with features including liveness detection, location intelligence, and document verification. ## Authentication All authenticated endpoints require two headers: - `Authorization: Bearer {API_KEY}` - Your API key - `X-CLIENT-ID: {CLIENT_ID}` - Your client ID API credentials can be generated from your Urtentic Dashboard under Settings > API Keys. ## Webhook Notifications Configure webhook URLs in your Urtentic Dashboard to receive real-time notifications about verification status changes. Webhooks include the verification ID and current status, allowing your system to react to verification completions or failures. ## Key Features - User and organization management - Customizable verification workflows - Multiple verification processes (Liveness, Location, Document, Watchlist Check, Email) - Analytics and reporting - Webhook notifications for verification results contact: name: Urtentic Support Team email: support@urtentic.com url: https://urtentic.com/support termsOfService: https://urtentic.com/terms license: name: Urtentic License url: https://urtentic.com/license servers: - url: https://api.urtentic.com/api/v1 description: Urtentic API security: [] tags: - name: Identity description: > Management of verified identity data, including retrieval and validation of identity information. Endpoints in this category allow you to: - Retrieve verified identity details - Check identity verification status - Update identity information - Link identities across verification sessions - name: Processes description: > Configuration and management of individual verification process types that can be used in workflows. The Urtentic platform supports these verification processes: - **Document Verification**: OCR and authenticity checks for identity documents - **Liveness Detection**: Confirms a person is physically present and not using photos/videos - **Location Intelligence**: Verifies geographic location and environments - **Email Verification**: Validates email ownership through OTP - **Watchlist Check**: Screens identities against compliance databases - name: Verification description: > Core verification operations including starting verifications, submitting verification data, and retrieving results. Key operations include: - Starting new verification sessions - Submitting identity data for verification - Retrieving verification results - Validating inputs before submission - Tracking verification status - name: Webhook description: > Configuration and management of webhook endpoints for receiving real-time event notifications. The webhook system allows you to: - Receive real-time notifications about verification status changes - Configure multiple webhook endpoints for different environments - Specify which events trigger notifications - Verify webhook signature to ensure authenticity - Track webhook delivery and retry failed deliveries - name: Workflow description: > Creation and management of verification workflows, combining multiple verification processes into customized sequences. Workflows allow you to: - Define multi-step verification sequences - Configure country-specific document requirements - Set custom verification rules and thresholds - Create specialized flows for different use cases - Manage verification process order and dependencies paths: /webhooks/configure: post: tags: - Webhook summary: Configure Webhook Endpoint description: > Configures a webhook endpoint to receive verification event notifications. This allows your application to receive real-time updates when verification statuses change. ### Use Cases - Setting up real-time verification notifications - Configuring webhook endpoints for your application - Specifying which events should trigger notifications ### Notes - This endpoint requires an API key with webhook configuration permissions - The webhook URL must be publicly accessible and support HTTPS - Webhooks are signed using a secret to verify authenticity - Webhook requests will time out after 10 seconds operationId: post-configure-webhook requestBody: required: true content: application/json: schema: type: object required: - url properties: url: type: string format: uri description: | The HTTPS URL that will receive webhook notifications example: https://example.com/webhooks/urtentic secret: type: string description: | Secret key used to sign webhook payloads for verification. If not provided, a random secret will be generated. example: whsec_8fJ9LKps6YtG3xZD7N2W events: type: array description: > List of events to subscribe to. If empty, all events will be sent. items: type: string enum: - verification.created - verification.updated - verification.completed - verification.failed - document.verified - liveness.verified - email.verified - location.verified example: - verification.completed - verification.failed active: type: boolean description: | Whether this webhook endpoint is active. Defaults to true. default: true example: true examples: webhook_config: value: url: https://example.com/webhooks/urtentic secret: whsec_8fJ9LKps6YtG3xZD7N2W events: - verification.completed - verification.failed active: true responses: '201': description: Webhook endpoint configured successfully content: application/json: schema: type: object properties: id: type: string description: Unique identifier for the webhook configuration example: wh_7dJ9LKps6YtG3xZD7N2W url: type: string format: uri example: https://example.com/webhooks/urtentic secret: type: string example: whsec_8fJ9LKps6YtG3xZD7N2W events: type: array items: type: string example: - verification.completed - verification.failed active: type: boolean example: true createdAt: type: string format: date-time example: '2023-06-15T14:30:00Z' examples: success: value: id: wh_7dJ9LKps6YtG3xZD7N2W url: https://example.com/webhooks/urtentic secret: whsec_8fJ9LKps6YtG3xZD7N2W events: - verification.completed - verification.failed active: true createdAt: '2023-06-15T14:30:00Z' '400': description: Invalid webhook configuration content: application/json: schema: type: object properties: error: type: string message: type: string examples: invalid_url: value: error: INVALID_WEBHOOK_URL message: Webhook URL must use HTTPS protocol security: - apiKeyAuth: [] components: {} ````