JostKYC API

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.

Popup API

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.

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="https://jostkyc.com/api_test" >Click Here</a>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://jostkyc.com/asset/js/cam.min.js"></script>
<script src="https://jostkyc.com/inline/jc.js"></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="sample@yahoo.com" data-request_id="time()"
 data-callback="https://jostkyc.com/api_test" data-firstname="Firstname" data-lastname="Lastname" data-phone="23480XXXXXXXX"
 data-country="Nigeria" data-type="Standard" >Click Here</a>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://jostkyc.com/asset/js/cam.min.js"></script>
<script src="https://jostkyc.com/inline/jc.js"></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">

<script>
  $(document).ready(function(){ setInterval(timer, 1000); });
    function timer(){
		var status= $(".jostkyc_is_completed").val();
        if(status=="Yes"){
			window.location = "https://mysite.com/success";
		}
    }
</script>
 

Callback

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

Sample Callback

  $status = $_POST["status:];
  $request_id =$_POST["request_id"];
  $message = $_POST["message"];
       if($status=="1")
                {
  //Status Completed
   /**{"status":"1","request_id":"xxxxxxxx","message":"{"PHOTOCAPTURE":"https://jostkyc.com/captures/xxxxxxx_xxxx/face_xxxx.xxxx.jpeg",
"IDCAPTURE":"https://jostkyc.com/captures/xxxxx_xxxxx/id_xxxx.xxxx.jpeg","STATUS":"COMPLETED","EMAIL":"sample@yahoo.com",
"PREVIEW":"https://jostkyc.com/preview/xxxxxxx","DETAILS":"Verification successful"}"} **/
  $json= json_decode($message,true);
  $email=$json["EMAIL"];
  //Do other operations;
                }
       if($status=="4")
                {
  // Status Remote Email
  $json= json_decode($message,true);
  $email=$json["EMAIL"];
  $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
                }
           if($status=="2")
                {
  //Status Suspended
  $email=$message;
  //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
                }

Mobile Integration

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 'https://jostkyc.com/inline/jcmobile.php'. 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 'https://jostkyc.com/inline/jcmobile.php' 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)
  setContentView(myWebView)
   

  
  
  Set internet permission in your manifest
  

  <manifest>
      <uses-permission android:name="android.permission.INTERNET" />
  </manifest>
   

  
  
  Enable javascript, zoom, domstorage, file access
  

  WebView myWebView = (WebView) findViewById(R.id.webview);
  WebSettings webSettings = myWebView.getSettings();
  webSettings.setJavaScriptEnabled(true);
  webSettings.setDomStorageEnabled(true);
  webSettings.setBuiltInZoomControls(true);
  webSettings.setAllowFileAccess(true);
  /** Allow camera access in webview
  webSettings.setWebChromeClient(new WebChromeClient() {
     @Override
     public void onPermissionRequest(final PermissionRequest request) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
           request.grant(request.getResources());
        }
     }
  
   });
   

  
  
  Load page
  

  /** Your url should be your local page or https://jostkyc.com/inline/jcmobile.php (if you are injecting directly) **/
  myWebView.loadUrl("https://jostkyc.com/inline/jctest.php")
   

  
  
  
In your page, load url. For this example, we are passing values from a page on our webserver as such we are referencing 'https://jostkyc.com/inline/jctest.php'. In your own case, you reference directly your own local page (where you would then reference 'https://jostkyc.com/inline/jcmobile.php') or you can add an eventlistener which you will use to inject your values directly (in which case you should directly reference 'https://jostkyc.com/inline/jcmobile.php' in your url)


/** Your url should be your local page or https://jostkyc.com/inline/jcmobile.php (if you are injecting directly) **/
var ref = window.open("https://jostkyc.com/inline/jctest.php", "_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.

JostKYC Namecheck

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)

Sample codes for getting fullname

<?php
$post_data=array(
'connection_id'=>'1505908679QDbzF5mwx4rUKjA',
'private_key'=>'Abcd1234-',
'email'=>'sample@example.com'
);

$api_url='https://jostkyc.com/api_check_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);
curl_close($ch);

if($response_code != 200)$msg="HTTP ERROR $response_code: $response";
else {
	$json=@json_decode($response,true);

	if($json===null)$msg="INVALID RESPONSE: $response"; 
	elseif(!empty($json['error']))$msg=$json['error'];
	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"}}

{"error_type":"RECORD","error":"No verification record for sample@example.com"}