Iverify API Endpoints
Last updated September 16, 2024
Iverify's API provides you with a comprehensive set of endpoints to interact with our verification solutions. This documentation outlines the key endpoints available, their parameters, and how to effectively utilize them to integrate verification seamlessly into your applications and platforms.
Key API Endpoints:
- Authentication Endpoint: The authentication endpoint allows you to authenticate your application and obtain a unique access token necessary for accessing other API endpoints.
- Project Management Endpoints: These endpoints enable you to create and manage projects within the Iverify platform. This includes actions like creating new projects, modifying project settings, and retrieving project details.
- Verification Request Endpoints: This set of endpoints allows you to initiate verification requests for various methods, such as document verification, facial recognition, and liveness detection. You can define the specific verification parameters, including document types, identity criteria, and liveness detection settings.
- Verification Status Endpoints: These endpoints provide you with the verification status of submitted requests. You can retrieve the result of a verification, including confidence levels, detected anomalies, and processing time.
- Data Retrieval Endpoints: Iverify provides endpoints to retrieve data related to your projects, such as user details, verification history, and reports.
- Webhooks Endpoint: Iverify offers a webhooks endpoint for receiving real-time notifications about verification events. This allows you to update your application and processes in real-time based on verification outcomes.
Using the API:
- Choose the Right Endpoint: Select the specific endpoint that aligns with the action you need to perform, like initiating a verification process, retrieving verification results, or managing projects.
- Craft Your Request: Construct your API request, including the necessary parameters and headers. Authentication is typically required through the access token obtained from the authentication endpoint.
- Send the Request: Send the API request using HTTP methods like GET, POST, PUT, or DELETE, depending on the intended action.
- Parse the Response: Analyze the JSON response from the API, which will include the result of the action, any error messages, and relevant data.
- Implement Actions: Based on the API response, implement the necessary actions within your application, such as updating user profiles, providing feedback to users, or triggering specific events.
Was this article helpful?