diff --git a/source/index.html.md.erb b/source/index.html.md.erb index bc8420b..0544f2e 100644 --- a/source/index.html.md.erb +++ b/source/index.html.md.erb @@ -74,11 +74,7 @@ The language bindings are in cURL, node.js, and PHP. The API documentation is se - **Motor Vehicle Record** check ## Environment URLs - -**Stage**: -https://stage.us.springverify.com -https://api-stage.us.springverify.com - + **Acceptance**: https://acceptance.us.springverify.com https://api-acceptance.us.springverify.com @@ -1191,41 +1187,43 @@ For a registered admin with a valid JWT, this API can be used to get the details ## Get company profile ```shell -curl --location --request GET 'https://api.us.springverify.com/profile' \ +curl --location --request GET 'https://api.us.springverify.com/v2-api/company/profile' \ --header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", 'Bearer JWT_TOKEN'); -fetch('https://api.us.springverify.com/profile', { - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/profile", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN' -}; - var options = { - url: 'https://api.us.springverify.com/profile', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/profile', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN' + } }; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +var request = require('request'); ``` ```php @@ -1235,7 +1233,7 @@ Requests::register_autoloader(); $headers = array( 'Authorization' => 'Bearer JWT_TOKEN' ); -$response = Requests::get('https://api.us.springverify.com/profile', $headers); +$response = Requests::get('https://api.us.springverify.com/v2-api/company/profile', $headers); ``` ```python @@ -1245,14 +1243,14 @@ headers = { 'Authorization': 'Bearer JWT_TOKEN', } -response = requests.get('https://api.us.springverify.com/profile', headers=headers) +response = requests.get('https://api.us.springverify.com/v2-api/company/profile', headers=headers) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/profile") +uri = URI.parse("https://api.us.springverify.com/v2-api/company/profile") request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer JWT_TOKEN" @@ -1274,123 +1272,137 @@ end { "success": true, "data": { - "first_name": "John", - "last_name": "Wick", - "phone": "999999999", - "email": "john@wick.com", - "domain": "wick.com", - "stripe_id": null, + "admin": { + "first_name": "Nitya", + "last_name": "Arora", + "email": "pooja@recrosoft.com", + "phone": "1-9767898764", + "role": "ADMIN", + "is_demo_done": true + }, "company": { - "name": "SmartBrains", + "name": "Recrosoft", "address": "901, Downtown Manhattan", "city": "NY", "state": "NY", "zipcode": "91319", - "tax_id_number": "1234567890", - "s3_logo": "https://spring-verify-us.s3.amazonaws.com/company/wick.com/logo" + "tax_id_number": "12345678", + "logo": "https://spring-verify-us.s3.amazonaws.com/company/recrosoft.com/logo", + "stripe_id": "cus_JywzdHRSP1NFPV", + "domain": "recrosoft.com" }, - "count": [ - { - "count": 0, - "type": null - }, - { - "count": 0, - "type": "FAILED" - }, - { - "count": 0, - "type": "PENDING" - }, - { - "count": 0, - "type": "VERIFIED" - } - ] + "count": { + "awaiting": 195, + "verified": 38, + "pending": 151, + "failed": 13 + } } } ``` For a registered admin with a valid JWT, this API can be used to get the company's profile. This is different from the company details. A company's profile contains details of the company given during registration as well as the count of the candidates whose profiles were verified, failed, or is pending. + + ## Get available packages ```shell -curl --location --request GET 'http://api-stage.us.springverify.com/company/package' \ +curl --location --request GET 'http://api-stage.us.springverify.com/v2-api/company/packages' \ --header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", 'Bearer JWT_TOKEN'); -fetch('http://api-stage.us.springverify.com/company/package', { - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/packages", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN' -}; - var options = { - url: 'http://api-stage.us.springverify.com/company/package', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/packages', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN' + } }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` ```php 'Bearer JWT_TOKEN' -); -$response = Requests::get('http://api-stage.us.springverify.com/company/package', $headers); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/v2-api/company/packages'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python + import requests +url = "https://api.us.springverify.com/v2-api/company/packages" + +payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization': 'Bearer JWT_TOKEN' } -response = requests.get('http://api-stage.us.springverify.com/company/package', headers=headers) +response = requests.request("GET", url, headers=headers, data=payload) + +print(response.text) ``` ```ruby -require 'net/http' -require 'uri' -uri = URI.parse("http://api-stage.us.springverify.com/company/package") -request = Net::HTTP::Get.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" +require "uri" +require "net/http" -req_options = { - use_ssl: uri.scheme == "https", -} +url = URI("https://api.us.springverify.com/v2-api/company/packages") -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" -# response.code -# response.body +response = http.request(request) +puts response.read_body ``` > Success Response: @@ -1403,7 +1415,7 @@ end { "id": "1", "name": "bronze", - "employment": null, + "employment": "0", "education": "0", "professional_license": "0", "civil_court": "0", @@ -1414,14 +1426,13 @@ end "sex_offender_search": "1", "ssn_trace": "1", "global_watchlist": "1", - "price": "750", - "created_at": "2019-07-03T11:07:27.000Z", - "updated_at": "2019-11-11T11:53:38.000Z" + "professional_reference": "0", + "price": "500" }, { "id": "2", "name": "silver", - "employment": null, + "employment": "1", "education": "0", "professional_license": "0", "civil_court": "0", @@ -1432,14 +1443,13 @@ end "sex_offender_search": "1", "ssn_trace": "1", "global_watchlist": "1", - "price": "1500", - "created_at": "2019-07-03T11:07:27.000Z", - "updated_at": "2019-11-11T11:53:38.000Z" + "professional_reference": "0", + "price": "1000" }, { "id": "3", "name": "gold", - "employment": null, + "employment": "2", "education": "0", "professional_license": "0", "civil_court": "0", @@ -1450,14 +1460,13 @@ end "sex_offender_search": "1", "ssn_trace": "1", "global_watchlist": "1", - "price": "2000", - "created_at": "2019-07-03T11:07:27.000Z", - "updated_at": "2019-11-11T11:53:39.000Z" + "professional_reference": "0", + "price": "2000" }, { "id": "4", "name": "platinum", - "employment": null, + "employment": "2", "education": "1", "professional_license": "0", "civil_court": "0", @@ -1468,14 +1477,13 @@ end "sex_offender_search": "1", "ssn_trace": "1", "global_watchlist": "1", - "price": "3000", - "created_at": "2019-07-03T11:07:27.000Z", - "updated_at": "2019-11-11T11:53:39.000Z" + "professional_reference": "0", + "price": "3000" }, { "id": "5", "name": "diamond", - "employment": null, + "employment": "2", "education": "1", "professional_license": "0", "civil_court": "1", @@ -1486,9 +1494,8 @@ end "sex_offender_search": "1", "ssn_trace": "1", "global_watchlist": "1", - "price": "4000", - "created_at": "2019-07-03T11:07:27.000Z", - "updated_at": "2019-11-11T11:53:39.000Z" + "professional_reference": "0", + "price": "4000" } ], "prices": { @@ -1499,13 +1506,16 @@ end "enhanced_driving_license": 200, "kba": 400, "employment": 750, + "mvr": 350, "education": 750, "professional_license": 500, "civil_court": 1000, "one_county_criminal_search": 1000, - "all_county_criminal_search": 1000, + "all_county_criminal_search": 2000, "county_criminal_search": 1000, "package": "", + "professional_reference": 500, + "rerun_criminal": 100, "created_at": "2019-07-03T11:07:27.000Z", "updated_at": "2019-09-18T13:27:52.000Z" } @@ -1515,12 +1525,16 @@ end This API is used to get the available pricing plans and packages. + + ## Invite candidates ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/invite' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/employee/invite' \ --header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ --data-raw '{ "email_list": [ "venunath2@gmail.com" @@ -1553,10 +1567,35 @@ curl --location --request POST 'https://api.us.springverify.com/employee/invite' // FETCH var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); myHeaders.append("Authorization", "Bearer JWT_TOKEN"); +myHeaders.append("Content-Type", "application/json"); -var raw = JSON.stringify({"email_list":["venunath2@gmail.com"],"employee_details":[{"email":"venunath2@gmail.com","first_name":"abcd","last_name":"xyc","middle_name":"zxcz","phone":"21321313","birthdate":"12-12-2012"}],"package":"bronze","addOns":{"employment":0,"education":0,"license":0,"driving_license":0,"civil_court":0,"all_county_criminal_search":false,"county_criminal_search":0,"MVR":false}}); +var raw = JSON.stringify({ + "email_list": [ + "venunath2@gmail.com" + ], + "employee_details": [ + { + "email": "venunath2@gmail.com", + "first_name": "abcd", + "last_name": "xyc", + "middle_name": "zxcz", + "phone": "21321313", + "birthdate": "12-12-2012" + } + ], + "package": "bronze", + "addOns": { + "employment": 0, + "education": 0, + "license": 0, + "driving_license": 0, + "civil_court": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "MVR": false + } +}); var requestOptions = { method: 'POST', @@ -1565,7 +1604,7 @@ var requestOptions = { redirect: 'follow' }; -fetch("https://api.us.springverify.com/employee/invite", requestOptions) +fetch("https://api.us.springverify.com/v2-api/company/employee/invite", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -1575,35 +1614,85 @@ fetch("https://api.us.springverify.com/employee/invite", requestOptions) var request = require('request'); var options = { 'method': 'POST', - 'url': 'https://api.us.springverify.com/employee/invite', + 'url': 'https://api.us.springverify.com/v2-api/company/employee/invite', 'headers': { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' }, - body: JSON.stringify({"email_list":["venunath2@gmail.com"],"employee_details":[{"email":"venunath2@gmail.com","first_name":"abcd","last_name":"xyc","middle_name":"zxcz","phone":"21321313","birthdate":"12-12-2012"}],"package":"bronze","addOns":{"employment":0,"education":0,"license":0,"driving_license":0,"civil_court":0,"all_county_criminal_search":false,"county_criminal_search":0,"MVR":false}}) + body: JSON.stringify({ + "email_list": [ + "venunath2@gmail.com" + ], + "employee_details": [ + { + "email": "venunath2@gmail.com", + "first_name": "abcd", + "last_name": "xyc", + "middle_name": "zxcz", + "phone": "21321313", + "birthdate": "12-12-2012" + } + ], + "package": "bronze", + "addOns": { + "employment": 0, + "education": 0, + "license": 0, + "driving_license": 0, + "civil_court": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "MVR": false + } + }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); - ``` ```php + setUrl('https://api.us.springverify.com/employee/invite'); +$request->setUrl('https://api.us.springverify.com/v2-api/company/employee/invite'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( - 'Content-Type' => 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' )); -$request->setBody('{\n "email_list": [\n "venunath2@gmail.com"\n ],\n "employee_details": [\n {\n "email": "venunath2@gmail.com",\n "first_name": "abcd",\n "last_name": "xyc",\n "middle_name": "zxcz",\n "phone": "21321313",\n "birthdate": "12-12-2012"\n }\n ],\n "package": "bronze",\n "addOns": {\n "employment": 0,\n "education": 0,\n "license": 0,\n "driving_license": 0,\n "civil_court": 0,\n "all_county_criminal_search": false,\n "county_criminal_search": 0,\n "MVR": false\n }\n}'); +$request->setBody('{ +\n "email_list": [ +\n "venunath2@gmail.com" +\n ], +\n "employee_details": [ +\n { +\n "email": "venunath2@gmail.com", +\n "first_name": "abcd", +\n "last_name": "xyc", +\n "middle_name": "zxcz", +\n "phone": "21321313", +\n "birthdate": "12-12-2012" +\n } +\n ], +\n "package": "bronze", +\n "addOns": { +\n "employment": 0, +\n "education": 0, +\n "license": 0, +\n "driving_license": 0, +\n "civil_court": 0, +\n "all_county_criminal_search": false, +\n "county_criminal_search": 0, +\n "MVR": false +\n } +\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { @@ -1620,39 +1709,89 @@ catch(HTTP_Request2_Exception $e) { ``` ```python + import requests +import json -url = "https://api.us.springverify.com/employee/invite" +url = "https://api.us.springverify.com/v2-api/company/employee/invite" -payload="{\n \"email_list\": [\n \"venunath2@gmail.com\"\n ],\n \"employee_details\": [\n {\n \"email\": \"venunath2@gmail.com\",\n \"first_name\": \"abcd\",\n \"last_name\": \"xyc\",\n \"middle_name\": \"zxcz\",\n \"phone\": \"21321313\",\n \"birthdate\": \"12-12-2012\"\n }\n ],\n \"package\": \"bronze\",\n \"addOns\": {\n \"employment\": 0,\n \"education\": 0,\n \"license\": 0,\n \"driving_license\": 0,\n \"civil_court\": 0,\n \"all_county_criminal_search\": false,\n \"county_criminal_search\": 0,\n \"MVR\": false\n }\n}" +payload = json.dumps({ + "email_list": [ + "venunath2@gmail.com" + ], + "employee_details": [ + { + "email": "venunath2@gmail.com", + "first_name": "abcd", + "last_name": "xyc", + "middle_name": "zxcz", + "phone": "21321313", + "birthdate": "12-12-2012" + } + ], + "package": "bronze", + "addOns": { + "employment": 0, + "education": 0, + "license": 0, + "driving_license": 0, + "civil_court": 0, + "all_county_criminal_search": False, + "county_criminal_search": 0, + "MVR": False + } +}) headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) - ``` ```ruby + require "uri" +require "json" require "net/http" -url = URI("https://api.us.springverify.com/employee/invite") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true +url = URI("https://api.us.springverify.com/v2-api/company/employee/invite") +http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) -request["Content-Type"] = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" -request.body = "{\n \"email_list\": [\n \"venunath2@gmail.com\"\n ],\n \"employee_details\": [\n {\n \"email\": \"venunath2@gmail.com\",\n \"first_name\": \"abcd\",\n \"last_name\": \"xyc\",\n \"middle_name\": \"zxcz\",\n \"phone\": \"21321313\",\n \"birthdate\": \"12-12-2012\"\n }\n ],\n \"package\": \"bronze\",\n \"addOns\": {\n \"employment\": 0,\n \"education\": 0,\n \"license\": 0,\n \"driving_license\": 0,\n \"civil_court\": 0,\n \"all_county_criminal_search\": false,\n \"county_criminal_search\": 0,\n \"MVR\": false\n }\n}" - -response = https.request(request) -puts response.read_body +request["Content-Type"] = "application/json" +request.body = JSON.dump({ + "email_list": [ + "venunath2@gmail.com" + ], + "employee_details": [ + { + "email": "venunath2@gmail.com", + "first_name": "abcd", + "last_name": "xyc", + "middle_name": "zxcz", + "phone": "21321313", + "birthdate": "12-12-2012" + } + ], + "package": "bronze", + "addOns": { + "employment": 0, + "education": 0, + "license": 0, + "driving_license": 0, + "civil_court": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "MVR": false + } +}) +response = http.request(request) +puts response.read_body ``` >Success Response: @@ -1661,12 +1800,12 @@ puts response.read_body { "success": true, "data": { - "price": 750, - "id": "0aa10b4e-e4fc-460b-95dc-6f0ca80be061", + "price": 500, + "id": "494a8419-b0f1-4985-8bc5-1cc495c36a57", "count": 1, "employees": [ { - "id": "48d18330-408e-40ff-b898-dac10cb32ce4", + "id": "144b531c-d1d3-40f6-ac1a-07c36352068b", "email": "venunath2@gmail.com" } ] @@ -1684,6 +1823,10 @@ This API is to be used only after using the [Get available packages](https://doc Candidate will be getting email reminders for filling up the form. + + **URL Parameters** | Parameter | Type | Description | @@ -1842,99 +1985,107 @@ This API is used to register the credit card with Stripe for payments. If this A ## Save payment info ```shell -curl --location --request POST 'https://api.us.springverify.com/payment/save-card' \ +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/payment/save-card' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT_TOKEN' \ --data-raw '{ - "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" + "source": "tok_1JVaS4Fq1aDrrzKzGgJoW577" }' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Content-Type", "application/json"); -fetch('https://api.us.springverify.com/payment/save-card', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }) +myHeaders.append("Authorization", "Bearer"); +var raw = JSON.stringify({ + "source": "tok_1JVaS4Fq1aDrrzKzGgJoW577" }); +var requestOptions = { + method: 'POST', + headers: myHeaders, + body: raw, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/payment/save-card", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); + // REQUEST var request = require('request'); - +var options = { + 'method': 'POST', + 'url': 'https://api.us.springverify.com/v2-api/company/payment/save-card', var headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }'; +body: JSON.stringify({ + "source": "tok_1JVaS4Fq1aDrrzKzGgJoW577" + }) -var options = { - url: 'https://api.us.springverify.com/payment/save-card', - method: 'POST', - headers: headers, - body: dataString }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` ```php setUrl('https://api.us.springverify.com/v2-api/company/payment/save-card'); +$request->setMethod(HTTP_Request2::METHOD_POST); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); + +$request->setHeader(array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }'; -$response = Requests::post('https://api.us.springverify.com/payment/save-card', $headers, $data); -``` - -```python -import requests - -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', +)); +$request->setBody('{\n "source": "tok_1JVaS4Fq1aDrrzKzGgJoW577"\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); } - -data = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }' - -response = requests.post('https://api.us.springverify.com/payment/save-card', headers=headers, data=data) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "json" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/payment/save-card") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/v2-api/company/payment/save-card") -req_options = { - use_ssl: uri.scheme == "https", -} +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Post.new(url) +request["Content-Type"] = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +request.body = JSON.dump({ + "source": "tok_1JVaS4Fq1aDrrzKzGgJoW577" +}) -# response.code -# response.body +response = http.request(request) +puts response.read_body ``` > Success Response @@ -1942,233 +2093,153 @@ end ```json { "success": true, - "data": "card saved for the specified user" + "data": { + "id": "091cfd15-bf84-4d6d-b842-5e0f37e0c20b", + "company_id_fk": 53, + "stripe_card_id": "card_1JVaS4Fq1aDrrzKzPT0xUbQO", + "default": true, + "updated_at": "2021-09-03T11:21:25.446Z", + "created_at": "2021-09-03T11:21:25.446Z" + } } ``` To save the token received from the [Save Credit Card in Stripe for Payments](https://docs.us.springverify.com/#save-credit-card-in-stripe-for-payments), use this API. +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +|source | `token` | Token is genrated when you save payment details to stripe. | + + + ## Payment For Invites ```shell -curl --location --request POST 'https://api.us.springverify.com/payment/charge-user' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/payment/charge-user' \ --header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ --data-raw '{ - "id": "2612d112-5827-4b1c-a177-03a85eabd03d", - "send_email": true, - "coupon_code": "" + "id": "009656e5-a327-4513-9a0c-d588a4ed2fdc", + "send_email": false }' ``` ```javascript // FETCH -var fetch = require('node-fetch'); - -fetch('https://api.us.springverify.com/payment/charge-user', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }) -}); +var myHeaders = new Headers(); -// REQUEST +myHeaders.append("Authorization":'Bearer JWT_TOKEN'); +myHeaders.append("Content-Type", "application/json"); -var request = require('request'); +var raw = JSON.stringify({ + "id": "009656e5-a327-4513-9a0c-d588a4ed2fdc", + "send_email": false +}); -var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' +var requestOptions = { + method: 'POST', + headers: myHeaders, + body: raw, + redirect: 'follow' }; -var dataString = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }'; +fetch("https://api.us.springverify.com/v2-api/company/payment/charge-user", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); -var options = { - url: 'https://api.us.springverify.com/payment/charge-user', - method: 'POST', - headers: headers, - body: dataString -}; +// REQUEST -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} +var request = require('request'); +var options = { + 'method': 'POST', + 'url': 'https://api.us.springverify.com/v2-api/company/payment/charge-user', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + "id": "009656e5-a327-4513-9a0c-d588a4ed2fdc", + "send_email": false + }) -request(options, callback); +}; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` ```php 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }'; -$response = Requests::post('https://api.us.springverify.com/payment/charge-user', $headers, $data); -``` - -```python -import requests +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/v2-api/company/payment/charge-user'); +$request->setMethod(HTTP_Request2::METHOD_POST); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' +)); +$request->setBody('{ +\n "id": "009656e5-a327-4513-9a0c-d588a4ed2fdc", +\n "send_email": false +\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); } - -data = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }' - -response = requests.post('https://api.us.springverify.com/payment/charge-user', headers=headers, data=data) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "json" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/payment/charge-user") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/v2-api/company/payment/charge-user") -req_options = { - use_ssl: uri.scheme == "https", -} +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Post.new(url) +request["Authorization"] = 'Bearer JWT_TOKEN' +request["Content-Type"] = "application/json" +request.body = JSON.dump({ + "id": "009656e5-a327-4513-9a0c-d588a4ed2fdc", + "send_email": false +}) -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +response = http.request(request) +puts response.read_body -# response.code -# response.body ``` >Success Response ```json { - "success": true, - "data": { - "id": "ch_1HJdvnFq1aDrrzKzZE6729eZ", - "object": "charge", - "amount": 9999, - "amount_refunded": 0, - "application": null, - "application_fee": null, - "application_fee_amount": null, - "balance_transaction": "txn_1HJdvnFq1aDrrzKzbZXCgvAO", - "billing_details": { - "address": { - "city": null, - "country": null, - "line1": null, - "line2": null, - "postal_code": "42424", - "state": null - }, - "email": null, - "name": "johndoe@gmail.com", - "phone": null - }, - "calculated_statement_descriptor": "SPRINGVERIFY.COM", - "captured": true, - "created": 1598268823, - "currency": "usd", - "customer": "cus_HjgWvwfPN7bKob", - "description": null, - "destination": null, - "dispute": null, - "disputed": false, - "failure_code": null, - "failure_message": null, - "fraud_details": {}, - "invoice": null, - "livemode": false, - "metadata": {}, - "on_behalf_of": null, - "order": null, - "outcome": { - "network_status": "approved_by_network", - "reason": null, - "risk_level": "normal", - "risk_score": 28, - "seller_message": "Payment complete.", - "type": "authorized" - }, - "paid": true, - "payment_intent": null, - "payment_method": "card_1HAD9gFq1aDrrzKzPZUtu418", - "payment_method_details": { - "card": { - "brand": "visa", - "checks": { - "address_line1_check": null, - "address_postal_code_check": "pass", - "cvc_check": null - }, - "country": "US", - "exp_month": 4, - "exp_year": 2024, - "fingerprint": "IpgpMeLB1qGPPEnT", - "funding": "credit", - "installments": null, - "last4": "4242", - "network": "visa", - "three_d_secure": null, - "wallet": null - }, - "type": "card" - }, - "receipt_email": "johndoe@gmail.com", - "receipt_number": null, - "receipt_url": "receipt_url_link", - "refunded": false, - "refunds": { - "object": "list", - "data": [], - "has_more": false, - "total_count": 0, - "url": "/v1/charges/ch_1HJdvnFq1aDrrzKzZE6729eZ/refunds" - }, - "review": null, - "shipping": null, - "source": { - "id": "card_1HAD9gFq1aDrrzKzPZUtu418", - "object": "card", - "address_city": null, - "address_country": null, - "address_line1": null, - "address_line1_check": null, - "address_line2": null, - "address_state": null, - "address_zip": "42424", - "address_zip_check": "pass", - "brand": "Visa", - "country": "US", - "customer": "cus_HjgWvwfPN7bKob", - "cvc_check": null, - "dynamic_last4": null, - "exp_month": 4, - "exp_year": 2024, - "fingerprint": "IygpMeLB1qGPPEnT", - "funding": "credit", - "last4": "4242", - "metadata": {}, - "name": "johndoe@gmail.com", - "tokenization_method": null - }, - "source_transfer": null, - "statement_descriptor": null, - "statement_descriptor_suffix": null, - "status": "succeeded", - "transfer_data": null, - "transfer_group": null - } + "links": [ + { + "email": "www@yopmail.com", + "link": "http://localhost:3000/candidate/personal-details?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoid3d3QHlvcG1haWwuY29tIiwiaWF0IjoxNjMwNjYzNTYyLCJleHAiOjE2MzQyNjM1NjJ9.mh1i6wApq14FDYAymRZ7lYMUnrcP2imUmX-UTkMBhO8", + "id": "f75beef7-a8ee-44d4-a15d-0b5d4391c135" + } + ] } ``` @@ -2187,94 +2258,115 @@ If you have a coupon code you can enter it here. | | | `false` -- returns the verifications links of the candidates. | | coupon_code | `string` | (Optional) Any coupon code that the admin has for discounted pricing | -## Get Single Candidate + + + +## Get company action ```shell -curl --location --request GET 'https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---data-raw '' +curl --location --request GET 'https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0' \ +--header 'Content-Type: application/json' \ +--header 'Content-Type: application/json' \ ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Content-Type", "application/json"); +myHeaders.append("Authorization", 'Bearer JWT_TOKEN'); -fetch('https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', { - method: 'POST', - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN' -}; - var options = { - url: 'https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', - method: 'POST', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0', + 'headers': { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN'' + } }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` ```php - 'Bearer JWT_TOKEN' -); -$data = array( -); -$response = Requests::post('https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', $headers, $data); +setUrl('https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Content-Type' => 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python + import requests +import json +url = "https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0" + +payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' } -params = ( - ('id', 'EMPLOYEE_ID'), -) +response = requests.request("GET", url, headers=headers, data=payload) -response = requests.post('https://api.us.springverify.com/company/employee', headers=headers, params=params) +print(response.text) ``` ```ruby -require 'net/http' -require 'uri' - -uri = URI.parse("https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID") -request = Net::HTTP::Get.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" +require "uri" +require "json" +require "net/http" -req_options = { - use_ssl: uri.scheme == "https", -} +url = URI("https://api.us.springverify.com/v2-api/company/actions?limit=10&offset=0") -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) +request["Content-Type"] = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" -# response.code -# response.body +response = http.request(request) +puts response.read_body ``` > Success Response @@ -2282,89 +2374,104 @@ end ```json { "success": true, - "data": { - "employee": { - "id": "6d6d81f5-6f00-4a38-a7d7-249cc2127ab6", - "access_id": null, - "email": "johndoe@gmail.com", - "password_hash": null, - "first_name": null, - "middle_name": null, - "last_name": null, - "name_verified": null, - "created_at": "2020-08-24T10:57:01.000Z", - "updated_at": "2020-08-24T10:57:01.000Z", - "employer_id": "fd725660-58f7-4a97-b626-5a4588e4ca31", - "payment_id": "0e9a7695-91bd-4e60-aefc-ba47f80ab0f0", - "email_sent": true, - "payment": false, - "status": null, - "flow_completed": null, - "company_created_by": "john@wick.com", - "employee_limit_id": "bd95351f-fc2a-4ff9-8652-88abbfe67bdd", - "kbaqna": null, - "employments": [], - "education": [], - "professional_licenses": [], - "employee_limit": { - "id": "bd95351f-fc2a-4ff9-8652-88abbfe67bdd", - "employment": 2, - "education": 1, - "professional_license": 0, - "all_county_criminal_search": true, - "county_criminal_search": 0, - "civil_court": 1, - "driving_license": 0, - "package_id": null, - "created_at": "2020-08-24T10:57:01.000Z", - "updated_at": "2020-08-24T10:57:01.000Z", - "employee_invite_group_id": "4153a150-4157-48ab-b258-9a9b47a05fc2", - "employee_invite_group": { - "id": "4153a150-4157-48ab-b258-9a9b47a05fc2", - "package": "diamond", - "active": true, - "created_at": "2020-08-24T10:57:00.000Z", - "updated_at": "2020-08-24T10:57:00.000Z", - "company_created_by": "john@wick.com", - "package_id": "5" - } - }, - "employee_detail": null, - "employee_verification": null, - "s3_files": [], - "criminal_statuses": [], - "cic_criminal_records": [], - "sjv_criminal_reports": [] + "data": [ + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T14:05:21.000Z", + "id": "32e953b2-1150-43b8-a4de-ea8f89ff7e93", + "email": "pehaty@digital10network.com" }, - "review": [], - "criminal_status": { - "national_criminal": "PENDING", - "sex_offender": "PENDING", - "global_watchlist": "PENDING", - "county_criminal_search": "PENDING", - "civil_court": "PENDING", - "overall_criminal_status": "PENDING" + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T13:56:20.000Z", + "id": "32e953b2-1150-43b8-a4de-ea8f89ff7e93", + "email": "pehaty@digital10network.com" + }, + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T13:52:21.000Z", + "id": "32e953b2-1150-43b8-a4de-ea8f89ff7e93", + "email": "pehaty@digital10network.com" + }, + { + "employee_name": "", + "action": "has been added as a candidate and invited to enter his information.", + "time": "2021-08-24T13:51:20.000Z", + "id": "32e953b2-1150-43b8-a4de-ea8f89ff7e93", + "email": "pehaty@digital10network.com" + }, + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T10:01:59.000Z", + "id": "a8e8356f-b321-43d8-95c7-e7832cf26fac", + "email": "filybedo@thichanthit.com" + }, + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T09:52:59.000Z", + "id": "a8e8356f-b321-43d8-95c7-e7832cf26fac", + "email": "filybedo@thichanthit.com" + }, + { + "employee_name": "", + "action": "Follow up email sent to candidate to complete the BGV form", + "time": "2021-08-24T09:48:59.000Z", + "id": "a8e8356f-b321-43d8-95c7-e7832cf26fac", + "email": "filybedo@thichanthit.com" + }, + { + "employee_name": "", + "action": "has been added as a candidate and invited to enter his information.", + "time": "2021-08-24T09:47:58.000Z", + "id": "a8e8356f-b321-43d8-95c7-e7832cf26fac", + "email": "filybedo@thichanthit.com" + }, + { + "employee_name": "Steven Brandon Ward", + "action": "has successfully verified their identity. (via Knowledge based authentication)", + "time": "2021-08-20T11:35:23.000Z", + "id": "5ea00d51-3214-4572-a802-a67ccc18cf33", + "email": "abcd1@yopmail.com" + }, + { + "employee_name": "Steven Brandon Ward", + "action": "has entered kba answers.", + "time": "2021-08-20T11:35:22.000Z", + "id": "5ea00d51-3214-4572-a802-a67ccc18cf33", + "email": "abcd1@yopmail.com" } - } + ] } ``` -When the details of a specific candidate whose profile is already verified is to be retrieved, use this API. This API retrieves the details of the candidate that have been verified, as well as the pricing package in which the candidate's profile was verified, along with the date of the most recent verification. +This API informs an admin/s of the activities of a specific candidate in the following scenarios: -**URL Parameters** +* The candidate has been invited to provide their information to initiate the verification. +* The candidate has entered their personal information. +* The candidate has successfully uploaded their driver's license. +* The candidate has successfully verified their identity using their driver's license. +* The candidate has failed to verify their identity using their driver's license. -| Parameter | Type | Description | -| --- | --- | --- | -|id | `uuid` | Contains the unique ID of the candidate. | -## Search Candidate + + +## Get Company Actions Pertaining to a candidate ```shell -curl --location --request POST 'https://api.us.springverify.com/company/employee/search' \ +curl --location --request POST 'https://api.us.springverify.com/company/actions' \ --header 'Authorization: Bearer JWT_TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ - "search":"johndoe@gmail.com" + "limit":10, + "offset":0, + "email":"employee@email.com" }' ``` @@ -2373,13 +2480,13 @@ curl --location --request POST 'https://api.us.springverify.com/company/employee var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/company/employee/search', { +fetch('https://api.us.springverify.com/company/actions', { method: 'POST', headers: { 'Authorization': 'Bearer JWT_TOKEN', 'Content-Type': 'application/json' }, - body: JSON.stringify({ "search":"johndoe@gmail.com" }) + body: JSON.stringify({ "limit":10, "offset":0, "email":"employee@email.com" }) }); // REQUEST @@ -2391,10 +2498,10 @@ var headers = { 'Content-Type': 'application/json' }; -var dataString = '{ "search":"johndoe@gmail.com" }'; +var dataString = '{ "limit":10, "offset":0, "email":"employee@email.com" }'; var options = { - url: 'https://api.us.springverify.com/company/employee/search', + url: 'https://api.us.springverify.com/company/actions', method: 'POST', headers: headers, body: dataString @@ -2417,8 +2524,8 @@ $headers = array( 'Authorization' => 'Bearer JWT_TOKEN', 'Content-Type' => 'application/json' ); -$data = '{ "search":"johndoe@gmail.com" }'; -$response = Requests::post('https://api.us.springverify.com/company/employee/search', $headers, $data); +$data = '{ "limit":10, "offset":0, "email":"employee@email.com" }'; +$response = Requests::post('https://api.us.springverify.com/company/actions', $headers, $data); ``` ```python @@ -2429,16 +2536,16 @@ headers = { 'Content-Type': 'application/json', } -data = '{ "search":"johndoe@gmail.com" }' +data = '{ "limit":10, "offset":0, "email":"employee@email.com" }' -response = requests.post('https://api.us.springverify.com/company/employee/search', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/company/actions', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/company/employee/search") +uri = URI.parse("https://api.us.springverify.com/company/actions") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -2459,60 +2566,105 @@ end ```json { - "success": true, - "data": [ - { - "id": "478543b4-43b0-45bd-82db-dc4ce0ff193c", - "email": "a13@yopmail.com", - "first_name": "Steven", - "middle_name": "Brandon", - "last_name": "Ward", - "status": "PENDING", - "employee_limit": { - "id": "63d34d43-794f-49c6-8de9-327935156076", - "employee_invite_group": { - "id": "c35d4851-8f23-4779-9310-a913bda6b1af", - "package": "bronze" - } - } - }, - { - "id": "f29aebee-df87-4cae-8779-7e6c48345d1d", - "email": "testdata1@yopmail.com", - "first_name": "Steven", - "middle_name": "Brandon", - "last_name": "Ward", - "status": null, - "employee_limit": { - "id": "149913a5-8bf1-4ca5-ba5b-3fb412cd68fa", - "employee_invite_group": { - "id": "f33cc6ab-c8d1-4535-b80a-b9f2cd45a319", - "package": "diamond" - } - } - } - ] + "success": true, + "data": [ + { + "string": "employment check is in progress.", + "time": "2020-08-13T14:32:50.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "education check is in progress.", + "time": "2020-08-13T14:32:08.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has entered their education.", + "time": "2020-08-13T14:31:34.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has entered their employment.", + "time": "2020-08-13T14:26:25.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has successfully verified their identity. (using their driving license)", + "time": "2020-08-13T14:24:44.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has uploaded their driving license.", + "time": "2020-08-13T14:23:15.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has entered personal details.", + "time": "2020-08-13T14:21:13.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + }, + { + "string": "has been added as a candidate and invited to enter his information.", + "time": "2020-08-13T14:19:32.000Z", + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "first_name": "Mark", + "middle_name": "James", + "last_name": "Smith", + "email": "johhndoe@gmail.com" + } + ] } - ``` -This API searches and retrieves the profile of a specific candidate that is already verified. - -**URL Parameters** +This API informs an admin/s of the activities of a specific candidate in the following scenarios: -| Parameter | Type | Description | -| --- | --- | --- | -| search | `string`| Search term which returns record after matching first name, middle name, last name or email | +* The candidate has been invited to provide their information to initiate the verification. +* The candidate has entered their personal information. +* The candidate has successfully uploaded their driver's license. +* The candidate has successfully verified their identity using their driver's license. +* The candidate has entered their education information. +* The candidate has entered their employment information. +* Verification for the education information has been initiated. +* Verification for the employment information has been initiated. -## Get company action +## Get Company Candidates by Filter ```shell -curl --location --request POST 'https://api.us.springverify.com/company/actions' \ +curl --location --request POST 'https://api.us.springverify.com/company/employees' \ --header 'Authorization: Bearer JWT_TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ - "limit":10, - "offset":0 + "limit":1, + "offset":0, + "filter":"NULL" }' ``` @@ -2521,13 +2673,13 @@ curl --location --request POST 'https://api.us.springverify.com/company/actions' var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/company/actions', { +fetch('https://api.us.springverify.com/company/employees', { method: 'POST', headers: { 'Authorization': 'Bearer JWT_TOKEN', 'Content-Type': 'application/json' }, - body: JSON.stringify({ "limit":10, "offset":0 }) + body: JSON.stringify({ "limit":1, "offset":0, "filter":"NULL" }) }); // REQUEST @@ -2539,10 +2691,10 @@ var headers = { 'Content-Type': 'application/json' }; -var dataString = '{ "limit":10, "offset":0 }'; +var dataString = '{ "limit":1, "offset":0, "filter":"NULL" }'; var options = { - url: 'https://api.us.springverify.com/company/actions', + url: 'https://api.us.springverify.com/company/employees', method: 'POST', headers: headers, body: dataString @@ -2565,8 +2717,8 @@ $headers = array( 'Authorization' => 'Bearer JWT_TOKEN', 'Content-Type' => 'application/json' ); -$data = '{ "limit":10, "offset":0 }'; -$response = Requests::post('https://api.us.springverify.com/company/actions', $headers, $data); +$data = '{ "limit":1, "offset":0, "filter":"NULL" }'; +$response = Requests::post('https://api.us.springverify.com/company/employees', $headers, $data); ``` ```python @@ -2577,16 +2729,16 @@ headers = { 'Content-Type': 'application/json', } -data = '{ "limit":10, "offset":0 }' +data = '{ "limit":1, "offset":0, "filter":"NULL" }' -response = requests.post('https://api.us.springverify.com/company/actions', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/company/employees', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/company/actions") +uri = URI.parse("https://api.us.springverify.com/company/employees") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -2607,121 +2759,125 @@ end ```json { - "success": true, - "data": [ - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T05:59:02.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T05:59:02.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T05:59:02.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "has successfully verified their identity. (using their driving license)", - "time": "2020-08-27T05:57:03.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "has uploaded their driving license.", - "time": "2020-08-27T05:56:44.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "has entered personal details.", - "time": "2020-08-27T05:55:40.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "has been added as a candidate and invited to enter his information.", - "time": "2020-08-27T05:54:24.000Z", - "id": "9282698a-72ac-49df-a750-85c169bfe08e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T04:29:02.000Z", - "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T04:29:02.000Z", - "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" - }, - { - "string": "identity verification failed. (using their driving license)", - "time": "2020-08-27T04:29:02.000Z", - "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "email": "johndoe@gmail.com" + "success": true, + "data": { + "employees": [{ + "id": "5d7bea97-fdca-4f2b-be32-72637a3491f4", + "email": "johbobby@Johns.com", + "first_name": "John", + "middle_name": "Bobby", + "last_name": "Johns", + "status": "PENDING", + "created_at": "2020-08-19T16:32:11.000Z", + "kbaqna": null, + "employments": [{ + "status": 0, + "super_admin_status": null, + "status_new": null, + "super_admin_status_new": null, + "adverse_action": null + }], + "education": [{ + "status": 3, + "super_admin_status": null, + "status_new": null, + "super_admin_status_new": null, + "adverse_action": null + }], + "professional_licenses": [], + "employee_limit": { + "employment": 2, + "education": 1, + "professional_license": 0, + "civil_court": 0, + "county_criminal_search": 0, + "all_county_criminal_search": true, + "employee_invite_group": { + "package": "platinum" + } + }, + "employee_verification": { + "s3_passport_verified": null, + "s3_dl_verified": 1, + "verification_type": "id", + "super_admin_status": null, + "passport_status": null, + "dl_status": null, + "super_admin_status_new": null + }, + "criminal_statuses": { + "national_criminal": "PENDING", + "sex_offender": "PENDING", + "global_watchlist": "PENDING", + "county_criminal_search": "PENDING" + }, + "cic_criminal_records": [{ + "id": "8b454419-8691-4688-9719-72571012978c", + "record_type": "SEX_OFFENDER", + "reviewed": false, + "adverse_action": { + "status": "CLOSED", + "cleared": false, + "id": "af1cef6e-e38f-4545-8fc4-6a31c0886b37" + } + }, + { + "id": "ade7b7cd-c80c-4302-a2f0-6066f81322b3", + "record_type": "SEX_OFFENDER", + "reviewed": true, + "adverse_action": { + "status": "CLOSED", + "cleared": false, + "id": "af1cef6e-e38f-4545-8fc4-6a31c0886b37" + } + } + ], + "sjv_criminal_reports": [{ + "id": "428fc0d7-9122-4eed-8a76-a382be5e847f", + "sjv_search_type": "COUNTY_CRIMINAL", + "county_name": { + "county_name": "Ocean County" + }, + "adverse_action": { + "status": "PENDING", + "cleared": null, + "id": "350849d9-24c2-40ea-ad20-d5654854fac9" + } + }, + { + "id": "281edcbe-cdb4-411e-8d8e-87f7aea33b2a", + "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", + "county_name": null, + "adverse_action": null + }, + { + "id": "96b6aef0-1114-4e5b-99a4-f9ed917504a2", + "sjv_search_type": "NATIONAL_CRIMINAL", + "county_name": { + "county_name": "Palm Beach County" + }, + "adverse_action": null + } + ] + }], + "count": 238 } - ] } ``` -This API informs an admin/s of the activities of a specific candidate in the following scenarios: +**URL Parameters** -* The candidate has been invited to provide their information to initiate the verification. -* The candidate has entered their personal information. -* The candidate has successfully uploaded their driver's license. -* The candidate has successfully verified their identity using their driver's license. -* The candidate has failed to verify their identity using their driver's license. +| Parameter | Type | Description | +| --- | --- | --- | +| limit | `integer` | Page limit | +| offset | `integer` | Page offset | +| filter | `string` | ALL/COMPLETED/VERIFIED/PENDING/NULL(AWAITING INPUT)/FAILED. -## Get Company Actions Pertaining to a candidate +## Get Company Adverse Action Counts ```shell -curl --location --request POST 'https://api.us.springverify.com/company/actions' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "limit":10, - "offset":0, - "email":"employee@email.com" -}' +curl --location --request GET 'https://api.us.springverify.com/company/action/adverse/counts' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript @@ -2729,13 +2885,10 @@ curl --location --request POST 'https://api.us.springverify.com/company/actions' var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/company/actions', { - method: 'POST', +fetch('https://api.us.springverify.com/company/action/adverse/counts', { headers: { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' - }, - body: JSON.stringify({ "limit":10, "offset":0, "email":"employee@email.com" }) + 'Authorization': 'Bearer JWT_TOKEN' + } }); // REQUEST @@ -2743,17 +2896,12 @@ fetch('https://api.us.springverify.com/company/actions', { var request = require('request'); var headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' + 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "limit":10, "offset":0, "email":"employee@email.com" }'; - var options = { - url: 'https://api.us.springverify.com/company/actions', - method: 'POST', - headers: headers, - body: dataString + url: 'https://api.us.springverify.com/company/action/adverse/counts', + headers: headers }; function callback(error, response, body) { @@ -2770,11 +2918,9 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( - 'Authorization' => 'Bearer JWT_TOKEN', - 'Content-Type' => 'application/json' + 'Authorization' => 'Bearer JWT_TOKEN' ); -$data = '{ "limit":10, "offset":0, "email":"employee@email.com" }'; -$response = Requests::post('https://api.us.springverify.com/company/actions', $headers, $data); +$response = Requests::get('https://api.us.springverify.com/company/action/adverse/counts', $headers); ``` ```python @@ -2782,21 +2928,17 @@ import requests headers = { 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json', } -data = '{ "limit":10, "offset":0, "email":"employee@email.com" }' - -response = requests.post('https://api.us.springverify.com/company/actions', headers=headers, data=data) +response = requests.get('https://api.us.springverify.com/company/action/adverse/counts', headers=headers) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/company/actions") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" +uri = URI.parse("https://api.us.springverify.com/company/action/adverse/counts") +request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -2815,105 +2957,50 @@ end ```json { - "success": true, - "data": [ - { - "string": "employment check is in progress.", - "time": "2020-08-13T14:32:50.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "education check is in progress.", - "time": "2020-08-13T14:32:08.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has entered their education.", - "time": "2020-08-13T14:31:34.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has entered their employment.", - "time": "2020-08-13T14:26:25.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has successfully verified their identity. (using their driving license)", - "time": "2020-08-13T14:24:44.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has uploaded their driving license.", - "time": "2020-08-13T14:23:15.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has entered personal details.", - "time": "2020-08-13T14:21:13.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" - }, - { - "string": "has been added as a candidate and invited to enter his information.", - "time": "2020-08-13T14:19:32.000Z", - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "first_name": "Mark", - "middle_name": "James", - "last_name": "Smith", - "email": "johhndoe@gmail.com" + "message": "successfully retrieved count", + "data": { + "PENDING": { + "pendingCount": 4, + "totalCount": 8 + }, + "NOTICE_SENT": { + "pendingCount": 2, + "totalCount": 19 + }, + "IN_REVIEW": { + "pendingCount": 2, + "totalCount": 3 + }, + "FINAL_CALL": { + "pendingCount": 0, + "totalCount": 24 + }, + "CLOSED": { + "pendingCount": 5, + "totalCount": 30 + } } - ] } ``` -This API informs an admin/s of the activities of a specific candidate in the following scenarios: +This API gives the count of the total adverse actions that are/have been: -* The candidate has been invited to provide their information to initiate the verification. -* The candidate has entered their personal information. -* The candidate has successfully uploaded their driver's license. -* The candidate has successfully verified their identity using their driver's license. -* The candidate has entered their education information. -* The candidate has entered their employment information. -* Verification for the education information has been initiated. -* Verification for the employment information has been initiated. +* closed -- the candidate's response has been accepted or rejected and the verification is completed. +* pending -- the candidate is to be informed of the issue; or the candidate's response is to be received. +* being reviewed -- the candidate's response is being reviewed. +* sent a notice -- the candidate has been informed of an issue with their verification. +* taken a final call on -- a decision has been taken by the company on the adverse action and is to be informed to the candidate. -## Get Company Candidates by Filter +## Get Company Adverse Actions ```shell -curl --location --request POST 'https://api.us.springverify.com/company/employees' \ +curl --location --request POST 'https://api.us.springverify.com/company/action/adverse/fetch' \ --header 'Authorization: Bearer JWT_TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ - "limit":1, + "limit":10, "offset":0, - "filter":"NULL" + "status":"PENDING" }' ``` @@ -2922,13 +3009,13 @@ curl --location --request POST 'https://api.us.springverify.com/company/employee var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/company/employees', { +fetch('https://api.us.springverify.com/company/action/adverse/fetch', { method: 'POST', headers: { 'Authorization': 'Bearer JWT_TOKEN', 'Content-Type': 'application/json' }, - body: JSON.stringify({ "limit":1, "offset":0, "filter":"NULL" }) + body: JSON.stringify({ "limit":10, "offset":0, "status":"PENDING" }) }); // REQUEST @@ -2940,10 +3027,10 @@ var headers = { 'Content-Type': 'application/json' }; -var dataString = '{ "limit":1, "offset":0, "filter":"NULL" }'; +var dataString = '{ "limit":10, "offset":0, "status":"PENDING" }'; var options = { - url: 'https://api.us.springverify.com/company/employees', + url: 'https://api.us.springverify.com/company/action/adverse/fetch', method: 'POST', headers: headers, body: dataString @@ -2966,8 +3053,8 @@ $headers = array( 'Authorization' => 'Bearer JWT_TOKEN', 'Content-Type' => 'application/json' ); -$data = '{ "limit":1, "offset":0, "filter":"NULL" }'; -$response = Requests::post('https://api.us.springverify.com/company/employees', $headers, $data); +$data = '{ "limit":10, "offset":0, "status":"PENDING" }'; +$response = Requests::post('https://api.us.springverify.com/company/action/adverse/fetch', $headers, $data); ``` ```python @@ -2978,16 +3065,16 @@ headers = { 'Content-Type': 'application/json', } -data = '{ "limit":1, "offset":0, "filter":"NULL" }' +data = '{ "limit":10, "offset":0, "status":"PENDING" }' -response = requests.post('https://api.us.springverify.com/company/employees', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/company/action/adverse/fetch', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/company/employees") +uri = URI.parse("https://api.us.springverify.com/company/action/adverse/fetch") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -3010,653 +3097,317 @@ end { "success": true, "data": { - "employees": [{ - "id": "5d7bea97-fdca-4f2b-be32-72637a3491f4", - "email": "johbobby@Johns.com", - "first_name": "John", - "middle_name": "Bobby", - "last_name": "Johns", - "status": "PENDING", - "created_at": "2020-08-19T16:32:11.000Z", - "kbaqna": null, - "employments": [{ - "status": 0, - "super_admin_status": null, - "status_new": null, - "super_admin_status_new": null, - "adverse_action": null - }], - "education": [{ - "status": 3, - "super_admin_status": null, - "status_new": null, - "super_admin_status_new": null, - "adverse_action": null - }], - "professional_licenses": [], - "employee_limit": { - "employment": 2, - "education": 1, - "professional_license": 0, - "civil_court": 0, - "county_criminal_search": 0, - "all_county_criminal_search": true, - "employee_invite_group": { - "package": "platinum" - } - }, - "employee_verification": { - "s3_passport_verified": null, - "s3_dl_verified": 1, - "verification_type": "id", - "super_admin_status": null, - "passport_status": null, - "dl_status": null, - "super_admin_status_new": null - }, - "criminal_statuses": { - "national_criminal": "PENDING", - "sex_offender": "PENDING", - "global_watchlist": "PENDING", - "county_criminal_search": "PENDING" - }, - "cic_criminal_records": [{ - "id": "8b454419-8691-4688-9719-72571012978c", - "record_type": "SEX_OFFENDER", - "reviewed": false, - "adverse_action": { - "status": "CLOSED", - "cleared": false, - "id": "af1cef6e-e38f-4545-8fc4-6a31c0886b37" - } - }, - { - "id": "ade7b7cd-c80c-4302-a2f0-6066f81322b3", - "record_type": "SEX_OFFENDER", - "reviewed": true, - "adverse_action": { - "status": "CLOSED", - "cleared": false, - "id": "af1cef6e-e38f-4545-8fc4-6a31c0886b37" - } - } - ], - "sjv_criminal_reports": [{ - "id": "428fc0d7-9122-4eed-8a76-a382be5e847f", - "sjv_search_type": "COUNTY_CRIMINAL", - "county_name": { - "county_name": "Ocean County" - }, - "adverse_action": { - "status": "PENDING", - "cleared": null, - "id": "350849d9-24c2-40ea-ad20-d5654854fac9" + "adverse_actions": [ + { + "id": "2504d7c7-3f68-47a7-b9dc-be2adb99936e", + "check_id": null, + "status": "PENDING", + "type": "SEX_OFFENDER", + "cleared": null, + "comments": null, + "created_at": "2020-08-25T08:17:24.000Z", + "updated_at": "2020-08-25T08:17:24.000Z", + "deleted_at": null, + "education": null, + "employment": null, + "read_statuses": [], + "cic_criminal_records": [ + { + "id": "0548ea1c-b3de-4008-8147-1376c5870b8f", + "employee_email_fk": "johndoe@gmail.com", + "cic_criminal_report_id_fk": "62b71576-8456-42db-8ce9-4d12b2d864cb", + "created_at": "2020-08-13T14:24:42.000Z", + "updated_at": "2020-08-25T08:17:24.000Z", + "employee": { + "id": "298af70a-b3a3-4605-8789-37387bb276a1", + "access_id": "05065b6d-8272-4ba5-b31e-b9f576c0a44a", + "email": "johndoe@gmail.com", + "password_hash": "qwerty123", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "name_verified": null, + "created_at": "2020-08-13T13:59:22.000Z", + "updated_at": "2020-08-25T08:17:24.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "3aa91fd2-aca5-456b-a375-cf4df6ededed", + "email_sent": true, + "payment": false, + "status": "VERIFIED", + "flow_completed": true, + "company_created_by": "john@wick.com", + "employee_limit_id": "0e3ee39a-32c2-4eb6-a7f2-61a3507a26ba" + } + } + ], + "sjv_criminal_reports": [] + }, + { + "id": "df359f7d-fff3-4de6-bbfa-f3719b1f4b9b", + "check_id": null, + "status": "PENDING", + "type": "SEX_OFFENDER", + "cleared": null, + "comments": null, + "created_at": "2020-08-20T12:45:29.000Z", + "updated_at": "2020-08-20T12:45:29.000Z", + "deleted_at": null, + "education": null, + "employment": null, + "read_statuses": [], + "cic_criminal_records": [ + { + "id": "271e6b31-cef1-4b67-a8b5-28a1781081c5", + "employee_email_fk": "johndoe@gmail.com", + "cic_criminal_report_id_fk": "45127f48-b878-4aa5-8bab-881b79883d4a", + "created_at": "2020-08-20T12:07:49.000Z", + "updated_at": "2020-08-20T12:45:29.000Z", + "employee": { + "id": "37d40f7f-90a9-415d-8679-75500654aa5e", + "access_id": "3d5ed4fd-f2c4-4d86-94c0-c8836fe12132", + "email": "johndoe@gmail.com", + "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "name_verified": null, + "created_at": "2020-08-20T11:27:01.000Z", + "updated_at": "2020-08-20T12:45:30.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "881e74c4-0c8c-4c7c-9238-be5053474ee2", + "email_sent": true, + "payment": false, + "status": "FAILED", + "flow_completed": true, + "company_created_by": "john@wick.com", + "employee_limit_id": "8a51971e-bf6f-4b03-9db9-9062546e0533" + } + } + ], + "sjv_criminal_reports": [] + }, + { + "id": "350849d9-24c2-40ea-ad20-d5654854fac9", + "check_id": null, + "status": "PENDING", + "type": "COUNTY_CRIMINAL", + "cleared": null, + "comments": null, + "created_at": "2020-08-19T18:11:53.000Z", + "updated_at": "2020-08-19T18:11:53.000Z", + "deleted_at": null, + "education": null, + "employment": null, + "read_statuses": [], + "cic_criminal_records": [], + "sjv_criminal_reports": [ + { + "id": "428fc0d7-9122-4eed-8a76-a382be5e847f", + "employee_email_fk": "johndoe@gmail.com", + "status": "RECEIVED", + "sjv_search_type": "COUNTY_CRIMINAL", + "reference_id": null, + "cic_criminal_record_fk": null, + "report_link": "report_link", + "marked_done": 0, + "marked_reviewed": 0, + "county_id": 1789, + "adverse_action_fk": "350849d9-24c2-40ea-ad20-d5654854fac9", + "authenticating_unique_identifier": "08bdee45-0cf6-4630-9f34-a9b0e50d2fcf", + "created_at": "2020-08-19T18:11:51.000Z", + "updated_at": "2020-08-19T18:11:53.000Z", + "county_name": { + "id": "1789", + "county_name": "Ocean County", + "state_name": "New Jersey", + "created_at": null, + "updated_at": null + }, + "employee": { + "id": "5d7bea97-fdca-4f2b-be32-72637a3491f4", + "access_id": "67a61c82-8bf6-4717-8df1-a0ece4ffd2c8", + "email": "johndoe@gmail.com", + "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", + "first_name": "Jane", + "middle_name": "Elizabeth", + "last_name": "Smith", + "name_verified": null, + "created_at": "2020-08-19T16:32:11.000Z", + "updated_at": "2020-08-19T17:45:05.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "c26bc8a4-c136-4af6-bf2e-497745597085", + "email_sent": true, + "payment": false, + "status": "PENDING", + "flow_completed": true, + "company_created_by": "john@wick.com", + "employee_limit_id": "372b4cc6-63ce-4811-9d80-eb0527bce1ea" + } + } + ] + }, + { + "id": "5c0a073a-ebd8-4417-989f-7ac5f3b11f98", + "check_id": "b33aaaa7-5253-4542-a18f-ab4ff91ae8d3", + "status": "PENDING", + "type": "EMPLOYMENT", + "cleared": null, + "comments": null, + "created_at": "2020-08-12T13:59:03.000Z", + "updated_at": "2020-08-12T13:59:03.000Z", + "deleted_at": null, + "education": null, + "employment": { + "id": "b33aaaa7-5253-4542-a18f-ab4ff91ae8d3", + "email": "johndoe@gmail.com", + "access_id": null, + "employer_name": "Nags", + "employer_name_verified": null, + "employer_phone": null, + "employer_phone_verified": null, + "employer_address": "Philadelphia International Airport (PHL), Essington Ave, Philadelphia, PA, USA", + "employer_address_verified": null, + "employer_town": "Philadelphia", + "employer_town_verified": null, + "state": "PA", + "state_verified": null, + "zipcode": "19153", + "zipcode_verified": null, + "employer_country": "United States", + "employer_country_verified": null, + "job_title": "sefdwe", + "job_title_verified": null, + "start_date": "01-01-2010", + "start_date_verified": null, + "end_date": "01-01-2018", + "end_date_verified": null, + "supervisor_name": "ber", + "supervisor_contact": null, + "current_employment": null, + "current_employment_verified": null, + "contract_type": null, + "contract_type_verified": null, + "source": null, + "created_at": "2020-08-12T13:58:20.000Z", + "updated_at": "2020-08-19T14:14:15.000Z", + "job_type": "full time employee", + "reason_for_leaving": null, + "status": 2, + "status_new": "FAILED", + "super_admin_status": null, + "super_admin_status_new": null, + "consent": false, + "employee": { + "id": "ee561c16-db51-4da0-a2b5-57780703ed3c", + "access_id": "36761e70-abcc-4d25-8b88-cf9f5ecd0ae5", + "email": "johndoe@gmail.com", + "password_hash": null, + "first_name": "Jane", + "middle_name": "Elizabeth", + "last_name": "Smith", + "name_verified": null, + "created_at": "2020-08-12T13:53:46.000Z", + "updated_at": "2020-08-12T13:55:43.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "b76847d7-fd23-4a64-8fb9-5d57f3c2693a", + "email_sent": true, + "payment": false, + "status": null, + "flow_completed": null, + "company_created_by": "john@wick.com", + "employee_limit_id": "2621a7d1-b00c-408d-99bc-c1f072e4c8ac" } }, - { - "id": "281edcbe-cdb4-411e-8d8e-87f7aea33b2a", - "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", - "county_name": null, - "adverse_action": null - }, - { - "id": "96b6aef0-1114-4e5b-99a4-f9ed917504a2", - "sjv_search_type": "NATIONAL_CRIMINAL", - "county_name": { - "county_name": "Palm Beach County" - }, - "adverse_action": null - } - ] - }], - "count": 238 - } -} -``` - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | `integer` | Page limit | -| offset | `integer` | Page offset | -| filter | `string` | ALL/COMPLETED/VERIFIED/PENDING/NULL(AWAITING INPUT)/FAILED. - -## Get Company Adverse Action Counts - -```shell -curl --location --request GET 'https://api.us.springverify.com/company/action/adverse/counts' \ ---header 'Authorization: Bearer JWT_TOKEN' -``` - -```javascript -// FETCH - -var fetch = require('node-fetch'); - -fetch('https://api.us.springverify.com/company/action/adverse/counts', { - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); - -// REQUEST - -var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN' -}; - -var options = { - url: 'https://api.us.springverify.com/company/action/adverse/counts', - headers: headers -}; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); -``` - -```php - 'Bearer JWT_TOKEN' -); -$response = Requests::get('https://api.us.springverify.com/company/action/adverse/counts', $headers); -``` - -```python -import requests - -headers = { - 'Authorization': 'Bearer JWT_TOKEN', -} - -response = requests.get('https://api.us.springverify.com/company/action/adverse/counts', headers=headers) -``` - -```ruby -require 'net/http' -require 'uri' - -uri = URI.parse("https://api.us.springverify.com/company/action/adverse/counts") -request = Net::HTTP::Get.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" - -req_options = { - use_ssl: uri.scheme == "https", -} - -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end - -# response.code -# response.body -``` - -> Success Response - -```json -{ - "message": "successfully retrieved count", - "data": { - "PENDING": { - "pendingCount": 4, - "totalCount": 8 - }, - "NOTICE_SENT": { - "pendingCount": 2, - "totalCount": 19 - }, - "IN_REVIEW": { - "pendingCount": 2, - "totalCount": 3 - }, - "FINAL_CALL": { - "pendingCount": 0, - "totalCount": 24 - }, - "CLOSED": { - "pendingCount": 5, - "totalCount": 30 - } - } -} -``` - -This API gives the count of the total adverse actions that are/have been: - -* closed -- the candidate's response has been accepted or rejected and the verification is completed. -* pending -- the candidate is to be informed of the issue; or the candidate's response is to be received. -* being reviewed -- the candidate's response is being reviewed. -* sent a notice -- the candidate has been informed of an issue with their verification. -* taken a final call on -- a decision has been taken by the company on the adverse action and is to be informed to the candidate. - -## Get Company Adverse Actions - -```shell -curl --location --request POST 'https://api.us.springverify.com/company/action/adverse/fetch' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "limit":10, - "offset":0, - "status":"PENDING" -}' -``` - -```javascript -// FETCH - -var fetch = require('node-fetch'); - -fetch('https://api.us.springverify.com/company/action/adverse/fetch', { - method: 'POST', - headers: { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' - }, - body: JSON.stringify({ "limit":10, "offset":0, "status":"PENDING" }) -}); - -// REQUEST - -var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' -}; - -var dataString = '{ "limit":10, "offset":0, "status":"PENDING" }'; - -var options = { - url: 'https://api.us.springverify.com/company/action/adverse/fetch', - method: 'POST', - headers: headers, - body: dataString -}; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); -``` - -```php - 'Bearer JWT_TOKEN', - 'Content-Type' => 'application/json' -); -$data = '{ "limit":10, "offset":0, "status":"PENDING" }'; -$response = Requests::post('https://api.us.springverify.com/company/action/adverse/fetch', $headers, $data); -``` - -```python -import requests - -headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json', -} - -data = '{ "limit":10, "offset":0, "status":"PENDING" }' - -response = requests.post('https://api.us.springverify.com/company/action/adverse/fetch', headers=headers, data=data) -``` - -```ruby -require 'net/http' -require 'uri' - -uri = URI.parse("https://api.us.springverify.com/company/action/adverse/fetch") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" - -req_options = { - use_ssl: uri.scheme == "https", -} - -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end - -# response.code -# response.body -``` - -> Success Response - -```json -{ - "success": true, - "data": { - "adverse_actions": [ + "read_statuses": [], + "cic_criminal_records": [], + "sjv_criminal_reports": [] + }, { - "id": "2504d7c7-3f68-47a7-b9dc-be2adb99936e", + "id": "b376ef1b-65d7-4f5a-ab0c-ccb81a05f55b", "check_id": null, "status": "PENDING", "type": "SEX_OFFENDER", "cleared": null, "comments": null, - "created_at": "2020-08-25T08:17:24.000Z", - "updated_at": "2020-08-25T08:17:24.000Z", + "created_at": "2020-07-17T15:11:45.000Z", + "updated_at": "2020-07-17T15:11:45.000Z", "deleted_at": null, "education": null, "employment": null, - "read_statuses": [], + "read_statuses": [ + { + "id": "772ae675-f222-4baa-b31b-75007cba318a", + "reference_id": "b376ef1b-65d7-4f5a-ab0c-ccb81a05f55b", + "user_email": "john@wick.com", + "read": true, + "table": null, + "user_role": null, + "created_at": "2020-07-17T15:38:28.000Z", + "updated_at": "2020-07-17T15:38:28.000Z" + } + ], "cic_criminal_records": [ { - "id": "0548ea1c-b3de-4008-8147-1376c5870b8f", + "id": "bdb73700-4445-4954-8b36-9c144c46ab29", "employee_email_fk": "johndoe@gmail.com", - "cic_criminal_report_id_fk": "62b71576-8456-42db-8ce9-4d12b2d864cb", - "created_at": "2020-08-13T14:24:42.000Z", - "updated_at": "2020-08-25T08:17:24.000Z", + "cic_criminal_report_id_fk": "234220d6-1a3b-49c5-9ea1-a1daa1cb710f", + "created_at": "2020-07-17T15:09:02.000Z", + "updated_at": "2020-07-20T13:32:48.000Z", "employee": { - "id": "298af70a-b3a3-4605-8789-37387bb276a1", - "access_id": "05065b6d-8272-4ba5-b31e-b9f576c0a44a", + "id": "7cdbce62-b788-461a-8560-3264d10eeaac", + "access_id": "ce907ccd-ccd6-4aab-bc81-e2b7053fd915", "email": "johndoe@gmail.com", - "password_hash": "qwerty123", - "first_name": "John", - "middle_name": "Mark", + "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", + "first_name": "Jane", + "middle_name": "Elizabeth", "last_name": "Smith", "name_verified": null, - "created_at": "2020-08-13T13:59:22.000Z", - "updated_at": "2020-08-25T08:17:24.000Z", + "created_at": "2020-07-17T15:06:30.000Z", + "updated_at": "2020-07-17T15:09:29.000Z", "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "3aa91fd2-aca5-456b-a375-cf4df6ededed", + "payment_id": "8779db6f-99a8-4d2d-b05a-6481112f1c5c", "email_sent": true, "payment": false, - "status": "VERIFIED", + "status": "PENDING", "flow_completed": true, "company_created_by": "john@wick.com", - "employee_limit_id": "0e3ee39a-32c2-4eb6-a7f2-61a3507a26ba" + "employee_limit_id": "797dbc70-04df-4d26-8140-dfd11bdb37aa" } } ], "sjv_criminal_reports": [] }, { - "id": "df359f7d-fff3-4de6-bbfa-f3719b1f4b9b", + "id": "0c495ae6-756b-4681-b295-3b0f8ea96eac", "check_id": null, "status": "PENDING", "type": "SEX_OFFENDER", "cleared": null, "comments": null, - "created_at": "2020-08-20T12:45:29.000Z", - "updated_at": "2020-08-20T12:45:29.000Z", + "created_at": "2020-07-09T14:57:35.000Z", + "updated_at": "2020-07-09T14:57:35.000Z", "deleted_at": null, "education": null, "employment": null, - "read_statuses": [], + "read_statuses": [ + { + "id": "7347e6c6-d863-4de4-b945-049dc00583c6", + "reference_id": "0c495ae6-756b-4681-b295-3b0f8ea96eac", + "user_email": "john@wick.com", + "read": true, + "table": null, + "user_role": null, + "created_at": "2020-07-24T10:49:38.000Z", + "updated_at": "2020-07-24T10:49:38.000Z" + } + ], "cic_criminal_records": [ { - "id": "271e6b31-cef1-4b67-a8b5-28a1781081c5", + "id": "e8e33362-8fb0-4fed-8e5c-b2f6575f33bf", "employee_email_fk": "johndoe@gmail.com", - "cic_criminal_report_id_fk": "45127f48-b878-4aa5-8bab-881b79883d4a", - "created_at": "2020-08-20T12:07:49.000Z", - "updated_at": "2020-08-20T12:45:29.000Z", - "employee": { - "id": "37d40f7f-90a9-415d-8679-75500654aa5e", - "access_id": "3d5ed4fd-f2c4-4d86-94c0-c8836fe12132", - "email": "johndoe@gmail.com", - "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", - "first_name": "John", - "middle_name": "Mark", - "last_name": "Smith", - "name_verified": null, - "created_at": "2020-08-20T11:27:01.000Z", - "updated_at": "2020-08-20T12:45:30.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "881e74c4-0c8c-4c7c-9238-be5053474ee2", - "email_sent": true, - "payment": false, - "status": "FAILED", - "flow_completed": true, - "company_created_by": "john@wick.com", - "employee_limit_id": "8a51971e-bf6f-4b03-9db9-9062546e0533" - } - } - ], - "sjv_criminal_reports": [] - }, - { - "id": "350849d9-24c2-40ea-ad20-d5654854fac9", - "check_id": null, - "status": "PENDING", - "type": "COUNTY_CRIMINAL", - "cleared": null, - "comments": null, - "created_at": "2020-08-19T18:11:53.000Z", - "updated_at": "2020-08-19T18:11:53.000Z", - "deleted_at": null, - "education": null, - "employment": null, - "read_statuses": [], - "cic_criminal_records": [], - "sjv_criminal_reports": [ - { - "id": "428fc0d7-9122-4eed-8a76-a382be5e847f", - "employee_email_fk": "johndoe@gmail.com", - "status": "RECEIVED", - "sjv_search_type": "COUNTY_CRIMINAL", - "reference_id": null, - "cic_criminal_record_fk": null, - "report_link": "report_link", - "marked_done": 0, - "marked_reviewed": 0, - "county_id": 1789, - "adverse_action_fk": "350849d9-24c2-40ea-ad20-d5654854fac9", - "authenticating_unique_identifier": "08bdee45-0cf6-4630-9f34-a9b0e50d2fcf", - "created_at": "2020-08-19T18:11:51.000Z", - "updated_at": "2020-08-19T18:11:53.000Z", - "county_name": { - "id": "1789", - "county_name": "Ocean County", - "state_name": "New Jersey", - "created_at": null, - "updated_at": null - }, - "employee": { - "id": "5d7bea97-fdca-4f2b-be32-72637a3491f4", - "access_id": "67a61c82-8bf6-4717-8df1-a0ece4ffd2c8", - "email": "johndoe@gmail.com", - "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", - "first_name": "Jane", - "middle_name": "Elizabeth", - "last_name": "Smith", - "name_verified": null, - "created_at": "2020-08-19T16:32:11.000Z", - "updated_at": "2020-08-19T17:45:05.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "c26bc8a4-c136-4af6-bf2e-497745597085", - "email_sent": true, - "payment": false, - "status": "PENDING", - "flow_completed": true, - "company_created_by": "john@wick.com", - "employee_limit_id": "372b4cc6-63ce-4811-9d80-eb0527bce1ea" - } - } - ] - }, - { - "id": "5c0a073a-ebd8-4417-989f-7ac5f3b11f98", - "check_id": "b33aaaa7-5253-4542-a18f-ab4ff91ae8d3", - "status": "PENDING", - "type": "EMPLOYMENT", - "cleared": null, - "comments": null, - "created_at": "2020-08-12T13:59:03.000Z", - "updated_at": "2020-08-12T13:59:03.000Z", - "deleted_at": null, - "education": null, - "employment": { - "id": "b33aaaa7-5253-4542-a18f-ab4ff91ae8d3", - "email": "johndoe@gmail.com", - "access_id": null, - "employer_name": "Nags", - "employer_name_verified": null, - "employer_phone": null, - "employer_phone_verified": null, - "employer_address": "Philadelphia International Airport (PHL), Essington Ave, Philadelphia, PA, USA", - "employer_address_verified": null, - "employer_town": "Philadelphia", - "employer_town_verified": null, - "state": "PA", - "state_verified": null, - "zipcode": "19153", - "zipcode_verified": null, - "employer_country": "United States", - "employer_country_verified": null, - "job_title": "sefdwe", - "job_title_verified": null, - "start_date": "01-01-2010", - "start_date_verified": null, - "end_date": "01-01-2018", - "end_date_verified": null, - "supervisor_name": "ber", - "supervisor_contact": null, - "current_employment": null, - "current_employment_verified": null, - "contract_type": null, - "contract_type_verified": null, - "source": null, - "created_at": "2020-08-12T13:58:20.000Z", - "updated_at": "2020-08-19T14:14:15.000Z", - "job_type": "full time employee", - "reason_for_leaving": null, - "status": 2, - "status_new": "FAILED", - "super_admin_status": null, - "super_admin_status_new": null, - "consent": false, - "employee": { - "id": "ee561c16-db51-4da0-a2b5-57780703ed3c", - "access_id": "36761e70-abcc-4d25-8b88-cf9f5ecd0ae5", - "email": "johndoe@gmail.com", - "password_hash": null, - "first_name": "Jane", - "middle_name": "Elizabeth", - "last_name": "Smith", - "name_verified": null, - "created_at": "2020-08-12T13:53:46.000Z", - "updated_at": "2020-08-12T13:55:43.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "b76847d7-fd23-4a64-8fb9-5d57f3c2693a", - "email_sent": true, - "payment": false, - "status": null, - "flow_completed": null, - "company_created_by": "john@wick.com", - "employee_limit_id": "2621a7d1-b00c-408d-99bc-c1f072e4c8ac" - } - }, - "read_statuses": [], - "cic_criminal_records": [], - "sjv_criminal_reports": [] - }, - { - "id": "b376ef1b-65d7-4f5a-ab0c-ccb81a05f55b", - "check_id": null, - "status": "PENDING", - "type": "SEX_OFFENDER", - "cleared": null, - "comments": null, - "created_at": "2020-07-17T15:11:45.000Z", - "updated_at": "2020-07-17T15:11:45.000Z", - "deleted_at": null, - "education": null, - "employment": null, - "read_statuses": [ - { - "id": "772ae675-f222-4baa-b31b-75007cba318a", - "reference_id": "b376ef1b-65d7-4f5a-ab0c-ccb81a05f55b", - "user_email": "john@wick.com", - "read": true, - "table": null, - "user_role": null, - "created_at": "2020-07-17T15:38:28.000Z", - "updated_at": "2020-07-17T15:38:28.000Z" - } - ], - "cic_criminal_records": [ - { - "id": "bdb73700-4445-4954-8b36-9c144c46ab29", - "employee_email_fk": "johndoe@gmail.com", - "cic_criminal_report_id_fk": "234220d6-1a3b-49c5-9ea1-a1daa1cb710f", - "created_at": "2020-07-17T15:09:02.000Z", - "updated_at": "2020-07-20T13:32:48.000Z", - "employee": { - "id": "7cdbce62-b788-461a-8560-3264d10eeaac", - "access_id": "ce907ccd-ccd6-4aab-bc81-e2b7053fd915", - "email": "johndoe@gmail.com", - "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", - "first_name": "Jane", - "middle_name": "Elizabeth", - "last_name": "Smith", - "name_verified": null, - "created_at": "2020-07-17T15:06:30.000Z", - "updated_at": "2020-07-17T15:09:29.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "8779db6f-99a8-4d2d-b05a-6481112f1c5c", - "email_sent": true, - "payment": false, - "status": "PENDING", - "flow_completed": true, - "company_created_by": "john@wick.com", - "employee_limit_id": "797dbc70-04df-4d26-8140-dfd11bdb37aa" - } - } - ], - "sjv_criminal_reports": [] - }, - { - "id": "0c495ae6-756b-4681-b295-3b0f8ea96eac", - "check_id": null, - "status": "PENDING", - "type": "SEX_OFFENDER", - "cleared": null, - "comments": null, - "created_at": "2020-07-09T14:57:35.000Z", - "updated_at": "2020-07-09T14:57:35.000Z", - "deleted_at": null, - "education": null, - "employment": null, - "read_statuses": [ - { - "id": "7347e6c6-d863-4de4-b945-049dc00583c6", - "reference_id": "0c495ae6-756b-4681-b295-3b0f8ea96eac", - "user_email": "john@wick.com", - "read": true, - "table": null, - "user_role": null, - "created_at": "2020-07-24T10:49:38.000Z", - "updated_at": "2020-07-24T10:49:38.000Z" - } - ], - "cic_criminal_records": [ - { - "id": "e8e33362-8fb0-4fed-8e5c-b2f6575f33bf", - "employee_email_fk": "johndoe@gmail.com", - "cic_criminal_report_id_fk": "3dca9124-83e9-4a2c-adac-a16b80e40fa5", - "created_at": "2020-07-09T10:52:32.000Z", - "updated_at": "2020-07-09T14:57:35.000Z", + "cic_criminal_report_id_fk": "3dca9124-83e9-4a2c-adac-a16b80e40fa5", + "created_at": "2020-07-09T10:52:32.000Z", + "updated_at": "2020-07-09T14:57:35.000Z", "employee": { "id": "00890df3-2595-4cb9-9a76-6d743277ef21", "access_id": "573ab2de-9aea-4355-8c73-34329f815ac4", @@ -4628,14 +4379,16 @@ On an candidate profile that is being processed for adversities, an admin can ge | --- | --- | --- | | sjv_id | `string` | The SJV ID of the criminal report. | -## Create Webhook + +## Verify-coupon ```shell -curl --location --request POST 'https://api.us.springverify.com/company/webhook' \ +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/verify-coupon' \ --header 'Authorization: Bearer JWT_TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ - "url": "https://httpstat.us/200?sleep=2000" + "amount": 750, + "coupon_code": "100OFF" }' ``` @@ -4646,7 +4399,10 @@ var myHeaders = new Headers(); myHeaders.append("Authorization", "Bearer JWT_TOKEN"); myHeaders.append("Content-Type", "application/json"); -var raw = JSON.stringify({"url":"https://httpstat.us/200?sleep=2000"}); +var raw = JSON.stringify({ + "amount": 750, + "coupon_code": "100OFF" +}); var requestOptions = { method: 'POST', @@ -4655,7 +4411,7 @@ var requestOptions = { redirect: 'follow' }; -fetch("https://api.us.springverify.com/company/webhook", requestOptions) +fetch("https://api.us.springverify.com/v2-api/company/verify-coupon", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -4663,35 +4419,31 @@ fetch("https://api.us.springverify.com/company/webhook", requestOptions) // REQUEST var request = require('request'); - -var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' -}; - -var dataString = JSON.stringify({"url":"https://httpstat.us/200?sleep=2000"}); - var options = { - url: 'https://api.us.springverify.com/company/webhook', - method: 'POST', - headers: headers, - body: dataString -}; + 'method': 'POST', + 'url': 'https://api.us.springverify.com/v2-api/company/verify-coupon', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + "amount": 750, + "coupon_code": "100OFF" + }) -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} +}; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -request(options, callback); ``` ```php setUrl('https://api.us.springverify.com/company/webhook'); +$request->setUrl('https://api.us.springverify.com/v2-api/company/verify-coupon'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE @@ -4700,7 +4452,10 @@ $request->setHeader(array( 'Authorization' => 'Bearer JWT_TOKEN', 'Content-Type' => 'application/json' )); -$request->setBody('{\n "url": "https://httpstat.us/200?sleep=2000"\n}'); +$request->setBody('{ +\n "amount": 750, +\n "coupon_code": "100OFF" +\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { @@ -4719,9 +4474,12 @@ catch(HTTP_Request2_Exception $e) { ```python import requests -url = "https://api.us.springverify.com/company/webhook" +url = "https://api.us.springverify.com/v2-api/company/verify-coupon" -payload="{\n \"url\": \"https://httpstat.us/200?sleep=2000\"\n}" +payload="json.dumps({ + "amount": 750, + "coupon_code": "100OFF" + })" headers = { 'Authorization': 'Bearer JWT_TOKEN', 'Content-Type': 'application/json' @@ -4734,23 +4492,24 @@ print(response.text) ```ruby require "uri" +require "json" require "net/http" -url = URI("https://api.us.springverify.com/company/webhook") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true +url = URI("https://api.us.springverify.com/v2-api/company/verify-coupon") +http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) + request["Authorization"] = "Bearer JWT_TOKEN" request["Content-Type"] = "application/json" -request.body = "{\n \"url\": \"https://httpstat.us/200?sleep=2000\"\n}" +request.body = JSON.dump({ + "amount": 750, + "coupon_code": "100OFF" +}) -response = https.request(request) +response = http.request(request) puts response.read_body -# response.code -# response.body ``` > Success Response @@ -4758,47 +4517,25 @@ puts response.read_body ```json { "success": true, - "data": { - "id": "ea48d205-aeac-4b5a-b687-17fba5854396", - "company_id": 53, - "url": "https://httpstat.us/200?sleep=2000", - "active": true, - "updated_at": "2020-12-01T08:33:27.802Z", - "created_at": "2020-12-01T08:33:27.802Z" - } + "data": 100 } ``` -A company can register a webhook for any overall status updates to the candidate. Only one webhook can be registered per company. Webhook url must be a valid url and must respond with a status code of 200. +A company can Verify the coupon code. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| url | `string` | Webhook url | - -**Webhook Data Sample** - - { - "data": { - "employee_email": "abc@email.com", - "overall_status": "FAILED" - }, - "event_type": "overall_status_update" - } - -**Webhook Event Types** - -| Event types | Description | -| --- | --- | -| overall_status_update | Any status change in overall status of the candidate. Individual status of each check for the candidate is not included in this event. | +| coupon code | `string` | The Coupon code which you want to verify. | -## Get Webhook +## Get Single Candidate ```shell -curl --location --request GET 'https://api.us.springverify.com/company/webhook' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c' \ +--header 'Authorization: Bearer JWT_TOKEN' \ + ``` ```javascript @@ -4813,7 +4550,7 @@ var requestOptions = { redirect: 'follow' }; -fetch("https://api.us.springverify.com/company/webhook", requestOptions) +fetch("https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -4821,39 +4558,33 @@ fetch("https://api.us.springverify.com/company/webhook", requestOptions) // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' -}; - var options = { - url: 'https://api.us.springverify.com/company/webhook', - method: 'GET', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN' + } }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` ```php setUrl('https://api.us.springverify.com/company/webhook'); +$request->setUrl('https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' )); + try { $response = $request->send(); if ($response->getStatus() == 200) { @@ -4872,35 +4603,33 @@ catch(HTTP_Request2_Exception $e) { ```python import requests -url = "https://api.us.springverify.com/company/webhook" +url = "https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c" payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' } response = requests.request("GET", url, headers=headers, data=payload) - print(response.text) + ``` ```ruby require "uri" require "net/http" -url = URI("https://api.us.springverify.com/company/webhook") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true +url = URI("https://api.us.springverify.com/v2-api/company/employee?id=3eda99f8-7196-4af4-9b71-0d1db2afe02c") +http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Get.new(url) + request["Authorization"] = "Bearer JWT_TOKEN" -response = https.request(request) +response = http.request(request) puts response.read_body -# response.code -# response.body ``` > Success Response @@ -4909,20 +4638,177 @@ puts response.read_body { "success": true, "data": { - "id": "3f8f1464-d4a9-4020-86bd-048b2660f01b", - "url": "https://httpstat.us/200?sleep=2000", - "active": true + "employee": { + "id": "3eda99f8-7196-4af4-9b71-0d1db2afe02c", + "email": "a13@yopmail.com", + "first_name": "Steven", + "middle_name": "Brandon", + "last_name": "Ward", + "created_at": "2021-01-15T11:54:42.000Z", + "employer_id": "0120d104-cd48-4d00-a2a4-6fb9ee1d2f42", + "status": "AWAITING_INPUT", + "flow_completed": null, + "company_created_by": "pooja@recrosoft.com", + "added_by_fk": { + "email": "pooja@recrosoft.com", + "first_name": "Nitya", + "last_name": "Arora" + }, + "deleted_at": null, + "pricing": { + "package": "bronze", + "package_price": 500, + "total_price": null, + "add_on_price": { + "employment": { + "count": 0, + "price": 0 + }, + "education": { + "count": 0, + "price": 0 + }, + "professional_license": { + "count": 0, + "price": 0 + }, + "all_county_criminal_search": { + "count": 0, + "price": 0 + }, + "county_criminal_search": { + "count": 0, + "price": 0 + }, + "civil_court": { + "count": 0, + "price": 0 + }, + "driving_license": { + "count": null, + "price": null + }, + "mvr": { + "count": 0, + "price": 0, + "state_fee": 0 + }, + "professional_reference": { + "count": 0, + "price": 0 + } + }, + "charged_price": { + "total": null, + "total_without_additional_charge": null, + "coupon": null, + "discount": 0, + "discount_amount": 0 + } + }, + "refund_amount": 750, + "bgv_link": "https://api.us.springverify.com/candidate/personal-details?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiYTEzQHlvcG1haWwuY29tIiwiaWF0IjoxNjMwNjU3Njk3LCJleHAiOjE2MzQyNTc2OTd9.iyA183UdaFDmXTj_3o7r7JKtb49CXfLbPa_NAnooXmk", + "checks": { + "criminal_check_last_run": null, + "criminal_checks": { + "national_criminal": {}, + "sex_offender": {}, + "global_watchlist": {}, + "country_criminal_search": {}, + "civil_court": {} + }, + "employments": [], + "professional_references": [], + "educations": [], + "professional_licenses": [], + "motor_vehicle_record": null + }, + "employee_limit": { + "id": "94833ca9-f051-4e7b-9c69-6842d1db809a", + "employment": 0, + "mvr": false, + "education": 0, + "professional_license": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "civil_court": 0, + "package_id": null, + "professional_reference": null, + "employee_invite_group": { + "id": "ed072d66-d15e-457a-a083-58b732160410", + "package": "bronze" + } + }, + "employee_detail": { + "id": "002a931f-d422-4d02-9a62-e691eca2432f", + "address": "136 , Florence Drive", + "city": "Jupiter", + "state": "FL", + "zipcode": "33458", + "country": null, + "birthdate": "12-11-1980", + "phone": "1-4256894563", + "ssn": "2714" + }, + "employee_verification": { + "id": "2e395ce2-0e97-4b93-9cb1-2adb6230bc42", + "verification_type": "id", + "address": null, + "city": null, + "state": null, + "zipcode": null, + "country": null, + "birthdate": null, + "global_watchlist_verified": null, + "is_report_checked": true, + "summary_of_rights_accepted": null, + "background_check_disclosure_accepted": true, + "id_manual_review": null, + "consent_link": "https://pdf-reports-springrole.s3.amazonaws.com/DocumentsDev/165435294.pdf", + "verified_id_type": "PASSPORT", + "id_status": "PENDING" + }, + "s3_files": [ + { + "id": "d4692411-0e89-480f-aec8-1c48a1ab6e0f", + "type": "ID", + "sub_type": "FRONT", + "link": "https://spring-verify-us.s3.amazonaws.com/env_localhost/employee-id/a13%40yopmail.com/05646cd7-1d1a-4cc1-b2ab-38f9009bf078-passport.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4SIBCNXYYJ4MUL76%2F20210903%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210903T082817Z&X-Amz-Expires=300&X-Amz-Signature=d60ddae954bd223f0cbe8f9cf3535a6ce5a3d522835ef3665390fd1dfded1843&X-Amz-SignedHeaders=host", + "deleted_at": null, + "file_name": "05646cd7-1d1a-4cc1-b2ab-38f9009bf078-passport.jpg", + "id_type": "PASSPORT" + } + ], + "archived_by": null, + "bgv_form_progress": { + "total": 2, + "filled": 0 + } + }, + "adverse_action_pending_count": 0 } } ``` -A company can get the details of a registered webhook using this API. +When the details of a specific candidate whose profile is already verified is to be retrieved, use this API. This API retrieves the details of the candidate that have been verified, as well as the pricing package in which the candidate's profile was verified, along with the date of the most recent verification. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +|id | `uuid` | Contains the unique ID of the candidate. | + + -## Delete Webhook + +## Get employee actions ```shell -curl --location --request DELETE 'https://api.us.springverify.com/company/webhook' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request POST 'https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0'' \ +--header 'Authorization: Bearer JWT_TOKEN' \ + ``` ```javascript @@ -4932,12 +4818,13 @@ var myHeaders = new Headers(); myHeaders.append("Authorization", "Bearer JWT_TOKEN"); var requestOptions = { - method: 'DELETE', + method: 'GET', headers: myHeaders, redirect: 'follow' }; -fetch("https://api.us.springverify.com/company/webhook", requestOptions) + +fetch("https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -4945,38 +4832,29 @@ fetch("https://api.us.springverify.com/company/webhook", requestOptions) // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' -}; - var options = { - url: 'https://api.us.springverify.com/company/webhook', - method: 'DELETE', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0', + 'headers': { + 'Authorization': "Bearer JWT_TOKEN" + } }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` - ```php setUrl('https://api.us.springverify.com/company/webhook'); -$request->setMethod(HTTP_Request2::METHOD_DELETE); +$request->setUrl('https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0'); +$request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN' )); try { $response = $request->send(); @@ -4996,14 +4874,14 @@ catch(HTTP_Request2_Exception $e) { ```python import requests -url = "https://api.us.springverify.com/company/webhook" +url = "https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0" payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN' } -response = requests.request("DELETE", url, headers=headers, data=payload) +response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` @@ -5012,19 +4890,15 @@ print(response.text) require "uri" require "net/http" -url = URI("https://api.us.springverify.com/company/webhook") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true +url = URI("https://api.us.springverify.com/v2-api/company/employee/actions?email=pooja@recrosoft.com&limit=5&offset=0") -request = Net::HTTP::Delete.new(url) +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer JWT_TOKEN" -response = https.request(request) +response = http.request(request) puts response.read_body -# response.code -# response.body ``` > Success Response @@ -5032,25 +4906,67 @@ puts response.read_body ```json { "success": true, - "data": 1 -} -``` - -A company can delete a registered webhook using this API. - -## Get Webhook Logs - -```shell -curl --location --request GET 'https://api.us.springverify.com/company/webhook/logs' \ ---header 'Content-Type: application/json' \ ---header 'Authorization: Bearer JWT_TOKEN' + "data": [ + { + "employee_name": "", + "action": "has successfully verified their identity. (using their driving license)", + "time": "2020-11-25T06:40:50.000Z", + "id": "e419511b-f7ea-47b8-b87b-b6997f494624", + "email": "pooja@recrosoft.com" + }, + { + "employee_name": "", + "action": "has successfully verified their identity. (using their passport)", + "time": "2020-09-11T11:15:19.000Z", + "id": "e419511b-f7ea-47b8-b87b-b6997f494624", + "email": "pooja@recrosoft.com" + }, + { + "employee_name": "", + "action": "has successfully verified their identity. (using their passport)", + "time": "2020-09-07T06:36:07.000Z", + "id": "e419511b-f7ea-47b8-b87b-b6997f494624", + "email": "pooja@recrosoft.com" + }, + { + "employee_name": "", + "action": "has successfully verified their identity. (using their driving license)", + "time": "2020-09-07T05:49:08.000Z", + "id": "e419511b-f7ea-47b8-b87b-b6997f494624", + "email": "pooja@recrosoft.com" + }, + { + "employee_name": "", + "action": "has successfully verified their identity. (using their driving license)", + "time": "2020-09-07T05:48:49.000Z", + "id": "e419511b-f7ea-47b8-b87b-b6997f494624", + "email": "pooja@recrosoft.com" + } + ] +} +``` +A company can check the actions status of candidates which are completed/In progress by employee + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| email | `string` | Email of the employee | +| limit | `integer` | Set the limit to get data | +| offset | `integer` | Set the offset as well | + +## Search Candidate + +```shell +curl --location --request GET 'https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja' \ +--header 'Authorization: Bearer JWT_TOKEN' \ + ``` ```javascript // FETCH var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); myHeaders.append("Authorization", "Bearer JWT_TOKEN"); var requestOptions = { @@ -5059,7 +4975,7 @@ var requestOptions = { redirect: 'follow' }; -fetch("https://api.us.springverify.com/company/webhook/logs", requestOptions) +fetch("https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -5068,32 +4984,28 @@ fetch("https://api.us.springverify.com/company/webhook/logs", requestOptions) var request = require('request'); var options = { - 'method': 'GET', - 'url': 'https://api.us.springverify.com/company/webhook/logs', + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja', 'headers': { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': "Bearer JWT_TOKEN" } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); - ``` - ```php setUrl('https://api.us.springverify.com/company/webhook/logs'); +$request->setUrl('https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( - 'Content-Type' => 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN' )); try { $response = $request->send(); @@ -5112,32 +5024,27 @@ catch(HTTP_Request2_Exception $e) { ```python import requests -import json -url = "https://api.us.springverify.com/company/webhook/logs" +url = "https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja" payload={} headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) - ``` ```ruby require "uri" -require "json" require "net/http" -url = URI("https://api.us.springverify.com/company/webhook/logs") +url = URI("https://api.us.springverify.com/v2-api/company/employee/search?limit=5&offset=0&search=pooja") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Get.new(url) -request["Content-Type"] = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" response = http.request(request) @@ -5150,153 +5057,195 @@ puts response.read_body ```json { "success": true, - "data": { - "logs": [ - { - "email": "johndoe@gmail.com", - "event_type": "overall_status_update", - "response": { - "code":200, - "description":"OK" - }, - "response_code": 200, - "curl": "curl \"https://webhook.site/be9bcd8c-c819-4b5a-9652-0984e6dfa282\" \\n-H \"cache-control: no-cache\" \\n-H \"content-type: application/json\" \\n-H \"secret-token: null\" \\n-H \"authorization: Bearer JWT_TOKEN\" \\n-H \"accept: application/json\" \\n--data-binary \"{\"\"data\"\":{\"\"employee_email\"\":\"\"johndoe@gmail.com\"\",\"\"overall_status\"\":\"\"PENDING\"\"},\"\"event_type\"\":\"\"overall_status_update\"\",\"\"company_id\"\":126}\" --compressed", - "id": "61026a761e331e43541d7925", - "created_at": "2021-07-29T08:44:38.242Z" + "data": [ + { + "id": "8dbd6ad1-63c6-40e9-bb2d-3a659eda4023", + "email": "hammer@yopmail.com", + "first_name": "Pooja", + "middle_name": "P", + "last_name": "Gaur", + "status": "UNABLE_TO_VERIFY", + "employee_limit": { + "id": "e795ec96-3348-4db0-a478-fd786289e575", + "employee_invite_group": { + "id": "789bd3c0-bdd3-4df1-98ed-2d9f194ae331", + "package": "bronze" + } } - ], - "count": 1 - } + }, + { + "id": "8dfa288e-7a36-4bd6-aa7e-39e984f4f1a2", + "email": "pooja145@yopmail.com", + "first_name": "Jessica", + "middle_name": "", + "last_name": "MA", + "status": "AWAITING_INPUT", + "employee_limit": { + "id": "15a59ab0-696a-4554-a848-caef20b62d21", + "employee_invite_group": { + "id": "c652e1f5-4385-44f5-9720-4aa9098f3c9f", + "package": "bronze" + } + } + }, + { + "id": "f434f529-dd6b-4511-bc85-d73d81bbbfbc", + "email": "pooja34@yopmail.com", + "first_name": null, + "middle_name": null, + "last_name": null, + "status": "AWAITING_INPUT", + "employee_limit": { + "id": "eb8961e8-86ba-487c-847f-bf178bae2c98", + "employee_invite_group": { + "id": "3ba48668-9003-46aa-ac0b-f3aab6014e8e", + "package": "bronze" + } + } + }, + { + "id": "f24f138b-1fd0-4e39-afff-9b17a425c027", + "email": "pooja56@yopmail.com", + "first_name": null, + "middle_name": null, + "last_name": null, + "status": "AWAITING_INPUT", + "employee_limit": { + "id": "1595c49e-b994-43df-87a0-cc816beff12e", + "employee_invite_group": { + "id": "04e06691-a835-482a-b9b0-c5370dbd2ffa", + "package": "bronze" + } + } + }, + { + "id": "0636d5fb-df9d-4535-8b77-e5f25b70740d", + "email": "pooja678@yopmail.com", + "first_name": "Steven", + "middle_name": "Brandon", + "last_name": "Ward", + "status": "VERIFIED", + "employee_limit": { + "id": "ef269645-493e-42fd-a427-2d9585597e17", + "employee_invite_group": { + "id": "801cc61f-ccca-441e-a78d-c055f1485666", + "package": "bronze" + } + } + } + ] } ``` - -A company can get the logs of a registered webhook using this API. +This API searches and retrieves the profile of the candidates. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| status | `string` | ALL/SUCCESS/ERROR | -| search | `string` | Search term which returns record after matching email of the candidate | -| limit | `integer` | Page Limit | -| offset | `integer` | Page Offset | - - +| search | `string` | name/email more then three char | +| limit | `integer` | Set the limit to get data | +| offset | `integer` | Set the offset as well | ---- - -# Candidate -This section covers the API details available for users logged in as candidates i.e., users who wish to get background verification checks performed on their profiles. + -## Submit Personal Details +## BGV progress ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/personal-details' \ ---header 'Content-Type: application/json' \ +curl --location --request GET 'https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e'\ --header 'Authorization: Bearer JWT_TOKEN' \ ---data-raw '{ - "first_name":"John", - "middle_name":"David", - "last_name":"Doe", - "dob":"12-11-1980", - "ssn":"123456789", - "email":"johndoe@gmail.com", - "house_number": "239", - "street_name": "Avea street", - "address":"236 Avea street", - "city":"Gotham", - "state":"CA", - "zip_code":"33433", - "phone":"56-999222992" -}' + ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/personal-details', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' -}; - -var dataString = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; - var options = { - url: 'https://api.us.springverify.com/employee/personal-details', - method: 'POST', - headers: headers, - body: dataString + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e', + 'headers': { + 'Authorization': "Bearer JWT_TOKEN" + } }; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); ``` - ```php 'application/json', +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; -$response = Requests::post('https://api.us.springverify.com/employee/personal-details', $headers, $data); +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python import requests +url = "https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e" + +payload={} headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization' => 'Bearer JWT_TOKEN' } -data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' +response = requests.request("GET", url, headers=headers, data=payload) -response = requests.post('https://api.us.springverify.com/employee/personal-details', headers=headers, data=data) +print(response.text) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/personal-details") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/v2-api/company/employee/bgv-progress?id=d5639f49-243b-44a8-941e-64a410c2530e") -req_options = { - use_ssl: uri.scheme == "https", -} +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +response = http.request(request) +puts response.read_body -# response.code -# response.body ``` > Success Response @@ -5305,226 +5254,157 @@ end { "success": true, "data": { - "id": "ee23f57c-ad7a-40fc-8845-18aa12d67a5e", - "access_id": "799bee32-72e6-480f-b023-883bde7aa34f", - "email": "johndoe@yopmail.com", - "password_hash": null, - "first_name": "John", - "middle_name": "David", - "last_name": "Doe", - "name_verified": null, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:48.157Z", - "employer_id": "64c5e04f-c9cc-43ca-bb6a-3bb70abb9d6a", - "payment_id": "11061087-7975-4ef9-8e3d-9f2c8dd44ad6", - "email_sent": true, - "payment": { - "charged": true - }, - "status": null, - "flow_completed": null, - "company_created_by": "pooja@recrosoft.com", - "employee_limit_id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", - "employments": [], - "education": [], - "cic_criminal_records": [], - "professional_licenses": [], - "employee_detail": { - "id": "5988dda2-66aa-4ecb-a239-398465e569ab", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2021-01-19T04:25:48.000Z", - "updated_at": "2021-01-19T04:25:48.000Z", - "employee_email": "johndoe@yopmail.com" - }, - "employee_verification": null, - "employee_limit": { - "id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", - "employment": 0, - "mvr": false, - "education": 0, - "professional_license": 0, - "all_county_criminal_search": false, - "county_criminal_search": 0, - "civil_court": 0, - "driving_license": 0, - "package_id": null, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:21.000Z", - "employee_invite_group_id": "e38d60d3-e474-4710-aa84-847221f77910", - "employee_invite_group": { - "id": "e38d60d3-e474-4710-aa84-847221f77910", - "package": "bronze", - "active": true, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:21.000Z", - "company_created_by": "pooja@recrosoft.com", - "package_id": "1" - } + "personal_details": { + "name": "personal_details", + "skip": false }, - "kbaqna": null, - "employee_flow": { - "id": 274, - "employment_flow": null, - "education_flow": null, - "professional_license_flow": null, - "created_at": "2021-01-19T04:25:47.000Z", - "updated_at": "2021-01-19T04:25:47.000Z", - "employee_email": "johndoe@yopmail.com" - }, - "s3_files": [], - "criminal_statuses": [], - "sjv_criminal_reports": [], - "motor_vehicle_record": null + "id_verification": { + "name": "id_verification", + "skip": false + } } } ``` -A candidate can submit their personal details using this API. It is of the utmost importance that the details entered here are absolutely accurate. For creating the profile, the same email ID must be used to which the verification request was sent. +The company can check Backgroung Verification progress/status of the employee. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| first_name | `string` | The candidate's first name. | -| middle_name | `string` | The candidate's middle name. | -| last_name | `string` | The candidate's last name. | -| dob | `string` | The candidate's date of birth in the format DD-MM-YYYY. | -| ssn | `string` | The candidate's SSN. | -| email | `string` | The candidate's email address - must be the same address to which the verification request was sent. | -| house_number | `integer` | The candidate's house number. | -| street_name | `string` | The name of the street where the candidate's house is located. | -| address | `string` | The candidate's residential address. | -| city | `string` | The city where the candidate's house is located. | -| state | `string` | The state where the candidate's house is located. | -| zip_code | `string` | The ZIP code of the postal district where the candidate's house is located. | -| phone | `string` | The candidate's phone number. | +| ID | `string` | id of employee | -## Update Personal Details + +## Demo Status ```shell -curl --location --request PUT 'https://api.us.springverify.com/employee/personal-details' \ ---header 'Content-Type: application/json' \ + +curl --location --request PATCH 'https://api.us.springverify.com/v2-api/company/admin/demo-status' \ --header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ --data-raw '{ - "first_name":"John", - "middle_name":"David", - "last_name":"Doe", - "dob":"12-11-1980", - "ssn":"123456789", - "email":"johndoe@gmail.com", - "house_number": "239", - "street_name": "A clear street", - "address":"236 A clear street", - "city":"Gotham", - "state":"CA", - "zip_code":"33433", - "phone":"56-999222992" + "is_demo_done": true }' + ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); +myHeaders.append("Content-Type", "application/json"); -fetch('https://api.us.springverify.com/employee/personal-details', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "A clear street" "address":"236 A clear street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' +var raw = JSON.stringify({ + "is_demo_done": true }); -// REQUEST - -var request = require('request'); - -var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' +var requestOptions = { + method: 'PATCH', + headers: myHeaders, + body: raw, + redirect: 'follow' }; -var dataString = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; +fetch("https://api.us.springverify.com/v2-api/company/admin/demo-status", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); + +// REQUEST +var request = require('request'); var options = { - url: 'https://api.us.springverify.com/employee/personal-details', - method: 'POST', - headers: headers, - body: dataString -}; + 'method': 'PATCH', + 'url': 'https://api.us.springverify.com/v2-api/company/admin/demo-status', + 'headers': { + 'Authorization': "Bearer JWT_TOKEN", + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + "is_demo_done": true + }) -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} +}; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -request(options, callback); ``` - ```php + 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; -$response = Requests::post('https://api.us.springverify.com/employee/personal-details', $headers, $data); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/v2-api/company/admin/demo-status'); +$request->setMethod('PATCH'); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' +)); +$request->setBody('{ +\n "is_demo_done": true +\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} + ``` ```python + import requests +import json +url = "https://api.us.springverify.com/v2-api/company/admin/demo-status" + +payload = json.dumps({ + "is_demo_done": True +}) headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' } -data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' +response = requests.request("PATCH", url, headers=headers, data=payload) + +print(response.text) -response = requests.post('https://api.us.springverify.com/employee/personal-details', headers=headers, data=data) ``` ```ruby -require 'net/http' -require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/personal-details") -request = Net::HTTP::Put.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +require "uri" +require "json" +require "net/http" -req_options = { - use_ssl: uri.scheme == "https", -} +url = URI("https://api.us.springverify.com/v2-api/company/admin/demo-status") -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Patch.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" +request["Content-Type"] = "application/json" +request.body = JSON.dump({ + "is_demo_done": true +}) + +response = http.request(request) +puts response.read_body -# response.code -# response.body ``` > Success Response @@ -5532,157 +5412,22 @@ end ```json { "success": true, - "data": { - "employee_details_resp": { - "id": "5988dda2-66aa-4ecb-a239-398465e569ab", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2021-01-19T04:25:48.000Z", - "updated_at": "2021-01-19T04:25:48.000Z", - "employee_email": "johndoe@yopmail.com" - }, - "employee_resp": { - "id": "ee23f57c-ad7a-40fc-8845-18aa12d67a5e", - "access_id": "799bee32-72e6-480f-b023-883bde7aa34f", - "email": "johndoe@yopmail.com", - "password_hash": null, - "first_name": "John", - "middle_name": "David", - "last_name": "Doe", - "name_verified": null, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:48.000Z", - "employer_id": "64c5e04f-c9cc-43ca-bb6a-3bb70abb9d6a", - "payment_id": "11061087-7975-4ef9-8e3d-9f2c8dd44ad6", - "email_sent": true, - "payment": { - "charged": true - }, - "status": null, - "flow_completed": null, - "company_created_by": "pooja@recrosoft.com", - "employee_limit_id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", - "employments": [], - "education": [], - "cic_criminal_records": [], - "professional_licenses": [], - "employee_detail": { - "id": "5988dda2-66aa-4ecb-a239-398465e569ab", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2021-01-19T04:25:48.000Z", - "updated_at": "2021-01-19T04:25:48.000Z", - "employee_email": "johndoe@yopmail.com" - }, - "employee_verification": null, - "employee_limit": { - "id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", - "employment": 0, - "mvr": false, - "education": 0, - "professional_license": 0, - "all_county_criminal_search": false, - "county_criminal_search": 0, - "civil_court": 0, - "driving_license": 0, - "package_id": null, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:21.000Z", - "employee_invite_group_id": "e38d60d3-e474-4710-aa84-847221f77910", - "employee_invite_group": { - "id": "e38d60d3-e474-4710-aa84-847221f77910", - "package": "bronze", - "active": true, - "created_at": "2021-01-19T04:25:21.000Z", - "updated_at": "2021-01-19T04:25:21.000Z", - "company_created_by": "pooja@recrosoft.com", - "package_id": "1" - } - }, - "kbaqna": null, - "employee_flow": { - "id": 274, - "employment_flow": null, - "education_flow": null, - "professional_license_flow": null, - "created_at": "2021-01-19T04:25:47.000Z", - "updated_at": "2021-01-19T04:25:47.000Z", - "employee_email": "johndoe@yopmail.com" - }, - "s3_files": [], - "criminal_statuses": [], - "sjv_criminal_reports": [], - "motor_vehicle_record": null - } - } + "data": [ + 1 + ] } ``` -A candidate who has created a profile can use this API to update their personal details. The updates can be made until the verification process is complete. - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| first_name | `string` | The candidate's first name. | -| middle_name | `string` | The candidate's middle name. | -| last_name | `string` | The candidate's last name. | -| dob | `string` | The candidate's date of birth in the format DD-MM-YYYY. | -| ssn | `string` | The candidate's SSN. | -| email | `string` | The candidate's email address - must be the same address to which the verification request was sent. | -| house_number | `integer` | The candidate's house number. | -| street_name | `string` | The name of the street where the candidate's house is located. | -| address | `string` | The candidate's residential address. | -| city | `string` | The city where the candidate's house is located. | -| state | `string` | The state where the candidate's house is located. | -| zip_code | `string` | The ZIP code of the postal district where the candidate's house is located. | -| phone | `string` | The candidate's phone number. | +A company admin can check the status of demo (given or not). -## Provide Consent +## Create Webhook ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/consent' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'https://api.us.springverify.com/company/webhook' \ --header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ --data-raw '{ - "summary_of_rights": true, - "background_check": true, - "report_checked": true, - "full_name": "John David Doe" + "url": "https://httpstat.us/200?sleep=2000" }' ``` @@ -5690,10 +5435,10 @@ curl --location --request POST 'https://api.us.springverify.com/employee/consent // FETCH var myHeaders = new Headers(); -myHeaders.append("Content-Type", "application/json"); myHeaders.append("Authorization", "Bearer JWT_TOKEN"); +myHeaders.append("Content-Type", "application/json"); -var raw = JSON.stringify({"summary_of_rights":true,"background_check":true,"report_checked":true,"full_name":"John David Doe"}); +var raw = JSON.stringify({"url":"https://httpstat.us/200?sleep=2000"}); var requestOptions = { method: 'POST', @@ -5702,7 +5447,7 @@ var requestOptions = { redirect: 'follow' }; -fetch("https://api.us.springverify.com/employee/consent", requestOptions) +fetch("https://api.us.springverify.com/company/webhook", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error)); @@ -5710,37 +5455,44 @@ fetch("https://api.us.springverify.com/employee/consent", requestOptions) // REQUEST var request = require('request'); -var options = { - 'method': 'POST', - 'url': 'https://api.us.springverify.com/employee/consent', - 'headers': { + +var headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({"summary_of_rights":true,"background_check":true,"report_checked":true,"full_name":"John David Doe"}) +}; +var dataString = JSON.stringify({"url":"https://httpstat.us/200?sleep=2000"}); + +var options = { + url: 'https://api.us.springverify.com/company/webhook', + method: 'POST', + headers: headers, + body: dataString }; -request(options, function (error, response) { - if (error) throw new Error(error); - console.log(response.body); -}); +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); ``` ```php setUrl('https://api.us.springverify.com/employee/consent'); +$request->setUrl('https://api.us.springverify.com/company/webhook'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( - 'Content-Type' => 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' )); -$request->setBody('{\n "summary_of_rights": true,\n "background_check": true,\n "report_checked": true,\n "full_name": "John David Doe"\n}'); +$request->setBody('{\n "url": "https://httpstat.us/200?sleep=2000"\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { @@ -5759,37 +5511,38 @@ catch(HTTP_Request2_Exception $e) { ```python import requests -url = "https://api.us.springverify.com/employee/consent" +url = "https://api.us.springverify.com/company/webhook" -payload="{\n \"summary_of_rights\": true,\n \"background_check\": true,\n \"report_checked\": true,\n \"full_name\": \"John David Doe\"\n}" +payload="{\n \"url\": \"https://httpstat.us/200?sleep=2000\"\n}" headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) - ``` ```ruby require "uri" require "net/http" -url = URI("https://api.us.springverify.com/employee/consent") +url = URI("https://api.us.springverify.com/company/webhook") 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 JWT_TOKEN" -request.body = "{\n \"summary_of_rights\": true,\n \"background_check\": true,\n \"report_checked\": true,\n \"full_name\": \"John David Doe\"\n}" +request["Content-Type"] = "application/json" +request.body = "{\n \"url\": \"https://httpstat.us/200?sleep=2000\"\n}" response = https.request(request) puts response.read_body +# response.code +# response.body ``` > Success Response @@ -5798,256 +5551,78 @@ puts response.read_body { "success": true, "data": { - "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", - "summary_of_rights_accepted": true, - "background_check_disclosure_accepted": true, - "is_report_checked": false, - "employee_email": "johndoe@gmail.com", - "consent_link": "s3 link", - "spring_sign_ref_id": "5f4524b817710d0014423b61", - "updated_at": "2020-08-25T14:48:27.394Z", - "created_at": "2020-08-25T14:48:27.394Z" + "id": "ea48d205-aeac-4b5a-b687-17fba5854396", + "company_id": 53, + "url": "https://httpstat.us/200?sleep=2000", + "active": true, + "updated_at": "2020-12-01T08:33:27.802Z", + "created_at": "2020-12-01T08:33:27.802Z" } } ``` -After creating their profile, a candidate needs to explicitly provide consent to allow background verification using this API. The name provided here should match the full name provided in the Submit Personal Details API. +A company can register a webhook for any overall status updates to the candidate. Only one webhook can be registered per company. Webhook url must be a valid url and must respond with a status code of 200. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| summary_of_rights | `boolean` | Indicates that the candidate has read the summary of rights. This flag can be "true" or "false". | -| background_check | `boolean` | Indicates that the candidate has agreed for a background check. This flag can be "true" or "false". | -| report_checked | `boolean` | Indicates that the candidate's report has been checked. This flag can be "true" or "false". | -| full_name | `string` | The candidate's full name. | +| url | `string` | Webhook url | -## Knowledge Based Quiz +**Webhook Data Sample** + + { + "data": { + "employee_email": "abc@email.com", + "overall_status": "FAILED" + }, + "event_type": "overall_status_update" + } + +**Webhook Event Types** + +| Event types | Description | +| --- | --- | +| overall_status_update | Any status change in overall status of the candidate. Individual status of each check for the candidate is not included in this event. | + + +## Get Webhook ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/kba/questions' \ +curl --location --request GET 'https://api.us.springverify.com/company/webhook' \ --header 'Authorization: Bearer JWT_TOKEN' ``` -> Success Response +```javascript +// FETCH -```json -{ - "success": true, - "data": { - "data": { - "idm_session_id": "103c7770a327eada", - "idmkba_response": { - "kba_question": [ - { - "question_id": 1, - "question": "Which of the following addresses have you lived at?", - "question_type": "StreetAddress", - "options": [ - { - "id": 1, - "option": "2601 GORDON AVE" - }, - { - "id": 2, - "option": "134 MARYLAND RD" - }, - { - "id": 3, - "option": "1131 CANYON RD" - }, - { - "id": 4, - "option": "9011 CENTRAL RD" - }, - { - "id": 5, - "option": "NONE OF THE ABOVE" - } - ] - }, - { - "question_id": 2, - "question": "Which of the following people is your relative?", - "question_type": "Relatives", - "options": [ - { - "id": 1, - "option": "Dwight Kurt Schrute" - }, - { - "id": 2, - "option": "Gabe" - }, - { - "id": 3, - "option": "Kelly" - }, - { - "id": 4, - "option": "Toby" - }, - { - "id": 5, - "option": "NONE OF THE ABOVE" - } - ] - }, - { - "question_id": 3, - "question": "Which of the following vehicles have you owned?", - "question_type": "Vehicle", - "options": [ - { - "id": 1, - "option": "1984 NISSAN 300ZX" - }, - { - "id": 2, - "option": "1997 ISUZU RODEO" - }, - { - "id": 3, - "option": "2008 HYUNDAI TIBURON" - }, - { - "id": 4, - "option": "1967 LINCOLN CONTINENTAL" - }, - { - "id": 5, - "option": "NONE OF THE ABOVE" - } - ] - }, - { - "question_id": 4, - "question": "Which of the following streets have you lived in?", - "question_type": "StreetName", - "options": [ - { - "id": 1, - "option": "BANDERO DR" - }, - { - "id": 2, - "option": "GALEWOOD DR" - }, - { - "id": 3, - "option": "UNION HALL RD" - }, - { - "id": 4, - "option": "KNOBHILL DR" - }, - { - "id": 5, - "option": "NONE OF THE ABOVE" - } - ] - }, - { - "question_id": 5, - "question": "Which of these businesses are you associated with?", - "question_type": "Businesses", - "options": [ - { - "id": 1, - "option": "Stark Industries" - }, - { - "id": 2, - "option": "Avengers LLC" - }, - { - "id": 3, - "option": "Wayne Enterprises" - }, - { - "id": 4, - "option": "Dunder Mifflin" - }, - { - "id": 5, - "option": "NONE OF THE ABOVE" - } - ] - } - ], - "kba_status": { - "questions_answered": 0, - "no_of_questions": 5 - }, - "is_kba_enabled": "1" - } - }, - "attempt_number": 1, - "success": true - } -} -``` - -This API is used to generate a knowledge-based quiz about the candidate to verify authenticity. A series of questions relating to the candidate's profile will be asked to which the candidate is required to answer. Based on these answers, a score will be generated. - -## Submit KBA Quiz - -```shell -curl --location --request POST 'https://api.us.springverify.com/employee/kba/verify' \ ---header 'Content-Type: application/json' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---data-raw '{ -"qna":[ - { - "question_id": 1, - "answer_id": 5 - },{ - "question_id": 2, - "answer_id": 5 - },{ - "question_id": 3, - "answer_id": 5 - },{ - "question_id": 4, - "answer_id": 5 - },{ - "question_id": 5, - "answer_id": 5 - } - ] -}' -``` - -```javascript -// FETCH +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -var fetch = require('node-fetch'); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; -fetch('https://api.us.springverify.com/employee/kba/verify', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }) -}); +fetch("https://api.us.springverify.com/company/webhook", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' }; -var dataString = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }'; - var options = { - url: 'https://api.us.springverify.com/employee/kba/verify', - method: 'POST', - headers: headers, - body: dataString + url: 'https://api.us.springverify.com/company/webhook', + method: 'GET', + headers: headers }; function callback(error, response, body) { @@ -6061,45 +5636,60 @@ request(options, callback); ```php 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }'; -$response = Requests::post('https://api.us.springverify.com/employee/kba/verify', $headers, $data); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/company/webhook'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python import requests +url = "https://api.us.springverify.com/company/webhook" + +payload={} headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization': 'Bearer JWT_TOKEN' } -data = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }' +response = requests.request("GET", url, headers=headers, data=payload) -response = requests.post('https://api.us.springverify.com/employee/kba/verify', headers=headers, data=data) +print(response.text) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/kba/verify") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/company/webhook") -req_options = { - use_ssl: uri.scheme == "https", -} +https = Net::HTTP.new(url.host, url.port) +https.use_ssl = true -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +request = Net::HTTP::Get.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" + +response = https.request(request) +puts response.read_body # response.code # response.body @@ -6109,64 +5699,53 @@ end ```json { - "success": true, - "data": { - "correct_answers": 5, - "total_questions": 5, - "success": true - } -} -``` - -> Error Response - -```json -{ - "message": "Your answers didn't seem to be correct, please try uploading DL or Passport.", - "stack": "message" + "success": true, + "data": { + "id": "3f8f1464-d4a9-4020-86bd-048b2660f01b", + "url": "https://httpstat.us/200?sleep=2000", + "active": true + } } ``` -This API is used to submit the candidate's answers of the [Knowledge Based Quiz](https://docs.us.springverify.com/#knowledge-based-quiz). - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| qna | `array` | This is an array that contains the IDs of the question as well as the ID of the responses to those questions. | +A company can get the details of a registered webhook using this API. -## Upload and Verify ID +## Delete Webhook ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/upload/id' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---form 'front=@/path/to/file' \ ---form 'back=@/path/to/file' \ +curl --location --request DELETE 'https://api.us.springverify.com/company/webhook' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/upload/id', { - method: 'POST', - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'DELETE', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/company/webhook", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); var headers = { - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' }; var options = { - url: 'https://api.us.springverify.com/employee/upload/id', - method: 'POST', + url: 'https://api.us.springverify.com/company/webhook', + method: 'DELETE', headers: headers }; @@ -6181,39 +5760,60 @@ request(options, callback); ```php 'Bearer JWT_TOKEN' -); -$response = Requests::post('https://api.us.springverify.com/employee/upload/id', $headers); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/company/webhook'); +$request->setMethod(HTTP_Request2::METHOD_DELETE); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python import requests +url = "https://api.us.springverify.com/company/webhook" + +payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization': 'Bearer JWT_TOKEN' } -response = requests.post('https://api.us.springverify.com/employee/upload/id', headers=headers) +response = requests.request("DELETE", url, headers=headers, data=payload) + +print(response.text) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/upload/id") -request = Net::HTTP::Post.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/company/webhook") -req_options = { - use_ssl: uri.scheme == "https", -} +https = Net::HTTP.new(url.host, url.port) +https.use_ssl = true -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +request = Net::HTTP::Delete.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" + +response = https.request(request) +puts response.read_body # response.code # response.body @@ -6224,112 +5824,112 @@ end ```json { "success": true, - "data": { - "success": true, - "attempts": 1, - "user_access_code": "6e7d5f15-9456-430d-b9da-9df67a4d9996" - } + "data": 1 } ``` -This API records the ID of the candidate and verifies its authenticity. - -**Important Notes:** - -1. The maximum allowed size of the image uploaded (per image) is capped at 2MB. Uploading photos larger than 2MB will throw an exception. -2. If using a mobile device, capturing a clear, non-blurry image is extremely important so that the ID can be processed accurately. -3. At a minimum, a 5MP camera should be used to capture the images for the UploadID parameter. -4. It is mandatory to have a contrast between the ID and the background. The background must be solid colored. -5. It must be ensured that all the edges of the ID are visible and none of the edges are cutoff. - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| front | `image` | The image of the front of the ID. | -| back | `image` | The image of the back of the ID. | +A company can delete a registered webhook using this API. -## Upload and Verify Passport +## Get Webhook Logs ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/upload/passport' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---form 'front=@/path/to/file' +curl --location --request GET 'https://api.us.springverify.com/v2-api/company/webhook/logs' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/upload/passport', { - method: 'POST', - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/v2-api/company/webhook/logs", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { - 'Authorization': 'Bearer JWT_TOKEN' -}; - var options = { - url: 'https://api.us.springverify.com/employee/upload/passport', - method: 'POST', - headers: headers + 'method': 'GET', + 'url': 'https://api.us.springverify.com/v2-api/company/webhook/logs', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN' + } }; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); ``` ```php + 'Bearer JWT_TOKEN' -); -$response = Requests::post('https://api.us.springverify.com/employee/upload/passport', $headers); -``` +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/v2-api/company/webhook/logs'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ```python + import requests +url = "https://api.us.springverify.com/v2-api/company/webhook/logs" + +payload={} headers = { - 'Authorization': 'Bearer JWT_TOKEN', + 'Authorization': 'Bearer JWT_TOKEN' } -response = requests.post('https://api.us.springverify.com/employee/upload/passport', headers=headers) +response = requests.request("GET", url, headers=headers, data=payload) + +print(response.text) + ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "json" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/upload/passport") -request = Net::HTTP::Post.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/v2-api/company/webhook/logs") -req_options = { - use_ssl: uri.scheme == "https", -} +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) +request["Content-Type"] = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +response = http.request(request) +puts response.read_body -# response.code -# response.body ``` > Success Response @@ -6337,40 +5937,70 @@ end ```json { "success": true, - "data": true -} -``` - -> Error Response - -```json -{ - "message": "The Passport could not be parsed. Please make sure all four sides are visible and the Passport is in front of a dark background." + "data": { + "logs": [ + { + "email": "johndoe@gmail.com", + "event_type": "overall_status_update", + "response": { + "code":200, + "description":"OK" + }, + "response_code": 200, + "curl": "curl \"https://webhook.site/be9bcd8c-c819-4b5a-9652-0984e6dfa282\" \\n-H \"cache-control: no-cache\" \\n-H \"content-type: application/json\" \\n-H \"secret-token: null\" \\n-H \"authorization: Bearer JWT_TOKEN\" \\n-H \"accept: application/json\" \\n--data-binary \"{\"\"data\"\":{\"\"employee_email\"\":\"\"johndoe@gmail.com\"\",\"\"overall_status\"\":\"\"PENDING\"\"},\"\"event_type\"\":\"\"overall_status_update\"\",\"\"company_id\"\":126}\" --compressed", + "id": "61026a761e331e43541d7925", + "created_at": "2021-07-29T08:44:38.242Z" + } + ], + "count": 1 + } } ``` -This API records the Passport details of the emcaployee and verifies its authenticity. - -This API is used to upload an image of the candidate's passport that will be scanned and parsed. The image should have the candidate's information on it on the first or the second page. It must be a single picture that captures both pages of the passport. This follows the same logic as the other uploadId endpoints -- the picture needs to be clear with minimal glare and must have sufficient lighting. - -There are several variables that are more likely to cause a document to fail: -1. The quality of the captured image - blurred images or images with reflections. -2. Personalization of the document such as documents with especially long names. -3. Variations in manufacturing techniques - for example, a card printed on the wrong side or slight variations in the printing location. -4. Wear and aging of the document - a worn or dirty card can cause failure. -5. Tampering and counterfeiting - unlawful changes or reproduction of documents. +A company can get the logs of a registered webhook using this API. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| front | `image` | The image of the passport. | +| status | `string` | ALL/SUCCESS/ERROR | +| search | `string` | Search term which returns record after matching email of the candidate | +| limit | `integer` | Page Limit | +| offset | `integer` | Page Offset | -## Request Manual Review of the ID or Passport + + + + +--- + +# Candidate + +This section covers the API details available for users logged in as candidates i.e., users who wish to get background verification checks performed on their profiles. + +## Submit Personal Details ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/id/manual-review' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request POST 'https://api.us.springverify.com/employee/personal-details' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "first_name":"John", + "middle_name":"David", + "last_name":"Doe", + "dob":"12-11-1980", + "ssn":"123456789", + "email":"johndoe@gmail.com", + "house_number": "239", + "street_name": "Avea street", + "address":"236 Avea street", + "city":"Gotham", + "state":"CA", + "zip_code":"33433", + "phone":"56-999222992" +}' ``` ```javascript @@ -6378,10 +6008,13 @@ curl --location --request GET 'https://api.us.springverify.com/employee/id/manua var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/id/manual-review', { +fetch('https://api.us.springverify.com/employee/personal-details', { + method: 'POST', headers: { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' - } + }, + body: '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' }); // REQUEST @@ -6389,12 +6022,17 @@ fetch('https://api.us.springverify.com/employee/id/manual-review', { var request = require('request'); var headers = { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }; +var dataString = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; + var options = { - url: 'https://api.us.springverify.com/employee/id/manual-review', - headers: headers + url: 'https://api.us.springverify.com/employee/personal-details', + method: 'POST', + headers: headers, + body: dataString }; function callback(error, response, body) { @@ -6411,28 +6049,33 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( + 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' ); -$response = Requests::get('https://api.us.springverify.com/employee/id/manual-review', $headers); +$data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; +$response = Requests::post('https://api.us.springverify.com/employee/personal-details', $headers, $data); ``` ```python import requests headers = { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN', } -response = requests.get('https://api.us.springverify.com/employee/id/manual-review', headers=headers) +data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' + +response = requests.post('https://api.us.springverify.com/employee/personal-details', headers=headers, data=data) ``` ```ruby - require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/id/manual-review") -request = Net::HTTP::Get.new(uri) +uri = URI.parse("https://api.us.springverify.com/employee/personal-details") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -6452,17 +6095,140 @@ end ```json { "success": true, - "data": "success" + "data": { + "id": "ee23f57c-ad7a-40fc-8845-18aa12d67a5e", + "access_id": "799bee32-72e6-480f-b023-883bde7aa34f", + "email": "johndoe@yopmail.com", + "password_hash": null, + "first_name": "John", + "middle_name": "David", + "last_name": "Doe", + "name_verified": null, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:48.157Z", + "employer_id": "64c5e04f-c9cc-43ca-bb6a-3bb70abb9d6a", + "payment_id": "11061087-7975-4ef9-8e3d-9f2c8dd44ad6", + "email_sent": true, + "payment": { + "charged": true + }, + "status": null, + "flow_completed": null, + "company_created_by": "pooja@recrosoft.com", + "employee_limit_id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", + "employments": [], + "education": [], + "cic_criminal_records": [], + "professional_licenses": [], + "employee_detail": { + "id": "5988dda2-66aa-4ecb-a239-398465e569ab", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2021-01-19T04:25:48.000Z", + "updated_at": "2021-01-19T04:25:48.000Z", + "employee_email": "johndoe@yopmail.com" + }, + "employee_verification": null, + "employee_limit": { + "id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", + "employment": 0, + "mvr": false, + "education": 0, + "professional_license": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "civil_court": 0, + "driving_license": 0, + "package_id": null, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:21.000Z", + "employee_invite_group_id": "e38d60d3-e474-4710-aa84-847221f77910", + "employee_invite_group": { + "id": "e38d60d3-e474-4710-aa84-847221f77910", + "package": "bronze", + "active": true, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:21.000Z", + "company_created_by": "pooja@recrosoft.com", + "package_id": "1" + } + }, + "kbaqna": null, + "employee_flow": { + "id": 274, + "employment_flow": null, + "education_flow": null, + "professional_license_flow": null, + "created_at": "2021-01-19T04:25:47.000Z", + "updated_at": "2021-01-19T04:25:47.000Z", + "employee_email": "johndoe@yopmail.com" + }, + "s3_files": [], + "criminal_statuses": [], + "sjv_criminal_reports": [], + "motor_vehicle_record": null + } } ``` -If the uploading of an ID _and_ of the passport fails more than once, a manual review can be requested using this API. +A candidate can submit their personal details using this API. It is of the utmost importance that the details entered here are absolutely accurate. For creating the profile, the same email ID must be used to which the verification request was sent. -## Get ID verification tries +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| first_name | `string` | The candidate's first name. | +| middle_name | `string` | The candidate's middle name. | +| last_name | `string` | The candidate's last name. | +| dob | `string` | The candidate's date of birth in the format DD-MM-YYYY. | +| ssn | `string` | The candidate's SSN. | +| email | `string` | The candidate's email address - must be the same address to which the verification request was sent. | +| house_number | `integer` | The candidate's house number. | +| street_name | `string` | The name of the street where the candidate's house is located. | +| address | `string` | The candidate's residential address. | +| city | `string` | The city where the candidate's house is located. | +| state | `string` | The state where the candidate's house is located. | +| zip_code | `string` | The ZIP code of the postal district where the candidate's house is located. | +| phone | `string` | The candidate's phone number. | + +## Update Personal Details ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/id/try-counts' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request PUT 'https://api.us.springverify.com/employee/personal-details' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "first_name":"John", + "middle_name":"David", + "last_name":"Doe", + "dob":"12-11-1980", + "ssn":"123456789", + "email":"johndoe@gmail.com", + "house_number": "239", + "street_name": "A clear street", + "address":"236 A clear street", + "city":"Gotham", + "state":"CA", + "zip_code":"33433", + "phone":"56-999222992" +}' ``` ```javascript @@ -6470,10 +6236,13 @@ curl --location --request GET 'https://api.us.springverify.com/employee/id/try-c var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/id/try-counts', { +fetch('https://api.us.springverify.com/employee/personal-details', { + method: 'POST', headers: { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' - } + }, + body: '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "A clear street" "address":"236 A clear street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' }); // REQUEST @@ -6481,12 +6250,17 @@ fetch('https://api.us.springverify.com/employee/id/try-counts', { var request = require('request'); var headers = { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }; +var dataString = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; + var options = { - url: 'https://api.us.springverify.com/employee/id/try-counts', - headers: headers + url: 'https://api.us.springverify.com/employee/personal-details', + method: 'POST', + headers: headers, + body: dataString }; function callback(error, response, body) { @@ -6503,27 +6277,33 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( + 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' ); -$response = Requests::get('https://api.us.springverify.com/employee/id/try-counts', $headers); +$data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }'; +$response = Requests::post('https://api.us.springverify.com/employee/personal-details', $headers, $data); ``` ```python import requests headers = { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN', } -response = requests.get('https://api.us.springverify.com/employee/id/try-counts', headers=headers) +data = '{ "first_name":"John", "middle_name":"David", "last_name":"Doe", "dob":"12-11-1980", "ssn":"123456789", "email":"johndoe@gmail.com", "house_number": "239", "street_name": "Avea street" "address":"236 Avea street", "city":"Gotham", "state":"CA", "zip_code":"33433", "phone":"56-999222992" }' + +response = requests.post('https://api.us.springverify.com/employee/personal-details', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/id/try-counts") -request = Net::HTTP::Get.new(uri) +uri = URI.parse("https://api.us.springverify.com/employee/personal-details") +request = Net::HTTP::Put.new(uri) +request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -6544,94 +6324,300 @@ end { "success": true, "data": { - "dl": 1, - "passport": 0, - "kba": 2 + "employee_details_resp": { + "id": "5988dda2-66aa-4ecb-a239-398465e569ab", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2021-01-19T04:25:48.000Z", + "updated_at": "2021-01-19T04:25:48.000Z", + "employee_email": "johndoe@yopmail.com" + }, + "employee_resp": { + "id": "ee23f57c-ad7a-40fc-8845-18aa12d67a5e", + "access_id": "799bee32-72e6-480f-b023-883bde7aa34f", + "email": "johndoe@yopmail.com", + "password_hash": null, + "first_name": "John", + "middle_name": "David", + "last_name": "Doe", + "name_verified": null, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:48.000Z", + "employer_id": "64c5e04f-c9cc-43ca-bb6a-3bb70abb9d6a", + "payment_id": "11061087-7975-4ef9-8e3d-9f2c8dd44ad6", + "email_sent": true, + "payment": { + "charged": true + }, + "status": null, + "flow_completed": null, + "company_created_by": "pooja@recrosoft.com", + "employee_limit_id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", + "employments": [], + "education": [], + "cic_criminal_records": [], + "professional_licenses": [], + "employee_detail": { + "id": "5988dda2-66aa-4ecb-a239-398465e569ab", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2021-01-19T04:25:48.000Z", + "updated_at": "2021-01-19T04:25:48.000Z", + "employee_email": "johndoe@yopmail.com" + }, + "employee_verification": null, + "employee_limit": { + "id": "8ff7ef5e-0182-46ba-847b-6b22bc65b408", + "employment": 0, + "mvr": false, + "education": 0, + "professional_license": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "civil_court": 0, + "driving_license": 0, + "package_id": null, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:21.000Z", + "employee_invite_group_id": "e38d60d3-e474-4710-aa84-847221f77910", + "employee_invite_group": { + "id": "e38d60d3-e474-4710-aa84-847221f77910", + "package": "bronze", + "active": true, + "created_at": "2021-01-19T04:25:21.000Z", + "updated_at": "2021-01-19T04:25:21.000Z", + "company_created_by": "pooja@recrosoft.com", + "package_id": "1" + } + }, + "kbaqna": null, + "employee_flow": { + "id": 274, + "employment_flow": null, + "education_flow": null, + "professional_license_flow": null, + "created_at": "2021-01-19T04:25:47.000Z", + "updated_at": "2021-01-19T04:25:47.000Z", + "employee_email": "johndoe@yopmail.com" + }, + "s3_files": [], + "criminal_statuses": [], + "sjv_criminal_reports": [], + "motor_vehicle_record": null + } } } ``` -This API will provide the number of tries that a candidate has made for uploading the Driving License ID, the Passport and also the number of tries a candidate has made on the KBA (Knowledge Based Quiz). The maximum allowed limit is 2 per method per candidate. +A candidate who has created a profile can use this API to update their personal details. The updates can be made until the verification process is complete. -## Get Candidate Info +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| first_name | `string` | The candidate's first name. | +| middle_name | `string` | The candidate's middle name. | +| last_name | `string` | The candidate's last name. | +| dob | `string` | The candidate's date of birth in the format DD-MM-YYYY. | +| ssn | `string` | The candidate's SSN. | +| email | `string` | The candidate's email address - must be the same address to which the verification request was sent. | +| house_number | `integer` | The candidate's house number. | +| street_name | `string` | The name of the street where the candidate's house is located. | +| address | `string` | The candidate's residential address. | +| city | `string` | The city where the candidate's house is located. | +| state | `string` | The state where the candidate's house is located. | +| zip_code | `string` | The ZIP code of the postal district where the candidate's house is located. | +| phone | `string` | The candidate's phone number. | + +## Provide Consent ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request POST 'https://api.us.springverify.com/employee/consent' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "summary_of_rights": true, + "background_check": true, + "report_checked": true, + "full_name": "John David Doe" +}' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Content-Type", "application/json"); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/', { - headers: { - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var raw = JSON.stringify({"summary_of_rights":true,"background_check":true,"report_checked":true,"full_name":"John David Doe"}); + +var requestOptions = { + method: 'POST', + headers: myHeaders, + body: raw, + redirect: 'follow' +}; +fetch("https://api.us.springverify.com/employee/consent", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { +var options = { + 'method': 'POST', + 'url': 'https://api.us.springverify.com/employee/consent', + 'headers': { + 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' -}; + }, + body: JSON.stringify({"summary_of_rights":true,"background_check":true,"report_checked":true,"full_name":"John David Doe"}) -var options = { - url: 'https://api.us.springverify.com/employee/', - headers: headers }; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); ``` ```php 'Bearer JWT_TOKEN' -); -$response = Requests::get('https://api.us.springverify.com/employee/', $headers); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/employee/consent'); +$request->setMethod(HTTP_Request2::METHOD_POST); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Content-Type' => 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +)); +$request->setBody('{\n "summary_of_rights": true,\n "background_check": true,\n "report_checked": true,\n "full_name": "John David Doe"\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python import requests +url = "https://api.us.springverify.com/employee/consent" + +payload="{\n \"summary_of_rights\": true,\n \"background_check\": true,\n \"report_checked\": true,\n \"full_name\": \"John David Doe\"\n}" headers = { - 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' } -response = requests.get('https://api.us.springverify.com/employee/', headers=headers) +response = requests.request("POST", url, headers=headers, data=payload) + +print(response.text) + ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/") -request = Net::HTTP::Get.new(uri) -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/employee/consent") -req_options = { - use_ssl: uri.scheme == "https", +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 JWT_TOKEN" +request.body = "{\n \"summary_of_rights\": true,\n \"background_check\": true,\n \"report_checked\": true,\n \"full_name\": \"John David Doe\"\n}" + +response = https.request(request) +puts response.read_body + +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", + "summary_of_rights_accepted": true, + "background_check_disclosure_accepted": true, + "is_report_checked": false, + "employee_email": "johndoe@gmail.com", + "consent_link": "s3 link", + "spring_sign_ref_id": "5f4524b817710d0014423b61", + "updated_at": "2020-08-25T14:48:27.394Z", + "created_at": "2020-08-25T14:48:27.394Z" + } } +``` -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +After creating their profile, a candidate needs to explicitly provide consent to allow background verification using this API. The name provided here should match the full name provided in the Submit Personal Details API. -# response.code -# response.body +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| summary_of_rights | `boolean` | Indicates that the candidate has read the summary of rights. This flag can be "true" or "false". | +| background_check | `boolean` | Indicates that the candidate has agreed for a background check. This flag can be "true" or "false". | +| report_checked | `boolean` | Indicates that the candidate's report has been checked. This flag can be "true" or "false". | +| full_name | `string` | The candidate's full name. | + +## Knowledge Based Quiz + +```shell +curl --location --request GET 'https://api.us.springverify.com/employee/kba/questions' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` > Success Response @@ -6640,287 +6626,186 @@ end { "success": true, "data": { - "employee": { - "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "access_id": "ba92f24e-796e-4de4-8907-675f0ee77d58", - "email": "johndoe@gmail.com", - "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", - "first_name": "John", - "middle_name": "David", - "last_name": "Doe", - "name_verified": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-26T09:56:22.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", - "email_sent": true, - "payment": false, - "status": "PENDING", - "flow_completed": true, - "company_created_by": "zed@max.com", - "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employments": [ - { - "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", - "email": "johndoe@gmail.com", - "access_id": null, - "employer_name": "Stark Industries pvt ltd", - "employer_name_verified": null, - "employer_phone": "9911991199", - "employer_phone_verified": null, - "employer_address": "12, Manhattan Street", - "employer_address_verified": null, - "employer_town": "New York", - "employer_town_verified": null, - "state": "New York", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "employer_country": "USA", - "employer_country_verified": null, - "job_title": "Senior Manager", - "job_title_verified": null, - "start_date": "19-11-2000", - "start_date_verified": null, - "end_date": "19-11-2002", - "end_date_verified": null, - "supervisor_name": "Nick Fury", - "supervisor_contact": "nickfury@starkindustries.com", - "current_employment": "0", - "current_employment_verified": null, - "contract_type": null, - "contract_type_verified": null, - "source": null, - "created_at": "2020-08-26T06:24:25.000Z", - "updated_at": "2020-08-26T06:26:07.000Z", - "job_type": "Full time", - "reason_for_leaving": "xyz", - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent": null, - "adverse_action": null - } - ], - "education": [ - { - "id": "18304027-e78a-426c-aae5-db9c677c1704", - "email": "johndoe@gmail.com", - "access_id": null, - "employee_alias_name": null, - "employee_alias_name_verified": null, - "school_name": "MIT", - "school_name_verified": null, - "school_campus": "Boston", - "school_campus_verified": null, - "phone": null, - "phone_verified": null, - "address": "New street east block", - "address_verified": null, - "town": null, - "town_verified": null, - "city": "Boston", - "city_verified": null, - "state": "Massachusetts", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "country": "USA", - "country_verified": null, - "start_date": "28-12-1991", - "start_date_verified": null, - "end_date": "12-28-1996", - "end_date_verified": null, - "degree": "Engineering", - "degree_verified": null, - "major": "Biotech", - "major_verified": null, - "school_type": "University", - "source": null, - "created_at": "2020-08-26T07:15:58.000Z", - "updated_at": "2020-08-26T07:16:55.000Z", - "currently_attending": 0, - "completed_successfully": 1, - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "adverse_action": null - } - ], - "kbaqna": { - "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", - "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", - "email": "johndoe@gmail.com", - "questions_flag": 1, - "kba_enabled": 1, - "question_count": "5", - "correct_answers": "4", - "verified": false, - "created_at": "2020-08-25T15:06:19.000Z", - "updated_at": "2020-08-25T15:11:49.000Z", - "idm_session_id": "91b59885191b01f5", - "employee_email": "johndoe@gmail.com" - }, - "professional_licenses": [], - "employee_limit": { - "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employment": 2, - "education": 1, - "professional_license": 0, - "all_county_criminal_search": true, - "county_criminal_search": 0, - "civil_court": 1, - "driving_license": 0, - "package_id": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-25T14:28:47.000Z", - "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85" - }, - "employee_detail": { - "id": "efa4191a-331d-48c3-8e52-8915ed8167be", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2020-08-25T14:32:46.000Z", - "updated_at": "2020-08-26T09:52:33.000Z", - "employee_email": "johndoe@gmail.com" - }, - "employee_verification": { - "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", - "s3_gov_id": "link", - "s3_gov_id_back": "link", - "s3_gov_id_match": false, - "s3_web_img": null, - "s3_passport_verified": 1, - "passport_status": "VERIFIED", - "s3_dl_verified": 1, - "dl_status": "VERIFIED", - "verification_type": "id", - "address": null, - "address_verified": null, - "city": null, - "city_verified": null, - "state": null, - "state_verified": null, - "zipcode": null, - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": null, - "birthdate_verified": null, - "criminal_verified": null, - "global_watchlist_verified": null, - "created_at": "2020-08-25T14:48:27.000Z", - "updated_at": "2020-08-26T09:52:59.000Z", - "is_report_checked": false, - "summary_of_rights_accepted": true, - "background_check_disclosure_accepted": true, - "id_manual_review": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent_link": "link", - "spring_sign_ref_id": "5f4630f817710d0014423b74", - "employee_email": "johndoe@gmail.com" - }, - "employee_flow": { - "id": 289, - "employment_flow": "SUBMITTED", - "education_flow": "SUBMITTED", - "professional_license_flow": null, - "created_at": "2020-08-25T14:32:40.000Z", - "updated_at": "2020-08-26T07:36:45.000Z", - "employee_email": "johndoe@gmail.com" - }, - "criminal_statuses": { - "national_criminal": "PENDING", - "sex_offender": "PENDING", - "global_watchlist": "PENDING", - "county_criminal_search": "PENDING", - "civil_court": "PENDING", - "overall_criminal_status": "PENDING" - }, - "employer": { - "id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "active": true, - "email": "zed@max.com", - "domain": "springrole.com", - "role": "ADMIN", - "password": "$2b$10$WbyPfKtgYGSgU36arbbqnOpivH9hBFKuORLJ0iF.Dln6f289v3IvW", - "first_name": "Zed", - "last_name": "Max", - "phone_number": "1-2132143213", - "stripe_id": "cus_Bu8MQZ5BNDiij0", - "email_sent_time": null, - "created_at": "2019-07-23T11:32:51.000Z", - "updated_at": "2020-08-26T08:34:45.000Z", - "company": { - "id": 1, - "created_by": "zed@max.com", - "name": "Google", - "address": "Address", - "city": "reqbodycity", - "state": "reqbodystate", - "zipcode": "12345", - "tax_id_number": "reqbodytaxIdNumber", - "credits": 496250, - "domain": "springrole.com", - "employment_limit": null, - "education_limit": null, - "license_limit": null, - "civilcourt_limit": null, - "dl_limit": null, - "s3_logo": "link", - "created_at": "2019-07-23T11:33:04.000Z", - "updated_at": "2020-08-20T08:25:09.000Z" - } + "data": { + "idm_session_id": "103c7770a327eada", + "idmkba_response": { + "kba_question": [ + { + "question_id": 1, + "question": "Which of the following addresses have you lived at?", + "question_type": "StreetAddress", + "options": [ + { + "id": 1, + "option": "2601 GORDON AVE" + }, + { + "id": 2, + "option": "134 MARYLAND RD" + }, + { + "id": 3, + "option": "1131 CANYON RD" + }, + { + "id": 4, + "option": "9011 CENTRAL RD" + }, + { + "id": 5, + "option": "NONE OF THE ABOVE" + } + ] + }, + { + "question_id": 2, + "question": "Which of the following people is your relative?", + "question_type": "Relatives", + "options": [ + { + "id": 1, + "option": "Dwight Kurt Schrute" + }, + { + "id": 2, + "option": "Gabe" + }, + { + "id": 3, + "option": "Kelly" + }, + { + "id": 4, + "option": "Toby" + }, + { + "id": 5, + "option": "NONE OF THE ABOVE" + } + ] + }, + { + "question_id": 3, + "question": "Which of the following vehicles have you owned?", + "question_type": "Vehicle", + "options": [ + { + "id": 1, + "option": "1984 NISSAN 300ZX" + }, + { + "id": 2, + "option": "1997 ISUZU RODEO" + }, + { + "id": 3, + "option": "2008 HYUNDAI TIBURON" + }, + { + "id": 4, + "option": "1967 LINCOLN CONTINENTAL" + }, + { + "id": 5, + "option": "NONE OF THE ABOVE" + } + ] + }, + { + "question_id": 4, + "question": "Which of the following streets have you lived in?", + "question_type": "StreetName", + "options": [ + { + "id": 1, + "option": "BANDERO DR" + }, + { + "id": 2, + "option": "GALEWOOD DR" + }, + { + "id": 3, + "option": "UNION HALL RD" + }, + { + "id": 4, + "option": "KNOBHILL DR" + }, + { + "id": 5, + "option": "NONE OF THE ABOVE" + } + ] + }, + { + "question_id": 5, + "question": "Which of these businesses are you associated with?", + "question_type": "Businesses", + "options": [ + { + "id": 1, + "option": "Stark Industries" + }, + { + "id": 2, + "option": "Avengers LLC" + }, + { + "id": 3, + "option": "Wayne Enterprises" + }, + { + "id": 4, + "option": "Dunder Mifflin" + }, + { + "id": 5, + "option": "NONE OF THE ABOVE" + } + ] + } + ], + "kba_status": { + "questions_answered": 0, + "no_of_questions": 5 + }, + "is_kba_enabled": "1" } - } + }, + "attempt_number": 1, + "success": true } } ``` -This API returns all info pertaining to a candidate including all types of verification. +This API is used to generate a knowledge-based quiz about the candidate to verify authenticity. A series of questions relating to the candidate's profile will be asked to which the candidate is required to answer. Based on these answers, a score will be generated. -## Add Candidate Employment +## Submit KBA Quiz ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/employment' \ +curl --location --request POST 'https://api.us.springverify.com/employee/kba/verify' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT_TOKEN' \ --data-raw '{ - "employer_name": "Stark Industries", - "employer_address": "12, Manhattan Street", - "employer_phone": "9911991199", - "employer_town": "New York", - "state": "New York", - "zip_code": "129012", - "country": "USA", - "job_title": "Senior Manager", - "start_date": "19-11-2000", - "end_date": "19-11-2002", - "supervisor_name": "Nick Fury", - "current_employment": "0", - "job_type": "Contract", - "reason_for_leaving": "xyz", - "supervisor_contact": "nickfury@starkindustries.com" +"qna":[ + { + "question_id": 1, + "answer_id": 5 + },{ + "question_id": 2, + "answer_id": 5 + },{ + "question_id": 3, + "answer_id": 5 + },{ + "question_id": 4, + "answer_id": 5 + },{ + "question_id": 5, + "answer_id": 5 + } + ] }' ``` @@ -6929,13 +6814,13 @@ curl --location --request POST 'https://api.us.springverify.com/employee/employm var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/employment', { +fetch('https://api.us.springverify.com/employee/kba/verify', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }, - body: JSON.stringify({ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }) + body: JSON.stringify({ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }) }); // REQUEST @@ -6947,10 +6832,10 @@ var headers = { 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; +var dataString = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }'; var options = { - url: 'https://api.us.springverify.com/employee/employment', + url: 'https://api.us.springverify.com/employee/kba/verify', method: 'POST', headers: headers, body: dataString @@ -6973,8 +6858,8 @@ $headers = array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' ); -$data = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; -$response = Requests::post('https://api.us.springverify.com/employee/employment', $headers, $data); +$data = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }'; +$response = Requests::post('https://api.us.springverify.com/employee/kba/verify', $headers, $data); ``` ```python @@ -6985,16 +6870,16 @@ headers = { 'Authorization': 'Bearer JWT_TOKEN', } -data = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }' +data = '{ "qna":[ { "question_id": 1, "answer_id": 5 },{ "question_id": 2, "answer_id": 5 },{ "question_id": 3, "answer_id": 5 },{ "question_id": 4, "answer_id": 5 },{ "question_id": 5, "answer_id": 5 } ] }' -response = requests.post('https://api.us.springverify.com/employee/employment', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/employee/kba/verify', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/employment") +uri = URI.parse("https://api.us.springverify.com/employee/kba/verify") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -7015,58 +6900,39 @@ end ```json { - "success": true, - "data": { - "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", - "email": "johndoe@gmail.com", - "employer_name": "Stark Industries", - "employer_town": "New York", - "employer_country": "USA", - "state": "New York", - "job_title": "Senior Manager", - "start_date": "19-11-2000", - "end_date": "19-11-2002", - "supervisor_name": "Nick Fury", - "job_type": "Contract", - "status": "PENDING", - "employer_address": "12, Manhattan Street", - "employer_phone": "9911991199", - "zipcode": "129012", - "reason_for_leaving": "xyz", - "supervisor_contact": "nickfury@starkindustries.com", - "updated_at": "2020-08-25T15:24:03.346Z", - "created_at": "2020-08-25T15:24:03.346Z" - } + "success": true, + "data": { + "correct_answers": 5, + "total_questions": 5, + "success": true + } } ``` -This API will be used to submit the Employment records for the candidate. +> Error Response + +```json +{ + "message": "Your answers didn't seem to be correct, please try uploading DL or Passport.", + "stack": "message" +} +``` + +This API is used to submit the candidate's answers of the [Knowledge Based Quiz](https://docs.us.springverify.com/#knowledge-based-quiz). **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| employer_name | `string` | Name of the employer. | -| employer_address | `string` | Address of the employer. | -| employer_phone | `string` | Phone number of the employer. | -| employer_town | `string` | Town where the employer is located. | -| state | `string` | State where the employer is located. | -| zip_code | `string` | Zip Code of the postal district where the employer is located. | -| country | `string` | Country where the employer is located. | -| job_title | `string` | Job title of the latest employment. | -| start_date | `string` | Start Date of the employment. | -| end_date | `string` | End Date of the employment. | -| supervisor_name | `string` | The name of the candidate's supervisor in this employment. | -| current_employment | `string` | Is this the candidate's current employment? | -| job_type | `string` | Is this a contract or a full-time employment? | -| reason_for_leaving | `string` | Reason for leaving the job (optional). | -| supervisor_contact | `string` | Contact details of the supervisor. | +| qna | `array` | This is an array that contains the IDs of the question as well as the ID of the responses to those questions. | -## Delete Employment +## Upload and Verify ID ```shell -curl --location --request DELETE 'https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7' \ ---header 'Authorization: Bearer JWT_TOKEN' +curl --location --request POST 'https://api.us.springverify.com/employee/upload/id' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--form 'front=@/path/to/file' \ +--form 'back=@/path/to/file' \ ``` ```javascript @@ -7074,7 +6940,8 @@ curl --location --request DELETE 'https://api.us.springverify.com/employee/emplo var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', { +fetch('https://api.us.springverify.com/employee/upload/id', { + method: 'POST', headers: { 'Authorization': 'Bearer JWT_TOKEN' } @@ -7089,7 +6956,8 @@ var headers = { }; var options = { - url: 'https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', + url: 'https://api.us.springverify.com/employee/upload/id', + method: 'POST', headers: headers }; @@ -7109,7 +6977,7 @@ Requests::register_autoloader(); $headers = array( 'Authorization' => 'Bearer JWT_TOKEN' ); -$response = Requests::get('https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', $headers); +$response = Requests::post('https://api.us.springverify.com/employee/upload/id', $headers); ``` ```python @@ -7119,19 +6987,15 @@ headers = { 'Authorization': 'Bearer JWT_TOKEN', } -params = ( - ('id', 'ef9e7612-3789-405a-be37-c7bc1871c1f7'), -) - -response = requests.get('https://api.us.springverify.com/employee/employment', headers=headers, params=params) +response = requests.post('https://api.us.springverify.com/employee/upload/id', headers=headers) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7") -request = Net::HTTP::Delete.new(uri) +uri = URI.parse("https://api.us.springverify.com/employee/upload/id") +request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -7151,42 +7015,37 @@ end ```json { "success": true, - "data": 1 + "data": { + "success": true, + "attempts": 1, + "user_access_code": "6e7d5f15-9456-430d-b9da-9df67a4d9996" + } } ``` -This API is used to delete the employment submitted in the "Add Candidate Employment" API before it goes for verification. +This API records the ID of the candidate and verifies its authenticity. + +**Important Notes:** + +1. The maximum allowed size of the image uploaded (per image) is capped at 2MB. Uploading photos larger than 2MB will throw an exception. +2. If using a mobile device, capturing a clear, non-blurry image is extremely important so that the ID can be processed accurately. +3. At a minimum, a 5MP camera should be used to capture the images for the UploadID parameter. +4. It is mandatory to have a contrast between the ID and the background. The background must be solid colored. +5. It must be ensured that all the edges of the ID are visible and none of the edges are cutoff. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| id | `uuid` | UUID of the employment record. | +| front | `image` | The image of the front of the ID. | +| back | `image` | The image of the back of the ID. | -## Edit Employment +## Upload and Verify Passport ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/employment' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'https://api.us.springverify.com/employee/upload/passport' \ --header 'Authorization: Bearer JWT_TOKEN' \ ---data-raw '{ - "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", - "employer_name": "Stark Industries pvt ltd", - "employer_address": "12, Manhattan Street", - "employer_phone": "9911991199", - "employer_town": "New York", - "state": "New York", - "zip_code": "129012", - "country": "USA", - "job_title": "Senior Manager", - "start_date": "19-11-2000", - "end_date": "19-11-2002", - "supervisor_name": "Nick Fury", - "current_employment": "0", - "job_type": "Contract", - "reason_for_leaving": "xyz", - "supervisor_contact": "nickfury@starkindustries.com" -}' +--form 'front=@/path/to/file' ``` ```javascript @@ -7194,13 +7053,11 @@ curl --location --request POST 'https://api.us.springverify.com/employee/employm var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/employment', { +fetch('https://api.us.springverify.com/employee/upload/passport', { method: 'POST', headers: { - 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }) + } }); // REQUEST @@ -7208,17 +7065,13 @@ fetch('https://api.us.springverify.com/employee/employment', { var request = require('request'); var headers = { - 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; - var options = { - url: 'https://api.us.springverify.com/employee/employment', + url: 'https://api.us.springverify.com/employee/upload/passport', method: 'POST', - headers: headers, - body: dataString + headers: headers }; function callback(error, response, body) { @@ -7235,33 +7088,27 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( - 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' ); -$data = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; -$response = Requests::post('https://api.us.springverify.com/employee/employment', $headers, $data); +$response = Requests::post('https://api.us.springverify.com/employee/upload/passport', $headers); ``` ```python import requests headers = { - 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN', } -data = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }' - -response = requests.post('https://api.us.springverify.com/employee/employment', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/employee/upload/passport', headers=headers) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/employment") +uri = URI.parse("https://api.us.springverify.com/employee/upload/passport") request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -7281,172 +7128,114 @@ end ```json { "success": true, - "data": { - "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", - "email": "johndoe@gmail.com", - "access_id": null, - "employer_name": "Stark Industries pvt ltd", - "employer_name_verified": null, - "employer_phone": "9911991199", - "employer_phone_verified": null, - "employer_address": "12, Manhattan Street", - "employer_address_verified": null, - "employer_town": "New York", - "employer_town_verified": null, - "state": "New York", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "employer_country": "USA", - "employer_country_verified": null, - "job_title": "Senior Manager", - "job_title_verified": null, - "start_date": "19-11-2000", - "start_date_verified": null, - "end_date": "19-11-2002", - "end_date_verified": null, - "supervisor_name": "Nick Fury", - "supervisor_contact": "nickfury@starkindustries.com", - "current_employment": "0", - "current_employment_verified": null, - "contract_type": null, - "contract_type_verified": null, - "source": null, - "created_at": "2020-08-26T06:24:25.000Z", - "updated_at": "2020-08-26T06:26:07.019Z", - "job_type": "Full time", - "reason_for_leaving": "xyz", - "status": "PENDING", - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent": null - } + "data": true } ``` -By adding the ID received in the "Submit Employment" response in this API, it can be used to edit the employment data. +> Error Response + +```json +{ + "message": "The Passport could not be parsed. Please make sure all four sides are visible and the Passport is in front of a dark background." +} +``` + +This API records the Passport details of the emcaployee and verifies its authenticity. + +This API is used to upload an image of the candidate's passport that will be scanned and parsed. The image should have the candidate's information on it on the first or the second page. It must be a single picture that captures both pages of the passport. This follows the same logic as the other uploadId endpoints -- the picture needs to be clear with minimal glare and must have sufficient lighting. + +There are several variables that are more likely to cause a document to fail: +1. The quality of the captured image - blurred images or images with reflections. +2. Personalization of the document such as documents with especially long names. +3. Variations in manufacturing techniques - for example, a card printed on the wrong side or slight variations in the printing location. +4. Wear and aging of the document - a worn or dirty card can cause failure. +5. Tampering and counterfeiting - unlawful changes or reproduction of documents. **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| id | `uuid` | UUID of the employment record. | -| employer_name | `string` | Name of the employer. | -| employer_address | `string` | Address of the employer. | -| employer_phone | `string` | Phone number of the employer. | -| employer_town | `string` | Town where the employer is located. | -| state | `string` | State where the employer is located. | -| zip_code | `string` | Zip Code of the postal district where the employer is located. | -| country | `string` | Country where the employer is located. | -| job_title | `string` | Job title of the latest employment. | -| start_date | `string` | Start Date of the employment. | -| end_date | `string` | End Date of the employment. | -| supervisor_name | `string` | The name of the candidate's supervisor in this employment. | -| current_employment | `string` | Is this the candidate's current employment? | -| job_type | `string` | Is this a contract or a full-time employment? | -| reason_for_leaving | `string` | Reason for leaving the job (optional). | -| supervisor_contact | `string` | Contact details of the supervisor. | +| front | `image` | The image of the passport. | -## Trigger Employment Verification +## Request Manual Review of the ID or Passport ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/submit/employment' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "run_mock": true, - "fail_check": false -}' +curl --location --request GET 'https://api.us.springverify.com/employee/id/manual-review' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var myHeaders = new Headers(); -myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -myHeaders.append("Content-Type", "application/json"); +var fetch = require('node-fetch'); -var raw = JSON.stringify({"run_mock":true,"fail_check":false}); +fetch('https://api.us.springverify.com/employee/id/manual-review', { + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); -var requestOptions = { - method: 'GET', - headers: myHeaders, - body: raw, - redirect: 'follow' +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' }; -fetch("https://api.us.springverify.com/employee/submit/employment", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); - -// REQUEST - -var request = require('request'); var options = { - 'method': 'GET', - 'url': 'https://api.us.springverify.com/employee/submit/employment', - 'headers': { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' - }, - body: JSON.stringify({"run_mock":true,"fail_check":false}) - + url: 'https://api.us.springverify.com/employee/id/manual-review', + headers: headers }; -request(options, function (error, response) { - if (error) throw new Error(error); - console.log(response.body); -}); +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); ``` ```php setUrl('https://api.us.springverify.com/employee/submit/employment'); -$request->setMethod(HTTP_Request2::METHOD_GET); -$request->setConfig(array( - 'follow_redirects' => TRUE -)); -$request->setHeader(array( - 'Authorization' => 'Bearer JWT_TOKEN', - 'Content-Type' => 'application/json' -)); -$request->setBody('{\n "run_mock": true,\n "fail_check": false\n}'); -try { - $response = $request->send(); - if ($response->getStatus() == 200) { - echo $response->getBody(); - } - else { - echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . - $response->getReasonPhrase(); - } -} -catch(HTTP_Request2_Exception $e) { - echo 'Error: ' . $e->getMessage(); +include('vendor/rmccue/requests/library/Requests.php'); +Requests::register_autoloader(); +$headers = array( + 'Authorization' => 'Bearer JWT_TOKEN' +); +$response = Requests::get('https://api.us.springverify.com/employee/id/manual-review', $headers); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', } + +response = requests.get('https://api.us.springverify.com/employee/id/manual-review', headers=headers) ``` ```ruby -require "uri" -require "net/http" - -url = URI("https://api.us.springverify.com/employee/submit/employment") -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true +require 'net/http' +require 'uri' -request = Net::HTTP::Get.new(url) +uri = URI.parse("https://api.us.springverify.com/employee/id/manual-review") +request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer JWT_TOKEN" -request["Content-Type"] = "application/json" -request.body = "{\n \"run_mock\": true,\n \"fail_check\": false\n}" -response = https.request(request) -puts response.read_body +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end +# response.code +# response.body ``` > Success Response @@ -7454,82 +7243,17 @@ puts response.read_body ```json { "success": true, - "data": { - "success": true, - "status": "Completed", - "institution_name_verified": false, - "employer_name_verified": false, - "count": 1 - } + "data": "success" } ``` -Once the employment records have been submitted and finalized, an Employment Verification request can be triggered using this API. - - - - - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| run_mock | `boolean` | (Optional) Run mock api | -| fail_check | `boolean` | (Optional) Whether the employment check should fail or not | +If the uploading of an ID _and_ of the passport fails more than once, a manual review can be requested using this API. -## Add Candidate's Education +## Get ID verification tries ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/education' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "school_name": "MIT", - "school_type": "University", - "school_campus": "Boston", - "address": "Asdasd", - "city":"Boston", - "state":"Massachusetts", - "zip_code": "126112" - "country":"USA", - "start_date":"28-12-1991", - "end_date":"12-28-1996", - "degree":"Engineering", - "currently_attending":"0", - "completed_successfully":"1", - "major":"Biotech" -}' -``` -> Success Response - -```json -{ - "success": true, - "data": { - "id": "de359912-1223-4338-87c4-0783a0ea495b", - "email": "johndoe@gmail.com", - "school_name": "MIT", - "school_type": "University", - "school_campus": "Boston", - "address": "Asdasd", - "city": "Boston", - "country": "USA", - "start_date": "28-12-1991", - "end_date": "12-28-1996", - "degree": "Engineering", - "currently_attending": "0", - "completed_successfully": "1", - "status": "PENDING", - "state": "Massachusetts", - "major": "Biotech", - "zipcode": "126112", - "updated_at": "2020-08-26T06:57:12.876Z", - "created_at": "2020-08-26T06:57:12.876Z" - } -} +curl --location --request GET 'https://api.us.springverify.com/employee/id/try-counts' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript @@ -7537,12 +7261,10 @@ curl --location --request POST 'https://api.us.springverify.com/employee/educati var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/education', { - method: 'POST', +fetch('https://api.us.springverify.com/employee/id/try-counts', { headers: { - 'Content-Type': 'application/json' - }, - body: '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' + 'Authorization': 'Bearer JWT_TOKEN' + } }); // REQUEST @@ -7550,16 +7272,12 @@ fetch('https://api.us.springverify.com/employee/education', { var request = require('request'); var headers = { - 'Content-Type': 'application/json' + 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; - var options = { - url: 'https://api.us.springverify.com/employee/education', - method: 'POST', - headers: headers, - body: dataString + url: 'https://api.us.springverify.com/employee/id/try-counts', + headers: headers }; function callback(error, response, body) { @@ -7576,32 +7294,28 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( - 'Content-Type' => 'application/json' + 'Authorization' => 'Bearer JWT_TOKEN' ); -$data = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; -$response = Requests::post('https://api.us.springverify.com/employee/education', $headers, $data); +$response = Requests::get('https://api.us.springverify.com/employee/id/try-counts', $headers); ``` ```python import requests headers = { - 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', } -data = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' - -response = requests.post('https://api.us.springverify.com/employee/education', headers=headers, data=data) +response = requests.get('https://api.us.springverify.com/employee/id/try-counts', headers=headers) ``` ```ruby - require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/education") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" +uri = URI.parse("https://api.us.springverify.com/employee/id/try-counts") +request = Net::HTTP::Get.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" req_options = { use_ssl: uri.scheme == "https", @@ -7615,49 +7329,26 @@ end # response.body ``` -This API will be used to submit the education records of the candidate. +> Success Response -**URL Parameters** +```json +{ + "success": true, + "data": { + "dl": 1, + "passport": 0, + "kba": 2 + } +} +``` -| Parameter | Type | Description | -| --- | --- | --- | -| school_name | `string` | The name of the candidate's school. | -| school_type | `string` | The type of the candidate's school. | -| school_campus | `string` | The campus of the candidate's school. | -| address | `string` | The address of the candidate's school. | -| city | `string` | The city where the candidate's school is located. | -| state | `string` | The state where the candidate's school is located. | -| zip_code | `string` | The ZIP code of the postal district where the candidate's school is located. | -| country | `string` | The country where the candidate's school is located. | -| start_date | `string` | Start date of the course. | -| end_date | `string` | End date of the course. | -| degree | `string` | Official degree of the course. | -| currently_attending | `string` | This flag will be set to 1 if the candidate is currently attending the course, else it will be set to 0. | -| completed_successfully | `string` | This flag will be set to 1 if the candidate has successfully completed the course, else it will be set to 0. | -| major | `string` | The field in which the candidate has majored. | +This API will provide the number of tries that a candidate has made for uploading the Driving License ID, the Passport and also the number of tries a candidate has made on the KBA (Knowledge Based Quiz). The maximum allowed limit is 2 per method per candidate. -## Edit Education Entry +## Get Candidate Info ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/education' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "id":"de359912-1223-4338-87c4-0783a0ea495b", - "school_name": "MIT", - "school_type": "University", - "school_campus": "Boston", - "address":"New street east block", - "city":"Boston", - "state":"Massachusetts", - "zip_code": "129012", - "country":"USA", - "start_date": "28-12-1991", - "end_date": "12-28-1996", - "degree":"Engineering", - "currently_attending":"0", - "completed_successfully":"1", - "major":"Biotech" -}' +curl --location --request GET 'https://api.us.springverify.com/employee/' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript @@ -7665,174 +7356,13 @@ curl --location --request POST 'https://api.us.springverify.com/employee/educati var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/education', { - method: 'POST', - headers: { - 'Content-Type': 'application/json' - }, - body: JSON.stringify({ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }) -}); - -// REQUEST - -var request = require('request'); - -var headers = { - 'Content-Type': 'application/json' -}; - -var dataString = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; - -var options = { - url: 'https://api.us.springverify.com/employee/education', - method: 'POST', - headers: headers, - body: dataString -}; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); -``` - -```php - 'application/json' -); -$data = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; -$response = Requests::post('https://api.us.springverify.com/employee/education', $headers, $data); -``` - -```python -import requests - -headers = { - 'Content-Type': 'application/json', -} - -data = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' - -response = requests.post('https://api.us.springverify.com/employee/education', headers=headers, data=data) -``` - -```ruby -require 'net/http' -require 'uri' - -uri = URI.parse("https://api.us.springverify.com/employee/education") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" - -req_options = { - use_ssl: uri.scheme == "https", -} - -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end - -# response.code -# response.body -``` - -> Success Response - -```json -{ - "success": true, - "data": { - "id": "18304027-e78a-426c-aae5-db9c677c1704", - "email": "johndoe@gmail.com", - "access_id": null, - "employee_alias_name": null, - "employee_alias_name_verified": null, - "school_name": "MIT", - "school_name_verified": null, - "school_campus": "Boston", - "school_campus_verified": null, - "phone": null, - "phone_verified": null, - "address": "New street east block", - "address_verified": null, - "town": null, - "town_verified": null, - "city": "Boston", - "city_verified": null, - "state": "Massachusetts", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "country": "USA", - "country_verified": null, - "start_date": "28-12-1991", - "start_date_verified": null, - "end_date": "12-28-1996", - "end_date_verified": null, - "degree": "Engineering", - "degree_verified": null, - "major": "Biotech", - "major_verified": null, - "school_type": "University", - "source": null, - "created_at": "2020-08-26T07:15:58.000Z", - "updated_at": "2020-08-26T07:16:55.604Z", - "currently_attending": "0", - "completed_successfully": "1", - "status": "PENDING", - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null - } -} -``` - -This API will be used to edit the education records for the Candidate. The id parameter passed will be the same as received at the time of Education Entry submission. - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| id | `uuid` | UUID of the education entry. | -| school_name | `string` | The name of the candidate's school. | -| school_type | `string` | The type of the candidate's school. | -| school_campus | `string` | The campus of the candidate's school. | -| address | `string` | The address of the candidate's school. | -| city | `string` | The city where the candidate's school is located. | -| state | `string` | The state where the candidate's school is located. | -| zip_code | `string` | The ZIP code of the postal district where the candidate's school is located. | -| country | `string` | The country where the candidate's school is located. | -| start_date | `string` | Start date of the course. | -| end_date | `string` | End date of the course. | -| degree | `string` | Official degree of the course. | -| currently_attending | `string` | This flag will be set to 1 if the candidate is currently attending the course, else it will be set to 0. | -| completed_successfully | `string` | This flag will be set to 1 if the candidate has successfully completed the course, else it will be set to 0. | -| major | `string` | The field in which the candidate has majored. | - -## Delete Education - -```shell -curl --location --request DELETE 'https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b' \ ---header 'Authorization: Bearer JWT_TOKEN' -``` - -```javascript -// FETCH - -var fetch = require('node-fetch'); - -fetch('https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', { +fetch('https://api.us.springverify.com/employee/', { headers: { 'Authorization': 'Bearer JWT_TOKEN' } }); + // REQUEST var request = require('request'); @@ -7842,7 +7372,7 @@ var headers = { }; var options = { - url: 'https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', + url: 'https://api.us.springverify.com/employee/', headers: headers }; @@ -7862,7 +7392,7 @@ Requests::register_autoloader(); $headers = array( 'Authorization' => 'Bearer JWT_TOKEN' ); -$response = Requests::get('https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', $headers); +$response = Requests::get('https://api.us.springverify.com/employee/', $headers); ``` ```python @@ -7872,19 +7402,15 @@ headers = { 'Authorization': 'Bearer JWT_TOKEN', } -params = ( - ('id', 'de359912-1223-4338-87c4-0783a0ea495b'), -) - -response = requests.get('https://api.us.springverify.com/employee/education', headers=headers, params=params) +response = requests.get('https://api.us.springverify.com/employee/', headers=headers) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b") -request = Net::HTTP::Delete.new(uri) +uri = URI.parse("https://api.us.springverify.com/employee/") +request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer JWT_TOKEN" req_options = { @@ -7901,179 +7427,2475 @@ end > Success Response -```json -{ - "success": true, - "data": 1 -} -``` - -This API is used to delete the education entry submitted in the previous API before it goes for verification. - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| id | `uuid` | UUID of the education entry. | - -## Trigger Education Verification - -```shell -curl --location --request GET 'https://api.us.springverify.com/employee/submit/education' \ ---header 'Authorization: Bearer JWT_TOKEN' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "run_mock": true, - "fail_check": false -}' -``` - -```javascript -// FETCH - -var myHeaders = new Headers(); -myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -myHeaders.append("Content-Type", "application/json"); - -var raw = JSON.stringify({"run_mock":true,"fail_check":false}); - -var requestOptions = { - method: 'GET', - headers: myHeaders, - body: raw, - redirect: 'follow' -}; - -fetch("https://api.us.springverify.com/employee/submit/education", requestOptions) - .then(response => response.text()) - .then(result => console.log(result)) - .catch(error => console.log('error', error)); - -// REQUEST - -var request = require('request'); -var options = { - 'method': 'GET', - 'url': 'https://api.us.springverify.com/employee/submit/education', - 'headers': { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' - }, - body: JSON.stringify({"run_mock":true,"fail_check":false}) - -}; -request(options, function (error, response) { - if (error) throw new Error(error); - console.log(response.body); -}); - -``` - -```php -setUrl('https://api.us.springverify.com/employee/submit/education'); -$request->setMethod(HTTP_Request2::METHOD_GET); -$request->setConfig(array( - 'follow_redirects' => TRUE -)); -$request->setHeader(array( - 'Authorization' => 'Bearer JWT_TOKEN', - 'Content-Type' => 'application/json' -)); -$request->setBody('{\n "run_mock": true,\n "fail_check": false\n}'); -try { - $response = $request->send(); - if ($response->getStatus() == 200) { - echo $response->getBody(); - } - else { - echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . - $response->getReasonPhrase(); - } -} -catch(HTTP_Request2_Exception $e) { - echo 'Error: ' . $e->getMessage(); -} -``` - -```python -import requests - -url = "https://api.us.springverify.com/employee/submit/education" - -payload="{\n \"run_mock\": true,\n \"fail_check\": false\n}" -headers = { - 'Authorization': 'Bearer JWT_TOKEN', - 'Content-Type': 'application/json' -} - -response = requests.request("GET", url, headers=headers, data=payload) - -print(response.text) - -``` - -```ruby -require "uri" -require "net/http" - -url = URI("https://api.us.springverify.com/employee/submit/education") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Authorization"] = "Bearer JWT_TOKEN" -request["Content-Type"] = "application/json" -request.body = "{\n \"run_mock\": true,\n \"fail_check\": false\n}" - -response = https.request(request) -puts response.read_body - -``` - -> Success Response - ```json { "success": true, "data": { - "success": true, - "status": "Completed", - "institution_name_verified": false, - "employer_name_verified": false - } + "employee": { + "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "access_id": "ba92f24e-796e-4de4-8907-675f0ee77d58", + "email": "johndoe@gmail.com", + "password_hash": "100d5fcb45dc552d1a9011e2707b937904f79df410199fcb7a1e2b3c022d9911", + "first_name": "John", + "middle_name": "David", + "last_name": "Doe", + "name_verified": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-26T09:56:22.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", + "email_sent": true, + "payment": false, + "status": "PENDING", + "flow_completed": true, + "company_created_by": "zed@max.com", + "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employments": [ + { + "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", + "email": "johndoe@gmail.com", + "access_id": null, + "employer_name": "Stark Industries pvt ltd", + "employer_name_verified": null, + "employer_phone": "9911991199", + "employer_phone_verified": null, + "employer_address": "12, Manhattan Street", + "employer_address_verified": null, + "employer_town": "New York", + "employer_town_verified": null, + "state": "New York", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "employer_country": "USA", + "employer_country_verified": null, + "job_title": "Senior Manager", + "job_title_verified": null, + "start_date": "19-11-2000", + "start_date_verified": null, + "end_date": "19-11-2002", + "end_date_verified": null, + "supervisor_name": "Nick Fury", + "supervisor_contact": "nickfury@starkindustries.com", + "current_employment": "0", + "current_employment_verified": null, + "contract_type": null, + "contract_type_verified": null, + "source": null, + "created_at": "2020-08-26T06:24:25.000Z", + "updated_at": "2020-08-26T06:26:07.000Z", + "job_type": "Full time", + "reason_for_leaving": "xyz", + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent": null, + "adverse_action": null + } + ], + "education": [ + { + "id": "18304027-e78a-426c-aae5-db9c677c1704", + "email": "johndoe@gmail.com", + "access_id": null, + "employee_alias_name": null, + "employee_alias_name_verified": null, + "school_name": "MIT", + "school_name_verified": null, + "school_campus": "Boston", + "school_campus_verified": null, + "phone": null, + "phone_verified": null, + "address": "New street east block", + "address_verified": null, + "town": null, + "town_verified": null, + "city": "Boston", + "city_verified": null, + "state": "Massachusetts", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "country": "USA", + "country_verified": null, + "start_date": "28-12-1991", + "start_date_verified": null, + "end_date": "12-28-1996", + "end_date_verified": null, + "degree": "Engineering", + "degree_verified": null, + "major": "Biotech", + "major_verified": null, + "school_type": "University", + "source": null, + "created_at": "2020-08-26T07:15:58.000Z", + "updated_at": "2020-08-26T07:16:55.000Z", + "currently_attending": 0, + "completed_successfully": 1, + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "adverse_action": null + } + ], + "kbaqna": { + "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", + "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", + "email": "johndoe@gmail.com", + "questions_flag": 1, + "kba_enabled": 1, + "question_count": "5", + "correct_answers": "4", + "verified": false, + "created_at": "2020-08-25T15:06:19.000Z", + "updated_at": "2020-08-25T15:11:49.000Z", + "idm_session_id": "91b59885191b01f5", + "employee_email": "johndoe@gmail.com" + }, + "professional_licenses": [], + "employee_limit": { + "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employment": 2, + "education": 1, + "professional_license": 0, + "all_county_criminal_search": true, + "county_criminal_search": 0, + "civil_court": 1, + "driving_license": 0, + "package_id": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-25T14:28:47.000Z", + "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85" + }, + "employee_detail": { + "id": "efa4191a-331d-48c3-8e52-8915ed8167be", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2020-08-25T14:32:46.000Z", + "updated_at": "2020-08-26T09:52:33.000Z", + "employee_email": "johndoe@gmail.com" + }, + "employee_verification": { + "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", + "s3_gov_id": "link", + "s3_gov_id_back": "link", + "s3_gov_id_match": false, + "s3_web_img": null, + "s3_passport_verified": 1, + "passport_status": "VERIFIED", + "s3_dl_verified": 1, + "dl_status": "VERIFIED", + "verification_type": "id", + "address": null, + "address_verified": null, + "city": null, + "city_verified": null, + "state": null, + "state_verified": null, + "zipcode": null, + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": null, + "birthdate_verified": null, + "criminal_verified": null, + "global_watchlist_verified": null, + "created_at": "2020-08-25T14:48:27.000Z", + "updated_at": "2020-08-26T09:52:59.000Z", + "is_report_checked": false, + "summary_of_rights_accepted": true, + "background_check_disclosure_accepted": true, + "id_manual_review": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent_link": "link", + "spring_sign_ref_id": "5f4630f817710d0014423b74", + "employee_email": "johndoe@gmail.com" + }, + "employee_flow": { + "id": 289, + "employment_flow": "SUBMITTED", + "education_flow": "SUBMITTED", + "professional_license_flow": null, + "created_at": "2020-08-25T14:32:40.000Z", + "updated_at": "2020-08-26T07:36:45.000Z", + "employee_email": "johndoe@gmail.com" + }, + "criminal_statuses": { + "national_criminal": "PENDING", + "sex_offender": "PENDING", + "global_watchlist": "PENDING", + "county_criminal_search": "PENDING", + "civil_court": "PENDING", + "overall_criminal_status": "PENDING" + }, + "employer": { + "id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "active": true, + "email": "zed@max.com", + "domain": "springrole.com", + "role": "ADMIN", + "password": "$2b$10$WbyPfKtgYGSgU36arbbqnOpivH9hBFKuORLJ0iF.Dln6f289v3IvW", + "first_name": "Zed", + "last_name": "Max", + "phone_number": "1-2132143213", + "stripe_id": "cus_Bu8MQZ5BNDiij0", + "email_sent_time": null, + "created_at": "2019-07-23T11:32:51.000Z", + "updated_at": "2020-08-26T08:34:45.000Z", + "company": { + "id": 1, + "created_by": "zed@max.com", + "name": "Google", + "address": "Address", + "city": "reqbodycity", + "state": "reqbodystate", + "zipcode": "12345", + "tax_id_number": "reqbodytaxIdNumber", + "credits": 496250, + "domain": "springrole.com", + "employment_limit": null, + "education_limit": null, + "license_limit": null, + "civilcourt_limit": null, + "dl_limit": null, + "s3_logo": "link", + "created_at": "2019-07-23T11:33:04.000Z", + "updated_at": "2020-08-20T08:25:09.000Z" + } + } + } + } +} +``` + +This API returns all info pertaining to a candidate including all types of verification. + +## Add Candidate Employment + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/employment' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "employer_name": "Stark Industries", + "employer_address": "12, Manhattan Street", + "employer_phone": "9911991199", + "employer_town": "New York", + "state": "New York", + "zip_code": "129012", + "country": "USA", + "job_title": "Senior Manager", + "start_date": "19-11-2000", + "end_date": "19-11-2002", + "supervisor_name": "Nick Fury", + "current_employment": "0", + "job_type": "Contract", + "reason_for_leaving": "xyz", + "supervisor_contact": "nickfury@starkindustries.com" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/employment', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' + }, + body: JSON.stringify({ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/employment', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; +$response = Requests::post('https://api.us.springverify.com/employee/employment', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "employer_name": "Stark Industries", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }' + +response = requests.post('https://api.us.springverify.com/employee/employment', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/employment") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", + "email": "johndoe@gmail.com", + "employer_name": "Stark Industries", + "employer_town": "New York", + "employer_country": "USA", + "state": "New York", + "job_title": "Senior Manager", + "start_date": "19-11-2000", + "end_date": "19-11-2002", + "supervisor_name": "Nick Fury", + "job_type": "Contract", + "status": "PENDING", + "employer_address": "12, Manhattan Street", + "employer_phone": "9911991199", + "zipcode": "129012", + "reason_for_leaving": "xyz", + "supervisor_contact": "nickfury@starkindustries.com", + "updated_at": "2020-08-25T15:24:03.346Z", + "created_at": "2020-08-25T15:24:03.346Z" + } +} +``` + +This API will be used to submit the Employment records for the candidate. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| employer_name | `string` | Name of the employer. | +| employer_address | `string` | Address of the employer. | +| employer_phone | `string` | Phone number of the employer. | +| employer_town | `string` | Town where the employer is located. | +| state | `string` | State where the employer is located. | +| zip_code | `string` | Zip Code of the postal district where the employer is located. | +| country | `string` | Country where the employer is located. | +| job_title | `string` | Job title of the latest employment. | +| start_date | `string` | Start Date of the employment. | +| end_date | `string` | End Date of the employment. | +| supervisor_name | `string` | The name of the candidate's supervisor in this employment. | +| current_employment | `string` | Is this the candidate's current employment? | +| job_type | `string` | Is this a contract or a full-time employment? | +| reason_for_leaving | `string` | Reason for leaving the job (optional). | +| supervisor_contact | `string` | Contact details of the supervisor. | + +## Delete Employment + +```shell +curl --location --request DELETE 'https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7' \ +--header 'Authorization: Bearer JWT_TOKEN' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', { + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN' +); +$response = Requests::get('https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7', $headers); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', +} + +params = ( + ('id', 'ef9e7612-3789-405a-be37-c7bc1871c1f7'), +) + +response = requests.get('https://api.us.springverify.com/employee/employment', headers=headers, params=params) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/employment?id=ef9e7612-3789-405a-be37-c7bc1871c1f7") +request = Net::HTTP::Delete.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": 1 +} +``` + +This API is used to delete the employment submitted in the "Add Candidate Employment" API before it goes for verification. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| id | `uuid` | UUID of the employment record. | + +## Edit Employment + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/employment' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", + "employer_name": "Stark Industries pvt ltd", + "employer_address": "12, Manhattan Street", + "employer_phone": "9911991199", + "employer_town": "New York", + "state": "New York", + "zip_code": "129012", + "country": "USA", + "job_title": "Senior Manager", + "start_date": "19-11-2000", + "end_date": "19-11-2002", + "supervisor_name": "Nick Fury", + "current_employment": "0", + "job_type": "Contract", + "reason_for_leaving": "xyz", + "supervisor_contact": "nickfury@starkindustries.com" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/employment', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' + }, + body: JSON.stringify({ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/employment', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }'; +$response = Requests::post('https://api.us.springverify.com/employee/employment', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", "employer_name": "Stark Industries pvt ltd", "employer_address": "12, Manhattan Street", "employer_phone": "9911991199", "employer_town": "New York", "state": "New York", "zip_code": "129012", "country": "USA", "job_title": "Senior Manager", "start_date": "19-11-2000", "end_date": "19-11-2002", "supervisor_name": "Nick Fury", "current_employment": "0", "job_type": "Contract", "reason_for_leaving": "xyz", "supervisor_contact": "nickfury@starkindustries.com" }' + +response = requests.post('https://api.us.springverify.com/employee/employment', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/employment") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "ef9e7612-3789-405a-be37-c7bc1871c1f7", + "email": "johndoe@gmail.com", + "access_id": null, + "employer_name": "Stark Industries pvt ltd", + "employer_name_verified": null, + "employer_phone": "9911991199", + "employer_phone_verified": null, + "employer_address": "12, Manhattan Street", + "employer_address_verified": null, + "employer_town": "New York", + "employer_town_verified": null, + "state": "New York", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "employer_country": "USA", + "employer_country_verified": null, + "job_title": "Senior Manager", + "job_title_verified": null, + "start_date": "19-11-2000", + "start_date_verified": null, + "end_date": "19-11-2002", + "end_date_verified": null, + "supervisor_name": "Nick Fury", + "supervisor_contact": "nickfury@starkindustries.com", + "current_employment": "0", + "current_employment_verified": null, + "contract_type": null, + "contract_type_verified": null, + "source": null, + "created_at": "2020-08-26T06:24:25.000Z", + "updated_at": "2020-08-26T06:26:07.019Z", + "job_type": "Full time", + "reason_for_leaving": "xyz", + "status": "PENDING", + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent": null + } +} +``` + +By adding the ID received in the "Submit Employment" response in this API, it can be used to edit the employment data. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| id | `uuid` | UUID of the employment record. | +| employer_name | `string` | Name of the employer. | +| employer_address | `string` | Address of the employer. | +| employer_phone | `string` | Phone number of the employer. | +| employer_town | `string` | Town where the employer is located. | +| state | `string` | State where the employer is located. | +| zip_code | `string` | Zip Code of the postal district where the employer is located. | +| country | `string` | Country where the employer is located. | +| job_title | `string` | Job title of the latest employment. | +| start_date | `string` | Start Date of the employment. | +| end_date | `string` | End Date of the employment. | +| supervisor_name | `string` | The name of the candidate's supervisor in this employment. | +| current_employment | `string` | Is this the candidate's current employment? | +| job_type | `string` | Is this a contract or a full-time employment? | +| reason_for_leaving | `string` | Reason for leaving the job (optional). | +| supervisor_contact | `string` | Contact details of the supervisor. | + +## Trigger Employment Verification + +```shell +curl --location --request GET 'https://api.us.springverify.com/employee/submit/employment' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "run_mock": true, + "fail_check": false +}' +``` + +```javascript +// FETCH + +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); +myHeaders.append("Content-Type", "application/json"); + +var raw = JSON.stringify({"run_mock":true,"fail_check":false}); + +var requestOptions = { + method: 'GET', + headers: myHeaders, + body: raw, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/employee/submit/employment", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); + +// REQUEST + +var request = require('request'); +var options = { + 'method': 'GET', + 'url': 'https://api.us.springverify.com/employee/submit/employment', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' + }, + body: JSON.stringify({"run_mock":true,"fail_check":false}) + +}; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); + +``` + +```php +setUrl('https://api.us.springverify.com/employee/submit/employment'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' +)); +$request->setBody('{\n "run_mock": true,\n "fail_check": false\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} +``` + +```ruby +require "uri" +require "net/http" + +url = URI("https://api.us.springverify.com/employee/submit/employment") + +https = Net::HTTP.new(url.host, url.port) +https.use_ssl = true + +request = Net::HTTP::Get.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" +request["Content-Type"] = "application/json" +request.body = "{\n \"run_mock\": true,\n \"fail_check\": false\n}" + +response = https.request(request) +puts response.read_body + +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "success": true, + "status": "Completed", + "institution_name_verified": false, + "employer_name_verified": false, + "count": 1 + } +} +``` + +Once the employment records have been submitted and finalized, an Employment Verification request can be triggered using this API. + + + + + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| run_mock | `boolean` | (Optional) Run mock api | +| fail_check | `boolean` | (Optional) Whether the employment check should fail or not | + +## Add Candidate's Education + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/education' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "school_name": "MIT", + "school_type": "University", + "school_campus": "Boston", + "address": "Asdasd", + "city":"Boston", + "state":"Massachusetts", + "zip_code": "126112" + "country":"USA", + "start_date":"28-12-1991", + "end_date":"12-28-1996", + "degree":"Engineering", + "currently_attending":"0", + "completed_successfully":"1", + "major":"Biotech" +}' +``` +> Success Response + +```json +{ + "success": true, + "data": { + "id": "de359912-1223-4338-87c4-0783a0ea495b", + "email": "johndoe@gmail.com", + "school_name": "MIT", + "school_type": "University", + "school_campus": "Boston", + "address": "Asdasd", + "city": "Boston", + "country": "USA", + "start_date": "28-12-1991", + "end_date": "12-28-1996", + "degree": "Engineering", + "currently_attending": "0", + "completed_successfully": "1", + "status": "PENDING", + "state": "Massachusetts", + "major": "Biotech", + "zipcode": "126112", + "updated_at": "2020-08-26T06:57:12.876Z", + "created_at": "2020-08-26T06:57:12.876Z" + } +} +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/education', { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json' +}; + +var dataString = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/education', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json' +); +$data = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; +$response = Requests::post('https://api.us.springverify.com/employee/education', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', +} + +data = '{ "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address": "Asdasd", "city":"Boston", "state":"Massachusetts", "zip_code": "126112" "country":"USA", "start_date":"28-12-1991", "end_date":"12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' + +response = requests.post('https://api.us.springverify.com/employee/education', headers=headers, data=data) +``` + +```ruby + +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/education") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +This API will be used to submit the education records of the candidate. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| school_name | `string` | The name of the candidate's school. | +| school_type | `string` | The type of the candidate's school. | +| school_campus | `string` | The campus of the candidate's school. | +| address | `string` | The address of the candidate's school. | +| city | `string` | The city where the candidate's school is located. | +| state | `string` | The state where the candidate's school is located. | +| zip_code | `string` | The ZIP code of the postal district where the candidate's school is located. | +| country | `string` | The country where the candidate's school is located. | +| start_date | `string` | Start date of the course. | +| end_date | `string` | End date of the course. | +| degree | `string` | Official degree of the course. | +| currently_attending | `string` | This flag will be set to 1 if the candidate is currently attending the course, else it will be set to 0. | +| completed_successfully | `string` | This flag will be set to 1 if the candidate has successfully completed the course, else it will be set to 0. | +| major | `string` | The field in which the candidate has majored. | + +## Edit Education Entry + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/education' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "id":"de359912-1223-4338-87c4-0783a0ea495b", + "school_name": "MIT", + "school_type": "University", + "school_campus": "Boston", + "address":"New street east block", + "city":"Boston", + "state":"Massachusetts", + "zip_code": "129012", + "country":"USA", + "start_date": "28-12-1991", + "end_date": "12-28-1996", + "degree":"Engineering", + "currently_attending":"0", + "completed_successfully":"1", + "major":"Biotech" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/education', { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json' +}; + +var dataString = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/education', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json' +); +$data = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }'; +$response = Requests::post('https://api.us.springverify.com/employee/education', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', +} + +data = '{ "id":"de359912-1223-4338-87c4-0783a0ea495b", "school_name": "MIT", "school_type": "University", "school_campus": "Boston", "address":"New street east block", "city":"Boston", "state":"Massachusetts", "zip_code": "129012", "country":"USA", "start_date": "28-12-1991", "end_date": "12-28-1996", "degree":"Engineering", "currently_attending":"0", "completed_successfully":"1", "major":"Biotech" }' + +response = requests.post('https://api.us.springverify.com/employee/education', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/education") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "18304027-e78a-426c-aae5-db9c677c1704", + "email": "johndoe@gmail.com", + "access_id": null, + "employee_alias_name": null, + "employee_alias_name_verified": null, + "school_name": "MIT", + "school_name_verified": null, + "school_campus": "Boston", + "school_campus_verified": null, + "phone": null, + "phone_verified": null, + "address": "New street east block", + "address_verified": null, + "town": null, + "town_verified": null, + "city": "Boston", + "city_verified": null, + "state": "Massachusetts", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "country": "USA", + "country_verified": null, + "start_date": "28-12-1991", + "start_date_verified": null, + "end_date": "12-28-1996", + "end_date_verified": null, + "degree": "Engineering", + "degree_verified": null, + "major": "Biotech", + "major_verified": null, + "school_type": "University", + "source": null, + "created_at": "2020-08-26T07:15:58.000Z", + "updated_at": "2020-08-26T07:16:55.604Z", + "currently_attending": "0", + "completed_successfully": "1", + "status": "PENDING", + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null + } +} +``` + +This API will be used to edit the education records for the Candidate. The id parameter passed will be the same as received at the time of Education Entry submission. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| id | `uuid` | UUID of the education entry. | +| school_name | `string` | The name of the candidate's school. | +| school_type | `string` | The type of the candidate's school. | +| school_campus | `string` | The campus of the candidate's school. | +| address | `string` | The address of the candidate's school. | +| city | `string` | The city where the candidate's school is located. | +| state | `string` | The state where the candidate's school is located. | +| zip_code | `string` | The ZIP code of the postal district where the candidate's school is located. | +| country | `string` | The country where the candidate's school is located. | +| start_date | `string` | Start date of the course. | +| end_date | `string` | End date of the course. | +| degree | `string` | Official degree of the course. | +| currently_attending | `string` | This flag will be set to 1 if the candidate is currently attending the course, else it will be set to 0. | +| completed_successfully | `string` | This flag will be set to 1 if the candidate has successfully completed the course, else it will be set to 0. | +| major | `string` | The field in which the candidate has majored. | + +## Delete Education + +```shell +curl --location --request DELETE 'https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b' \ +--header 'Authorization: Bearer JWT_TOKEN' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', { + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN' +); +$response = Requests::get('https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b', $headers); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', +} + +params = ( + ('id', 'de359912-1223-4338-87c4-0783a0ea495b'), +) + +response = requests.get('https://api.us.springverify.com/employee/education', headers=headers, params=params) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/education?id=de359912-1223-4338-87c4-0783a0ea495b") +request = Net::HTTP::Delete.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": 1 +} +``` + +This API is used to delete the education entry submitted in the previous API before it goes for verification. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| id | `uuid` | UUID of the education entry. | + +## Trigger Education Verification + +```shell +curl --location --request GET 'https://api.us.springverify.com/employee/submit/education' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "run_mock": true, + "fail_check": false +}' +``` + +```javascript +// FETCH + +var myHeaders = new Headers(); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); +myHeaders.append("Content-Type", "application/json"); + +var raw = JSON.stringify({"run_mock":true,"fail_check":false}); + +var requestOptions = { + method: 'GET', + headers: myHeaders, + body: raw, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/employee/submit/education", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); + +// REQUEST + +var request = require('request'); +var options = { + 'method': 'GET', + 'url': 'https://api.us.springverify.com/employee/submit/education', + 'headers': { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' + }, + body: JSON.stringify({"run_mock":true,"fail_check":false}) + +}; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); + +``` + +```php +setUrl('https://api.us.springverify.com/employee/submit/education'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' +)); +$request->setBody('{\n "run_mock": true,\n "fail_check": false\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} +``` + +```python +import requests + +url = "https://api.us.springverify.com/employee/submit/education" + +payload="{\n \"run_mock\": true,\n \"fail_check\": false\n}" +headers = { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' +} + +response = requests.request("GET", url, headers=headers, data=payload) + +print(response.text) + +``` + +```ruby +require "uri" +require "net/http" + +url = URI("https://api.us.springverify.com/employee/submit/education") + +https = Net::HTTP.new(url.host, url.port) +https.use_ssl = true + +request = Net::HTTP::Get.new(url) +request["Authorization"] = "Bearer JWT_TOKEN" +request["Content-Type"] = "application/json" +request.body = "{\n \"run_mock\": true,\n \"fail_check\": false\n}" + +response = https.request(request) +puts response.read_body + +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "success": true, + "status": "Completed", + "institution_name_verified": false, + "employer_name_verified": false + } +} +``` + +Once the education records have been submitted and finalized, an Education Verification request can be triggered using this API. + + + + + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| run_mock | `boolean` | (Optional) Run mock api | +| fail_check | `boolean` | (Optional) Whether the education check should fail or not | + +## Create Password + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/create-password' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "token": "JWT_TOKEN" + "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/create-password', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' + }, + body: '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }' +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/create-password', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }'; +$response = Requests::post('https://api.us.springverify.com/employee/create-password', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }' + +response = requests.post('https://api.us.springverify.com/employee/create-password', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/create-password") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", + "email": "johndoe@gmail.com", + "password_hash": "yahoo123456789", + "first_name": "John", + "middle_name": "David", + "last_name": "Doe", + "name_verified": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-26T07:52:04.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", + "email_sent": true, + "payment": false, + "status": null, + "flow_completed": null, + "company_created_by": "zed@max.com", + "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employments": [ + { + "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", + "email": "johndoe@gmail.com", + "access_id": null, + "employer_name": "Stark Industries pvt ltd", + "employer_name_verified": null, + "employer_phone": "9911991199", + "employer_phone_verified": null, + "employer_address": "12, Manhattan Street", + "employer_address_verified": null, + "employer_town": "New York", + "employer_town_verified": null, + "state": "New York", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "employer_country": "USA", + "employer_country_verified": null, + "job_title": "Senior Manager", + "job_title_verified": null, + "start_date": "19-11-2000", + "start_date_verified": null, + "end_date": "19-11-2002", + "end_date_verified": null, + "supervisor_name": "Nick Fury", + "supervisor_contact": "nickfury@starkindustries.com", + "current_employment": "0", + "current_employment_verified": null, + "contract_type": null, + "contract_type_verified": null, + "source": null, + "created_at": "2020-08-26T06:24:25.000Z", + "updated_at": "2020-08-26T06:26:07.000Z", + "job_type": "Full time", + "reason_for_leaving": "xyz", + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent": null, + "adverse_action": null + } + ], + "education": [ + { + "id": "18304027-e78a-426c-aae5-db9c677c1704", + "email": "johndoe@gmail.com", + "access_id": null, + "employee_alias_name": null, + "employee_alias_name_verified": null, + "school_name": "MIT", + "school_name_verified": null, + "school_campus": "Boston", + "school_campus_verified": null, + "phone": null, + "phone_verified": null, + "address": "New street east block", + "address_verified": null, + "town": null, + "town_verified": null, + "city": "Boston", + "city_verified": null, + "state": "Massachusetts", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "country": "USA", + "country_verified": null, + "start_date": "28-12-1991", + "start_date_verified": null, + "end_date": "12-28-1996", + "end_date_verified": null, + "degree": "Engineering", + "degree_verified": null, + "major": "Biotech", + "major_verified": null, + "school_type": "University", + "source": null, + "created_at": "2020-08-26T07:15:58.000Z", + "updated_at": "2020-08-26T07:16:55.000Z", + "currently_attending": 0, + "completed_successfully": 1, + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "adverse_action": null + } + ], + "cic_criminal_records": [ + { + "id": "4fb5b9ee-873e-4a7c-b19b-b0ae943f420b", + "record_type": null, + "reviewed": false, + "adverse_action": null + }, + { + "id": "f68e75da-a915-4e4c-8159-9e86ca595996", + "record_type": null, + "reviewed": false, + "adverse_action": null + } + ], + "professional_licenses": [], + "employee_detail": { + "id": "efa4191a-331d-48c3-8e52-8915ed8167be", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2020-08-25T14:32:46.000Z", + "updated_at": "2020-08-25T14:32:46.000Z", + "employee_email": "johndoe@gmail.com" + }, + "employee_verification": { + "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", + "s3_gov_id": "image link", + "s3_gov_id_back": "image link", + "s3_gov_id_match": false, + "s3_web_img": null, + "s3_passport_verified": 1, + "passport_status": "VERIFIED", + "s3_dl_verified": 1, + "dl_status": "VERIFIED", + "verification_type": "id", + "address": null, + "address_verified": null, + "city": null, + "city_verified": null, + "state": null, + "state_verified": null, + "zipcode": null, + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": null, + "birthdate_verified": null, + "criminal_verified": null, + "global_watchlist_verified": null, + "created_at": "2020-08-25T14:48:27.000Z", + "updated_at": "2020-08-26T05:01:16.000Z", + "is_report_checked": false, + "summary_of_rights_accepted": true, + "background_check_disclosure_accepted": true, + "id_manual_review": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent_link": "link", + "spring_sign_ref_id": "5f4524b817710d0014423b61", + "employee_email": "johndoe@gmail.com" + }, + "employee_limit": { + "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employment": 2, + "education": 1, + "professional_license": 0, + "all_county_criminal_search": true, + "county_criminal_search": 0, + "civil_court": 1, + "driving_license": 0, + "package_id": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-25T14:28:47.000Z", + "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", + "employee_invite_group": { + "id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", + "package": "diamond", + "active": true, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-25T14:28:47.000Z", + "company_created_by": "zed@max.com", + "package_id": "5" + } + }, + "kbaqna": { + "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", + "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", + "email": "johndoe@gmail.com", + "questions_flag": 1, + "kba_enabled": 1, + "question_count": "5", + "correct_answers": "4", + "verified": false, + "created_at": "2020-08-25T15:06:19.000Z", + "updated_at": "2020-08-25T15:11:49.000Z", + "idm_session_id": "91b59885191b01f5", + "employee_email": "johndoe@gmail.com" + }, + "employee_flow": { + "id": 289, + "employment_flow": "SUBMITTED", + "education_flow": "SUBMITTED", + "professional_license_flow": null, + "created_at": "2020-08-25T14:32:40.000Z", + "updated_at": "2020-08-26T07:36:45.000Z", + "employee_email": "johndoe@gmail.com" + }, + "s3_files": [ + { + "id": "0d81811f-4cb7-4d3e-875f-0e229ab98fa4", + "type": "ID", + "sub_type": "BACK", + "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", + "link": "link", + "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "status": null, + "comments": null, + "deleted_at": null, + "created_at": "2020-08-25T15:14:00.000Z", + "updated_at": "2020-08-25T15:14:00.000Z" + }, + { + "id": "3bf55d4f-6570-4d32-93ae-fc101677fce9", + "type": "ID", + "sub_type": "FRONT", + "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", + "link": "link", + "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "status": null, + "comments": null, + "deleted_at": null, + "created_at": "2020-08-25T15:14:00.000Z", + "updated_at": "2020-08-25T15:14:00.000Z" + } + ], + "criminal_statuses": [ + { + "id": "026c5a13-8112-40c7-8bba-39655a3f987a", + "type": "NATIONAL_CRIMINAL", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "0e9fb3d3-d464-4752-bc34-8537807482b9", + "type": "GLOBAL_WATCHLIST", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "2cf42d97-850f-4348-bac9-a7eacbe575b9", + "type": "SEX_OFFENDER", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "4b8e8f14-db92-476c-b2fb-bf9d054ad96e", + "type": "COUNTY_CRIMINAL_SEARCH", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "5d16c475-ba47-44fe-962c-a32dc26878c5", + "type": "CIVIL_COURT", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + } + ], + "sjv_criminal_reports": [ + { + "id": "d18c1432-91be-4ce2-8f07-4bff6728850c", + "employee_email_fk": "johndoe@gmail.com", + "status": "NOT_INITIATED", + "sjv_search_type": "CIVIL_COURT_NOTIFICATION", + "reference_id": null, + "cic_criminal_record_fk": null, + "report_link": null, + "marked_done": 0, + "marked_reviewed": 0, + "county_id": null, + "adverse_action_fk": null, + "authenticating_unique_identifier": null, + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z", + "county_name": null, + "adverse_action": null + }, + { + "id": "fed50a2f-bc72-4d3b-99dd-5e5053304008", + "employee_email_fk": "johndoe@gmail.com", + "status": "NOT_INITIATED", + "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", + "reference_id": null, + "cic_criminal_record_fk": null, + "report_link": null, + "marked_done": 0, + "marked_reviewed": 0, + "county_id": null, + "adverse_action_fk": null, + "authenticating_unique_identifier": null, + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z", + "county_name": null, + "adverse_action": null + } + ] + } +} +``` + +After all the previously mentioned checks have been successfully submitted and triggered, the candidate can create a password for their profile using this API. + + + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| token | `string` | JWT_TOKEN | +| password_hash | `string` | Hash of the password. (8 characters minimum). | + +## Reset Password + +```shell +curl --location --request POST 'https://api.us.springverify.com/employee/reset-password' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/reset-password', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' + }, + body: JSON.stringify({ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }'; + +var options = { + url: 'https://api.us.springverify.com/employee/reset-password', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }'; +$response = Requests::post('https://api.us.springverify.com/employee/reset-password', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }' + +response = requests.post('https://api.us.springverify.com/employee/reset-password', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/reset-password") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": true +} +``` + +This API is used to reset the candidate profile password. + + + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| password | `string` | Hash of the password. (8 characters minimum). | + +## Complete Candidate Flow + +```shell +curl --location --request GET 'https://api.us.springverify.com/employee/flow-completed' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/employee/flow-completed', { + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'https://api.us.springverify.com/employee/flow-completed', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$response = Requests::get('https://api.us.springverify.com/employee/flow-completed', $headers); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +response = requests.get('https://api.us.springverify.com/employee/flow-completed', headers=headers) +``` + +```ruby + +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/employee/flow-completed") +request = Net::HTTP::Get.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", + "email": "johndoe@gmail.com", + "password_hash": "yahoo123456789", + "first_name": "John", + "middle_name": "David", + "last_name": "Doe", + "name_verified": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-26T07:52:04.000Z", + "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", + "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", + "email_sent": true, + "payment": false, + "status": null, + "flow_completed": null, + "company_created_by": "zed@max.com", + "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employments": [ + { + "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", + "email": "johndoe@gmail.com", + "access_id": null, + "employer_name": "Stark Industries pvt ltd", + "employer_name_verified": null, + "employer_phone": "9911991199", + "employer_phone_verified": null, + "employer_address": "12, Manhattan Street", + "employer_address_verified": null, + "employer_town": "New York", + "employer_town_verified": null, + "state": "New York", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "employer_country": "USA", + "employer_country_verified": null, + "job_title": "Senior Manager", + "job_title_verified": null, + "start_date": "19-11-2000", + "start_date_verified": null, + "end_date": "19-11-2002", + "end_date_verified": null, + "supervisor_name": "Nick Fury", + "supervisor_contact": "nickfury@starkindustries.com", + "current_employment": "0", + "current_employment_verified": null, + "contract_type": null, + "contract_type_verified": null, + "source": null, + "created_at": "2020-08-26T06:24:25.000Z", + "updated_at": "2020-08-26T06:26:07.000Z", + "job_type": "Full time", + "reason_for_leaving": "xyz", + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent": null, + "adverse_action": null + } + ], + "education": [ + { + "id": "18304027-e78a-426c-aae5-db9c677c1704", + "email": "johndoe@gmail.com", + "access_id": null, + "employee_alias_name": null, + "employee_alias_name_verified": null, + "school_name": "MIT", + "school_name_verified": null, + "school_campus": "Boston", + "school_campus_verified": null, + "phone": null, + "phone_verified": null, + "address": "New street east block", + "address_verified": null, + "town": null, + "town_verified": null, + "city": "Boston", + "city_verified": null, + "state": "Massachusetts", + "state_verified": null, + "zipcode": "129012", + "zipcode_verified": null, + "country": "USA", + "country_verified": null, + "start_date": "28-12-1991", + "start_date_verified": null, + "end_date": "12-28-1996", + "end_date_verified": null, + "degree": "Engineering", + "degree_verified": null, + "major": "Biotech", + "major_verified": null, + "school_type": "University", + "source": null, + "created_at": "2020-08-26T07:15:58.000Z", + "updated_at": "2020-08-26T07:16:55.000Z", + "currently_attending": 0, + "completed_successfully": 1, + "status": 0, + "status_new": null, + "super_admin_status": null, + "super_admin_status_new": null, + "adverse_action": null + } + ], + "cic_criminal_records": [ + { + "id": "4fb5b9ee-873e-4a7c-b19b-b0ae943f420b", + "record_type": null, + "reviewed": false, + "adverse_action": null + }, + { + "id": "f68e75da-a915-4e4c-8159-9e86ca595996", + "record_type": null, + "reviewed": false, + "adverse_action": null + } + ], + "professional_licenses": [ + + ], + "employee_detail": { + "id": "efa4191a-331d-48c3-8e52-8915ed8167be", + "access_id": null, + "address": "236 Avea street", + "address_verified": null, + "driving_number": null, + "driving_number_verified": null, + "city": "Gotham", + "city_verified": null, + "state": "CA", + "state_verified": null, + "zipcode": "33433", + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": "12-11-1980", + "birthdate_verified": null, + "phone": "56-999222992", + "phone_verified": null, + "ssn": "6789", + "ssn_verified": null, + "created_at": "2020-08-25T14:32:46.000Z", + "updated_at": "2020-08-25T14:32:46.000Z", + "employee_email": "johndoe@gmail.com" + }, + "employee_verification": { + "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", + "s3_gov_id": "image link", + "s3_gov_id_back": "image link", + "s3_gov_id_match": false, + "s3_web_img": null, + "s3_passport_verified": 1, + "passport_status": "FAILED", + "s3_dl_verified": 1, + "dl_status": "VERIFIED", + "verification_type": "id", + "address": null, + "address_verified": null, + "city": null, + "city_verified": null, + "state": null, + "state_verified": null, + "zipcode": null, + "zipcode_verified": null, + "country": null, + "country_verified": null, + "birthdate": null, + "birthdate_verified": null, + "criminal_verified": null, + "global_watchlist_verified": null, + "created_at": "2020-08-25T14:48:27.000Z", + "updated_at": "2020-08-26T05:01:16.000Z", + "is_report_checked": false, + "summary_of_rights_accepted": true, + "background_check_disclosure_accepted": true, + "id_manual_review": null, + "super_admin_status": null, + "super_admin_status_new": null, + "consent_link": "link", + "spring_sign_ref_id": "5f4524b817710d0014423b61", + "employee_email": "johndoe@gmail.com" + }, + "employee_limit": { + "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", + "employment": 2, + "education": 1, + "professional_license": 0, + "all_county_criminal_search": true, + "county_criminal_search": 0, + "civil_court": 1, + "driving_license": 0, + "package_id": null, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-25T14:28:47.000Z", + "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", + "employee_invite_group": { + "id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", + "package": "diamond", + "active": true, + "created_at": "2020-08-25T14:28:47.000Z", + "updated_at": "2020-08-25T14:28:47.000Z", + "company_created_by": "zed@max.com", + "package_id": "5" + } + }, + "kbaqna": { + "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", + "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", + "email": "johndoe@gmail.com", + "questions_flag": 1, + "kba_enabled": 1, + "question_count": "5", + "correct_answers": "4", + "verified": false, + "created_at": "2020-08-25T15:06:19.000Z", + "updated_at": "2020-08-25T15:11:49.000Z", + "idm_session_id": "91b59885191b01f5", + "employee_email": "johndoe@gmail.com" + }, + "employee_flow": { + "id": 289, + "employment_flow": "SUBMITTED", + "education_flow": "SUBMITTED", + "professional_license_flow": null, + "created_at": "2020-08-25T14:32:40.000Z", + "updated_at": "2020-08-26T07:36:45.000Z", + "employee_email": "johndoe@gmail.com" + }, + "s3_files": [ + { + "id": "0d81811f-4cb7-4d3e-875f-0e229ab98fa4", + "type": "ID", + "sub_type": "BACK", + "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", + "link": "link", + "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "status": null, + "comments": null, + "deleted_at": null, + "created_at": "2020-08-25T15:14:00.000Z", + "updated_at": "2020-08-25T15:14:00.000Z" + }, + { + "id": "3bf55d4f-6570-4d32-93ae-fc101677fce9", + "type": "ID", + "sub_type": "FRONT", + "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", + "link": "link", + "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", + "status": null, + "comments": null, + "deleted_at": null, + "created_at": "2020-08-25T15:14:00.000Z", + "updated_at": "2020-08-25T15:14:00.000Z" + } + ], + "criminal_statuses": [ + { + "id": "026c5a13-8112-40c7-8bba-39655a3f987a", + "type": "NATIONAL_CRIMINAL", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "0e9fb3d3-d464-4752-bc34-8537807482b9", + "type": "GLOBAL_WATCHLIST", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "2cf42d97-850f-4348-bac9-a7eacbe575b9", + "type": "SEX_OFFENDER", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "4b8e8f14-db92-476c-b2fb-bf9d054ad96e", + "type": "COUNTY_CRIMINAL_SEARCH", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + }, + { + "id": "5d16c475-ba47-44fe-962c-a32dc26878c5", + "type": "CIVIL_COURT", + "status": "PENDING", + "source": "SYSTEM", + "employee_email_fk": "johndoe@gmail.com", + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z" + } + ], + "sjv_criminal_reports": [ + { + "id": "d18c1432-91be-4ce2-8f07-4bff6728850c", + "employee_email_fk": "johndoe@gmail.com", + "status": "NOT_INITIATED", + "sjv_search_type": "CIVIL_COURT_NOTIFICATION", + "reference_id": null, + "cic_criminal_record_fk": null, + "report_link": null, + "marked_done": 0, + "marked_reviewed": 0, + "county_id": null, + "adverse_action_fk": null, + "authenticating_unique_identifier": null, + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z", + "county_name": null, + "adverse_action": null + }, + { + "id": "fed50a2f-bc72-4d3b-99dd-5e5053304008", + "employee_email_fk": "johndoe@gmail.com", + "status": "NOT_INITIATED", + "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", + "reference_id": null, + "cic_criminal_record_fk": null, + "report_link": null, + "marked_done": 0, + "marked_reviewed": 0, + "county_id": null, + "adverse_action_fk": null, + "authenticating_unique_identifier": null, + "created_at": "2020-08-25T15:14:36.000Z", + "updated_at": "2020-08-25T15:14:36.000Z", + "county_name": null, + "adverse_action": null + } + ] + } } ``` -Once the education records have been submitted and finalized, an Education Verification request can be triggered using this API. - - - - - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| run_mock | `boolean` | (Optional) Run mock api | -| fail_check | `boolean` | (Optional) Whether the education check should fail or not | +This API is used to let the system know that candidate form has been submitted successfully. -## Create Password +## Candidate Login ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/create-password' \ +curl --location --request POST 'https://api.us.springverify.com/auth/login' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT_TOKEN' \ --data-raw '{ - "token": "JWT_TOKEN" - "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" + "email": "john@wick.com", + "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", + "role":"employee" }' ``` @@ -8082,13 +9904,13 @@ curl --location --request POST 'https://api.us.springverify.com/employee/create- var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/employee/create-password', { +fetch('https://api.us.springverify.com/auth/login', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' }, - body: '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }' + body: JSON.stringify({ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }) }); // REQUEST @@ -8100,10 +9922,10 @@ var headers = { 'Authorization': 'Bearer JWT_TOKEN' }; -var dataString = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }'; +var dataString = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }'; var options = { - url: 'https://api.us.springverify.com/employee/create-password', + url: 'https://api.us.springverify.com/auth/login', method: 'POST', headers: headers, body: dataString @@ -8126,8 +9948,8 @@ $headers = array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer JWT_TOKEN' ); -$data = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }'; -$response = Requests::post('https://api.us.springverify.com/employee/create-password', $headers, $data); +$data = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }'; +$response = Requests::post('https://api.us.springverify.com/auth/login', $headers, $data); ``` ```python @@ -8138,16 +9960,16 @@ headers = { 'Authorization': 'Bearer JWT_TOKEN', } -data = '{ "token": "JWT_TOKEN" "password_hash":"5c29a959abce4eda5f0e7a4e7ea53dce4fa0f0abbe8eaa63717e2fed5f193d31" }' +data = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }' -response = requests.post('https://api.us.springverify.com/employee/create-password', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/auth/login', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/employee/create-password") +uri = URI.parse("https://api.us.springverify.com/auth/login") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -8170,941 +9992,1392 @@ end { "success": true, "data": { - "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", - "email": "johndoe@gmail.com", - "password_hash": "yahoo123456789", - "first_name": "John", - "middle_name": "David", - "last_name": "Doe", - "name_verified": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-26T07:52:04.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", - "email_sent": true, - "payment": false, - "status": null, - "flow_completed": null, - "company_created_by": "zed@max.com", - "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employments": [ - { - "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", - "email": "johndoe@gmail.com", - "access_id": null, - "employer_name": "Stark Industries pvt ltd", - "employer_name_verified": null, - "employer_phone": "9911991199", - "employer_phone_verified": null, - "employer_address": "12, Manhattan Street", - "employer_address_verified": null, - "employer_town": "New York", - "employer_town_verified": null, - "state": "New York", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "employer_country": "USA", - "employer_country_verified": null, - "job_title": "Senior Manager", - "job_title_verified": null, - "start_date": "19-11-2000", - "start_date_verified": null, - "end_date": "19-11-2002", - "end_date_verified": null, - "supervisor_name": "Nick Fury", - "supervisor_contact": "nickfury@starkindustries.com", - "current_employment": "0", - "current_employment_verified": null, - "contract_type": null, - "contract_type_verified": null, - "source": null, - "created_at": "2020-08-26T06:24:25.000Z", - "updated_at": "2020-08-26T06:26:07.000Z", - "job_type": "Full time", - "reason_for_leaving": "xyz", - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent": null, - "adverse_action": null - } - ], - "education": [ - { - "id": "18304027-e78a-426c-aae5-db9c677c1704", - "email": "johndoe@gmail.com", - "access_id": null, - "employee_alias_name": null, - "employee_alias_name_verified": null, - "school_name": "MIT", - "school_name_verified": null, - "school_campus": "Boston", - "school_campus_verified": null, - "phone": null, - "phone_verified": null, - "address": "New street east block", - "address_verified": null, - "town": null, - "town_verified": null, - "city": "Boston", - "city_verified": null, - "state": "Massachusetts", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "country": "USA", - "country_verified": null, - "start_date": "28-12-1991", - "start_date_verified": null, - "end_date": "12-28-1996", - "end_date_verified": null, - "degree": "Engineering", - "degree_verified": null, - "major": "Biotech", - "major_verified": null, - "school_type": "University", - "source": null, - "created_at": "2020-08-26T07:15:58.000Z", - "updated_at": "2020-08-26T07:16:55.000Z", - "currently_attending": 0, - "completed_successfully": 1, - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "adverse_action": null - } - ], - "cic_criminal_records": [ + "success": true, + "success_msg": "employee logged in successfully", + "data": { + "token": "JWT_TOKEN" + } + } +} +``` + +> Error Response: + +```json +{ + "errors": [ + { + "value": "", + "msg": "Not a valid role", + "param": "role", + "location": "body" + } + ] +} +``` + +For logging in, the aim is to generate a JSON web token that is to be used in all subsequent API calls. The JWT generated will be valid for one hour. + +To call the subsequent APIs, the candidate will need to send the JWT successfully in the header of those APIs. + + + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| email | `string` | The email address used by the candidate to register with SpringVerify. | +| password | `string` | The password used by the candidate to register with SpringVerify. (Hashed, 8 characters minimum). | +| role | `string` | The role of the user being logged in - in this case, `employee`. | + +--- + +# Old Apis + +All the old apis are documented here. + +## Get company profile + +```shell +curl --location --request GET 'https://api.us.springverify.com/profile' \ +--header 'Authorization: Bearer JWT_TOKEN' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/profile', { + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'https://api.us.springverify.com/profile', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN' +); +$response = Requests::get('https://api.us.springverify.com/profile', $headers); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', +} + +response = requests.get('https://api.us.springverify.com/profile', headers=headers) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/profile") +request = Net::HTTP::Get.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "first_name": "John", + "last_name": "Wick", + "phone": "999999999", + "email": "john@wick.com", + "domain": "wick.com", + "stripe_id": null, + "company": { + "name": "SmartBrains", + "address": "901, Downtown Manhattan", + "city": "NY", + "state": "NY", + "zipcode": "91319", + "tax_id_number": "1234567890", + "s3_logo": "https://spring-verify-us.s3.amazonaws.com/company/wick.com/logo" + }, + "count": [ { - "id": "4fb5b9ee-873e-4a7c-b19b-b0ae943f420b", - "record_type": null, - "reviewed": false, - "adverse_action": null + "count": 0, + "type": null }, { - "id": "f68e75da-a915-4e4c-8159-9e86ca595996", - "record_type": null, - "reviewed": false, - "adverse_action": null - } - ], - "professional_licenses": [], - "employee_detail": { - "id": "efa4191a-331d-48c3-8e52-8915ed8167be", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2020-08-25T14:32:46.000Z", - "updated_at": "2020-08-25T14:32:46.000Z", - "employee_email": "johndoe@gmail.com" - }, - "employee_verification": { - "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", - "s3_gov_id": "image link", - "s3_gov_id_back": "image link", - "s3_gov_id_match": false, - "s3_web_img": null, - "s3_passport_verified": 1, - "passport_status": "VERIFIED", - "s3_dl_verified": 1, - "dl_status": "VERIFIED", - "verification_type": "id", - "address": null, - "address_verified": null, - "city": null, - "city_verified": null, - "state": null, - "state_verified": null, - "zipcode": null, - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": null, - "birthdate_verified": null, - "criminal_verified": null, - "global_watchlist_verified": null, - "created_at": "2020-08-25T14:48:27.000Z", - "updated_at": "2020-08-26T05:01:16.000Z", - "is_report_checked": false, - "summary_of_rights_accepted": true, - "background_check_disclosure_accepted": true, - "id_manual_review": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent_link": "link", - "spring_sign_ref_id": "5f4524b817710d0014423b61", - "employee_email": "johndoe@gmail.com" - }, - "employee_limit": { - "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employment": 2, - "education": 1, - "professional_license": 0, - "all_county_criminal_search": true, - "county_criminal_search": 0, - "civil_court": 1, - "driving_license": 0, - "package_id": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-25T14:28:47.000Z", - "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", - "employee_invite_group": { - "id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", - "package": "diamond", - "active": true, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-25T14:28:47.000Z", - "company_created_by": "zed@max.com", - "package_id": "5" - } - }, - "kbaqna": { - "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", - "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", - "email": "johndoe@gmail.com", - "questions_flag": 1, - "kba_enabled": 1, - "question_count": "5", - "correct_answers": "4", - "verified": false, - "created_at": "2020-08-25T15:06:19.000Z", - "updated_at": "2020-08-25T15:11:49.000Z", - "idm_session_id": "91b59885191b01f5", - "employee_email": "johndoe@gmail.com" - }, - "employee_flow": { - "id": 289, - "employment_flow": "SUBMITTED", - "education_flow": "SUBMITTED", - "professional_license_flow": null, - "created_at": "2020-08-25T14:32:40.000Z", - "updated_at": "2020-08-26T07:36:45.000Z", - "employee_email": "johndoe@gmail.com" - }, - "s3_files": [ + "count": 0, + "type": "FAILED" + }, { - "id": "0d81811f-4cb7-4d3e-875f-0e229ab98fa4", - "type": "ID", - "sub_type": "BACK", - "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", - "link": "link", - "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "status": null, - "comments": null, - "deleted_at": null, - "created_at": "2020-08-25T15:14:00.000Z", - "updated_at": "2020-08-25T15:14:00.000Z" + "count": 0, + "type": "PENDING" }, { - "id": "3bf55d4f-6570-4d32-93ae-fc101677fce9", - "type": "ID", - "sub_type": "FRONT", - "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", - "link": "link", - "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "status": null, - "comments": null, - "deleted_at": null, - "created_at": "2020-08-25T15:14:00.000Z", - "updated_at": "2020-08-25T15:14:00.000Z" + "count": 0, + "type": "VERIFIED" } - ], - "criminal_statuses": [ + ] + } +} +``` + +For a registered admin with a valid JWT, this API can be used to get the company's profile. This is different from the company details. A company's profile contains details of the company given during registration as well as the count of the candidates whose profiles were verified, failed, or is pending. + +## Get available packages + +```shell +curl --location --request GET 'http://api-stage.us.springverify.com/company/package' \ + --header 'Authorization: Bearer JWT_TOKEN' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('http://api-stage.us.springverify.com/company/package', { + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'http://api-stage.us.springverify.com/company/package', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN' +); +$response = Requests::get('http://api-stage.us.springverify.com/company/package', $headers); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', +} + +response = requests.get('http://api-stage.us.springverify.com/company/package', headers=headers) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("http://api-stage.us.springverify.com/company/package") +request = Net::HTTP::Get.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response: + +```json +{ + "success": true, + "data": { + "package": [ { - "id": "026c5a13-8112-40c7-8bba-39655a3f987a", - "type": "NATIONAL_CRIMINAL", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" + "id": "1", + "name": "bronze", + "employment": null, + "education": "0", + "professional_license": "0", + "civil_court": "0", + "driving_license": "0", + "county_criminal_search": "0", + "all_county_criminal_search": false, + "national_criminal_search": "1", + "sex_offender_search": "1", + "ssn_trace": "1", + "global_watchlist": "1", + "price": "750", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-11-11T11:53:38.000Z" }, { - "id": "0e9fb3d3-d464-4752-bc34-8537807482b9", - "type": "GLOBAL_WATCHLIST", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" + "id": "2", + "name": "silver", + "employment": null, + "education": "0", + "professional_license": "0", + "civil_court": "0", + "driving_license": "0", + "county_criminal_search": "0", + "all_county_criminal_search": false, + "national_criminal_search": "1", + "sex_offender_search": "1", + "ssn_trace": "1", + "global_watchlist": "1", + "price": "1500", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-11-11T11:53:38.000Z" }, { - "id": "2cf42d97-850f-4348-bac9-a7eacbe575b9", - "type": "SEX_OFFENDER", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" + "id": "3", + "name": "gold", + "employment": null, + "education": "0", + "professional_license": "0", + "civil_court": "0", + "driving_license": "0", + "county_criminal_search": "1", + "all_county_criminal_search": false, + "national_criminal_search": "1", + "sex_offender_search": "1", + "ssn_trace": "1", + "global_watchlist": "1", + "price": "2000", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-11-11T11:53:39.000Z" }, { - "id": "4b8e8f14-db92-476c-b2fb-bf9d054ad96e", - "type": "COUNTY_CRIMINAL_SEARCH", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" + "id": "4", + "name": "platinum", + "employment": null, + "education": "1", + "professional_license": "0", + "civil_court": "0", + "driving_license": "0", + "county_criminal_search": "0", + "all_county_criminal_search": true, + "national_criminal_search": "1", + "sex_offender_search": "1", + "ssn_trace": "1", + "global_watchlist": "1", + "price": "3000", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-11-11T11:53:39.000Z" }, { - "id": "5d16c475-ba47-44fe-962c-a32dc26878c5", - "type": "CIVIL_COURT", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" + "id": "5", + "name": "diamond", + "employment": null, + "education": "1", + "professional_license": "0", + "civil_court": "1", + "driving_license": "0", + "county_criminal_search": "0", + "all_county_criminal_search": true, + "national_criminal_search": "1", + "sex_offender_search": "1", + "ssn_trace": "1", + "global_watchlist": "1", + "price": "4000", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-11-11T11:53:39.000Z" } ], - "sjv_criminal_reports": [ - { - "id": "d18c1432-91be-4ce2-8f07-4bff6728850c", - "employee_email_fk": "johndoe@gmail.com", - "status": "NOT_INITIATED", - "sjv_search_type": "CIVIL_COURT_NOTIFICATION", - "reference_id": null, - "cic_criminal_record_fk": null, - "report_link": null, - "marked_done": 0, - "marked_reviewed": 0, - "county_id": null, - "adverse_action_fk": null, - "authenticating_unique_identifier": null, - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z", - "county_name": null, - "adverse_action": null - }, - { - "id": "fed50a2f-bc72-4d3b-99dd-5e5053304008", - "employee_email_fk": "johndoe@gmail.com", - "status": "NOT_INITIATED", - "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", - "reference_id": null, - "cic_criminal_record_fk": null, - "report_link": null, - "marked_done": 0, - "marked_reviewed": 0, - "county_id": null, - "adverse_action_fk": null, - "authenticating_unique_identifier": null, - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z", - "county_name": null, - "adverse_action": null - } - ] + "prices": { + "id": "1", + "env": "development", + "passport": 200, + "driving_license": 200, + "enhanced_driving_license": 200, + "kba": 400, + "employment": 750, + "education": 750, + "professional_license": 500, + "civil_court": 1000, + "one_county_criminal_search": 1000, + "all_county_criminal_search": 1000, + "county_criminal_search": 1000, + "package": "", + "created_at": "2019-07-03T11:07:27.000Z", + "updated_at": "2019-09-18T13:27:52.000Z" + } } } ``` +This API is used to get the available pricing plans and packages. -After all the previously mentioned checks have been successfully submitted and triggered, the candidate can create a password for their profile using this API. - - - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| token | `string` | JWT_TOKEN | -| password_hash | `string` | Hash of the password. (8 characters minimum). | - -## Reset Password +## Invite candidates ```shell -curl --location --request POST 'https://api.us.springverify.com/employee/reset-password' \ +curl --location --request POST 'https://api.us.springverify.com/employee/invite' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT_TOKEN' \ --data-raw '{ - "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" + "email_list": [ + "venunath2@gmail.com" + ], + "employee_details": [ + { + "email": "venunath2@gmail.com", + "first_name": "abcd", + "last_name": "xyc", + "middle_name": "zxcz", + "phone": "21321313", + "birthdate": "12-12-2012" + } + ], + "package": "bronze", + "addOns": { + "employment": 0, + "education": 0, + "license": 0, + "driving_license": 0, + "civil_court": 0, + "all_county_criminal_search": false, + "county_criminal_search": 0, + "MVR": false + } }' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Content-Type", "application/json"); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/reset-password', { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - }, - body: JSON.stringify({ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }) -}); +var raw = JSON.stringify({"email_list":["venunath2@gmail.com"],"employee_details":[{"email":"venunath2@gmail.com","first_name":"abcd","last_name":"xyc","middle_name":"zxcz","phone":"21321313","birthdate":"12-12-2012"}],"package":"bronze","addOns":{"employment":0,"education":0,"license":0,"driving_license":0,"civil_court":0,"all_county_criminal_search":false,"county_criminal_search":0,"MVR":false}}); + +var requestOptions = { + method: 'POST', + headers: myHeaders, + body: raw, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/employee/invite", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { +var options = { + 'method': 'POST', + 'url': 'https://api.us.springverify.com/employee/invite', + 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' -}; - -var dataString = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }'; + }, + body: JSON.stringify({"email_list":["venunath2@gmail.com"],"employee_details":[{"email":"venunath2@gmail.com","first_name":"abcd","last_name":"xyc","middle_name":"zxcz","phone":"21321313","birthdate":"12-12-2012"}],"package":"bronze","addOns":{"employment":0,"education":0,"license":0,"driving_license":0,"civil_court":0,"all_county_criminal_search":false,"county_criminal_search":0,"MVR":false}}) -var options = { - url: 'https://api.us.springverify.com/employee/reset-password', - method: 'POST', - headers: headers, - body: dataString }; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); ``` ```php 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' -); -$data = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }'; -$response = Requests::post('https://api.us.springverify.com/employee/reset-password', $headers, $data); +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/employee/invite'); +$request->setMethod(HTTP_Request2::METHOD_POST); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Content-Type' => 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +)); +$request->setBody('{\n "email_list": [\n "venunath2@gmail.com"\n ],\n "employee_details": [\n {\n "email": "venunath2@gmail.com",\n "first_name": "abcd",\n "last_name": "xyc",\n "middle_name": "zxcz",\n "phone": "21321313",\n "birthdate": "12-12-2012"\n }\n ],\n "package": "bronze",\n "addOns": {\n "employment": 0,\n "education": 0,\n "license": 0,\n "driving_license": 0,\n "civil_court": 0,\n "all_county_criminal_search": false,\n "county_criminal_search": 0,\n "MVR": false\n }\n}'); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); +} ``` ```python import requests +url = "https://api.us.springverify.com/employee/invite" + +payload="{\n \"email_list\": [\n \"venunath2@gmail.com\"\n ],\n \"employee_details\": [\n {\n \"email\": \"venunath2@gmail.com\",\n \"first_name\": \"abcd\",\n \"last_name\": \"xyc\",\n \"middle_name\": \"zxcz\",\n \"phone\": \"21321313\",\n \"birthdate\": \"12-12-2012\"\n }\n ],\n \"package\": \"bronze\",\n \"addOns\": {\n \"employment\": 0,\n \"education\": 0,\n \"license\": 0,\n \"driving_license\": 0,\n \"civil_court\": 0,\n \"all_county_criminal_search\": false,\n \"county_criminal_search\": 0,\n \"MVR\": false\n }\n}" headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' } -data = '{ "password":"ab0365e1c40ea17c8d1e7819c45a477ac836080b3b5fd1305ccb281acf24c62e" }' +response = requests.request("POST", url, headers=headers, data=payload) + +print(response.text) -response = requests.post('https://api.us.springverify.com/employee/reset-password', headers=headers, data=data) ``` ```ruby -require 'net/http' -require 'uri' +require "uri" +require "net/http" -uri = URI.parse("https://api.us.springverify.com/employee/reset-password") -request = Net::HTTP::Post.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = URI("https://api.us.springverify.com/employee/invite") -req_options = { - use_ssl: uri.scheme == "https", -} +https = Net::HTTP.new(url.host, url.port) +https.use_ssl = true -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end +request = Net::HTTP::Post.new(url) +request["Content-Type"] = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" +request.body = "{\n \"email_list\": [\n \"venunath2@gmail.com\"\n ],\n \"employee_details\": [\n {\n \"email\": \"venunath2@gmail.com\",\n \"first_name\": \"abcd\",\n \"last_name\": \"xyc\",\n \"middle_name\": \"zxcz\",\n \"phone\": \"21321313\",\n \"birthdate\": \"12-12-2012\"\n }\n ],\n \"package\": \"bronze\",\n \"addOns\": {\n \"employment\": 0,\n \"education\": 0,\n \"license\": 0,\n \"driving_license\": 0,\n \"civil_court\": 0,\n \"all_county_criminal_search\": false,\n \"county_criminal_search\": 0,\n \"MVR\": false\n }\n}" + +response = https.request(request) +puts response.read_body -# response.code -# response.body ``` -> Success Response +>Success Response: ```json { "success": true, - "data": true + "data": { + "price": 750, + "id": "0aa10b4e-e4fc-460b-95dc-6f0ca80be061", + "count": 1, + "employees": [ + { + "id": "48d18330-408e-40ff-b898-dac10cb32ce4", + "email": "venunath2@gmail.com" + } + ] + } } + ``` +This API is used to invite existing and/or prospective candidates to get their profiles verified. It can be used to invite candidates in bulk. However, emails will be sent to the candidates only once the payment is successfully completed. -This API is used to reset the candidate profile password. + **URL Parameters** | Parameter | Type | Description | | --- | --- | --- | -| password | `string` | Hash of the password. (8 characters minimum). | +| email_list | `array` | Contains a list of the email addresses of the candidates to be contacted | +| package | `string` | Name of the package as retrieved from the [Get available packages](https://docs.us.springverify.com/#get-available-packages) API | +| employee_details | `object` | (Optional) Details of the candidate | +| add_ons | `object` | To add additional services into the retrieved package | -## Complete Candidate Flow +**Response Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| price | `number` | The price (in cents) that is to be paid | +| id | `string` | The reference ID against which the payment is being made | +| count | `number` | The total number of candidates that are being verified | +| employees | `array` | Id and email id of invited candidates | + + +## Get Webhook Logs ```shell -curl --location --request GET 'https://api.us.springverify.com/employee/flow-completed' \ +curl --location --request GET 'https://api.us.springverify.com/company/webhook/logs' \ --header 'Content-Type: application/json' \ ---header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Authorization: Bearer JWT_TOKEN' ``` ```javascript // FETCH -var fetch = require('node-fetch'); +var myHeaders = new Headers(); +myHeaders.append("Content-Type", "application/json"); +myHeaders.append("Authorization", "Bearer JWT_TOKEN"); -fetch('https://api.us.springverify.com/employee/flow-completed', { - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' - } -}); +var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' +}; + +fetch("https://api.us.springverify.com/company/webhook/logs", requestOptions) + .then(response => response.text()) + .then(result => console.log(result)) + .catch(error => console.log('error', error)); // REQUEST var request = require('request'); - -var headers = { +var options = { + 'method': 'GET', + 'url': 'https://api.us.springverify.com/company/webhook/logs', + 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN' + } }; +request(options, function (error, response) { + if (error) throw new Error(error); + console.log(response.body); +}); -var options = { - url: 'https://api.us.springverify.com/employee/flow-completed', - headers: headers -}; - -function callback(error, response, body) { - if (!error && response.statusCode == 200) { - console.log(body); - } -} - -request(options, callback); ``` ```php 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' -); -$response = Requests::get('https://api.us.springverify.com/employee/flow-completed', $headers); -``` - -```python -import requests - -headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN', +require_once 'HTTP/Request2.php'; +$request = new HTTP_Request2(); +$request->setUrl('https://api.us.springverify.com/company/webhook/logs'); +$request->setMethod(HTTP_Request2::METHOD_GET); +$request->setConfig(array( + 'follow_redirects' => TRUE +)); +$request->setHeader(array( + 'Content-Type' => 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +)); +try { + $response = $request->send(); + if ($response->getStatus() == 200) { + echo $response->getBody(); + } + else { + echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . + $response->getReasonPhrase(); + } +} +catch(HTTP_Request2_Exception $e) { + echo 'Error: ' . $e->getMessage(); } - -response = requests.get('https://api.us.springverify.com/employee/flow-completed', headers=headers) ``` -```ruby - -require 'net/http' -require 'uri' +```python +import requests +import json -uri = URI.parse("https://api.us.springverify.com/employee/flow-completed") -request = Net::HTTP::Get.new(uri) -request.content_type = "application/json" -request["Authorization"] = "Bearer JWT_TOKEN" +url = "https://api.us.springverify.com/company/webhook/logs" -req_options = { - use_ssl: uri.scheme == "https", +payload={} +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' } -response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| - http.request(request) -end - -# response.code -# response.body -``` - -> Success Response +response = requests.request("GET", url, headers=headers, data=payload) -```json -{ - "success": true, - "data": { - "id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", - "email": "johndoe@gmail.com", - "password_hash": "yahoo123456789", - "first_name": "John", - "middle_name": "David", - "last_name": "Doe", - "name_verified": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-26T07:52:04.000Z", - "employer_id": "1d4fb8ba-09ac-412c-aa62-58970b4d7472", - "payment_id": "6c75e302-ac2a-4efa-9ba9-c5dfc97b941e", - "email_sent": true, - "payment": false, - "status": null, - "flow_completed": null, - "company_created_by": "zed@max.com", - "employee_limit_id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employments": [ - { - "id": "d0284d0b-eae8-4f0c-a574-66d39ad9d548", - "email": "johndoe@gmail.com", - "access_id": null, - "employer_name": "Stark Industries pvt ltd", - "employer_name_verified": null, - "employer_phone": "9911991199", - "employer_phone_verified": null, - "employer_address": "12, Manhattan Street", - "employer_address_verified": null, - "employer_town": "New York", - "employer_town_verified": null, - "state": "New York", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "employer_country": "USA", - "employer_country_verified": null, - "job_title": "Senior Manager", - "job_title_verified": null, - "start_date": "19-11-2000", - "start_date_verified": null, - "end_date": "19-11-2002", - "end_date_verified": null, - "supervisor_name": "Nick Fury", - "supervisor_contact": "nickfury@starkindustries.com", - "current_employment": "0", - "current_employment_verified": null, - "contract_type": null, - "contract_type_verified": null, - "source": null, - "created_at": "2020-08-26T06:24:25.000Z", - "updated_at": "2020-08-26T06:26:07.000Z", - "job_type": "Full time", - "reason_for_leaving": "xyz", - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent": null, - "adverse_action": null - } - ], - "education": [ - { - "id": "18304027-e78a-426c-aae5-db9c677c1704", - "email": "johndoe@gmail.com", - "access_id": null, - "employee_alias_name": null, - "employee_alias_name_verified": null, - "school_name": "MIT", - "school_name_verified": null, - "school_campus": "Boston", - "school_campus_verified": null, - "phone": null, - "phone_verified": null, - "address": "New street east block", - "address_verified": null, - "town": null, - "town_verified": null, - "city": "Boston", - "city_verified": null, - "state": "Massachusetts", - "state_verified": null, - "zipcode": "129012", - "zipcode_verified": null, - "country": "USA", - "country_verified": null, - "start_date": "28-12-1991", - "start_date_verified": null, - "end_date": "12-28-1996", - "end_date_verified": null, - "degree": "Engineering", - "degree_verified": null, - "major": "Biotech", - "major_verified": null, - "school_type": "University", - "source": null, - "created_at": "2020-08-26T07:15:58.000Z", - "updated_at": "2020-08-26T07:16:55.000Z", - "currently_attending": 0, - "completed_successfully": 1, - "status": 0, - "status_new": null, - "super_admin_status": null, - "super_admin_status_new": null, - "adverse_action": null - } - ], - "cic_criminal_records": [ - { - "id": "4fb5b9ee-873e-4a7c-b19b-b0ae943f420b", - "record_type": null, - "reviewed": false, - "adverse_action": null - }, - { - "id": "f68e75da-a915-4e4c-8159-9e86ca595996", - "record_type": null, - "reviewed": false, - "adverse_action": null - } - ], - "professional_licenses": [ - - ], - "employee_detail": { - "id": "efa4191a-331d-48c3-8e52-8915ed8167be", - "access_id": null, - "address": "236 Avea street", - "address_verified": null, - "driving_number": null, - "driving_number_verified": null, - "city": "Gotham", - "city_verified": null, - "state": "CA", - "state_verified": null, - "zipcode": "33433", - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": "12-11-1980", - "birthdate_verified": null, - "phone": "56-999222992", - "phone_verified": null, - "ssn": "6789", - "ssn_verified": null, - "created_at": "2020-08-25T14:32:46.000Z", - "updated_at": "2020-08-25T14:32:46.000Z", - "employee_email": "johndoe@gmail.com" - }, - "employee_verification": { - "id": "c068d1da-9615-4b8e-a7a7-5daf624ed8d1", - "s3_gov_id": "image link", - "s3_gov_id_back": "image link", - "s3_gov_id_match": false, - "s3_web_img": null, - "s3_passport_verified": 1, - "passport_status": "FAILED", - "s3_dl_verified": 1, - "dl_status": "VERIFIED", - "verification_type": "id", - "address": null, - "address_verified": null, - "city": null, - "city_verified": null, - "state": null, - "state_verified": null, - "zipcode": null, - "zipcode_verified": null, - "country": null, - "country_verified": null, - "birthdate": null, - "birthdate_verified": null, - "criminal_verified": null, - "global_watchlist_verified": null, - "created_at": "2020-08-25T14:48:27.000Z", - "updated_at": "2020-08-26T05:01:16.000Z", - "is_report_checked": false, - "summary_of_rights_accepted": true, - "background_check_disclosure_accepted": true, - "id_manual_review": null, - "super_admin_status": null, - "super_admin_status_new": null, - "consent_link": "link", - "spring_sign_ref_id": "5f4524b817710d0014423b61", - "employee_email": "johndoe@gmail.com" - }, - "employee_limit": { - "id": "e1e2fef4-a1dd-4be2-8dd1-b0ab8ec29ff8", - "employment": 2, - "education": 1, - "professional_license": 0, - "all_county_criminal_search": true, - "county_criminal_search": 0, - "civil_court": 1, - "driving_license": 0, - "package_id": null, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-25T14:28:47.000Z", - "employee_invite_group_id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", - "employee_invite_group": { - "id": "b630d0ec-e8d6-49a0-bbf2-8fd26a791a85", - "package": "diamond", - "active": true, - "created_at": "2020-08-25T14:28:47.000Z", - "updated_at": "2020-08-25T14:28:47.000Z", - "company_created_by": "zed@max.com", - "package_id": "5" - } - }, - "kbaqna": { - "id": "71f4dda4-2949-4f23-97ae-26d158c082a2", - "access_id": "6e7d5f15-9456-430d-b9da-9df67a4d9996", - "email": "johndoe@gmail.com", - "questions_flag": 1, - "kba_enabled": 1, - "question_count": "5", - "correct_answers": "4", - "verified": false, - "created_at": "2020-08-25T15:06:19.000Z", - "updated_at": "2020-08-25T15:11:49.000Z", - "idm_session_id": "91b59885191b01f5", - "employee_email": "johndoe@gmail.com" +print(response.text) + +``` + +```ruby +require "uri" +require "json" +require "net/http" + +url = URI("https://api.us.springverify.com/company/webhook/logs") + +http = Net::HTTP.new(url.host, url.port); +request = Net::HTTP::Get.new(url) +request["Content-Type"] = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +response = http.request(request) +puts response.read_body + +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "logs": [ + { + "email": "johndoe@gmail.com", + "event_type": "overall_status_update", + "response": { + "code":200, + "description":"OK" + }, + "response_code": 200, + "curl": "curl \"https://webhook.site/be9bcd8c-c819-4b5a-9652-0984e6dfa282\" \\n-H \"cache-control: no-cache\" \\n-H \"content-type: application/json\" \\n-H \"secret-token: null\" \\n-H \"authorization: Bearer JWT_TOKEN\" \\n-H \"accept: application/json\" \\n--data-binary \"{\"\"data\"\":{\"\"employee_email\"\":\"\"johndoe@gmail.com\"\",\"\"overall_status\"\":\"\"PENDING\"\"},\"\"event_type\"\":\"\"overall_status_update\"\",\"\"company_id\"\":126}\" --compressed", + "id": "61026a761e331e43541d7925", + "created_at": "2021-07-29T08:44:38.242Z" + } + ], + "count": 1 + } +} +``` + +A company can get the logs of a registered webhook using this API. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| status | `string` | ALL/SUCCESS/ERROR | +| search | `string` | Search term which returns record after matching email of the candidate | +| limit | `integer` | Page Limit | +| offset | `integer` | Page Offset | + + + +--- + + +For a registered admin with a valid JWT, this API can be used to get the company's profile. This is different from the company details. A company's profile contains details of the company given during registration as well as the count of the candidates whose profiles were verified, failed, or is pending. + +## Payment For Invites + +```shell +curl --location --request POST 'https://api.us.springverify.com/payment/charge-user' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "id": "2612d112-5827-4b1c-a177-03a85eabd03d", + "send_email": true, + "coupon_code": "" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/payment/charge-user', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' }, - "employee_flow": { - "id": 289, - "employment_flow": "SUBMITTED", - "education_flow": "SUBMITTED", - "professional_license_flow": null, - "created_at": "2020-08-25T14:32:40.000Z", - "updated_at": "2020-08-26T07:36:45.000Z", - "employee_email": "johndoe@gmail.com" + body: JSON.stringify({ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }'; + +var options = { + url: 'https://api.us.springverify.com/payment/charge-user', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }'; +$response = Requests::post('https://api.us.springverify.com/payment/charge-user', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "id": "2612d112-5827-4b1c-a177-03a85eabd03d", "send_email": true, "coupon_code": "" }' + +response = requests.post('https://api.us.springverify.com/payment/charge-user', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/payment/charge-user") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +>Success Response + +```json +{ + "success": true, + "data": { + "id": "ch_1HJdvnFq1aDrrzKzZE6729eZ", + "object": "charge", + "amount": 9999, + "amount_refunded": 0, + "application": null, + "application_fee": null, + "application_fee_amount": null, + "balance_transaction": "txn_1HJdvnFq1aDrrzKzbZXCgvAO", + "billing_details": { + "address": { + "city": null, + "country": null, + "line1": null, + "line2": null, + "postal_code": "42424", + "state": null + }, + "email": null, + "name": "johndoe@gmail.com", + "phone": null + }, + "calculated_statement_descriptor": "SPRINGVERIFY.COM", + "captured": true, + "created": 1598268823, + "currency": "usd", + "customer": "cus_HjgWvwfPN7bKob", + "description": null, + "destination": null, + "dispute": null, + "disputed": false, + "failure_code": null, + "failure_message": null, + "fraud_details": {}, + "invoice": null, + "livemode": false, + "metadata": {}, + "on_behalf_of": null, + "order": null, + "outcome": { + "network_status": "approved_by_network", + "reason": null, + "risk_level": "normal", + "risk_score": 28, + "seller_message": "Payment complete.", + "type": "authorized" + }, + "paid": true, + "payment_intent": null, + "payment_method": "card_1HAD9gFq1aDrrzKzPZUtu418", + "payment_method_details": { + "card": { + "brand": "visa", + "checks": { + "address_line1_check": null, + "address_postal_code_check": "pass", + "cvc_check": null + }, + "country": "US", + "exp_month": 4, + "exp_year": 2024, + "fingerprint": "IpgpMeLB1qGPPEnT", + "funding": "credit", + "installments": null, + "last4": "4242", + "network": "visa", + "three_d_secure": null, + "wallet": null + }, + "type": "card" + }, + "receipt_email": "johndoe@gmail.com", + "receipt_number": null, + "receipt_url": "receipt_url_link", + "refunded": false, + "refunds": { + "object": "list", + "data": [], + "has_more": false, + "total_count": 0, + "url": "/v1/charges/ch_1HJdvnFq1aDrrzKzZE6729eZ/refunds" + }, + "review": null, + "shipping": null, + "source": { + "id": "card_1HAD9gFq1aDrrzKzPZUtu418", + "object": "card", + "address_city": null, + "address_country": null, + "address_line1": null, + "address_line1_check": null, + "address_line2": null, + "address_state": null, + "address_zip": "42424", + "address_zip_check": "pass", + "brand": "Visa", + "country": "US", + "customer": "cus_HjgWvwfPN7bKob", + "cvc_check": null, + "dynamic_last4": null, + "exp_month": 4, + "exp_year": 2024, + "fingerprint": "IygpMeLB1qGPPEnT", + "funding": "credit", + "last4": "4242", + "metadata": {}, + "name": "johndoe@gmail.com", + "tokenization_method": null + }, + "source_transfer": null, + "statement_descriptor": null, + "statement_descriptor_suffix": null, + "status": "succeeded", + "transfer_data": null, + "transfer_group": null + } +} +``` + +Once a candidate has been invited to get themselves verified, the verification must be paid for. This API is used for the payment purpose and must be called immediately after the [Invite Candidates](https://docs.us.springverify.com/#invite-candidates) API. Payments will be processed using the details from the [Save Credit Card in Stripe for Payments](https://docs.us.springverify.com/#save-credit-card-in-stripe-for-payments) API. The reference ID retrieved from the "Invite Candidates" API is used here. Emails to candidates requesting verification will be sent only after the payment is successful. + +If the `send_email` field is set to `false`, the API will return the verification links of the candidates in the response. + +If you have a coupon code you can enter it here. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| id | `string` | The reference ID retrieved from the [Invite Candidates](https://docs.us.springverify.com/#invite-candidates) API. | +| send_email | `boolean` | `true` -- sends emails to the candidates. | +| | | `false` -- returns the verifications links of the candidates. | +| coupon_code | `string` | (Optional) Any coupon code that the admin has for discounted pricing | + + +## Save payment info + +```shell +curl --location --request POST 'https://api.us.springverify.com/payment/save-card' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '{ + "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/payment/save-card', { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' }, - "s3_files": [ - { - "id": "0d81811f-4cb7-4d3e-875f-0e229ab98fa4", - "type": "ID", - "sub_type": "BACK", - "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", - "link": "link", - "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "status": null, - "comments": null, - "deleted_at": null, - "created_at": "2020-08-25T15:14:00.000Z", - "updated_at": "2020-08-25T15:14:00.000Z" - }, - { - "id": "3bf55d4f-6570-4d32-93ae-fc101677fce9", - "type": "ID", - "sub_type": "FRONT", - "relation_id": "c7509e8b-49bb-40df-bc80-609c4f460af8", - "link": "link", - "reference_id": "9ca37df2-1d81-40df-90aa-b88e081b8103", - "status": null, - "comments": null, - "deleted_at": null, - "created_at": "2020-08-25T15:14:00.000Z", - "updated_at": "2020-08-25T15:14:00.000Z" - } - ], - "criminal_statuses": [ - { - "id": "026c5a13-8112-40c7-8bba-39655a3f987a", - "type": "NATIONAL_CRIMINAL", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" - }, - { - "id": "0e9fb3d3-d464-4752-bc34-8537807482b9", - "type": "GLOBAL_WATCHLIST", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" - }, - { - "id": "2cf42d97-850f-4348-bac9-a7eacbe575b9", - "type": "SEX_OFFENDER", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" - }, - { - "id": "4b8e8f14-db92-476c-b2fb-bf9d054ad96e", - "type": "COUNTY_CRIMINAL_SEARCH", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" - }, - { - "id": "5d16c475-ba47-44fe-962c-a32dc26878c5", - "type": "CIVIL_COURT", - "status": "PENDING", - "source": "SYSTEM", - "employee_email_fk": "johndoe@gmail.com", - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z" - } - ], - "sjv_criminal_reports": [ - { - "id": "d18c1432-91be-4ce2-8f07-4bff6728850c", - "employee_email_fk": "johndoe@gmail.com", - "status": "NOT_INITIATED", - "sjv_search_type": "CIVIL_COURT_NOTIFICATION", - "reference_id": null, - "cic_criminal_record_fk": null, - "report_link": null, - "marked_done": 0, - "marked_reviewed": 0, - "county_id": null, - "adverse_action_fk": null, - "authenticating_unique_identifier": null, - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z", - "county_name": null, - "adverse_action": null - }, - { - "id": "fed50a2f-bc72-4d3b-99dd-5e5053304008", - "employee_email_fk": "johndoe@gmail.com", - "status": "NOT_INITIATED", - "sjv_search_type": "COUNTY_CRIMINAL_NOTIFICATION", - "reference_id": null, - "cic_criminal_record_fk": null, - "report_link": null, - "marked_done": 0, - "marked_reviewed": 0, - "county_id": null, - "adverse_action_fk": null, - "authenticating_unique_identifier": null, - "created_at": "2020-08-25T15:14:36.000Z", - "updated_at": "2020-08-25T15:14:36.000Z", - "county_name": null, - "adverse_action": null - } + body: JSON.stringify({ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var dataString = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }'; + +var options = { + url: 'https://api.us.springverify.com/payment/save-card', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'application/json', + 'Authorization' => 'Bearer JWT_TOKEN' +); +$data = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }'; +$response = Requests::post('https://api.us.springverify.com/payment/save-card', $headers, $data); +``` + +```python +import requests + +headers = { + 'Content-Type': 'application/json', + 'Authorization': 'Bearer JWT_TOKEN', +} + +data = '{ "source":"tok_1EkXOa4wweuFtc0nQd0eOOhs" }' + +response = requests.post('https://api.us.springverify.com/payment/save-card', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/payment/save-card") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": "card saved for the specified user" +} +``` + +To save the token received from the [Save Credit Card in Stripe for Payments](https://docs.us.springverify.com/#save-credit-card-in-stripe-for-payments), use this API. + + +## Search Candidate + +```shell +curl --location --request POST 'https://api.us.springverify.com/company/employee/search' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "search":"johndoe@gmail.com" +}' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/company/employee/search', { + method: 'POST', + headers: { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ "search":"johndoe@gmail.com" }) +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' +}; + +var dataString = '{ "search":"johndoe@gmail.com" }'; + +var options = { + url: 'https://api.us.springverify.com/company/employee/search', + method: 'POST', + headers: headers, + body: dataString +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' +); +$data = '{ "search":"johndoe@gmail.com" }'; +$response = Requests::post('https://api.us.springverify.com/company/employee/search', $headers, $data); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json', +} + +data = '{ "search":"johndoe@gmail.com" }' + +response = requests.post('https://api.us.springverify.com/company/employee/search', headers=headers, data=data) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/company/employee/search") +request = Net::HTTP::Post.new(uri) +request.content_type = "application/json" +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": [ + { + "id": "478543b4-43b0-45bd-82db-dc4ce0ff193c", + "email": "a13@yopmail.com", + "first_name": "Steven", + "middle_name": "Brandon", + "last_name": "Ward", + "status": "PENDING", + "employee_limit": { + "id": "63d34d43-794f-49c6-8de9-327935156076", + "employee_invite_group": { + "id": "c35d4851-8f23-4779-9310-a913bda6b1af", + "package": "bronze" + } + } + }, + { + "id": "f29aebee-df87-4cae-8779-7e6c48345d1d", + "email": "testdata1@yopmail.com", + "first_name": "Steven", + "middle_name": "Brandon", + "last_name": "Ward", + "status": null, + "employee_limit": { + "id": "149913a5-8bf1-4ca5-ba5b-3fb412cd68fa", + "employee_invite_group": { + "id": "f33cc6ab-c8d1-4535-b80a-b9f2cd45a319", + "package": "diamond" + } + } + } ] - } +} + +``` + +This API searches and retrieves the profile of a specific candidate that is already verified. + +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +| search | `string`| Search term which returns record after matching first name, middle name, last name or email | + +## Get Single Candidate + +```shell +curl --location --request GET 'https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID' \ +--header 'Authorization: Bearer JWT_TOKEN' \ +--data-raw '' +``` + +```javascript +// FETCH + +var fetch = require('node-fetch'); + +fetch('https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', { + method: 'POST', + headers: { + 'Authorization': 'Bearer JWT_TOKEN' + } +}); + +// REQUEST + +var request = require('request'); + +var headers = { + 'Authorization': 'Bearer JWT_TOKEN' +}; + +var options = { + url: 'https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', + method: 'POST', + headers: headers +}; + +function callback(error, response, body) { + if (!error && response.statusCode == 200) { + console.log(body); + } +} + +request(options, callback); +``` + +```php + 'Bearer JWT_TOKEN' +); +$data = array( + +); +$response = Requests::post('https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID', $headers, $data); +``` + +```python +import requests + +headers = { + 'Authorization': 'Bearer JWT_TOKEN', +} + +params = ( + ('id', 'EMPLOYEE_ID'), +) + +response = requests.post('https://api.us.springverify.com/company/employee', headers=headers, params=params) +``` + +```ruby +require 'net/http' +require 'uri' + +uri = URI.parse("https://api.us.springverify.com/company/employee?id=EMPLOYEE_ID") +request = Net::HTTP::Get.new(uri) +request["Authorization"] = "Bearer JWT_TOKEN" + +req_options = { + use_ssl: uri.scheme == "https", +} + +response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http| + http.request(request) +end + +# response.code +# response.body +``` + +> Success Response + +```json +{ + "success": true, + "data": { + "employee": { + "id": "6d6d81f5-6f00-4a38-a7d7-249cc2127ab6", + "access_id": null, + "email": "johndoe@gmail.com", + "password_hash": null, + "first_name": null, + "middle_name": null, + "last_name": null, + "name_verified": null, + "created_at": "2020-08-24T10:57:01.000Z", + "updated_at": "2020-08-24T10:57:01.000Z", + "employer_id": "fd725660-58f7-4a97-b626-5a4588e4ca31", + "payment_id": "0e9a7695-91bd-4e60-aefc-ba47f80ab0f0", + "email_sent": true, + "payment": false, + "status": null, + "flow_completed": null, + "company_created_by": "john@wick.com", + "employee_limit_id": "bd95351f-fc2a-4ff9-8652-88abbfe67bdd", + "kbaqna": null, + "employments": [], + "education": [], + "professional_licenses": [], + "employee_limit": { + "id": "bd95351f-fc2a-4ff9-8652-88abbfe67bdd", + "employment": 2, + "education": 1, + "professional_license": 0, + "all_county_criminal_search": true, + "county_criminal_search": 0, + "civil_court": 1, + "driving_license": 0, + "package_id": null, + "created_at": "2020-08-24T10:57:01.000Z", + "updated_at": "2020-08-24T10:57:01.000Z", + "employee_invite_group_id": "4153a150-4157-48ab-b258-9a9b47a05fc2", + "employee_invite_group": { + "id": "4153a150-4157-48ab-b258-9a9b47a05fc2", + "package": "diamond", + "active": true, + "created_at": "2020-08-24T10:57:00.000Z", + "updated_at": "2020-08-24T10:57:00.000Z", + "company_created_by": "john@wick.com", + "package_id": "5" + } + }, + "employee_detail": null, + "employee_verification": null, + "s3_files": [], + "criminal_statuses": [], + "cic_criminal_records": [], + "sjv_criminal_reports": [] + }, + "review": [], + "criminal_status": { + "national_criminal": "PENDING", + "sex_offender": "PENDING", + "global_watchlist": "PENDING", + "county_criminal_search": "PENDING", + "civil_court": "PENDING", + "overall_criminal_status": "PENDING" + } + } } ``` -This API is used to let the system know that candidate form has been submitted successfully. +When the details of a specific candidate whose profile is already verified is to be retrieved, use this API. This API retrieves the details of the candidate that have been verified, as well as the pricing package in which the candidate's profile was verified, along with the date of the most recent verification. -## Candidate Login +**URL Parameters** + +| Parameter | Type | Description | +| --- | --- | --- | +|id | `uuid` | Contains the unique ID of the candidate. | + +## Get company action ```shell -curl --location --request POST 'https://api.us.springverify.com/auth/login' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'https://api.us.springverify.com/company/actions' \ --header 'Authorization: Bearer JWT_TOKEN' \ +--header 'Content-Type: application/json' \ --data-raw '{ - "email": "john@wick.com", - "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", - "role":"employee" + "limit":10, + "offset":0 }' ``` @@ -9113,13 +11386,13 @@ curl --location --request POST 'https://api.us.springverify.com/auth/login' \ var fetch = require('node-fetch'); -fetch('https://api.us.springverify.com/auth/login', { +fetch('https://api.us.springverify.com/company/actions', { method: 'POST', headers: { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' }, - body: JSON.stringify({ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }) + body: JSON.stringify({ "limit":10, "offset":0 }) }); // REQUEST @@ -9127,14 +11400,14 @@ fetch('https://api.us.springverify.com/auth/login', { var request = require('request'); var headers = { - 'Content-Type': 'application/json', - 'Authorization': 'Bearer JWT_TOKEN' + 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json' }; -var dataString = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }'; +var dataString = '{ "limit":10, "offset":0 }'; var options = { - url: 'https://api.us.springverify.com/auth/login', + url: 'https://api.us.springverify.com/company/actions', method: 'POST', headers: headers, body: dataString @@ -9154,31 +11427,31 @@ request(options, callback); include('vendor/rmccue/requests/library/Requests.php'); Requests::register_autoloader(); $headers = array( - 'Content-Type' => 'application/json', - 'Authorization' => 'Bearer JWT_TOKEN' + 'Authorization' => 'Bearer JWT_TOKEN', + 'Content-Type' => 'application/json' ); -$data = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }'; -$response = Requests::post('https://api.us.springverify.com/auth/login', $headers, $data); +$data = '{ "limit":10, "offset":0 }'; +$response = Requests::post('https://api.us.springverify.com/company/actions', $headers, $data); ``` ```python import requests headers = { - 'Content-Type': 'application/json', 'Authorization': 'Bearer JWT_TOKEN', + 'Content-Type': 'application/json', } -data = '{ "email": "john@wick.com", "password": "daaad6e5604e8e17bd9f108d91e26afe6281dac8fda0091040a7a6d7bd9b43b5", "role":"employee" }' +data = '{ "limit":10, "offset":0 }' -response = requests.post('https://api.us.springverify.com/auth/login', headers=headers, data=data) +response = requests.post('https://api.us.springverify.com/company/actions', headers=headers, data=data) ``` ```ruby require 'net/http' require 'uri' -uri = URI.parse("https://api.us.springverify.com/auth/login") +uri = URI.parse("https://api.us.springverify.com/company/actions") request = Net::HTTP::Post.new(uri) request.content_type = "application/json" request["Authorization"] = "Bearer JWT_TOKEN" @@ -9199,49 +11472,109 @@ end ```json { - "success": true, - "data": { - "success": true, - "success_msg": "employee logged in successfully", - "data": { - "token": "JWT_TOKEN" - } + "success": true, + "data": [ + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T05:59:02.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T05:59:02.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T05:59:02.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "has successfully verified their identity. (using their driving license)", + "time": "2020-08-27T05:57:03.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "has uploaded their driving license.", + "time": "2020-08-27T05:56:44.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "has entered personal details.", + "time": "2020-08-27T05:55:40.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "has been added as a candidate and invited to enter his information.", + "time": "2020-08-27T05:54:24.000Z", + "id": "9282698a-72ac-49df-a750-85c169bfe08e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T04:29:02.000Z", + "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T04:29:02.000Z", + "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" + }, + { + "string": "identity verification failed. (using their driving license)", + "time": "2020-08-27T04:29:02.000Z", + "id": "8bf63c9a-b89c-4dff-a03c-0d571dc4c47e", + "first_name": "John", + "middle_name": "Mark", + "last_name": "Smith", + "email": "johndoe@gmail.com" } + ] } ``` -> Error Response: - -```json -{ - "errors": [ - { - "value": "", - "msg": "Not a valid role", - "param": "role", - "location": "body" - } - ] -} -``` - -For logging in, the aim is to generate a JSON web token that is to be used in all subsequent API calls. The JWT generated will be valid for one hour. - -To call the subsequent APIs, the candidate will need to send the JWT successfully in the header of those APIs. - - - -**URL Parameters** - -| Parameter | Type | Description | -| --- | --- | --- | -| email | `string` | The email address used by the candidate to register with SpringVerify. | -| password | `string` | The password used by the candidate to register with SpringVerify. (Hashed, 8 characters minimum). | -| role | `string` | The role of the user being logged in - in this case, `employee`. | +This API informs an admin/s of the activities of a specific candidate in the following scenarios: ---- +* The candidate has been invited to provide their information to initiate the verification. +* The candidate has entered their personal information. +* The candidate has successfully uploaded their driver's license. +* The candidate has successfully verified their identity using their driver's license. +* The candidate has failed to verify their identity using their driver's license. # Changelog