Create Onboarding APIs in Darwinbox

How to Integrate SpringVerify with DarwinBox - Step 3 Create Onboarding APIs

Create Onboarding APIs in Darwinbox

1: Start by navigating to the DarwinBox Studio from the admin app section.

2: Once in the box studio, proceed to the studio user.

3: Click on the add user option.



4. Enter the Onboarding underscore test. Provide the vendor's email ID, username, and password.
Note that this username and password will be used for authentication.

  

5: After creating the studio user, navigate to the inbox API keys. Click on configure to our inbox API.


6: 
If the key type is static, provide the Studio user ID and password that you've created. If it's dynamic, call the token API from the doc token API documentation to fetch the access token.

7: You'll need to share four APIs from the inbox with SpringVerify. The first is the candidate list.

8: Select the user that you've created as the studio user. The module should be onboarding and the endpoint should be candidate list feed. Click on create.

9: Once created, click on the view icon.



10: Share this API key with the SpringVerify. This will allow SpringVerify to access the API and view the list of candidates ready for onboarding.

11: Next, configure the candidate details API. Select the studio user you created.



12:
Change the module to onboarding and select the candidate detail v2 endpoint.



13: After creating, click on the view icon and share this API key with the SpringVerify.

14: The third API is the file download API. Select the user, set the module to onboarding, and the endpoint to candidate file download API.



15:
Click on create

16: Click on the view icon and share this API key with SpringVerify. This API allows the SpringVerify  to download files uploaded by the candidate.


17:
The fourth API is the report submission API . Select the user, set the module to onboarding, and the endpoint to report submission API.
18: Click on create 19: Once the verification is completed, SpringVerify will submit the BGV report for the candidate using this API.

20: You can refer to the documentation to understand how to use the APIs.

API Endpoints Required

API

Endpoint

Purpose

Fetch Candidate List V2

https://{{subdomain}}.darwinbox.in/Bgv/candidatelistv2

Retrieve candidate list for initiation

Fetch Candidate Details V2

https://{{subdomain}}.darwinbox.in/Bgv/candidatedetailv2

Fetch detailed candidate information

Download Form Attachments

https://{{subdomain}}.darwinbox.in/Bgv/filedownloadv2

Download candidate files

Submit Verification Report V2

https://{{subdomain}}.darwinbox.in/Bgv/reportsubmissionv2

Submit completed BGV report to Darwinbox

Refer API Documentation here
https://api-docs.darwinbox.com/#536ca535-b668-412f-903d-6e9789cf92ff
https://api-docs.darwinbox.com