Welcome to SpringVerify India API Documentation. The endpoints exposed in this documentation are to initiate background verification of a candidate and query the verification report.
\nThe SpringVerify India API is organized around REST. Our API has predictable resource-oriented URLs, accepts form request JSON bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.
\nThe user should already be registered with SpringVerify. If not registered yet, please contact sales@springverify.com
\nThe user should have generated the API token from the SpringVerify dashboard. Steps to create the API token from the dashboard are given below
\nSign in to SpringVerify.
\nGo to SpringVerify/Settings from the Profile button in the top-right corner.
\nNavigate to the Settings tab.
\nUnder Settings Tab. Click on API sub section.
\nClick on the “Generate token” button on the top-right and give a name and expiry to the token and click on “Create” button.
\nCopy the API token and use it to call the APIs provided below.
\nIf you want to see a pictorial version of it. Click here
\nGiven below is the flowchart to show how the flow should be for calling these APIs:
\n![](\"https://lh5.googleusercontent.com/hc9aJt_Z-Ic-2G_DObneR9QTiNhuH3WDCnhraohDqa-IY39sTMVluDYBH5oiqJpP_9TrtsomfzXTJtKXLsPvOFcK34X17hafdUQWOwU1IKaYlM3KDskeYaKYH00y78XlExOTFD44ye7LZNwfhs24ch4EI45UcAfIBjfaoB9m17uah3lSqEK_yjXI4M0eMQ\")
\n\nThis API gives you the details of the configurations setup for your company in SpringVerify along with the package and subtype opted. You will need the package id and subtype id from this API to call the Add Candidate API.
\nPackage: Package is a collection of subtypes
\nSubtype: Subtype is a collection of checks.
\nExample: Lets say your company has opted for two different packages in SpringVerify. One package with a subtype for Freshers (candidates with no past employment experience) and other for Experienced folks (candidates with past employment experience). For Freshers most probably you'll opt for Education check rather than Employment check since there is no past experience. But for Experienced folks you'll opt for employment check rather than Education check. Since the cost for both combinations is same. Both the subtypes can now share same package balance.
\nResponse Parameters:
\nRequest Parameters
\nThis API gives you the details of the candidate. Response includes
\nOverall status of the case
\nURL of the report
\n[Optional] Check statuses of every check associated with the case.
\nPass either candidate_id, candidate_uuid or email to get details for single candidate
\nPass limit and offset to get list of candidate details, where limit can be max 100 and max 50 if include_check_details or include_check_status is 1 (true)
\nThis API returns the BGV report file of the candidate
\n","urlObject":{"path":["external","v1","candidate","report","pdf"],"host":["{{base_url}}"],"query":[{"key":"candidate_id","value":"{{candidate_id}}"}],"variable":[]}},"response":[],"_postman_id":"1eaa84d1-eafd-4294-a148-fae56ad33a3c"}],"event":[{"listen":"prerequest","script":{"id":"5facc80d-6554-40cf-81ad-2158e75938b0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ec9cac23-b760-4c67-85e2-6a78071dd4f1","type":"text/javascript","exec":[""]}}]}