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.
\nVetting Management:
\nCreate, retrieve, and manage background vetting requests.
\nTrack vetting statuses and export results as PDFs.
\nContact Management:
\nAdd, update, and retrieve contact information.
\nList all contacts with optional pagination for large datasets.
\nGroup Management:
\nCreate and manage groups of contacts.
\nAssign contacts to groups or remove them as needed.
\nSecure Access:
\nTo use the API, you’ll need an API Key for authentication. Follow these steps to get started:
\nFind Your API Key:
\nLog in to the Customer Portal.
\nNavigate to Integrations → API Keys tab.
\nCopy the API key provided for your account.
\nAuthenticate Requests:
\nInclude your API key in the request header or query parameters:
\nHeader: X-API-Key:
Query Parameter: ?x-api-key=
Explore the Endpoints:
\nUse the endpoints for Vetting, Contact, and ContactGroup to integrate with your system.
\nRefer to the detailed documentation for request parameters and responses.
\nThe API is hosted at:
\nhttps://api.infovetted.com/vetting/v1\n\nThis endpoint returns the vetting status of a given check identified by the VettingRequestId parameter.
\n","urlObject":{"path":["VettingStatus"],"host":["https://api.infovetted.com/vetting/v1"],"query":[{"description":{"content":"(Required) The VettingRequestId parameter, which is a unique identifier for the check.
\n","type":"text/plain"},"key":"VettingRequestId","value":"This endpoint generates and exports a PDF document for the given check identified by the VettingRequestId parameter.
\n","urlObject":{"path":["PDFExport"],"host":["https://api.infovetted.com/vetting/v1"],"query":[{"description":{"content":"(Required) The VettingRequestId parameter, which is a unique identifier for the vettingRequest.
\n","type":"text/plain"},"key":"VettingRequestId","value":"This endpoint cancels an existing vetting request.
\n","urlObject":{"path":["CancelAnExistingVettingRequest"],"host":["https://api.infovetted.com/vetting/v1"],"query":[],"variable":[]}},"response":[{"id":"b02d1534-0be0-4715-a8f2-c21026c16e1f","name":"The OK response containing the result of the process check.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"This endpoint creates a new vetting request for a contact.
\n","urlObject":{"path":["CreateContactVettingRequest"],"host":["https://api.infovetted.com/vetting/v1"],"query":[],"variable":[]}},"response":[{"id":"8d4ec5fc-cfce-4cd5-8044-63c007b9f88d","name":"The OK response containing the result of the vetting request creation.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"This endpoint retrieves vetting requests associated with a specific contact ID.
\n","urlObject":{"path":["GetVettingRequestsByContactId"],"host":["https://api.infovetted.com/vetting/v1"],"query":[{"description":{"content":"(Required) Unique identifier of the contact.
\n","type":"text/plain"},"key":"ContactId","value":"Sort direction, e.g., 'asc' or 'desc'.
\n","type":"text/plain"},"key":"Direction","value":"Pagination offset.
\n","type":"text/plain"},"key":"Offset","value":"Pagination limit.
\n","type":"text/plain"},"key":"Limit","value":"This endpoint retrieves all vetting requests with optional pagination parameters.
\n","urlObject":{"path":["GetAllVettingRequests"],"host":["https://api.infovetted.com/vetting/v1"],"query":[{"description":{"content":"Sort direction, e.g., 'asc' or 'desc'.
\n","type":"text/plain"},"key":"Direction","value":"Pagination offset.
\n","type":"text/plain"},"key":"Offset","value":"Pagination limit.
\n","type":"text/plain"},"key":"Limit","value":"The Vetting API section provides endpoints to manage and track background vetting requests. These endpoints allow you to:
\nRetrieve vetting requests associated with specific contacts.
\nExport vetting request results as PDF documents.
\nCheck the status of ongoing or completed vetting requests.
\nSubmit new vetting requests for contacts.
\nCancel existing vetting requests.
\nThese endpoints are essential for managing background checks and tracking their progress.
\n","_postman_id":"4426c8c9-8408-4e81-b273-b609dd4f3995","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{X-API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"aee2bf8c-2363-4ed8-bf5c-63c67c756d1d","id":"aee2bf8c-2363-4ed8-bf5c-63c67c756d1d","name":"InfoVetted Employment Screening OpenAPI","type":"collection"}}},{"name":"Contacts","item":[{"name":"Update contact details","id":"738f2f0a-9622-4bea-a5e5-c70068ee31ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"This endpoint updates details of an existing contact.
\n","urlObject":{"path":["UpdateContact"],"host":["https://api.infovetted.com/vetting/v1"],"query":[],"variable":[]}},"response":[{"id":"f068217f-f7e2-4a5c-9700-f1bf62557a2b","name":"The OK response containing updated contact details.","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"