API Documentation for Lexicon Application

Welcome to the Lexicon API Documentation. Below, you'll find the detailed API reference for various endpoints categorized under Verifications, Webhooks, and Identities. You can find the OpenAPI schema embedded in this document for deeper insights. Additionally, please follow the integration guide and best practices to maximize the efficiency of your API usage.

Servers

Tags Overview

Endpoints

Webhooks

1. Get Webhook by ID

• Endpoint: GET /lexicon/v1/webhooks/{id}
• Description: Returns the details of a webhook by its ID.
• Parameters:
  • id (path, required): The UUID of the webhook.
• Responses:
  • 200 OK: Webhook details returned.

2. Update Webhook

• Endpoint: PUT /lexicon/v1/webhooks/{id}
• Description: Updates an existing webhook by ID.
• Parameters:
  • id (path, required): The UUID of the webhook.
• Request Body:
  • JSON schema of the updated webhook.
• Responses:
  • 200 OK: Webhook updated successfully.

3. Delete Webhook

• Endpoint: DELETE /lexicon/v1/webhooks/{id}
• Description: Deletes a webhook by ID.
• Parameters:
  • id (path, required): The UUID of the webhook.
• Responses:
  • 200 OK: Webhook deleted successfully.

4. Get All Webhooks

• Endpoint: GET /lexicon/v1/webhooks
• Description: Returns a list of all webhooks.
• Responses:
  • 200 OK: Array of webhooks.

5. Create Webhook

• Endpoint: POST /lexicon/v1/webhooks
• Description: Creates a new webhook.
• Request Body:
  • JSON schema of the webhook to create.
• Responses:
  • 200 OK: Webhook created successfully.

Webhook Integration Guide

How Webhooks Work

Webhooks allow your application to receive real-time updates. Each webhook is triggered by specific events and delivers payloads to a specified endpoint.

Integration Steps

1. Create a Webhook: Use the POST /lexicon/v1/webhooks endpoint to register a webhook.
2. Handle Incoming Events: Ensure your endpoint can handle POST requests and parse incoming payloads.
3. Validate Events: Secure your webhook by validating incoming requests.
4. Test Webhook: Use test events to ensure proper functionality.

Best Practices

• Use HTTPS for secure communication.
• Implement retry logic for failed deliveries.
• Log webhook events for debugging.

Bulk Data Ingestion or Recovery

If you need to perform bulk data ingestion or recover data from events, reach out to your NewRosetta contact for assistance.

For more details or assistance, please refer to the full OpenAPI schema or contact support.