InfoVetted (Preview)

InfoVetted’s employment background screening solution streamlines candidate and employee verification by enabling efficient contact and screening requests, helping organisations stay compliant and make informed hiring decisions.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | InfoVetted |
URL | https://infovetted.com |
info@infovetted.com |
Connector Metadata | |
---|---|
Publisher | InfoVetted |
Website | https://www.infovetted.com |
Privacy policy | https://www.infovetted.com/privacy-policy |
Categories | Security;Business Management |
InfoVetted Vetting Connector
InfoVetted provides a connector to perform employment vetting on candidates and employees such as Identity Verification (IDV), Right to Work (RTW), Criminal - Disclosure & Barring Service (DBS) and finanical background checks.
The connector also supports querying the status of a requested check and downloading the vetting results as a PDF.
Publisher: InfoVetted
Prerequisites
- API key is required, must sign up and registered your business at InfoVetted to use the connector.
Supported Operations
The connector supports the following operations:
GetAllVettingRequests
GetVettingRequestsByContactId
CreateContactVettingRequest
Request a vetting check. The following check types are available:
- RightToWork
- StandardDBS
- EnhancedDBS
- BasicDBS
- WorkHistory3years
- WorkHistory5years
If requesting a DBS vetting check use one of the following employment sectors
Employment Sectors
- AcademyEducation
- AccommodationAndFoodService
- AdministrativeAndSupport
- Agriculture
- ArtsAndEntertainment
- CentralGovernment
- ChildCare
- Construction
- Drivers
- EnergyAndAirConditioning
- FinancialAndInsurance
- ForestryAndFishing
- FosterAdoption
- FurtherEducation
- HigherEducation
- IndependentEducation
- InformationAndCommunication
- LawEnforcementAndSecurity
- LeisureSportAndTourism
- LocalGovernment
- Manufacturing
- MiningAndQuarrying
- NHS
- PreschoolEducation
- PrimaryEducation
- PrivateHealthcare
- ProfessionalTechnical
- PublicSectorOther
- RealEstateActivities
- RecruitmentAndHR
- Retail
- SecondaryEducation
- SocialCare
- TradeOrRepairOfVehicles
- TransportationAndStorage
- VoluntaryCharity
- WaterAndWasteManagement
Vetting status updates will be sent to the (optional) webhook address provided in the following format
Webhook POST payload JSON:
{
"CheckId": "",
"Status": "",
"StatusDescription": ""
}
Statuses:
- NotStarted,
- InProgress,
- Complete,
- Deleted,
- PendingApproval,
- Rejected,
- Expired,
- Archived,
- Unknown
CancelAnExistingVettingRequest
Vetting Status
Returns the vetting status of the requested check
Statuses:
- NotStarted,
- InProgress,
- Complete,
- Deleted,
- PendingApproval,
- Rejected,
- Expired,
- Archived,
- Unknown
PDF Export
Returns a PDF result for the completed vetting
CreateContact
Creates a contact to be vetted
GetContact
Gets the contact
UpdateContact
Update the contact
GetAllContacts
Get a list of all the contacts
GetAssignedGroupsForContact
Return a list of groups that the contact belongs to
GetContactGroup
Get a contact group
CreateContactGroup
Create a contact group
UpdateContactGroup
Update a contact group
GetAllContactGroups
Get all contact groups
DeleteContactGroup
Delete a contact group
AddContactToContactGroup
Add a contact to a group
RemoveContactFromContactGroup
Remove a contact from a group
Obtaining Credentials
Your API Key can be obtained within the InfoVetted portal under Settings => API Keys => Primary Key.
You must have an active subscription for the relevant product or have invoicing enabled
Known Issues and Limitations
No known issues
Support
For any questions please contact InfoVetted Ltd here or fire an email to info@infovetted.com
Deployment Instructions
Please use these instructions to deploy this connector as custom connector in Microsoft Power Automate and Power Apps
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
apiKeyHeader | securestring | The apiKeyHeader for this api | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Add a contact to a contact group |
This endpoint adds an existing contact to a specific contact group. |
Cancel an Exisitng vetting request |
This endpoint cancels an existing vetting request. |
Create a new contact |
This endpoint creates a new contact based on input parameters. |
Create a new contact group |
This endpoint creates a new contact group with the provided name. |
Create a new contact vetting request |
This endpoint creates a new vetting request for a contact. |
Delete a contact group |
This endpoint deletes a contact group by its ID. |
Export check result as a PDF |
This endpoint generates and exports a PDF document for the given check identified by the VettingRequestId parameter. |
Get all vetting requests |
This endpoint retrieves all vetting requests with optional pagination parameters. |
Get the vetting status for a given vetting |
This endpoint returns the vetting status of a given check identified by the VettingRequestId parameter. |
Get vetting requests by contact ID |
This endpoint retrieves vetting requests associated with a specific contact ID. |
Remove a contact from a contact group |
This endpoint removes an existing contact from a specific contact group. |
Retrieve a contact group |
This endpoint retrieves details of a specific contact group by ID. |
Retrieve all contact groups |
This endpoint retrieves all contact groups associated with the subscription. |
Retrieve all contacts |
This endpoint retrieves all contacts with optional pagination. |
Retrieve assigned groups for a contact |
This endpoint retrieves groups assigned to a specific contact by ID. |
Retrieve contact details |
This endpoint retrieves details of a contact by its ID. |
Update an existing contact group |
This endpoint updates the details of an existing contact group by ID. |
Update contact details |
This endpoint updates details of an existing contact. |
Add a contact to a contact group
This endpoint adds an existing contact to a specific contact group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
contactGroupId
|
contactGroupId | string | ||
contactId
|
contactId | string |
Returns
- response
- object
Cancel an Exisitng vetting request
This endpoint cancels an existing vetting request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
vettingRequestId
|
vettingRequestId | integer |
Returns
Create a new contact
This endpoint creates a new contact based on input parameters.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
firstName
|
firstName | string | ||
lastName
|
lastName | string | ||
email
|
string | |||
phoneNumber
|
phoneNumber | string |
Returns
- Body
- contactResponse
Create a new contact group
This endpoint creates a new contact group with the provided name.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
name
|
name | string |
Returns
Create a new contact vetting request
This endpoint creates a new vetting request for a contact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
CheckType
|
CheckType | string |
The check type for the vetting request. |
|
contactId
|
contactId | string | ||
yourReference
|
yourReference | string | ||
NotifyContactPreference
|
NotifyContactPreference | string | ||
webhookUrl
|
webhookUrl | string | ||
identityVerified
|
identityVerified | boolean | ||
identityVerifiedBy
|
identityVerifiedBy | string | ||
jobTitleOfIndividual
|
jobTitleOfIndividual | string | ||
EmploymentSector
|
EmploymentSector | string | ||
isVolunteer
|
isVolunteer | boolean | ||
isWorkingWithVulnerableAdults
|
isWorkingWithVulnerableAdults | boolean | ||
isWorkingWithChildren
|
isWorkingWithChildren | boolean | ||
hasIndividualsAddressBeenChecked
|
hasIndividualsAddressBeenChecked | boolean | ||
isWorkingAtVulnerablePersonsHomeAddress
|
isWorkingAtVulnerablePersonsHomeAddress | boolean |
Returns
- Body
- vettingResponse
Delete a contact group
This endpoint deletes a contact group by its ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
contactGroupId
|
contactGroupId | string |
Returns
- response
- object
Export check result as a PDF
This endpoint generates and exports a PDF document for the given check identified by the VettingRequestId parameter.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
VettingRequestId parameter
|
VettingRequestId | True | string |
The VettingRequestId parameter, which is a unique identifier for the vettingRequest. |
Returns
Get all vetting requests
This endpoint retrieves all vetting requests with optional pagination parameters.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Sort direction
|
Direction | string |
Sort direction, e.g., 'asc' or 'desc'. |
|
Pagination offset
|
Offset | integer |
Format - int32. Pagination offset. |
|
Pagination limit
|
Limit | integer |
Format - int32. Pagination limit. |
Returns
Get the vetting status for a given vettingRequestId
This endpoint returns the vetting status of a given check identified by the VettingRequestId parameter.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
VettingRequestId parameter
|
VettingRequestId | True | integer |
Format - int32. The VettingRequestId parameter, which is a unique identifier for the check. |
Returns
Get vetting requests by contact ID
This endpoint retrieves vetting requests associated with a specific contact ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact Id - Format - uuid
|
ContactId | True | uuid |
Format - uuid. Unique identifier of the contact. |
Sort direction
|
Direction | string |
Sort direction, e.g., 'asc' or 'desc'. |
|
Pagination offset
|
Offset | integer |
Format - int32. Pagination offset. |
|
Pagination limit
|
Limit | integer |
Format - int32. Pagination limit. |
Returns
Remove a contact from a contact group
This endpoint removes an existing contact from a specific contact group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
contactGroupId
|
contactGroupId | string | ||
contactId
|
contactId | string |
Returns
Retrieve a contact group
This endpoint retrieves details of a specific contact group by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The ContactGroupId. Format - uuid
|
ContactGroupId | True | uuid |
Format - uuid. The unique identifier of the contact group. |
Returns
Retrieve all contact groups
This endpoint retrieves all contact groups associated with the subscription.
Returns
Retrieve all contacts
This endpoint retrieves all contacts with optional pagination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Sort direction (asc or desc)
|
Direction | string |
Sort direction (asc or desc). |
|
Offset - int32. Pagination offset
|
Offset | integer |
Format - int32. Pagination offset. |
|
Pagination limit
|
Limit | integer |
Format - int32. Pagination limit. |
Returns
- Body
- allContactsResponse
Retrieve assigned groups for a contact
This endpoint retrieves groups assigned to a specific contact by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
contactId
|
ContactId | True | uuid |
Format - uuid. The unique identifier of the contact. |
Returns
Retrieve contact details
This endpoint retrieves details of a contact by its ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Contact id. Format - uuid
|
ContactId | True | uuid |
Format - uuid. The unique identifier of the contact. |
Returns
- Body
- getContactResponse
Update an existing contact group
This endpoint updates the details of an existing contact group by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
contactGroupId
|
contactGroupId | string | ||
name
|
name | string |
Returns
Update contact details
This endpoint updates details of an existing contact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
firstName
|
firstName | string | ||
lastName
|
lastName | string | ||
email
|
string | |||
phoneNumber
|
phoneNumber | string | ||
contactId
|
contactId | string |
Returns
- Body
- getContactResponse
Definitions
allContactsResponse
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of getContactResponse | |
totalItems
|
totalItems | integer |
cancelVettingResponse
Name | Path | Type | Description |
---|---|---|---|
succeeded
|
succeeded | boolean | |
code
|
code | string | |
traceId
|
traceId | string |
checkResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer | |
firstName
|
firstName | string | |
surname
|
surname | string | |
dateOfBirth
|
dateOfBirth | string | |
email
|
string | ||
phoneNumber
|
phoneNumber | string | |
reference
|
reference | string | |
createdDateTime
|
createdDateTime | string | |
checkType
|
checkType | string | |
contactId
|
contactId | string | |
latestVettingStatus
|
latestVettingStatus | string | |
vettingStatuses
|
vettingStatuses | array of vettingStatusViewModel |
contactResponse
Name | Path | Type | Description |
---|---|---|---|
isDuplicate
|
isDuplicate | boolean | |
message
|
message | string | |
contactId
|
contactId | string | |
firstName
|
firstName | string | |
lastName
|
lastName | string | |
email
|
string | ||
phoneNumber
|
phoneNumber | string |
createContactGroupResponse
Name | Path | Type | Description |
---|---|---|---|
contactGroupId
|
contactGroupId | string | |
name
|
name | string | |
createdDateTime
|
createdDateTime | string |
getAllContactGroupsResponse
Name | Path | Type | Description |
---|---|---|---|
totalCount
|
totalCount | integer | |
contactGroups
|
contactGroups | array of getContactGroupResponse |
getAllVettingRequestsResponse
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of checkResponse | |
totalItems
|
totalItems | integer |
getAssignedGroupsForContactResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
name
|
name | string | |
createdDate
|
createdDate | string |
getContactGroupResponse
Name | Path | Type | Description |
---|---|---|---|
contactGroupId
|
contactGroupId | string | |
name
|
name | string | |
createdTime
|
createdTime | string | |
count
|
count | integer |
getContactResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
firstName
|
firstName | string | |
lastName
|
lastName | string | |
email
|
string | ||
phoneNumber
|
phoneNumber | string | |
registrationAccepted
|
registrationAccepted | boolean | |
acceptedRegistrationDate
|
acceptedRegistrationDate | string | |
recordCreationSource
|
recordCreationSource | string | |
createdDateTime
|
createdDateTime | string | |
updatedDateTime
|
updatedDateTime | string |
removeContactFromContactGroupResponse
Name | Path | Type | Description |
---|---|---|---|
contactListId
|
contactListId | string | |
contactId
|
contactId | string |
updateContactGroupResponse
Name | Path | Type | Description |
---|---|---|---|
contactGroupId
|
contactGroupId | string | |
name
|
name | string | |
createdTime
|
createdTime | string | |
count
|
count | integer |
vettingRequestRecordReferenceResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer | |
checkType
|
checkType | string |
vettingResponse
Name | Path | Type | Description |
---|---|---|---|
succeeded
|
succeeded | boolean | |
vettingRequestRecordReferences
|
vettingRequestRecordReferences | array of vettingRequestRecordReferenceResponse | |
code
|
code | string | |
traceId
|
traceId | string |
vettingStatusResponse
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string | |
latestVettingStatusDescription
|
latestVettingStatusDescription | string |
vettingStatusViewModel
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string | |
createdDateTime
|
createdDateTime | string |
PDFExportGet200ApplicationJsonResponse
getAssignedGroupsForContactResponseArray
Name | Path | Type | Description |
---|---|---|---|
Items
|
getAssignedGroupsForContactResponse |
object
This is the type 'object'.