# Getting Started

Whether you stumbled on Verifiedly out of curiosity or from a reference, we are glad to have you here. In this developer guide, we will attempt to simplify the most complex processes and get you rolling in minutes rather than days.

Deprecation warning!

We will be deprecating all API's still in V1 in favor of V2. Do not integrate with any V1 API or you will have to go over your integration again soon.

# Introduction

Verifiedly was built to take the complexity out of verifying global identies. Whether it is that of a business or that of an individual, in the Unites States of America or all the way in Nigeria.

Looking to resell our tech?

Shoot us an email at support@verified.ly and we can discuss a reseller agreement and pricing

# Introducing V2

alt text

If you think our V1 Products are interesting, prepare to have your mind blown . After receiving many feedbacks from developers and companies, we have built an even better experience with faster response times, better stability and a more mature API

A few things have changed in the way we handle requests and the structure in which responses are provided. So, if you currently are integrated with the v1 API, you will need to go over your integrations to make these changes. Luckily, for every V1 endpoint, there is a better and more stable V2 alternative.

# Setting up your account

Before you can begin using Verifiedly in either a Sandbox or Live environment, you need an API key. Luckily, that's very easy to get. You can get one on your developer dashboard here (opens new window). Upon registering for an account (if you don't already have one), you will be allowed to start making requests to the Sandbox environment so that you can get a feel of the request and response structure.

Please note!

You will not be able to make any live requests while your account is still in sandbox mode. You will have to request to move to production first.

# Moving to production

Moving to production is a fairly easy process. All you really need to do is, click the button on your developer dashboard that says "Request prod access" . Upon receiving your request to move to production, a customer representative will reach out to you within 24hrs, letting you know the next steps. If everything goes well without any delays from your side, you should have production access within 24hrs.

Helpful Tip!

To make the moving to production access move by as quickly as possible, ensure you have updated account with your live and sandbox webhooks here, added a debit/ credit card to your subsctiption page here (opens new window).

# Live URL

All V1 live requests must be directed to https://api.verified.ly/v1

All V2 live requests must be directed to https://api.verified.ly/v2

# Webhook

Some of our servces eg, Verifications require the presence of a webhook before you are allowed to interact with them. A webhook (opens new window) allows us to communicate with your server whenever we have a result that wasnt available at the time of the original request. Without the presense of one, your request to these endpoints will fail with a 400 error.

# Setting up a Webhook

Setting up a webhook is a fairly easy process. Following the steps listed below will help you ensure that everything is up and running fine.

  1. Create a webhook endpoint on your server with the http request method (opens new window) set as POST since our webhook notification will be sent as POST request from our servers to yours.

  2. Log into your developer dashboard (opens new window) and navigate to the webhooks (opens new window) section and set the webhook endpoint that you created in the previous step.

  3. Click on the Update Webhook button to save the new webhook endpoint. alt text

# Testing a webhook

Now that you have created and added a webhook endpoint to your account, how exactly do you know that it works as expected? We have made that process simple. After adding a webhook, there should now be a Test Webhook button at the top right of the webhooks page. Clicking that button will send a test notification to your specified webhook endpoint. If you are able to see the notification, Great !! it works. If not, you may need to trace back your steps to ensure that you didn't miss anything

# Authorization

In V2 we have intriduced a new method of authorization. In order to use any API in V2, you will have to include your API Key in the Authorization header 'Authorization':'YOUR_API_KEY', or you will receive a 401 error code

We have also changed how we handle requests. Requests must now be provided as JSON with the request header 'Content-Type': 'application/json'

Last Updated: 2/27/2022, 10:10:50 PM