diff --git a/source/index.html.md b/source/index.html.md index c19eec514e6..1c368efaebc 100644 --- a/source/index.html.md +++ b/source/index.html.md @@ -1,57 +1,51 @@ --- + title: API Reference -language_tabs: # must be one of https://git.io/vQNgJ - - shell - - ruby - - python - - javascript - - java +language_tabs: # must be one of https://git.io/vQNgJ - shell - ruby - python - javascript - java -toc_footers: - - Email us for access +toc_footers: - Email us for access -includes: - - errors +includes: - errors search: true code_clipboard: true + --- # Introduction -Welcome to SpringVerify India API Documentation. The endpoints exposed in this documentation are to collect user information to verify. Example: National ID, past employments or past education etc. The first step is to login to get a JWT token. The token is then used to submit add a candidate (initiate) and then submit documents(ID, education and experience). +Welcome to SpringVerify India API Documentation. The endpoints exposed in this documentation are to collect user information to verify. Example: National ID, past employments or past education etc. The first step is to login to get a JWT token. The token is then used to submit add a candidate (initiate) and then submit documents(ID, education and experience). The 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. - + ## Environment Urls We currently have two environments, development and production. Both the environments have separate databases. During development base url of development environment must be used. ### Development: - https://api-dev.in.springverify.com + +https://api-dev.in.springverify.com ### Production: - https://api.in.springverify.com + +https://api.in.springverify.com ## Postman [![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/collections/87c12d8a47528cde952c) - + # Login - -> The response looks like this - ```shell curl --location --request POST 'https://api-dev.in.springverify.com/v1/auth/login' \ --header 'Content-Type: application/json' \ @@ -61,217 +55,92 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/auth/logi }' ``` -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/auth/login") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request.body = "{\n\t\"email\":\"jackhym23@gmail.com\",\n \"password\":\"999999999\"\n}" - -response = https.request(request) -puts response.read_body -``` - -```python -import http.client -import mimetypes -conn = http.client.HTTPSConnection("api-dev.in.springverify.com") -payload = "{\n\t\"email\":\"jackhym23@gmail.com\",\n \"password\":\"999999999\"\n}" -headers = { - 'Content-Type': 'application/json' -} -conn.request("POST", "/v1/auth/login", payload, headers) -res = conn.getresponse() -data = res.read() -print(data.decode("utf-8")) -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); - -var raw = JSON.stringify({"email":"jackhym23@gmail.com","password":"999999999"}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/auth/login", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n\t\"email\":\"jackhym23@gmail.com\",\n \"password\":\"999999999\"\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/auth/login") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .build(); -Response response = client.newCall(request).execute(); -``` +> The response looks like this ```json { "message": "logged in successfully", "data": { - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6Mn0sImlhdCI6MTU4MjU1MjcyOCwiZXhwIjoxNTg2MTUyNzI4fQ.7zs45ogp_Rcma7sJkzNcH5cnZ6gMQK-NXZjbxDsyFJw" + "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6Mn0sImlhdCI6MTU4MjU1MjcyOCwiZXhwIjoxNTg2MTUyNzI4fQ.7zs45ogp_Rcma7sJkzNcH5cnZ6gMQK-NXZjbxDsyFJw" } } ``` - This API is used to login into the platform. We use Json Web Token for authentication. Please refer [here](https://jwt.io/introduction/) to know more about Json Web Token. It is used as Bearer Token in all the API's appart from login API. - - + Use the credentials provided to your company and the Auth Token for generating JWT token - - - + # Add Candidates + ```shell curl --location --request POST 'https://api-dev.in.springverify.com/v1/candidate' \ - --header 'Content-Type: application/json' \ - --header 'Authorization: Bearer ' \ - --data-raw '{ - "name": "Anurag Sandhu", - "email": "anurag.sandhu@springrole.com", - "consentUrl" : , - "verifications": { - "identity": { - "pan": true, - "drivingLicense": true, - "passport": true, - "voterId": true - }, - "address": { - "current": false, - "permanent": false - }, - "education": { - "10": true, - "12": true, - "bachelor": false, - "masters": true, - "doctorate": true - }, - "workExperience": { - "employments": 1 - }, - "criminalRecord": { - "current": false, - "permanent": false - } - } - }' -``` - -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"Anurag Sandhu\",\n \"email\": \"anurag.sandhu@springrole.com\",\n \"consentUrl\" : \"https://springverify-assets.s3.amazonaws.com/ccl_1574149640_332.pdf\",\n \"verifications\": {\n \"identity\": {\n \"pan\": true,\n \"drivingLicense\": true,\n \"passport\": true,\n \"voterId\": true\n },\n \"address\": {\n \"current\": true,\n \"permanent\": false\n },\n \"education\": {\n \"10\": true,\n \"12\": true,\n \"bachelor\": false,\n \"masters\": true,\n \"doctorate\": true\n },\n \"workExperience\": {\n \"employments\": 1\n },\n \"criminalRecord\": {\n \"current\": true,\n \"permanent\": false\n }\n }\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/candidate") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTA2NTA4MzMsImV4cCI6MTU5NDI1MDgzM30.9N-UbVrZh1894rbsmYuEUmY8CqD7jNuMWkx0KQ521XQ") - .build(); -Response response = client.newCall(request).execute(); -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/candidate") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTA2NTA4MzMsImV4cCI6MTU5NDI1MDgzM30.9N-UbVrZh1894rbsmYuEUmY8CqD7jNuMWkx0KQ521XQ" -request.body = "{\n \"name\": \"Anurag Sandhu\",\n \"email\": \"anurag.sandhu@springrole.com\",\n \"consentUrl\" : \"https://springverify-assets.s3.amazonaws.com/ccl_1574149640_332.pdf\",\n \"verifications\": {\n \"identity\": {\n \"pan\": true,\n \"drivingLicense\": true,\n \"passport\": true,\n \"voterId\": true\n },\n \"address\": {\n \"current\": true,\n \"permanent\": false\n },\n \"education\": {\n \"10\": true,\n \"12\": true,\n \"bachelor\": false,\n \"masters\": true,\n \"doctorate\": true\n },\n \"workExperience\": {\n \"employments\": 1\n },\n \"criminalRecord\": {\n \"current\": true,\n \"permanent\": false\n }\n }\n}" - -response = https.request(request) -puts response.read_body -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTA2NTA4MzMsImV4cCI6MTU5NDI1MDgzM30.9N-UbVrZh1894rbsmYuEUmY8CqD7jNuMWkx0KQ521XQ"); - -var raw = JSON.stringify({"name":"Anurag Sandhu","email":"anurag.sandhu@springrole.com","consentUrl":"https://springverify-assets.s3.amazonaws.com/ccl_1574149640_332.pdf","verifications":{"identity":{"pan":true,"drivingLicense":true,"passport":true,"voterId":true},"address":{"current":true,"permanent":false},"education":{"10":true,"12":true,"bachelor":false,"masters":true,"doctorate":true},"workExperience":{"employments":1},"criminalRecord":{"current":true,"permanent":false}}}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/candidate", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/candidate" - -payload = "{\n \"name\": \"Anurag Sandhu\",\n \"email\": \"anurag.sandhu@springrole.com\",\n \"consentUrl\" : \"https://springverify-assets.s3.amazonaws.com/ccl_1574149640_332.pdf\",\n \"verifications\": {\n \"identity\": {\n \"pan\": true,\n \"drivingLicense\": true,\n \"passport\": true,\n \"voterId\": true\n },\n \"address\": {\n \"current\": true,\n \"permanent\": false\n },\n \"education\": {\n \"10\": true,\n \"12\": true,\n \"bachelor\": false,\n \"masters\": true,\n \"doctorate\": true\n },\n \"workExperience\": {\n \"employments\": 1\n },\n \"criminalRecord\": {\n \"current\": true,\n \"permanent\": false\n }\n }\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTA2NTA4MzMsImV4cCI6MTU5NDI1MDgzM30.9N-UbVrZh1894rbsmYuEUmY8CqD7jNuMWkx0KQ521XQ' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) + --header 'Content-Type: application/json' \ + --header 'Authorization: Bearer ' \ + --data-raw '{ + "name": "Anurag Sandhu", + "email": "anurag.sandhu@springrole.com", + "consentUrl" : , + "uan_number": "XXXXX", + "phone" : "+91XXXXX", + "employeeId": "xxx", + "verifications": { + "identity": { + "pan": true, + "drivingLicense": true, + "passport": true, + "voterId": true + }, + "address": { + "current": false, + "permanent": false + }, + "education": { + "10": true, + "12": true, + "bachelor": false, + "masters": true, + "doctorate": true + }, + "workExperience": { + "employments": 1 + }, + "criminalRecord": { + "current": false, + "permanent": false + } + } + }' ``` > Response looks like this ```json { - "message": "Candidate registered, token shared for further communication of {Anurag Sandhu}", - "uuid": "57e7423d-5ed0-46d9-9d6b-f96255362c40", - "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozNjUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODI4OTA1NDJ9.NqSLyvSicWdvSHEJcS8C3-Q1DAS4N45HtaUlO1ICT0U" + "message": "Candidate registered, token shared for further communication of {Anurag Sandhu}", + "uuid": "57e7423d-5ed0-46d9-9d6b-f96255362c40", + "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozNjUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODI4OTA1NDJ9.NqSLyvSicWdvSHEJcS8C3-Q1DAS4N45HtaUlO1ICT0U" } ``` -Post API to gather candidate's basic details and configuration. The configuration is decided at the company (your) end. +Post API to gather candidate's basic details and configuration. The configuration is decided at the company (your) end. The configuration sent in this api will be validated against enteries in following APIs. For example, if Pan is True, we expect candidate's PAN card in identity verification API. - + + + # Add Candidate Details @@ -282,7 +151,9 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/candidate "candidate_uuid": "da67740b-3c7e-4cb3-95df-32555e12304c", "basic_details": { "full_name": "John Doe", - "employee_id": "412" + "employee_id": "412", + "uan_number": "xx-xx-xx", + "employee_id": "xx" }, "contact_details": { "email": "karan.ahuja@springrole.com", @@ -370,6 +241,7 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/candidate "relative_phone_number": "", "other_phone_number": "+91", "doc_type": "Passport", + preferred_verification_method: "Physical", "other_doc": "", "front_doc_url": "", "back_doc_url": "", @@ -429,85 +301,19 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/candidate } }, "consent": { - "docUrl": "www.google.com" + "doc_url": "www.google.com" }, "send_candidate_consent_email": false }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n \"candidate_uuid\": \"da67740b-3c7e-4cb3-95df-32555e12304c\",\n \"basic_details\": {\n \"full_name\": \"John Doe\",\n \"employee_id\": \"412\"\n },\n \"contact_details\": {\n \"email\": \"karan.ahuja@springrole.com\",\n \"alternate_email\": \"john.doe@personal.com\",\n \"phone_number\": \"+919999999999\",\n \"alternate_phone_number\": \"+918888888888\",\n \"whatsapp_update\": false\n },\n \"id_check\": [\n {\n \"id_type\": \"ind_pan\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\"\n }\n ],\n \"employment_check\": {\n \"no_of_previous_jobs\": 1,\n \"data\": [\n {\n \"company_name\": \"Testone\",\n \"employee_id\": \"567888\",\n \"city\": \"Delhi\",\n \"country\": \"India\",\n \"designation\": \"Dev\",\n \"currently_working\": false,\n \"reason\": \"Test\",\n \"duration\": {\n \"start_date\": \"2008-04-09\",\n \"end_date\": \"2012-06-06\",\n \"currently_working\": false\n },\n \"doc_type\": \"ExperienceLetter\",\n \"proof_doc\": [\n \"\",\n \"\"\n ],\n \"hr_info\": {\n \"full_name\": \"Testing\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+919658447556\"\n },\n \"manager_info\": {\n \"full_name\": \"Testone\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+918954914334\"\n }\n }\n ]\n },\n \"education_check\": [\n {\n \"education_level\": \"Professional Course\",\n \"degree_type\": \"Part Time\",\n \"university_name\": \"Tedt\",\n \"registration_number\": \"66445666\",\n \"degree\": \"Test\",\n \"areas_of_study\": \"Testtest\",\n \"dates_attended\": {\n \"start_date\": \"02/2013\",\n \"end_date\": \"05/2016\"\n },\n \"grade_sheet\": [\"\"],\n \"certificate\": \"\"\n }\n ],\n \"address_check\": {\n \"permanent_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n },\n \"current_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n }\n },\n \"consent\": {\n \"docUrl\": \"www.google.com\"\n },\n \"send_candidate_consent_email\": false\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/candidate/information") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .build(); -Response response = client.newCall(request).execute(); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/candidate/information" - -payload = "{\n \"candidate_uuid\": \"da67740b-3c7e-4cb3-95df-32555e12304c\",\n \"basic_details\": {\n \"full_name\": \"John Doe\",\n \"employee_id\": \"412\"\n },\n \"contact_details\": {\n \"email\": \"karan.ahuja@springrole.com\",\n \"alternate_email\": \"john.doe@personal.com\",\n \"phone_number\": \"+919999999999\",\n \"alternate_phone_number\": \"+918888888888\",\n \"whatsapp_update\": false\n },\n \"id_check\": [\n {\n \"id_type\": \"ind_pan\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\"\n }\n ],\n \"employment_check\": {\n \"no_of_previous_jobs\": 1,\n \"data\": [\n {\n \"company_name\": \"Testone\",\n \"employee_id\": \"567888\",\n \"city\": \"Delhi\",\n \"country\": \"India\",\n \"designation\": \"Dev\",\n \"currently_working\": false,\n \"reason\": \"Test\",\n \"duration\": {\n \"start_date\": \"2008-04-09\",\n \"end_date\": \"2012-06-06\",\n \"currently_working\": false\n },\n \"doc_type\": \"ExperienceLetter\",\n \"proof_doc\": [\n \"\",\n \"\"\n ],\n \"hr_info\": {\n \"full_name\": \"Testing\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+919658447556\"\n },\n \"manager_info\": {\n \"full_name\": \"Testone\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+918954914334\"\n }\n }\n ]\n },\n \"education_check\": [\n {\n \"education_level\": \"Professional Course\",\n \"degree_type\": \"Part Time\",\n \"university_name\": \"Tedt\",\n \"registration_number\": \"66445666\",\n \"degree\": \"Test\",\n \"areas_of_study\": \"Testtest\",\n \"dates_attended\": {\n \"start_date\": \"02/2013\",\n \"end_date\": \"05/2016\"\n },\n \"grade_sheet\": [\"\"],\n \"certificate\": \"\"\n }\n ],\n \"address_check\": {\n \"permanent_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n },\n \"current_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n }\n },\n \"consent\": {\n \"docUrl\": \"www.google.com\"\n },\n \"send_candidate_consent_email\": false\n}" -headers = { - 'Content-Type': 'application/json' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); - -var raw = JSON.stringify({"candidate_uuid":"da67740b-3c7e-4cb3-95df-32555e12304c","basic_details":{"full_name":"John Doe","employee_id":"412"},"contact_details":{"email":"karan.ahuja@springrole.com","alternate_email":"john.doe@personal.com","phone_number":"+919999999999","alternate_phone_number":"+918888888888","whatsapp_update":false},"id_check":[{"id_type":"ind_pan","front_doc_url":"","back_doc_url":""}],"employment_check":{"no_of_previous_jobs":1,"data":[{"company_name":"Testone","employee_id":"567888","city":"Delhi","country":"India","designation":"Dev","currently_working":false,"reason":"Test","duration":{"start_date":"2008-04-09","end_date":"2012-06-06","currently_working":false},"doc_type":"ExperienceLetter","proof_doc":["",""],"hr_info":{"full_name":"Testing","email":"Test@gmail.com","phone_number":"+919658447556"},"manager_info":{"full_name":"Testone","email":"Test@gmail.com","phone_number":"+918954914334"}}]},"education_check":[{"education_level":"Professional Course","degree_type":"Part Time","university_name":"Tedt","registration_number":"66445666","degree":"Test","areas_of_study":"Testtest","dates_attended":{"start_date":"02/2013","end_date":"05/2016"},"grade_sheet":[""],"certificate":""}],"address_check":{"permanent_address":{"house_no":"Tccycfyyd","colony":"Iggihiihi","rented":"false","landmark":"Uffififiiffiififufuf","pincode":"560030","country":"India","city":"Bengaluru ","state":"Karnataka","latitude":"","longitude":"","staying_period":"3 years","is_current_permanent_same":true,"is_candidate_available":true,"other_full_name":"","relation":"","other_relation":"","relative_country_code":"+91","relative_phone_number":"","other_phone_number":"+91","doc_type":"Passport","other_doc":"","front_doc_url":"","back_doc_url":"","front_pdf":true,"back_pdf":false,"single_doc":false,"gmap_address_info":{"lat":null,"lng":null,"full_address":null,"place_id":null},"absence_contact_details":{"full_name":null,"relation":null,"phone_number":null}},"current_address":{"house_no":"Tccycfyyd","colony":"Iggihiihi","rented":"false","landmark":"Uffififiiffiififufuf","pincode":"560030","country":"India","city":"Bengaluru ","state":"Karnataka","latitude":"","longitude":"","staying_period":"3 years","is_current_permanent_same":true,"is_candidate_available":true,"other_full_name":"","relation":"","other_relation":"","relative_country_code":"+91","relative_phone_number":"","other_phone_number":"+91","doc_type":"Passport","other_doc":"","front_doc_url":"","back_doc_url":"","front_pdf":true,"back_pdf":false,"single_doc":false,"gmap_address_info":{"lat":null,"lng":null,"full_address":null,"place_id":null},"absence_contact_details":{"full_name":null,"relation":null,"phone_number":null}}},"consent":{"docUrl":"www.google.com"},"send_candidate_consent_email":false}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/candidate/information", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/candidate/information") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request.body = "{\n \"candidate_uuid\": \"da67740b-3c7e-4cb3-95df-32555e12304c\",\n \"basic_details\": {\n \"full_name\": \"John Doe\",\n \"employee_id\": \"412\"\n },\n \"contact_details\": {\n \"email\": \"karan.ahuja@springrole.com\",\n \"alternate_email\": \"john.doe@personal.com\",\n \"phone_number\": \"+919999999999\",\n \"alternate_phone_number\": \"+918888888888\",\n \"whatsapp_update\": false\n },\n \"id_check\": [\n {\n \"id_type\": \"ind_pan\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\"\n }\n ],\n \"employment_check\": {\n \"no_of_previous_jobs\": 1,\n \"data\": [\n {\n \"company_name\": \"Testone\",\n \"employee_id\": \"567888\",\n \"city\": \"Delhi\",\n \"country\": \"India\",\n \"designation\": \"Dev\",\n \"currently_working\": false,\n \"reason\": \"Test\",\n \"duration\": {\n \"start_date\": \"2008-04-09\",\n \"end_date\": \"2012-06-06\",\n \"currently_working\": false\n },\n \"doc_type\": \"ExperienceLetter\",\n \"proof_doc\": [\n \"\",\n \"\"\n ],\n \"hr_info\": {\n \"full_name\": \"Testing\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+919658447556\"\n },\n \"manager_info\": {\n \"full_name\": \"Testone\",\n \"email\": \"Test@gmail.com\",\n \"phone_number\": \"+918954914334\"\n }\n }\n ]\n },\n \"education_check\": [\n {\n \"education_level\": \"Professional Course\",\n \"degree_type\": \"Part Time\",\n \"university_name\": \"Tedt\",\n \"registration_number\": \"66445666\",\n \"degree\": \"Test\",\n \"areas_of_study\": \"Testtest\",\n \"dates_attended\": {\n \"start_date\": \"02/2013\",\n \"end_date\": \"05/2016\"\n },\n \"grade_sheet\": [\"\"],\n \"certificate\": \"\"\n }\n ],\n \"address_check\": {\n \"permanent_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n },\n \"current_address\": {\n \"house_no\": \"Tccycfyyd\",\n \"colony\": \"Iggihiihi\",\n \"rented\": \"false\",\n \"landmark\": \"Uffififiiffiififufuf\",\n \"pincode\": \"560030\",\n \"country\": \"India\",\n \"city\": \"Bengaluru \",\n \"state\": \"Karnataka\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"staying_period\": \"3 years\",\n \"is_current_permanent_same\": true,\n \"is_candidate_available\": true,\n \"other_full_name\": \"\",\n \"relation\": \"\",\n \"other_relation\": \"\",\n \"relative_country_code\": \"+91\",\n \"relative_phone_number\": \"\",\n \"other_phone_number\": \"+91\",\n \"doc_type\": \"Passport\",\n \"other_doc\": \"\",\n \"front_doc_url\": \"\",\n \"back_doc_url\": \"\",\n \"front_pdf\": true,\n \"back_pdf\": false,\n \"single_doc\": false,\n \"gmap_address_info\": {\n \"lat\": null,\n \"lng\": null,\n \"full_address\": null,\n \"place_id\": null\n },\n \"absence_contact_details\": {\n \"full_name\": null,\n \"relation\": null,\n \"phone_number\": null\n }\n }\n },\n \"consent\": {\n \"docUrl\": \"www.google.com\"\n },\n \"send_candidate_consent_email\": false\n}" - -response = https.request(request) -puts response.read_body -``` - - - POST API to provide all the relevant information of the candidate for verification. Recommended, if you want to send bulk data programmatically or directly integrate this API in your product. -Alternatively, you can use [Get Background Verification URL](https://docs-bgv.springverify.com/#get-background-verification-url) to generate a form URL for the candidate. +Alternatively, you can use [Get Background Verification URL](https://docs-bgv.springverify.com/#get-background-verification-url) to generate a form URL for the candidate. - + Mandatory fields: @@ -522,15 +328,14 @@ all other fields are non-mandatory. Its advisable to send as much information as - For types of ID fields click [here](https://docs-bgv.springverify.com/#identity-verification) - For types of Address fields click [here](https://docs-bgv.springverify.com/#add-address) - - - + + # Get Background Verification URL @@ -543,100 +348,31 @@ curl --location --request GET 'https://api-dev.in.springverify.com/v1/candidate/ }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/candidate/backgroundVerificationUrl") - .method("GET", null) - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ2MzU2MjIsImV4cCI6MTU5ODIzNTYyMn0.tYKb4l911veWQ0JW2sONfkU-aflfLgtDL0P0Ff79PHw") - .addHeader("Content-Type", "application/json") - .build(); -Response response = client.newCall(request).execute(); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/candidate/backgroundVerificationUrl" - -payload = "{\n \"candidateId\": 958\n}" -headers = { - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ2MzU2MjIsImV4cCI6MTU5ODIzNTYyMn0.tYKb4l911veWQ0JW2sONfkU-aflfLgtDL0P0Ff79PHw', - 'Content-Type': 'application/json' -} - -response = requests.request("GET", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ2MzU2MjIsImV4cCI6MTU5ODIzNTYyMn0.tYKb4l911veWQ0JW2sONfkU-aflfLgtDL0P0Ff79PHw"); -myHeaders.append("Content-Type", "application/json"); - -var raw = JSON.stringify({"candidateId":958}); - -var requestOptions = { - method: 'GET', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/candidate/backgroundVerificationUrl", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/candidate/backgroundVerificationUrl") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ2MzU2MjIsImV4cCI6MTU5ODIzNTYyMn0.tYKb4l911veWQ0JW2sONfkU-aflfLgtDL0P0Ff79PHw" -request["Content-Type"] = "application/json" -request.body = "{\n \"candidateId\": 958\n}" - -response = https.request(request) -puts response.read_body -``` - ->Response looks like this +> Response looks like this ```json { - "link": "https://dev-portal.in.springverify.com/candidate/bgv?token=", - "status": 200 + "link": "https://dev-portal.in.springverify.com/candidate/bgv?token=", + "status": 200 } ``` -GET Background Verification (BGV) form's url. Candidate or HR can fill and submit this form for starting a verification of the candidate's information. +GET Background Verification (BGV) form's url. Candidate or HR can fill and submit this form for starting a verification of the candidate's information. We will do the verification and update statuses for the same via dashboard and email. - - - + + # Identity Verification - Post API to store ID cards of the candidate. Optionally, we can do OCR on the uploaded document. - ```shell curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents/identity' \ --header 'Content-Type: application/json' \ @@ -650,75 +386,7 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n\"type\" : \"ind_voter_id\",\n\"docs\" : [ \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"]\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/documents/identity") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozODEsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODQ2MTY0NTR9.CYYjDgp5kmRBxtbQpFmsaP2JB46Fct4yBOOmeW27rQc") - .build(); -Response response = client.newCall(request).execute(); -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozODEsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODQ2MTY0NTR9.CYYjDgp5kmRBxtbQpFmsaP2JB46Fct4yBOOmeW27rQc"); - -var raw = JSON.stringify({"type":"ind_voter_id","docs":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"]}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/documents/identity", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/documents/identity" - -payload = "{\n\"type\" : \"ind_voter_id\",\n\"docs\" : [ \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"]\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozODEsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODQ2MTY0NTR9.CYYjDgp5kmRBxtbQpFmsaP2JB46Fct4yBOOmeW27rQc' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/documents/identity") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjozODEsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSJ9LCJpYXQiOjE1ODQ2MTY0NTR9.CYYjDgp5kmRBxtbQpFmsaP2JB46Fct4yBOOmeW27rQc" -request.body = "{\n\"type\" : \"ind_voter_id\",\n\"docs\" : [ \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"]\n}" - -response = https.request(request) -puts response.read_body -``` - ->Response looks like this +> Response looks like this ```json { @@ -727,15 +395,13 @@ puts response.read_body } ``` +Please give the image url in this API. Use the token which was returned after add candidate API. If your image is in base64, we suggest you host it on your server. -Please give the image url in this API. Use the token which was returned after add candidate API. If your image is in base64, we suggest you host it on your server. - - - + -If you know the front and back, please send in front and back keys. If front and back are not known, please send in the docs as an array. +If you know the front and back, please send in front and back keys. If front and back are not known, please send in the docs as an array. If front and back are provided, we conduct OCR of the document which can be fetched using getCandidate API. Back is optional, so you can only send front of the doc. @@ -747,6 +413,7 @@ Doc Types with keys: 4. PAN (ind_pan) # Add Employment + ```shell curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents/employment' \ --header 'Content-Type: application/json' \ @@ -755,7 +422,7 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents "employments" : [ { "document_type": "ExperienceLetter", - "companyName": "ABC", + "companyName": "ABC", "designation": "1", "currentlyHere": "true", "startDate": "25/11/19", @@ -780,90 +447,20 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents }' ``` -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM"); - -var raw = JSON.stringify({"employments":[{"document_type":"ExperienceLetter","companyName":"ABC","designation":"1","currentlyHere":"true","startDate":"25/11/19","employee_id":"cxz102","location":"New Delhi","country":"India","employmentLinks":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"],"verifications":[{"type":"HR","number":"+91829102833"},{"type":"REPORTINGMANAGER","email":"reporting@manager.com"}]}]}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/documents/employment", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n \"employments\" : [\n {\n \"document_type\": \"ExperienceLetter\",\n\t\t\t\"companyName\": \"ABC\",\n \"designation\": \"1\",\n \"currentlyHere\": \"true\",\n \"startDate\": \"25/11/19\",\n \"employee_id\": \"cxz102\",\n \"location\": \"New Delhi\",\n \"country\": \"India\",\n \"employmentLinks\" : [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"verifications\" : [\n {\n \"type\": \"HR\",\n \"number\": \"+91829102833\"\n },\n {\n \"type\": \"REPORTINGMANAGER\",\n \"email\": \"reporting@manager.com\"\n }\n ]\n }\n ]\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/documents/employment") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM") - .build(); -Response response = client.newCall(request).execute(); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/documents/employment" - -payload = "{\n \"employments\" : [\n {\n \"document_type\": \"ExperienceLetter\",\n\t\t\t\"companyName\": \"ABC\",\n \"designation\": \"1\",\n \"currentlyHere\": \"true\",\n \"startDate\": \"25/11/19\",\n \"employee_id\": \"cxz102\",\n \"location\": \"New Delhi\",\n \"country\": \"India\",\n \"employmentLinks\" : [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"verifications\" : [\n {\n \"type\": \"HR\",\n \"number\": \"+91829102833\"\n },\n {\n \"type\": \"REPORTINGMANAGER\",\n \"email\": \"reporting@manager.com\"\n }\n ]\n }\n ]\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/documents/employment") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM" -request.body = "{\n \"employments\" : [\n {\n \"document_type\": \"ExperienceLetter\",\n\t\t\t\"companyName\": \"ABC\",\n \"designation\": \"1\",\n \"currentlyHere\": \"true\",\n \"startDate\": \"25/11/19\",\n \"employee_id\": \"cxz102\",\n \"location\": \"New Delhi\",\n \"country\": \"India\",\n \"employmentLinks\" : [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"verifications\" : [\n {\n \"type\": \"HR\",\n \"number\": \"+91829102833\"\n },\n {\n \"type\": \"REPORTINGMANAGER\",\n \"email\": \"reporting@manager.com\"\n }\n ]\n }\n ]\n}" - -response = https.request(request) -puts response.read_body -``` - ->Response looks like this +> Response looks like this ```json { - "message": "Employment saved", - "response": [ - "1d20-21f1-13cd-13df" - ] //uuids + "message": "Employment saved", + "response": ["1d20-21f1-13cd-13df"] //uuids } ``` This API is used to add employment details and any relevant docs of the user. Please give the image url in this API. - + Currently Supported Documents with keys @@ -873,9 +470,9 @@ This API is used to add employment details and any relevant docs of the user. Pl 4. Appointment Letter (AppointmentLetter) 5. Others - eg: no specific document (Other) - + # Add Education @@ -940,100 +537,27 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n \"education\": {\n \"10\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1991\",\n \"issue_date\": \"1992\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"12\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1992\",\n \"issue_date\": \"1993\",\n \"links\": []\n },\n \"bachelor\": {\n \"course_type\": \"bachelor\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1993\",\n \"issue_date\": \"1995\",\n \"degree\": \"UG\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"masters\": {\n \"course_type\": \"masters\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1995\",\n \"issue_date\": \"1997\",\n \"links\": [\n \"https://thumbor.forbes.com/thumbor/711x426/https://specials-images.forbesimg.com/dam/imageserve/673357300/960x0.jpg?fit=scale\"\n ]\n },\n \"doctorate\": {\n \"course_type\": \"doctorate\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1998\",\n \"issue_date\": \"1999\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n }\n }\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/documents/education") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM") - .build(); -Response response = client.newCall(request).execute(); -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM"); - -var raw = JSON.stringify({"education":{"10":{"course_type":"10th","institute_name":"tomorrow highland's school","registration_number":"123xyz","start_date":"24/08/1991","issue_date":"1992","links":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"]},"12":{"course_type":"10th","institute_name":"tomorrow highland's school","registration_number":"123xyz","start_date":"24/08/1992","issue_date":"1993","links":[]},"bachelor":{"course_type":"bachelor","institute_name":"tomorrow highland's college","registration_number":"123xyz","start_date":"24/08/1993","issue_date":"1995","degree":"UG","links":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"]},"masters":{"course_type":"masters","institute_name":"tomorrow highland's college","registration_number":"123xyz","start_date":"24/08/1995","issue_date":"1997","links":["https://thumbor.forbes.com/thumbor/711x426/https://specials-images.forbesimg.com/dam/imageserve/673357300/960x0.jpg?fit=scale"]},"doctorate":{"course_type":"doctorate","institute_name":"tomorrow highland's college","registration_number":"123xyz","start_date":"24/08/1998","issue_date":"1999","links":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front","https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"]}}}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/documents/education", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```python -import http.client -import mimetypes -conn = http.client.HTTPSConnection("api-dev.in.springverify.com") -payload = "{\n \"education\": {\n \"10\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1991\",\n \"issue_date\": \"1992\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"12\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1992\",\n \"issue_date\": \"1993\",\n \"links\": []\n },\n \"bachelor\": {\n \"course_type\": \"bachelor\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1993\",\n \"issue_date\": \"1995\",\n \"degree\": \"UG\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"masters\": {\n \"course_type\": \"masters\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1995\",\n \"issue_date\": \"1997\",\n \"links\": [\n \"https://thumbor.forbes.com/thumbor/711x426/https://specials-images.forbesimg.com/dam/imageserve/673357300/960x0.jpg?fit=scale\"\n ]\n },\n \"doctorate\": {\n \"course_type\": \"doctorate\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1998\",\n \"issue_date\": \"1999\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n }\n }\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM' -} -conn.request("POST", "/v1/documents/education", payload, headers) -res = conn.getresponse() -data = res.read() -print(data.decode("utf-8")) -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/documents/education") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM" -request.body = "{\n \"education\": {\n \"10\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1991\",\n \"issue_date\": \"1992\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"12\": {\n \"course_type\": \"10th\",\n \"institute_name\": \"tomorrow highland's school\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1992\",\n \"issue_date\": \"1993\",\n \"links\": []\n },\n \"bachelor\": {\n \"course_type\": \"bachelor\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1993\",\n \"issue_date\": \"1995\",\n \"degree\": \"UG\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n },\n \"masters\": {\n \"course_type\": \"masters\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1995\",\n \"issue_date\": \"1997\",\n \"links\": [\n \"https://thumbor.forbes.com/thumbor/711x426/https://specials-images.forbesimg.com/dam/imageserve/673357300/960x0.jpg?fit=scale\"\n ]\n },\n \"doctorate\": {\n \"course_type\": \"doctorate\",\n \"institute_name\": \"tomorrow highland's college\",\n \"registration_number\": \"123xyz\",\n \"start_date\": \"24/08/1998\",\n \"issue_date\": \"1999\",\n \"links\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\",\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ]\n }\n }\n}" - -response = https.request(request) -puts response.read_body -``` - -> example response +> Response looks like this ```json { - "message": "Education data saved", - "listOfUploadedDocs": [ - "10", - "masters", - "doctorate" - ], - "listOfNotUploadedDocs": [ - "bachelor" - ], - "ReasonForNoteUploadingDocs": "You may not have selected the config checks while creating the user with springverify", - "Note": "Empty array of any qualification won't get inserted in the DB" + "message": "Education data saved", + "listOfUploadedDocs": ["10", "masters", "doctorate"], + "listOfNotUploadedDocs": ["bachelor"], + "ReasonForNoteUploadingDocs": "You may not have selected the config checks while creating the user with springverify", + "Note": "Empty array of any qualification won't get inserted in the DB" } ``` This API is used to add education details and any relevant docs of the candidate. - + - + Supported Documents with Keys @@ -1062,6 +586,7 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents "zipcode": "560095", "country": "India", "length_of_stay": "10 years", + "preferred_verification_method: "Physical", "city": "Bengaluru", "state": "Karnataka", "is_candidate_available": true, @@ -1072,90 +597,20 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/documents }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n \"isPermanent\" : false,\n \"addressLinks\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"docType\": \"Driving License\",\n \"is_current_permanent_same\": true,\n \"currently_reside\": \"YES\",\n \"address_type\": \"Own / Parents\",\n \"landmark\": \"Temple\",\n \"zipcode\": \"560095\",\n \"country\": \"India\",\n \"length_of_stay\": \"10 years\",\n \"city\": \"Bengaluru\",\n \"state\": \"Karnataka\",\n \"is_candidate_available\": true,\n \"point_of_contact\" :{\n \"number\":\"+91892001010\",\n \"type\": \"FRIEND\"\n }\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/documents/address") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM") - .build(); -Response response = client.newCall(request).execute(); -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/documents/address" - -payload = "{\n \"isPermanent\" : false,\n \"addressLinks\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"docType\": \"Driving License\",\n \"is_current_permanent_same\": true,\n \"currently_reside\": \"YES\",\n \"address_type\": \"Own / Parents\",\n \"landmark\": \"Temple\",\n \"zipcode\": \"560095\",\n \"country\": \"India\",\n \"length_of_stay\": \"10 years\",\n \"city\": \"Bengaluru\",\n \"state\": \"Karnataka\",\n \"is_candidate_available\": true,\n \"point_of_contact\" :{\n \"number\":\"+91892001010\",\n \"type\": \"FRIEND\"\n }\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM"); - -var raw = JSON.stringify({"isPermanent":false,"addressLinks":["https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front"],"docType":"Driving License","is_current_permanent_same":true,"currently_reside":"YES","address_type":"Own / Parents","landmark":"Temple","zipcode":"560095","country":"India","length_of_stay":"10 years","city":"Bengaluru","state":"Karnataka","is_candidate_available":true,"point_of_contact":{"number":"+91892001010","type":"FRIEND"}}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/documents/address", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/documents/address") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo5NzksImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGwsImZvcm1GaWxsZWRCeSI6bnVsbH0sImlhdCI6MTU5NDg5MDI1MX0.olJF36gE50i5-iAmtjNCGyMPJZQ5xjOWOWVusMTuKCM" -request.body = "{\n \"isPermanent\" : false,\n \"addressLinks\": [\n \"https://springverify-assets-id.s3.amazonaws.com/323/ind_driving_license-front\"\n ],\n \"docType\": \"Driving License\",\n \"is_current_permanent_same\": true,\n \"currently_reside\": \"YES\",\n \"address_type\": \"Own / Parents\",\n \"landmark\": \"Temple\",\n \"zipcode\": \"560095\",\n \"country\": \"India\",\n \"length_of_stay\": \"10 years\",\n \"city\": \"Bengaluru\",\n \"state\": \"Karnataka\",\n \"is_candidate_available\": true,\n \"point_of_contact\" :{\n \"number\":\"+91892001010\",\n \"type\": \"FRIEND\"\n }\n}" - -response = https.request(request) -puts response.read_body -``` - ->Response looks like +> Response looks like this ```json { - "message": "Address saved", - "uuid": [ - "457b4cce-f5a8-494e-901e-42959b74395e" - ] + "message": "Address saved", + "uuid": ["457b4cce-f5a8-494e-901e-42959b74395e"] } ``` API to upload candidate's address information for verification. - + Point of contact type can be: @@ -1171,9 +626,19 @@ Address Type can be: 1. Own / Parents 2. Rented - +Preferred Verification Method + +The key preferred_verification_method can be used (optional) to indicate what method of verification is preferred. Values are: + +1. PHYSICAL +2. POSTAL +3. DIGITAL + +If not provided, we will decide on the verification method. + + # Get Candidate @@ -1186,547 +651,426 @@ curl --location --request POST 'https://api-dev.in.springverify.com/v1/candidate }' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("application/json"); -RequestBody body = RequestBody.create(mediaType, "{\n\t\"uuid\" : [\"b2c147ee-c971-41f9-bd86-98b2b13f6dac\"]\n}"); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/candidate/fetch") - .method("POST", body) - .addHeader("Content-Type", "application/json") - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo2NzUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGx9LCJpYXQiOjE1OTA2NTE3NDJ9.-1uPRImDyqRFumQKzgW5EpKexBJT4J5fCrnlgbEarWw") - .build(); -Response response = client.newCall(request).execute(); -``` - -```javascript -var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); -myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo2NzUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGx9LCJpYXQiOjE1OTA2NTE3NDJ9.-1uPRImDyqRFumQKzgW5EpKexBJT4J5fCrnlgbEarWw"); - -var raw = JSON.stringify({"uuid":["b2c147ee-c971-41f9-bd86-98b2b13f6dac"]}); - -var requestOptions = { - method: 'POST', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api-dev.in.springverify.com/v1/candidate/fetch", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/candidate/fetch") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo2NzUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGx9LCJpYXQiOjE1OTA2NTE3NDJ9.-1uPRImDyqRFumQKzgW5EpKexBJT4J5fCrnlgbEarWw" -request.body = "{\n\t\"uuid\" : [\"b2c147ee-c971-41f9-bd86-98b2b13f6dac\"]\n}" - -response = https.request(request) -puts response.read_body -``` - -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/candidate/fetch" - -payload = "{\n\t\"uuid\" : [\"b2c147ee-c971-41f9-bd86-98b2b13f6dac\"]\n}" -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImNhbmRpZGF0ZUlkIjo2NzUsImNvbXBhbnlJZCI6Miwicm9sZSI6ImNhbmRpZGF0ZSIsImVtYWlsIjpudWxsLCJjb21wYW55TmFtZSI6bnVsbCwiY29tcGFueUxvZ29VcmwiOm51bGwsImFjY2Vzc0xldmVsIjpudWxsLCJ1c2VySWQiOm51bGx9LCJpYXQiOjE1OTA2NTE3NDJ9.-1uPRImDyqRFumQKzgW5EpKexBJT4J5fCrnlgbEarWw' -} - -response = requests.request("POST", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` - This API is used to get candidates in bulk. You can provide multiple candidates in array. - - - -> Example Response (with all possible fields) + + +### Status mapping for Candidate (overall) level Verification + +| Integer | Status | API ENUM | +| ------- | ------------------ | ----------------- | +| 0 | In Progress | inProgress | +| 1 | Verified | verified | +| 2 | Candidate Added | candidateAdded | +| 3 | Awaiting Input | awaitingInput | +| 4 | Processing | processing | +| 5 | Discrepancy | discrepancy | +| 6 | Unable To Verify | unableToVerify | +| 7 | Insufficient info | inSufficiency | +| 8 | Closed | closed | +| 9 | On Hold | onHold | +| 10 | Cancelled | cancelled | +| 11 | Consent Missing | consentMissing | +| 12 | Insufficient Funds | insufficientFunds | + +### Status mapping for Check (id, employment etc) level Verification + +| Integer | Status | API ENUM | +| ------- | -------------------------- | ---------------- | +| -2 | Completed with Discrepancy | discrepancy | +| -1 | Insufficiency | insufficiency | +| 0 | In progress | processing | +| 1 | Completed | unable_to_verify | +| 2 | Unable To Verify | verified | +| 3 | Awaiting Input | awaiting_input | +| 4 | In Progress | in_progress | +| 5 | On Hold | on_hold | +| 6 | Closed | closed | +| 6 | Not Applicable | not_applicable | +| 8 | Cancelled | cancelled | +| 9 | Form submitted | form_submitted | +| 10 | Verified Auto | verified_auto | + +> Response looks like this (with all possible fields) ```json [ - { - "id": 279, - "uuid": "949ec540-fa8c-42cf-afc2-41888791755e", - "company_id": 2, - "candidate_id": 279, - "employee_id": "34e", - "phone_number": "9887484784", - "country_code": "IN", - "alt_phone_number": "8876868796", - "alt_country_code": "IN", - "resume": "https://springverify-assets-id.s3.amazonaws.com/-1578307634391-b2460e4c1de616a65546.doc", - "category_id": 16, - "created_at": "2020-01-06T10:47:14.000Z", - "updated_at": "2020-03-04T12:21:49.000Z", - "deleted_at": null, - "candidate_ids": null, - "work_experience": null, - "education": null, - "address": null, - "history": null, - "refcheck": null, - "worldcheck": null, - "creditcheck": null, - "drugscheck": null, - "typeform_url": null, - "signrequest_url": null, - "status": 0, - "signedrequest_status": 0, - "springverify_signature": null, - "consent_letter_url": "https://springverify-assets-id.s3.amazonaws.com/ccl_1578307806_472792.pdf", - "consent_added_at": "2020-01-06T10:50:07.000Z", - "spring_candidate_ip": "172.31.22.211", - "form_filled": "2020-01-06T10:50:10.000Z", - "candidate_added_by": 1, - "form_filled_by": 3, - "consent_added_by": 3, - "who_fills_form": 1, - "past_jobs": "1", - "springscan_id": null, - "candidate": { - "id": 279, - "uuid": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "email": "kafew45165@sammail.ws", - "alternate_email": "rest@gmail.com", - "name": "Kafew", - "type": null, - "created_at": "2020-01-06T10:47:14.000Z", - "updated_at": "2020-01-06T10:47:14.000Z", - "ongrid_id": 19961, - "gender": 2, - "deleted_at": null, - "dob": null, - "father_name": null, - "email_reject_type": "NA", - "user_id": 0, - "candidates_ids": [ - { - "id": 163, - "uuid": "762e2e49-f1d4-482a-8fd3-de04a512f8bd", - "candidate_id": 279, - "type_old": null, - "type": 2, - "identity_candidate_name": "Kafew45165", - "data": "{\"files\":[\"https:\/\/springverify-assets-id.s3.amazonaws.com\/Kafew45165-2-1578320096389-279-2.jpg\"]}", - "parsed_data": "https://springverify-assets-id.s3.amazonaws.com/Kafew45165-1578307705152-279-ind_pan.jpg", - "status": 2, - "qc_check_log_id": null, - "created_at": "2020-01-06T10:50:10.000Z", - "updated_at": "2020-02-19T14:39:03.000Z", - "ongrid_document_id": null, - "ongrid_request_id": null, - "identity_number": "FGSPS5178C", - "ongrid_reports": null, - "father_name": "Sreenath", - "dob": "1990-07-10", - "completed_at": "2020-01-05T18:30:00.000Z", - "comments": "", - "report": "{\"identity_name\":\"\",\"identity_name_status\":\"0\",\"identity_number\":\"\",\"identity_number_status\":\"0\",\"father_name\":\"N\/A\",\"father_name_status\":\"0\",\"dob\":\"09-9-1992\",\"dob_status\":\"1\"}", - "requested_at": "2020-01-05T18:30:00.000Z", - "added_to_report_at": null, - "ops_status_uuid": "N/A", - "isGovernmentVerificationSuccess": -1, - "isIdVerified": -1, - "isFrontNotShared": -1, - "is_migrated": 1, - "deleted_at": null - }, - { - "id": 166, - "uuid": "4938b331-fb66-42e8-a2df-7332bc06aad8", - "candidate_id": 279, - "type_old": null, - "type": 5, - "identity_candidate_name": "Kafew45165", - "data": "{\"files\":[\"https:\/\/springverify-assets-id.s3.amazonaws.com\/Kafew45165-identity_info-1578387628410-279-Voter_Id.jpg\"]}", - "parsed_data": null, - "status": -2, - "qc_check_log_id": null, - "created_at": "2020-01-07T09:00:28.000Z", - "updated_at": "2020-03-04T12:30:12.000Z", - "ongrid_document_id": 20262, - "ongrid_request_id": 14060, - "identity_number": "LBT1381581", - "ongrid_reports": null, - "father_name": "Balaicharan Mandal", - "dob": null, - "completed_at": "2020-03-03T18:30:00.000Z", - "comments": "", - "report": "{\"identity_name\":\"\",\"identity_name_status\":\"0\",\"identity_number\":\"\",\"identity_number_status\":\"0\",\"father_name\":\"\",\"father_name_status\":\"0\",\"dob\":null,\"dob_status\":\"0\"}", - "requested_at": "2020-01-06T18:30:00.000Z", - "added_to_report_at": null, - "ops_status_uuid": "N/A", - "isGovernmentVerificationSuccess": -1, - "isIdVerified": -1, - "isFrontNotShared": -1, - "is_migrated": 1, - "deleted_at": null - } - ], - "candidate_drugs": [ - { - "id": 25, - "uuid": "902f7dfb-aaa8-436d-bcae-df9f775ee52c", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "candidate_name": "Kafew45165", - "verification_type": null, - "sample_type": null, - "panel_type": "5 PANEL", - "status": 0, - "qc_check_log_id": null, - "comments": null, - "requested_date": null, - "completed_date": null, - "created_at": "2020-01-20T10:52:37.000Z", - "updated_at": "2020-01-20T10:52:37.000Z", - "deleted_at": null - } - ], - "candidates_creditchecks": [ - { - "id": 15, - "uuid": "08f2024e-b5b9-44f2-ba94-52c299f17a47", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "name": "Kafew45165", - "pan_number": "FGSPS5178C", - "dob": null, - "address": "TESYTHJGBJHGHJGHJ", - "credit_score": null, - "loan_score": null, - "status": 1, - "qc_check_log_id": null, - "comments": "", - "requested_date": null, - "completed_date": "2020-03-04", - "created_at": "2020-01-06T10:59:58.000Z", - "updated_at": "2020-03-04T12:20:43.000Z", - "deleted_at": null - }, - { - "id": 19, - "uuid": "2e08af0e-9a7d-4084-ba26-efa351768290", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "name": "Kafew45165", - "pan_number": "FGSPS5178C", - "dob": "1990-07-10", - "address": "TESYTHJGBJHGHJGHJ", - "credit_score": null, - "loan_score": null, - "status": 0, - "qc_check_log_id": null, - "comments": null, - "requested_date": null, - "completed_date": null, - "created_at": "2020-01-20T10:52:55.000Z", - "updated_at": "2020-01-20T10:52:55.000Z", - "deleted_at": null - }, - { - "id": 20, - "uuid": "01870e90-0f19-4fdf-bf3d-1afd60b3c353", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "name": "Kafew45165", - "pan_number": "FGSPS5178C", - "dob": "1990-07-10", - "address": "TESYTHJGBJHGHJGHJ", - "credit_score": null, - "loan_score": null, - "status": -1, - "qc_check_log_id": null, - "comments": "", - "requested_date": null, - "completed_date": null, - "created_at": "2020-01-21T11:10:32.000Z", - "updated_at": "2020-01-21T11:11:13.000Z", - "deleted_at": null - } - ], - "candidates_addresses": [ - { - "id": 184, - "uuid": "d4e17b9a-5412-4774-8c50-bb4a2e98dcbb", - "candidate_id": 279, - "address_candidate_name": "Kafew45165", - "provider_request_id": null, - "provider_postal_request_id": null, - "idfy_request_id": null, - "provider_type": null, - "order_number": null, - "sv_postal_id": null, - "address_id": null, - "type": "Permanent Address", - "data": "{\"files\":[\"https:\/\/springverify-assets-id.s3.amazonaws.com\/Kafew45165-1578307738392-279-candidate_ADDRESS_address.png\"]}", - "status": 2, - "qc_check_log_id": null, - "created_at": "2020-01-06T10:50:10.000Z", - "updated_at": "2020-05-06T11:21:49.000Z", - "requested_at": "2020-01-06", - "completed_at": "2020-03-04", - "address_1": "TESYT", - "address_2": "HJGBJHGHJGHJ", - "city": "BANGLORE", - "state": "karnataka", - "zipcode": 560097, - "country": "India", - "landmark": "ergrtgrtgtrg", - "reports": "{\"address_candidate_name_status\":\"0\",\"address_status\":\"0\",\"city_status\":\"0\",\"state_status\":\"0\",\"zipcode_status\":\"0\",\"address_type_status\":\"0\",\"ownership_status_status\":\"0\",\"staying_since_status\":\"0\",\"geo_point\":{\"latitude\":null,\"longitude\":null},\"verification_type\":\"\",\"completed_at\":1583260200000}", - "document_type": "Voter Id", - "is_candidate_available": 1, - "relation_name": null, - "address_information": "{\"address_type\":\"Own \/ Parents\",\"currently_reside\":\"Yes\",\"length_of_stay\":\"6 years\"}", - "gmap_address_info": "{\"lat\":\"\",\"lng\":\"\",\"full_address\":\"\",\"place_id\":\"\"}", - "ops_status_uuid": "N/A", - "deleted_at": null, - "is_file_migrated": 1, - "address_type": null, - "currently_reside": null, - "length_of_stay": null, - "other_document_type": null - } - ], - "candidates_educations": [ - { - "id": 160, - "uuid": "6215f9ff-057c-4535-a46b-b6280a84c639", - "candidate_id": 279, - "education_candidate_name": "Kafew45165", - "institute_name": "rweerf", - "specialization": "computer science", - "authority": "dit", - "type": "GRADUATE", - "course_type": "REGULAR", - "data": "{\"files\":[\"https:\/\/springverify-assets-id.s3.amazonaws.com\/Kafew45165-1578307785420-279-candidate_EDUCATION_education.jpg\"]}", - "document_type": "Degree Certificate", - "status": 1, - "qc_check_log_id": null, - "created_at": "2020-01-06T10:50:10.000Z", - "updated_at": "2020-03-04T12:35:09.000Z", - "ongrid_request_id": null, - "issue_date": "2020-03-02", - "registrationNumber": "e4554554", - "ongrid_document_id": null, - "ongrid_reports": "{\"education_candidate_name_status\":\"0\",\"name_of_institute_status\":\"0\",\"name_of_boarduniversity_status\":\"0\",\"course_name_status\":\"0\",\"course_type_status\":\"0\",\"registration_number_status\":\"0\",\"start_date_status\":\"0\",\"currently_studying_here_status\":\"0\",\"grade_status\":\"0\",\"respondent_name\":\"test\",\"respondent_designation\":\"fgbfgbgfb\",\"respondent_email\":\"tehst@gmail.com\",\"respondent_phone\":\"8954914334\",\"comments\":\"hvghfgh\"}", - "start_date": "February 2018", - "currently_studying_here": 1, - "passing_year": null, - "verification_type": null, - "verification_source": null, - "requested_at": "2020-01-06", - "completed_at": "2020-03-04", - "final_result": "", - "ops_status_uuid": "N/A", - "deleted_at": null, - "is_file_migrated": 1, - "degree": null - } - ], - "candidates_employments": [ - { - "id": 169, - "uuid": "65f81928-844f-49c1-8ed0-169fef16e580", - "candidate_id": 279, - "emp_candidate_name": "Kafew45165", - "company_name": "testueopkv", - "company_data": "{\"files\":[\"https:\/\/springverify-assets-id.s3.amazonaws.com\/Kafew45165-1578307755223-279-candidate_EMPLOYMENT_employment.png\"]}", - "status": 2, - "qc_check_log_id": null, - "created_at": "2020-01-06T10:50:10.000Z", - "updated_at": "2020-03-04T12:33:30.000Z", - "designation": "tester", - "employee_id": "233434", - "location": "Bangalore, Karnataka, India", - "start_date": "2017-03-07", - "currently_here": 0, - "end_date": "2019-09-09", - "verification_type": null, - "completion_date": "2020-03-04", - "ongrid_request_id": null, - "ongrid_document_id": null, - "document_type": "ExperienceLetter", - "ongrid_reports": "{\"name_status\":\"0\",\"company_name_status\":\"0\",\"designation_status\":\"0\",\"employee_id_status\":\"0\",\"working_city_status\":\"0\",\"joining_date_status\":\"0\",\"last_working_date_status\":\"0\",\"currently_here_status\":\"0\",\"reason_for_leaving_status\":\"0\",\"annual_compensation_status\":\"0\",\"rm_name_status\":\"0\",\"rm_email_status\":\"0\",\"rm_phone_status\":\"0\"}", - "hr_name": "test", - "hr_phone": "", - "hr_email": "", - "rm_name": "", - "rm_email": "", - "rm_phone": "", - "recommend_hire": null, - "left_comment": "", - "compensation": "", - "requested_at": "2020-01-05T18:30:00.000Z", - "compensation_type": "", - "initiated_to_vs": null, - "ops_status_uuid": "N/A", - "deleted_at": null, - "is_file_migrated": 1 - } - ], - "candidates_worldchecks": [ - { - "id": 31, - "uuid": "0934deb9-2593-49d0-8ad9-b9b78dca9440", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "candidate_name": "Kafew45165", - "father_name": "Sreenath", - "address": "TESYTHJGBJHGHJGHJ, BANGLORE, karnataka, 560097", - "dob": "1990-07-10", - "verification_type": null, - "status": 0, - "qc_check_log_id": null, - "verifier": null, - "comments": null, - "requested_date": null, - "completed_date": null, - "created_at": "2020-01-20T10:51:55.000Z", - "updated_at": "2020-01-20T10:51:55.000Z", - "deleted_at": null - } - ], - "candidate_histories": [ - { - "id": 23, - "uuid": "b5b54612-c68a-4a55-b3d1-c996c9803202", - "candidate_id": 279, - "address_id": 184, - "comments": "", - "completion_date": "2020-03-04", - "created_at": "2020-03-04T12:22:12.000Z", - "updated_at": "2020-03-04T12:37:25.000Z", - "deleted_at": null, - "status": 2, - "qc_check_log_id": null, - "file_url": null, - "verify_ids": null, - "store_data": null, - "final_data": null, - "algo_type": 11, - "requested_at": "2020-03-04", - "added_to_report_at": null, - "ops_status_uuid": "N/A", - "is_file_migrated": 0 - } - ], - "candidates_refchecks": [ - { - "id": 3, - "uuid": "c38221f2-9257-4623-9a9a-08671fae79a4", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "emp_uuid": null, - "name": "Kafew45165", - "employer_name": "terrtg", - "designation": "rtgrhrth", - "verification_type": "", - "verifier_name": "", - "verifier_phone": "", - "verifier_email": "", - "verifier_designation": "", - "is_verifier_working": 0, - "doj": null, - "lwd": null, - "currently_working": null, - "hr_name": "test", - "hr_phone": "", - "hr_email": "", - "rm_name": "rthrhhtrhy", - "rm_email": "trte@gmail.com", - "rm_phone": "887877647", - "status": 1, - "qc_check_log_id": null, - "comments": "", - "requested_date": null, - "completed_date": "2020-01-06", - "created_at": "2020-01-06T11:00:21.000Z", - "updated_at": "2020-01-06T11:00:21.000Z", - "deleted_at": null - }, - { - "id": 5, - "uuid": "bea817e6-2e2e-45a5-81c9-91f8ff8e6fdc", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "emp_uuid": null, - "name": "Kafew45165", - "employer_name": "", - "designation": "", - "verification_type": "ghnghn", - "verifier_name": "ghnghn", - "verifier_phone": "8984756574855", - "verifier_email": "test@gmail.com", - "verifier_designation": "rfgerggtr", - "is_verifier_working": 1, - "doj": null, - "lwd": null, - "currently_working": null, - "hr_name": "test", - "hr_phone": "", - "hr_email": "", - "rm_name": "", - "rm_email": "", - "rm_phone": "", - "status": 1, - "qc_check_log_id": null, - "comments": "", - "requested_date": null, - "completed_date": "2020-01-06", - "created_at": "2020-01-06T13:17:00.000Z", - "updated_at": "2020-01-06T13:17:00.000Z", - "deleted_at": null - }, - { - "id": 17, - "uuid": "34292294-447f-4ce7-a628-7730c816b661", - "candidate_id": "30f8f49f-947f-4efb-a779-52bf57d7abaa", - "emp_uuid": null, - "name": "Kafew45165", - "employer_name": "", - "designation": "", - "verification_type": null, - "verifier_name": null, - "verifier_phone": "", - "verifier_email": "", - "verifier_designation": null, - "is_verifier_working": null, - "doj": null, - "lwd": null, - "currently_working": null, - "hr_name": "test", - "hr_phone": "", - "hr_email": "", - "rm_name": "", - "rm_email": "", - "rm_phone": "", - - "qc_check_log_id": null, - "comments": null, - "requested_date": null, - "completed_date": null, - "created_at": "2020-01-20T10:53:19.000Z", - "updated_at": "2020-01-20T10:53:19.000Z", - "deleted_at": null - } - ] - } - }, + { + "id": 1038, + "uuid": "d1379de6-10fb-4e18-abad-abdf6f44a12d", + "email": "cemepa7794@academail.net", + "alternate_email": null, + "name": "yisoyip", + "type": null, + "created_at": "2020-08-17T07:58:39.000Z", + "updated_at": "2020-08-19T05:13:29.000Z", + "ongrid_id": null, + "gender": 2, + "deleted_at": null, + "dob": null, + "father_name": null, + "email_reject_type": "NA", + "user_id": 2, + "whatsapp_update": false, + "bgv_slack_notification_shared": false, + "company_candidate_mapping": { + "id": 1035, + "uuid": "24729b97-46e3-4786-8f04-42f14d8a60cc", + "company_id": 2, + "candidate_id": 1038, + "employee_id": "76767867", + "phone_number": "+918976353535", + "country_code": "IN", + "alt_phone_number": "+918973635352", + "alt_country_code": "IN", + "resume": "", + "category_id": null, + "candidate_ids": "564", + "work_experience": null, + "education": "551", + "address": "571", + "history": null, + "refcheck": null, + "worldcheck": null, + "creditcheck": null, + "drugscheck": null, + "typeform_url": null, + "signrequest_url": null, + "status": "verified", + "signedrequest_status": 1, + "springverify_signature": null, + "consent_letter_url": null, + "consent_added_at": null, + "spring_candidate_ip": null, + "form_filled": null, + "candidate_added_by": 2, + "form_filled_by": null, + "consent_added_by": null, + "who_fills_form": 2, + "past_jobs": null, + "springscan_id": "5f3a3c04eb6b480014a6b65e", + "uan_number": null, + "candidate_form": { + "id": 1058, + "uuid": "36f37423-03fc-4e97-a84e-ce4a97c56759", + "row_id": 1035, + "check_type": "1,7,8,6", + "status": 0, + "selected_identity_type": 1 + } + }, + "user": { + "id": 2, + "uuid": "dde7c7ff-1d81-45a9-9e24-e8ad2077d4f1", + "name": "Jack", + "username": null, + "email": "jackhym23@gmail.com", + "access_level": 5, + "mobile": "", + "status": 1, + "auth_key": null, + "password_reset_token": null, + "customer_id": "cust_Dq8sAd6hp3KLxu", + "email_reject_type": "NA", + "designation": "super admin" + }, + "candidate_company_category_mappings": [], + "candidate_user_category_mapping": null, + "candidates_metadata": [ + { + "id": 789, + "uuid": "1ba00f04-5195-4e17-a4a0-dcb80a178d2e", + "candidate_id": "d1379de6-10fb-4e18-abad-abdf6f44a12d", + "type": "PHONENUMBER", + "belongs_to": "CANDIDATE", + "data": "+918973635352" + } + ], + "candidates_addresses": [ + { + "id": 571, + "uuid": "97b0fdab-9340-43ae-8277-5e1c45e8795b", + "candidate_id": 1038, + "address_candidate_name": "yisoyip", + "provider_request_id": null, + "provider_postal_request_id": null, + "idfy_request_id": null, + "provider_type": null, + "order_number": null, + "sv_postal_id": null, + "address_id": null, + "type": "Permanent Address", + "data": "", + "status": "unable_to_verify", + "qc_check_log_id": "5fd1bd58b6e0bf0012445724", + "created_at": "2020-08-18T14:57:42.000Z", + "requested_at": "2020-08-25", + "completed_at": "2020-12-10", + "address_1": "sdfdsgrehe", + "address_2": "", + "city": "tryretetre", + "state": "vccxvxvx", + "zipcode": 123456, + "country": "India", + "landmark": "", + "reports": "{\"address_candidate_name\":\"sfdfsdfs\",\"address_candidate_name_status\":\"-2\",\"address\":\"sfsdfsd\",\"address_status\":\"1\",\"city\":null,\"city_status\":\"0\",\"state\":null,\"state_status\":\"0\",\"zipcode\":null,\"zipcode_status\":\"0\",\"ownership_status\":null,\"ownership_status_status\":\"0\",\"staying_since\":null,\"staying_since_status\":\"0\",\"address_type\":null,\"address_type_status\":\"0\",\"geo_point\":{\"latitude\":null,\"longitude\":null},\"verification_type\":\"PHYSICAL\",\"respondent\":[{\"respondent_name\":null,\"respondent_relationship\":null,\"respondent_email\":null,\"respondent_phone\":null}],\"result\":\"\",\"postal\":{}}", + "document_type": "Driving Licence", + "is_candidate_available": 1, + "relation_name": null, + "address_information": "{}", + "gmap_address_info": null, + "ops_status_uuid": "c19f2cb3-d82d-4951-854c-52a80ef28e80", + "is_file_migrated": 0, + "address_type": null, + "currently_reside": null, + "length_of_stay": null, + "is_current_permanent_same": null, + "preferred_verification_method": "PHYSICAL", + "files": [ + { + "id": 3739, + "uuid": "8f83e2f0-155b-46dd-94bf-8d5b048d0cc4", + "related_uuid": "97b0fdab-9340-43ae-8277-5e1c45e8795b", + "document_url": "https://springverify-assets-id.s3.amazonaws.com/yisoyip-1598447176025-1038-Driving-Licence.pdf", + "is_default": 0, + "is_verified": 0, + "show_in_report": 1, + "relation_id": null, + "active": null + } + ] + } + ], + "candidates_ids": [ + { + "id": 564, + "uuid": "725be610-c196-46fb-b278-99e4f4d21b75", + "candidate_id": 1038, + "type_old": null, + "type": 2, + "identity_candidate_name": "yisoyip", + "data": "{\"files\":[\"https://springverify-assets-id.s3.amazonaws.com/yisoyip-identity-info-1598342165435-1038-Pan.jpg\"]}", + "parsed_data": null, + "status": "verified", + "qc_check_log_id": "5fd1bd2fb6e0bf0012445720", + "created_at": "2020-08-25T13:26:05.000Z", + "ongrid_document_id": null, + "ongrid_request_id": null, + "identity_number": "FGSPS5178C", + "ongrid_reports": null, + "father_name": "SREENATH", + "dob": "1990-07-10", + "completed_at": "2020-12-10T00:00:00.000Z", + "comments": "", + "report": "{\"identity_name\":\"\",\"identity_name_status\":\"0\",\"identity_number\":\"\",\"identity_number_status\":\"0\",\"father_name\":\"\",\"father_name_status\":\"0\",\"dob\":\"\",\"dob_status\":\"0\"}", + "requested_at": "2020-12-10T00:00:00.000Z", + "added_to_report_at": null, + "ops_status_uuid": "909d94f8-0872-49db-a47e-076615c0baeb", + "isGovernmentVerificationSuccess": -1, + "isIdVerified": -1, + "isFrontNotShared": -1, + "is_migrated": 0, + "files": [ + { + "id": 3714, + "uuid": "16266f10-f7c2-4702-b553-14e837412817", + "related_uuid": "725be610-c196-46fb-b278-99e4f4d21b75", + "document_url": "https://springverify-assets-id.s3.amazonaws.com/yisoyip-identity-info-1598342165435-1038-Pan.jpg", + "is_default": 1, + "is_verified": 0, + "show_in_report": 1, + "relation_id": null, + "active": null + } + ] + } + ], + "candidates_educations": [ + { + "id": 551, + "uuid": "22fd7e9b-d52d-41eb-90bc-9b61f91e2b26", + "candidate_id": 1038, + "candidates_education": null, + "education_candidate_name": "yisoyip", + "institute_name": "F", + "specialization": "", + "authority": "", + "type": "NO_EDUCATION", + "course_type": null, + "data": null, + "document_type": null, + "status": "discrepancy", + "qc_check_log_id": "5fd1bdc0b6e0bf001244572f", + "created_at": "2020-08-18T15:13:24.000Z", + "ongrid_request_id": null, + "issue_date": null, + "registrationNumber": "", + "ongrid_document_id": null, + "ongrid_reports": "{\"respondent_name\":\"\",\"respondent_designation\":\"\",\"respondent_email\":\"\",\"respondent_phone\":\"\",\"comments\":\"\",\"verification_type\":\"None\",\"verification_source\":\"None\",\"currently_studying_here\":0,\"currently_studying_here_status\":\"0\",\"education_candidate_name\":\"sdfsdfsdf\",\"education_candidate_name_status\":\"2\",\"start_date\":null,\"start_date_status\":\"0\",\"degree\":\"sdfsdfsd\",\"degree_status\":\"0\",\"year_of_passing\":null,\"year_of_passing_status\":\"0\",\"grade\":null,\"grade_status\":\"0\",\"course_name\":null,\"course_name_status\":\"0\",\"course_type\":null,\"course_type_status\":\"0\",\"name_of_boarduniversity\":\"sfdsfsdfs\",\"name_of_boarduniversity_status\":\"1\",\"name_of_institute\":\"sdsfsdfs\",\"name_of_institute_status\":\"1\",\"registration_number\":null,\"registration_number_status\":\"0\"}", + "start_date": null, + "currently_studying_here": 0, + "passing_year": null, + "verification_type": null, + "verification_source": null, + "requested_at": "2020-12-10", + "completed_at": "2020-12-10", + "final_result": "", + "ops_status_uuid": "N/A", + "is_file_migrated": 0, + "degree": "", + "files": [] + } + ], + "candidate_histories": [ + { + "id": 4743, + "uuid": "a9b0a1e1-5a77-4e38-b6ca-c0e4f1b87333", + "candidate_id": 6300, + "address_id": 5722, + "comments": "No adverse records found.", + "completion_date": "2019-09-16", + "created_at": "2020-08-20T16:09:01.000Z", + "status": "verified", + "qc_check_log_id": "60599c34705e150011402c23", + "file_url": null, + "verify_ids": null, + "store_data": null, + "final_data": null, + "algo_type": 11, + "requested_at": "2019-09-09", + "added_to_report_at": "2020-08-20T12:51:22.000Z", + "ops_status_uuid": "N/A", + "is_file_migrated": 0, + "files": [ + { + "id": 40360, + "uuid": "8f591a3b-821a-4abd-8554-28bc98ab9f83", + "related_uuid": "a9b0a1e1-5a77-4e38-b6ca-c0e4f1b87333", + "document_url": "https://springverify-assets-id.s3.amazonaws.com/Ashok-Sundarrao-Jogdand-1597920009053-6300-history-verify-0.pdf", + "is_default": 0, + "is_verified": 1, + "show_in_report": 1, + "relation_id": null, + "active": null + } + ] + } + ], + "candidates_creditchecks": [ + { + "id": 79, + "uuid": "98f213a2-cdfa-4cbb-8028-655389e6351f", + "candidate_id": "4119a48d-b3f8-4e07-9dd9-d4414c70e01b", + "name": "Ashok Sundarrao Jogdand", + "pan_number": "BKMPA3164J", + "dob": "1995-03-05", + "address": "Sr. #-22/5/1, Lane #-1, Krantiveer Nagar, Near Sancheti School, Thergaon Road, Dange Chowk, Near Sancheti School, Tiger Gym Lane, , Pune, Maharashtra, 411035", + "credit_score": 8, + "loan_score": 720, + "status": 1, + "qc_check_log_id": "6059a04a7a4bba001182824b", + "comments": "test", + "requested_date": null, + "completed_date": "2021-03-23", + "created_at": "2021-03-23T07:43:39.000Z", + "files": [], + "insufficiencyTime": 0, + "onHold": 0, + "elapsedTime": 1, + "effectiveTATTime": 1 + } + ], + "candidates_employments": [ + { + "id": 497, + "uuid": "a5ad238b-f417-4ab0-8dff-c9ca3a3827eb", + "candidate_id": 1038, + "emp_candidate_name": "yisoyip", + "company_name": "xcvxbdfdgsf", + "company_data": null, + "status": "unable_to_verify", + "qc_check_log_id": null, + "created_at": "2020-08-18T15:44:39.000Z", + "designation": "SFE", + "employee_id": "535433", + "location": "dfdsgfdhtee", + "start_date": "", + "currently_here": 0, + "end_date": "", + "verification_type": null, + "completion_date": "2020-12-10", + "ongrid_request_id": null, + "ongrid_document_id": null, + "document_type": "SalarySlip", + "ongrid_reports": "{\"name\":\"Yivaj92035\",\"name_status\":\"2\",\"company_name\":null,\"company_name_status\":\"0\",\"designation\":null,\"designation_status\":\"0\",\"employee_id\":null,\"employee_id_status\":\"0\",\"working_city\":null,\"working_city_status\":\"0\",\"joining_date\":null,\"joining_date_status\":\"0\",\"last_working_date\":null,\"last_working_date_status\":\"0\",\"currently_here\":null,\"currently_here_status\":\"0\",\"rm_name\":null,\"rm_name_status\":\"0\",\"rm_email\":null,\"rm_email_status\":\"0\",\"rm_phone\":null,\"rm_phone_status\":\"0\",\"reason_for_leaving\":null,\"reason_for_leaving_status\":\"0\",\"annual_compensation\":null,\"annual_compensation_status\":\"0\",\"annual_compensation_type\":null,\"comments\":\"\",\"respondent_name\":\"\",\"respondent_designation\":\"\",\"respondent_email\":\"\",\"respondent_phone\":\"\"}", + "hr_name": "", + "hr_phone": null, + "hr_email": null, + "rm_name": "", + "rm_email": null, + "rm_phone": null, + "recommend_hire": null, + "left_comment": "", + "compensation": "", + "requested_at": "2020-12-10T00:00:00.000Z", + "compensation_type": null, + "initiated_to_vs": null, + "ops_status_uuid": "N/A", + "is_file_migrated": 0, + "country": "India", + "files": [ + { + "id": 3711, + "uuid": "8c42c6b3-f235-493d-abf4-9a2c5995a303", + "related_uuid": "a5ad238b-f417-4ab0-8dff-c9ca3a3827eb", + "document_url": "https://springverify-assets-id.s3.amazonaws.com/yisoyip-xcvxbdfdgsf-1598013946721-1038-SalarySlip.png", + "is_default": 0, + "is_verified": 0, + "show_in_report": 1, + "relation_id": null, + "active": null + }, + { + "id": 3716, + "uuid": "72906916-c094-474a-9e7e-72b0e1edbff3", + "related_uuid": "a5ad238b-f417-4ab0-8dff-c9ca3a3827eb", + "document_url": "https://springverify-assets-id.s3.amazonaws.com/yisoyip-1598423104397-1038-verify-report-SalarySlip.png", + "is_default": 0, + "is_verified": 1, + "show_in_report": 1, + "relation_id": null, + "active": null + } + ] + } + ], + "candidate_histories": [ + { + "id": 123, + "uuid": "1e10a301-632a-4b27-9251-b3d370c59257", + "candidate_id": 1038, + "address_id": 571, + "comments": "", + "completion_date": null, + "created_at": "2020-08-25T13:29:22.000Z", + "status": "processing", + "qc_check_log_id": null, + "file_url": null, + "verify_ids": null, + "store_data": null, + "final_data": null, + "algo_type": 11, + "requested_at": null, + "added_to_report_at": null, + "ops_status_uuid": "909d94f8-0872-49db-a47e-076615c0baeb", + "is_file_migrated": 0, + "files": [] + } + ], + "report_url": "https://api-dev-sa.in.springverify.com/candidate/report/pdf?candidate_id=1038&token=" + } ] ``` @@ -1736,68 +1080,14 @@ This API is used to get candidates in bulk. You can provide multiple candidates curl --location --request GET 'https://api-dev.in.springverify.com/v1/candidate/candidates?limit=20&page=2' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ5ODQ2OTcsImV4cCI6MTU5ODU4NDY5N30.eGrdMRasVlpp1xwcVTuiGfwDCujty22ULUxRynmeal0' ``` -```java -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -Request request = new Request.Builder() - .url("https://api-dev.in.springverify.com/v1/candidate/candidates?limit=20&page=2") - .method("GET", null) - .addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ5ODQ2OTcsImV4cCI6MTU5ODU4NDY5N30.eGrdMRasVlpp1xwcVTuiGfwDCujty22ULUxRynmeal0") - .build(); -Response response = client.newCall(request).execute(); -``` -```javascript -var settings = { - "url": "https://api-dev.in.springverify.com/v1/candidate/candidates?limit=20&page=2", - "method": "GET", - "timeout": 0, - "headers": { - "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ5ODQ2OTcsImV4cCI6MTU5ODU4NDY5N30.eGrdMRasVlpp1xwcVTuiGfwDCujty22ULUxRynmeal0" - }, -}; - -$.ajax(settings).done(function (response) { - console.log(response); -}); -``` -```python -import requests - -url = "https://api-dev.in.springverify.com/v1/candidate/candidates?limit=20&page=2" - -payload = {} -headers = { - 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ5ODQ2OTcsImV4cCI6MTU5ODU4NDY5N30.eGrdMRasVlpp1xwcVTuiGfwDCujty22ULUxRynmeal0' -} - -response = requests.request("GET", url, headers=headers, data = payload) - -print(response.text.encode('utf8')) -``` -```ruby -require "uri" -require "net/http" - -url = URI("https://api-dev.in.springverify.com/v1/candidate/candidates?limit=20&page=2") - -https = Net::HTTP.new(url.host, url.port); -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Authorization"] = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiamFja2h5bTIzQGdtYWlsLmNvbSIsImNvbXBhbnlJZCI6MiwidXNlcklkIjoyLCJjb21wYW55TmFtZSI6Im15ZmFrZWljbyB0ZXN0aW5nIiwiYWNjZXNzTGV2ZWwiOjV9LCJpYXQiOjE1OTQ5ODQ2OTcsImV4cCI6MTU5ODU4NDY5N30.eGrdMRasVlpp1xwcVTuiGfwDCujty22ULUxRynmeal0" - -response = https.request(request) -puts response.read_body -``` API to fetch all candidates uploaded by the Company, in a sorted fashion. Sorting is based on action taken on candidate - - + ->Response looks like +> Response looks like this ```json [ @@ -1866,176 +1156,3 @@ limit and page are optional. If not provided, either, default values are limit 1 ... ] ``` - - -