# 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.

# 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

# 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. 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.

# Live URL

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

# Sandbox URL

All sandbox requests must be directed to https://api.verifiedly.dev

# Webhook

Some of our servces eg, Verifications require the presence of a webhook before you are allowed to interact with them. A webhook 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 set as POST since our webhook notification will be sent as POST request from our servers to yours.

  2. Log into your developer dashboard and navigate to the webhooks 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. Cliking 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

Last Updated: 7/28/2021, 11:31:16 PM