# Individual Verifications

# KYC

And now the good stuff. You have been approved to use the verifications API and now, you're ready to verify your first Individual Identity (KYC) 🎉 . In this section, we will walk you through the entire process from start to finish.

alt text

# Getting started

Before you are allowed to make a request to this endpoint, ensure that you have set a webhook in your developer dashboard's webhook page (opens new window). Without this, your request will fail with a 400 error code. You should also ensure that you have enough balance to cover the cost of the request.

# Endpoint

/verification/individual POST

# Request Body Structure

Parameter Required Description
apiKEY YES Your Verifiedly API Key
firstName YES The individual's first name
lastName YES The individual's last name
ssn YES The individual's full 9 digits SSN
address YES The individual's address
city YES The individual's address city
state YES The individual's address state in ANSI (opens new window) format
zipCode YES The individual's address zip-code
country YES The individual's country in Alpha 2 (opens new window) format

# Sample Request

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
  'firstName': 'Your_First_Name',
  'lastName': 'your_Last_Name',
  'apiKEY': 'your_API_Key',
  'ssn': 'your_FULL_SSN',
  'address': 'your_Address',
  'city': 'your_City',
  'state': 'your_State',
  'country': 'your_Country',
  'zipCode': 'your_Zipcode' 
});
var config = {
  method: 'post',
  url: 'https://api.verified.ly/v1/verification/individual',
  headers: { 
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

# Sample Response (Result Pending)

Note!

You may not get a result on the verification instantly in some cases. If this ever happens, we will provide a result_pending status in the response body in addition to a requestID. Please save this requestID in your database as that is what you will need to get the full result in about 5 minutes.

{
    "message": "Unable to provide a result at the moment . Please check the results endpoint in 5 - 10 minutes using the requestID",
    "status": "result_pending",
    "requestID": "yXDqhKUxhZqQzPSrQafA91wlvn1lXLD2"
}

# Sample Response (Completed)

Note!

In the event that you get a result with the status completed immediately after the request is made, you will receive the full verification result and validated data as a response. You can then use the returned data to complete the user onboarding.

{
    "status": "completed",
    "individual_verification_result": {
        "request_id": "yXDqhKUxhZqQzPSrQafA91wlvn1lXLD2",
        "verification_status": "PASS",
        "failure_reason": null,
        "request_time": "2021-06-24T22:34:38.000Z",
        "individual_details": {
            "first_name": "Samuel",
            "last_name": "Ailemen",
            "individual_address": "6 may drive",
            "individual_city": "baltimore",
            "individual_state": "md",
            "individual_zipcode": "21204",
            "individual_country": "us"
        },
        "validated_individual_address": {
            "primary_number": "6",
            "street_direction": "",
            "street_name": "MAY",
            "street_suffix": "DRIVE",
            "secondary_designator": "",
            "secondary_number": "",
            "city": "BALTIMORE",
            "state": "MD",
            "zip": "21204",
            "county": "BALTIMORE",
            "longitude": -76.800000,
            "latitude": -76.800000,
            "address_type": "residential",
            "building_type": "street",
            "mail_deliverability": "deliverable"
        },
        "individual_ofac_check": {
            "ofac_status": "PASS",
            "ofac_result": null
        }
    }
}

# Verification Result

In the event that you do not get a result immedately an individual verification request is received, you will need to wait a couple of minutes (preferrably 5 - 10) and then request for the updated result.

# Endpoint

/verification/individual/result/:requestID POST

# Sample Request (Verification Result)

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
  'apiKEY': 'your_API_Key' 
});
var config = {
  method: 'post',
  url: 'https://api.verified.ly/v1/verification/individual/result/yXDqhKUxhZqQzPSrQafA91wlvn1lXLD2',
  headers: { 
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});


# Verification status types

TIP

There are only two verification statuses: PASS or FAIL

# PASS

A PASS verification status means that the identity details provided matches official government sources and has been successfully verified.

# FAIL

A FAIL verification status means that the identity details provided does not match official government sources and so has failed the verification.

# Status Codes

Congratulations 🎉 🎉 , you have verified your first individual identity successfully. Here are some status codes to take note of.

Status code Meaning Reason
401 No access You are trying to access an endpoint you don't have access to
401 APIKey issue You are trying to make a request with an invalid api key
200 Success Your request was successful
400 Request error There was an error in your request
Last Updated: 2/27/2022, 10:10:50 PM