As an Background Verification partner working with Keka you can follow these steps to enable your customers to Initiate Background Verification for candidates or employees through Keka and upload the Background Verification results back to Keka.

Step 1: Create a new Background Verification App

• Create a "New App" using the Keka App portal

• Select the "BGV App" template to configure the permissions automatically.

  

• Configure your app by adding the required info in the App URL tab

  • Redirect URL (for Production and Development)
  • Company Name
  • Short Description

• Check the Permissions and Event Subscription tabs

• Add a Request URL on the "Event Subscription" page

  

Step 2: Add Background Verification Category to your app

🚧

Without adding the "Background" category your app will not be visible in the Sandbox for testing as an Background Verification Provider

• Click on the Listing Details tab -> Add "Background Verification" as the app category for your app

  

Step 3: Install your app in the Keka Sandbox

• Now click on the Testing and Installation tab, click on the "Install App" button in the Keka App portal

  

• Open your Keka Sandbox and search for your Background Verification app

  

• Click on Install button on the app listing page and Install your app in the Sandbox.

  

• An OAuth code will be shared with the Redirect URL added by you in Step 1 earlier

• Refer to Step no. 8 on the App builder documentation and create an access token using this OAuth token which will be further used as a "Bearer token" to access Keka APIs

Step 4: Find your "appId"

• You can find and copy your appId from the app URL in the App portal or your Sandbox

📘

Your appId is used as the "vendorId" while accessing the Keka Background Verification API in the next steps

Step 5: Configure Checks for the tenant in which app is installed

• Configure checks at a tenant level using the "Create and Update Checks API"
• In the Add checks API , you can add the following fields:
  • name: The name of the check
  • description: Short description about the check
  • vendorCheckId: You can use this field to add a ID that can be used to identify a check in your system
  • hasMultiple: Set this to true if you want the user to pass a number along with this check
    • Example: "Employment Check by number of years" for 5 years
      
      

Step 6: Initiate a background verification request for a Candidate or Employee from the Keka Interface

• Follow this documentation to initiate a Background Verification request from Keka

Step 7: View Background Verification Requests and Add Report

• Use the Get all BGV Request API to check the Background Verification requests Initiated from Keka
• You will receive the following fields in the list of initiated Background verification requests:
  • id: corresponds to the unique "requestId" for this BGV request
  • candidateId: this is the employeId or candidateId for a particular candidate/employee
  • email, mobileNumber, gender
  • checks: array of list of checks as selected by the customer during initation of the BGV request
  • Partners can use these details to initiate the Background Verification process for a particular employee/ candidate in their system.
• Once the Background Verification Report for a employee/ candidate is ready you can upload it to Keka using the Add bgvRequest Report API
  • Partners can add multiple files while uploading the BGV report but as of now they can only upload a report once.
  • Note: Support for uploading multiple reports at different intervals is currently under development.