{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"847d1f9c-897c-450b-8e5f-bdfc229caa0c","name":"InfoVetted Employment Screening OpenAPI","description":"The **InfoVetted Employment Screening API** enables businesses to streamline their background screening and contact management processes. It provides robust endpoints for managing vetting requests, contact information, and contact groups. The API is designed for seamless integration into your systems, ensuring secure and efficient data handling for employment screening and related workflows.\n\n### **Key Features**\n\n1. **Vetting Management**:\n    \n    - Create, retrieve, and manage background vetting requests.\n        \n    - Track vetting statuses and export results as PDFs.\n        \n2. **Contact Management**:\n    \n    - Add, update, and retrieve contact information.\n        \n    - List all contacts with optional pagination for large datasets.\n        \n3. **Group Management**:\n    \n    - Create and manage groups of contacts.\n        \n    - Assign contacts to groups or remove them as needed.\n        \n4. **Secure Access**:\n    \n    - Protect API access with API keys, ensuring secure integration.\n        \n\n### **Getting Started**\n\nTo use the API, you’ll need an **API Key** for authentication. Follow these steps to get started:\n\n1. **Find Your API Key**:\n    \n    - Log in to the **Customer Portal**.\n        \n    - Navigate to **Integrations** → **API Keys** tab.\n        \n    - Copy the API key provided for your account.\n        \n2. **Authenticate Requests**:\n    \n    - Include your API key in the request header or query parameters:\n        \n        - Header: `X-API-Key:`\n            \n        - Query Parameter: `?x-api-key=`\n            \n3. **Explore the Endpoints**:\n    \n    - Use the endpoints for Vetting, Contact, and ContactGroup to integrate with your system.\n        \n    - Refer to the detailed documentation for request parameters and responses.\n        \n\n### **Base URL**\n\nThe API is hosted at:\n\n```\nhttps://api.infovetted.com/vetting/v1\n\n ```\n\n## Webhooks\n\nWe notify you whenever one of your checks changes status, so you do not have to\npoll. Send `WebhookUrl` when you create a check to receive notifications for that\ncheck alone, or configure an account-level URL in the portal to receive them for\nevery check. A per-check URL takes precedence. HTTPS only: we will not deliver to\na plain HTTP endpoint.\n\n### What we send\n\n```json\n{\n  \"eventId\": \"88e88041-8601-536e-ba66-7bc801596b58\",\n  \"checkReference\": \"f2a3d54b-2529-430c-9059-4261332df2f3\",\n  \"status\": 2,\n  \"statusName\": \"Complete\",\n  \"outcome\": \"Pass\",\n  \"reviewReason\": null,\n  \"occurredAt\": \"2026-09-21T23:23:51.4047337Z\"\n}\n```\n\n| Field | Meaning |\n| --- | --- |\n| `eventId` | Identifies the event, not the delivery. Deduplicate on it. |\n| `checkReference` | The check. Pass it to any endpoint here to fetch the detail. |\n| `status` | Where the check has reached, as a number. |\n| `statusName` | The same status by name. |\n| `outcome` | `Pass`, `Fail` or `Review`. Null until the check has a verdict. |\n| `reviewReason` | Present only when the outcome is `Review`, and says who must act. |\n| `occurredAt` | When the change happened, not when we sent it. |\n\nThe payload carries no personal data. Use `checkReference` to fetch what you need.\n\n### Deduplicating\n\n`eventId` is derived from the change itself rather than generated per delivery, so\na notification we send more than once carries the same id and you can safely\ndiscard the repeat. A verdict is part of that change: a check that completes and is\ngiven an outcome later produces two events with different ids, and both matter.\n\n### Retries\n\nWe treat any 2xx as delivered. Anything else is retried up to 8 times in total,\nover roughly two days:\n\nimmediately, then after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours,\n12 hours and 24 hours.\n\nEach attempt waits up to 10 seconds for your endpoint. Delays carry a small random\noffset so that a batch failing together does not return as one burst. Reply `429`\nwith a `Retry-After` header and we will wait as long as you ask, within reason.\nReply `410 Gone` and we will stop sending for that check and not retry.\n\nNotifications are not ordered. Use `occurredAt` if sequence matters to you.\n\nContact Support:\n Name: InfoVetted\n Email: info@infovetted.com","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"40052116","team":6640213,"collectionId":"847d1f9c-897c-450b-8e5f-bdfc229caa0c","publishedId":"2sBYB4M75a","public":true,"publicUrl":"https://docs.infovetted.com","privateUrl":"https://go.postman.co/documentation/40052116-847d1f9c-897c-450b-8e5f-bdfc229caa0c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"84cc2b"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"InfoVetted Employment Screening OpenAPI for customers\n"},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ec3159e1-7261-4bd2-bf7b-e158ea190b65/SW5mb1ZldHRlZCBNYWluIExvZ28gODAweDYwMC5qcGc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"84cc2b"}},{"name":"light","logo":"https://content.pstmn.io/ec3159e1-7261-4bd2-bf7b-e158ea190b65/SW5mb1ZldHRlZCBNYWluIExvZ28gODAweDYwMC5qcGc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"84cc2b"}}]}},"version":"8.12.12","publishDate":"2026-09-29T13:29:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"InfoVetted Employment Screening OpenAPI for customers\n"},"logos":{"logoLight":"https://content.pstmn.io/ec3159e1-7261-4bd2-bf7b-e158ea190b65/SW5mb1ZldHRlZCBNYWluIExvZ28gODAweDYwMC5qcGc=","logoDark":"https://content.pstmn.io/ec3159e1-7261-4bd2-bf7b-e158ea190b65/SW5mb1ZldHRlZCBNYWluIExvZ28gODAweDYwMC5qcGc="}},"statusCode":200},"environments":[],"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/045f52c01facc3435aced1c81fafbf606622c009aded10ff0f19d2fadd983f5b","favicon":"https://infovetted.com/favicon.ico"},"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"}],"canonicalUrl":"https://docs.infovetted.com/view/metadata/2sBYB4M75a"}