No results

Help CenterIntegrations and APIGetting Started with Veriff API

Getting Started with Veriff API

Last updated October 8, 2024

Getting Started with Veriff API

The Veriff API provides developers with the tools to integrate Veriff’s identity verification services into their applications. This article guides you through the process of getting started with the Veriff API, ensuring that you can quickly and effectively implement verification functionalities.

Prerequisites

Before you begin using the Veriff API, ensure that you have the following:

  • A registered account with Veriff.
  • API keys which you can obtain from your Veriff account.
  • Basic knowledge of RESTful APIs and JSON.

Step-by-Step Guide

Follow these steps to get started with the Veriff API:

  • 1. Obtain your API key: Log into your Veriff account and navigate to the API section. Here, you will find your API key, which is needed to authenticate your requests.
  • 2. Set up your environment: Choose a programming language and environment where you will make the API calls. You can use tools like Postman for testing your API requests.
  • 3. Make your first API call: Use the following endpoint to initiate a new verification:

Endpoint: POST https://api.veriff.com/v1/sessions

You will need to include the following headers in your request:

  • Authorization: Bearer YOUR_API_KEY
  • Content-Type: application/json

And include the following JSON payload:

{ "webhook": "https://your-domain.com/webhook", "return_url": "https://your-domain.com/return" }

4. Handle the response: After executing the API call, you will receive a response indicating whether the session was created successfully. Handle the response accordingly in your application.

Additional Resources

For additional information, refer to the following resources:

  • Veriff API Documentation: Detailed API specifications and usage examples.
  • Veriff Blog: Updates and best practices.

By following this guide, you can successfully set up and begin using the Veriff API in your applications. With the powerful features available through Veriff, you can enhance the identity verification process for your users.

Was this article helpful?