{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6f5f88be-2ea6-402e-9e60-274973306409","name":"CREDCHECK.PRO - APIs","description":"Welcome to the CredCheck.Pro API Documentation. The endpoints outlined here allow you to initiate background verification for candidates and retrieve their verification reports.\n\nThe CredCheck.Pro API is built around REST principles. It features predictable resource-oriented URLs, accepts JSON-formatted request bodies, returns JSON responses, and adheres to standard HTTP authentication, response codes, and methods.\n\n## **Getting started guide**\n\n**Pre-requisites**\n\n- The user must be registered with CredCheck.Pro. If you are not registered, please contact [sales@credcheck.pro](https://mail:sales@credcheck.pro). or purchase a plan from [https://credcheck.pro/#pricing](https://credcheck.pro/#pricing)\n    \n- The user should have generated an API KEY from the CredCheck.Pro dashboard. Steps to create the API token from the dashboard are provided below.\n    \n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n    \n- The API only responds to HTTP communications. Any requests sent via HTTPS return an Error 500.\n    \n- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n    \n\n**Steps to Generate API Key :**\n\n1. Sign in to **CredCheck.Pro**.\n    \n2. From the \"My Account\" button in the top-right corner, go to **CredCheck.Pro/Dashboard**.\n    \n3. Navigate to the **Account** tab.\n    \n4. Under the **Developer Information** tab, click on the **Generate** **API Key**.\n    \n5. Copy the generated API Key and Client ID and use it to call the APIs listed below.\n    \n\n## Authentication\n\nCredCheck.Pro uses API key & Client ID for authentication. You can generate a CredCheck.Pro API key as described above. Client ID is auto generated and unique to each individual account.\n\nYou must include an API key & Client ID in each request to the CredCheck.Pro with the \"apikey\" header for API Key and \"clientid\" header for Client ID.\n\n### Authentication error response\n\nIf an API key or Client ID is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 15 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |\n\n### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, on mail at [support@credcheck.pro](https://mailto:support@credcheck.pro)\n\n### **Need some help?**\n\nIn case you have questions, you can contact us at [dev@credcheck.pro](https://mailto:dev@credcheck.pro). Remember to include your client id in email.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"20904036","collectionId":"6f5f88be-2ea6-402e-9e60-274973306409","publishedId":"2sAXxMeY2u","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20904036/2sAXxMeY2u","privateUrl":"https://go.postman.co/documentation/20904036-6f5f88be-2ea6-402e-9e60-274973306409","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7434db"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"## Introduction Welcome to CredCheck.Pro API Documentation. The endpoints exposed in this documentation are to initiate background verification of a candidate and query the verification report. The CredCheck.Pro API is organized around REST."},{"name":"title","value":"CredCheck.Pro - APIs"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/cccdca0f-2e2e-4ded-ae38-7c9844ecff4c/Q3JlZENoZWNrLlBybyBsb2dvLTMucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"7434db"}},{"name":"light","logo":"https://content.pstmn.io/da4ab4dc-ac72-45cf-a8f4-fa581e6cdc24/Q3JlZENoZWNrLlBybyBsb2dvLTUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7434db"}}]}},"version":"8.10.1","publishDate":"2024-10-04T10:33:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"CredCheck.Pro - APIs","description":"## Introduction Welcome to CredCheck.Pro API Documentation. The endpoints exposed in this documentation are to initiate background verification of a candidate and query the verification report. The CredCheck.Pro API is organized around REST."},"logos":{"logoLight":"https://content.pstmn.io/da4ab4dc-ac72-45cf-a8f4-fa581e6cdc24/Q3JlZENoZWNrLlBybyBsb2dvLTUucG5n","logoDark":"https://content.pstmn.io/cccdca0f-2e2e-4ded-ae38-7c9844ecff4c/Q3JlZENoZWNrLlBybyBsb2dvLTMucG5n"}},"statusCode":200},"environments":[{"name":"Production","id":"e9585d3e-1844-404a-bca5-2a1e87d23a6a","owner":"20904036","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"20904036-e9585d3e-1844-404a-bca5-2a1e87d23a6a"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXxMeY2u"}