Zwayam

Zwayam BGV Capability 

API Reference Guide

Base URL & Authentication

Get Candidate List

Get Candidate Details

Get Candidate Documents

Update BGV Status

Blank

Zwayam Hire - Background verification

Production

Sandbox

<p class="slate-p " >Zwayam is a B2B SaaS-based Applicant Tracking System (ATS) designed to provide a comprehensive end-to-end hiring solution.</p><p class="slate-p " >The Zwayam BGV Capability allows recruiters to seamlessly integrate background verification functionalities into their hiring processes. With this feature, recruiters can automate the process of verifying candidates&apos; backgrounds at various stages, directly within the Zwayam platform. This integrated offering streamlines the hiring process and provides easy access to BGV reports from partnered vendors.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Zwayam is a B2B SaaS-based Applicant Tracking System (ATS) designed to provide a comprehensive end-to-end hiring solution.

The Zwayam BGV Capability allows recruiters to seamlessly integrate background verification functionalities into their hiring processes. With this feature, recruiters can automate the process of verifying candidates' backgrounds at various stages, directly within the Zwayam platform. This integrated offering streamlines the hiring process and provides easy access to BGV reports from partnered vendors.

<p class="slate-p " ></p><h4 class="slate-h4 " >How Integration with standard API works?</h4><p class="slate-p " ></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">When BGV is initiated for a candidate then candidate will be made available in BGV API</div></li><li class="slate-li " ><div style="position:relative">The candidate list which are ready for BGV should be fetched using Get Candidate List</div></li><li class="slate-li " ><div style="position:relative">For each candidate in the list Get Candidate details api should be iterated to fetch candidate details</div></li><li class="slate-li " ><div style="position:relative">Documents uploaded by candidate can be fetched using Get Candidate Documents</div></li><li class="slate-li " ><div style="position:relative">Once all candidate details and documents are fetched, update status of candidate using update BGV status </div></li><li class="slate-li " ><div style="position:relative">The status passed in APIs will be maintained in Zwayam</div></li><li class="slate-li " ><div style="position:relative">Pre-defined status used in Zwayam are</div></li></ol><p class="slate-p slate-indent-1" style="24px">a. PENDING - candidate in BGV ready state</p><p class="slate-p slate-indent-1" style="24px">b. INITIATED - candidate details fetched by vendor via API and BGV initiated from their side</p><p class="slate-p slate-indent-1" style="24px">c. RED - candidate failed in BGV</p><p class="slate-p slate-indent-1" style="24px">d. AMBER - candidate BGV is in progress</p><p class="slate-p slate-indent-1" style="24px">e. GREEN - candidate BGV completed successfully</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

a. PENDING - candidate in BGV ready state

b. INITIATED - candidate details fetched by vendor via API and BGV initiated from their side

e. GREEN - candidate BGV completed successfully

<p class="slate-p slate-indent-0" style="0px">The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.</p><p class="slate-p slate-indent-0" style="0px">It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Authentication</h3><p class="slate-p slate-indent-0" style="0px">When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API&apos;s resources, ensuring that only authorized users can make requests.</p><p class="slate-p slate-indent-0" style="0px">BGV API can be accessed using API keys</p><p class="slate-p " >To get our APIs, <a href="https://www.zwayam.com/" target="_self">Book A Demo</a> with us and explore our comprehensive documentation. </p>

The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.

It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.

When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API's resources, ensuring that only authorized users can make requests.

 with us and explore our comprehensive documentation. 

<p class="slate-p " >Creates a subscription to a subscription plan by a customer.</p><p class="slate-p " >If a card on file is provided in the request, the API provider will charge the card for the subscription. Otherwise, an email invoice is sent to the customer. The subscription begins instantly unless the optional start date parameter is included in the request. Each unique subscription corresponds to a certain region.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Creates a subscription to a subscription plan by a customer.

If a card on file is provided in the request, the API provider will charge the card for the subscription. Otherwise, an email invoice is sent to the customer. The subscription begins instantly unless the optional start date parameter is included in the request. Each unique subscription corresponds to a certain region.

api_key

session_id

instance_key

status

page_no

<p class="slate-p " >Give details of candidates based on ID</p><p class="slate-p " >You can set, modify, and clear the <code class="slate-code">subscription</code> field values.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

candidate_id

<p class="slate-p " >Fetch candidate documents submitted for BGV</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Fetch candidate documents submitted for BGV

applyId

jobId

documentType

subCategory

timeBound

page_number

Successful operation.Returns the document downloadable URLs.

cause

stackTrace

message

suppressed

localizedMessage

timestamp

details

Bad request. Detailed errors are specified in the details section of the response

<p class="slate-p " >Uodated BGV status against candidate</p><p class="slate-p " >Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched.</p><p class="slate-p " >You can also optionally specify <code class="slate-code">customer_ids</code> to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched.

 to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

Sections