JostKYC API allows verification using a popup system while selecting your customized colour themes that conforms to your website colours. This allows you to verify your users without them leaving your website. It provides a unique system to make your users stay focused.

All successful and approved verification will return a callback response if provided. The callback response contains a preview link field to view user verification details. Check the preview sample section below for details. To use JostKYC API, you must sign up for an account. You will require your Connection ID from your "Connection Settings" area of your account.

For all successful verification request, an initial status indicating that verification was completed is sent to callback url (if provided). When the verification is reviewed and approved or suspended either by Merchant or Jostkyc, another status indicator is sent to the callback url.

All submitted verification, usually are reveiwed within 24 hours by our agents. During review, a verification may be approved if all details are valid or suspended if any details provided is invalid and merchant and/or user are/is notified depending on notification settings set by in merchant's account. The provided merchant request callback url is also notified. The callback notification should be handled by merchant in order to update user verification status on merchant platform.

You can read JostKYC Guide for guidance and requirements. Read below for more details on how to integrate. We also provide support for mobile integration. Check the mobile integration section for sample code

Notice to Merchants

  • All completed verifications are automically callbacked as status "Done". When it is reviewed and approved, its status changes to "Completed". It is therefore important you handle the callback appropraitely
  • It is your duty to review your verifications. You can suspend if you find any details supplied as being invalid. When you suspend, user will be notified and you should provide thesame initial verification link on your platform for user to be able to verify. This time around, when they come back, Jostkyc will direct them to provide only invalid details.
  • Only suspend users on Jostkyc for reasons related to their verification.

JostKYC popup API allows you to integerate JostKYC with your website without leaving navigating away. It is easy and very handy to integrate. All that you require to integrate popup API is a reference to Jquery Library, a reference to our third-party Webcam Library and a reference to JostKYC Popup API It may also require bootstrap JS and bootstrap CSS libraries depending on your site architecture. Please, in your integration, ensure the JQuery library is also loaded on your site.

  • Our Popup API requires that you call our function through any click event.
  • The html element with the click event must have the class 'jcverify'.
  • You must also attach the required data attributes to this html element.
  • You must create a div with id "jccontent" to anchor the JostKYC popup.
  • JostKYC Popup API requires that your website is SSL encrypted. User must also have a working webcam.

Check below for parameters, scripts and callbacks.

Note: parameters are all in lower cases.

request_id XXXXXXXX Required Unique ID to identify request
id XXXXXXXXXXXXXXXX Required Connection ID
mode Live | Test Optional Default is Live
type Basic | Standard Optional Default is Standard
emailrequest Jostkyc | Remote Optional Default is Jostkyc. If set to Remote, then Jostkyc platform will send email verification code to merchant callback. Merchant must handle callback to send email code to user. If set to Jostkyc, email verification is sent directly to user from Jostkyc platform. The verification code is stored in field TOKEN
callback URL Optional Verification response will be sent to
footerbackground #083154 Optional Footer colour. Default is #083154
button #083154 Optional Button colour. Default is #083154
country Nigeria | Others Optional Default is Nigeria
phone 2348193837776 Optional User phone number
email Optional User email
firstname Uche Optional User firstname
othernames Audu Optional User other names
lastname Segun Optional User lastname
delete_request No|Yes Optional If Yes verification request record will be deleted after 24 hours and will no longer be available on our system

Sample Script

Minimal requirement approach for JostKYC Popup API

<div id="jccontent"></div>
<a href="#" class="jcverify" data-type="Standard" data-id="XXXXXXXXXXXXXXXXX" data-request_id="YOUR_UNIQUE_IDENTIFIER_FOR_THIS_USER"
 data-callback="" >Click Here</a>
<script src=""></script>
<script src=""></script>
<script src=""></script>

Full options approach for JostKYC Popup API

<div id="jccontent"></div><!-- use this when there is possibility of pop-up been blocked. You may have to check first before rendering -->
<a href="#" class="jcverify" data-type="Standard" data-id="XXXXXXXXXXXXXXXXX" data-email="" data-request_id="time()"
 data-callback="" data-firstname="Firstname" data-lastname="Lastname" data-phone="23480XXXXXXXX"
 data-country="Nigeria" data-type="Standard" >Click Here</a>
<script src=""></script>
<script src=""></script>
<script src=""></script>

Verification Completion

You can monitor if a verification process has been completed by a user or not. An hidden field with class name 'jostkyc_is_completed' is always prevented at every view. The value of the field could be 'Yes','No' or ''. It is 'Yes' when verification process is completed and '' when verification process is still in progress. It is 'No' when verification process is terminated for any reason.

Using this field, you can know when user has completed verification and redirect to a success page. Check the sample code below.

//The hidden field is in the format and values may be "Yes", "No", ""
//<input type="hidden" class="jostkyc_is_completed" name="jostkyc_is_completed" value="No">

  $(document).ready(function(){ setInterval(timer, 1000); });
    function timer(){
		var status= $(".jostkyc_is_completed").val();
			window.location = "";


Below are the parameters that will be sent back in JostKYC Popup API to callback url if provided.

status 0 | 1 | 2 | 3 | 4 0 for Pending, 1 for Completed, 2 for Suspended, 3 for Done, 4 for Email Verification Code
request_id XXXXXXXX Unique ID to identify request
message Parameters are not set Message is json of verification details when status is 1 or 3, email of verified user when status is 2 else text description. The json message for status 1 will contain key with value "COMPLETED" and status 3 will contain key with value "DONE"

Sample Callback

  $status = $_POST["status:];
  $request_id =$_POST["request_id"];
  $message = $_POST["message"];
  //Status Completed
"PREVIEW":"","DETAILS":"Verification successful"}"} **/
  $json= json_decode($message,true);
  //Do other operations;
  // Status Remote Email
  $json= json_decode($message,true);
  $firstname = $json["FIRSTNAME"];
  $token = $json["TOKEN"];
  //Create sample email
  $message = "Dear ".$firstname.",<br><br> Use <b>".$token."</b> as your KYC email verification token. Please disregard if you do not initiate any verification process<br>";
  //Send email;
  //Do other operations
  //Status Suspended
  //Create sample email
  $message = "Hello,<br><br> Your KYC has been rejected. You must login to your account to re-capture your KYC details. You must ensure that you provide accurate, clear and valid details only.<br>";
  //Send email;
  //Do other operations

Jostkyc mobile integration follows same method as explained above. All request and responses will come in the same format. However, we have customized scripts to ease your integration depending on the platform you are using to develop your mobile app.

Our mobile integration relies on the native browser of the IDE you are using. Whatever the IDE is, you may inject your values into the native browser and reference url ''. The reference url already loads Jquery Library, a reference to our third-party Webcam Library and a reference to a mobile version of JostKYC Popup API

Note: You are free to implement and/or customize your mobile application whichever way you want. As such it is not complusory you reference '' as you may decide to reference your own customized private url. However, we advice that you reference the mobile version of JostKYC Popup API that will not load as a popup. Check below for sample scripts for some platforms

  • Android Studio: uses webview suppport. To use webview, you can add it in the activity layout or add it on create. For this sample, we will be using on create. Also since Jostkyc uses javascript and camera, you have to grant access to internet and javascript. You can pass your values using javascript to the .jcverify class. Check below for the sample integration process

    Add webview to onCreate() method
    val myWebView = WebView(activityContext)

    Set internet permission in your manifest
        <uses-permission android:name="android.permission.INTERNET" />

    Enable javascript, zoom, domstorage, file access
    WebView myWebView = (WebView) findViewById(;
    WebSettings webSettings = myWebView.getSettings();
    /** Allow camera access in webview
    webSettings.setWebChromeClient(new WebChromeClient() {
       public void onPermissionRequest(final PermissionRequest request) {
          if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {

    Load page
    /** Your url should be your local page or (if you are injecting directly) **/

  • In your page, load url. For this example, we are passing values from a page on our webserver as such we are referencing ''. In your own case, you reference directly your own local page (where you would then reference '') or you can add an eventlistener which you will use to inject your values directly (in which case you should directly reference '' in your url)
    /** Your url should be your local page or (if you are injecting directly) **/
    var ref ="", "_self", "location=no,clearcache=yes,footer=yes,clearsessioncache=yes,closebuttoncaption=close");
    ref.addEventListener("loadstop", function() {"values_to_inject"});

    Note: In you choose the inject method, you must attach your values as data attributes to the class .jcverify.

You can make a direct HTTP call to JostKYC server, to get the fullname of any of your verified customers, by supplying their email address.
Each successful namecheck costs 0.5 credits (₦5)

The following parameters can be sent, through HTTP GET or POST request to

Input Field Name Description Example Value
connection_id Your JostKYC connnection ID 1505908679QDbzF5mwx4rUKjA
private_key Your private key as specified on your account-settings Abcd1234-
email The valid email-address, for which you want to get the fullname.
Sample codes for getting fullname


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_POST, true);
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$response_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if($response_code != 200)$response=curl_error($ch);

if($response_code != 200)$msg="HTTP ERROR $response_code: $response";
else {

	if($json===null)$msg="INVALID RESPONSE: $response"; 
	else {
		$msg="Fullname: ".$json['data']['fullname'];			

echo $msg;

The response to a successful 'fullname' request will be a JSON Object, containing the requested information,
Below is a sample successful process's response.

{"data":{"fullname":"John Doe","firstname":"John","lastname":"Doe"}}
Below is a sample response to a failed process, a JSON Object
{"error_type":"RECORD","error":"No verification record for"}
The error_type can be any of: BALANCE, RECORD (for missing or unverified record), or AUTH (for missing or invalid request parameters).