InfoVetted (Certified connector) (#3521)
* InfoVetted Certified connector * Update Title and other errors * Update ReadMe * Update ReadMe
This commit is contained in:
Stephen
GitHub
Родитель
9f17809da7
Коммит
82b1faef92
|
|
@ -0,0 +1,394 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "InfoVetted",
|
||||
"version": "v1",
|
||||
"description": "Info Vetted's Right to Work and DBS Checks",
|
||||
"contact": {
|
||||
"name": "Info Vetted Support",
|
||||
"email": "info@infovetted.com"
|
||||
}
|
||||
},
|
||||
"host": "infovetted-api.azure-api.net",
|
||||
"basePath": "/vetting/v1",
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"consumes": [],
|
||||
"produces": [],
|
||||
"paths": {
|
||||
"/vetting-status": {
|
||||
"get": {
|
||||
"description": "This endpoint returns the vetting status of a given check identified by the checkId parameter.",
|
||||
"operationId": "vetting-status",
|
||||
"summary": "Get the vetting status for a given checkId",
|
||||
"tags": [
|
||||
"vettingStatus"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "checkId",
|
||||
"in": "query",
|
||||
"description": "Format - uuid. The **CheckId** parameter, which is a unique identifier for the check.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"x-ms-summary": "Check ID parameter"
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The OK response with the vetting status.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/vettingStatusResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"status": 0
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request response in case of missing or invalid parameters.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/process-check": {
|
||||
"post": {
|
||||
"description": "This endpoint processes a check based on the provided JSON request body containing the ProcessCheckRequest.",
|
||||
"operationId": "process-check",
|
||||
"summary": "Process a check request",
|
||||
"tags": [
|
||||
"processCheck"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "processCheckRequest",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/processCheckRequest"
|
||||
},
|
||||
"description": "JSON request body containing the process check details."
|
||||
}
|
||||
],
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The OK response containing the result of the process check.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/processCheckResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"succeeded": true,
|
||||
"checkId": "string",
|
||||
"errorCode": 0,
|
||||
"metaData": {
|
||||
"traceId": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request response in case of missing or invalid parameters.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/requestModelError"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"field": "string",
|
||||
"error": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden response when the client does not have permission to access this resource.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error response in case of server-side issues.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/pdf-export": {
|
||||
"get": {
|
||||
"description": "This endpoint generates and exports a PDF document for the given check identified by the CheckId parameter.",
|
||||
"operationId": "get-pdf-export",
|
||||
"summary": "Export check result as a PDF",
|
||||
"tags": [
|
||||
"PDF Export"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "CheckId",
|
||||
"in": "query",
|
||||
"description": "The **CheckId** parameter, which is a unique identifier for the check.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"x-ms-summary": "Check ID parameter"
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The OK response containing the PDF document.",
|
||||
"schema": {
|
||||
"format": "binary",
|
||||
"type": "string"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": "string"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request response in case of missing or invalid parameters.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error response.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/errorResponse"
|
||||
},
|
||||
"examples": {
|
||||
"application/json": {
|
||||
"message": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"errorResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"metaData": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"traceId": {
|
||||
"format": "uuid",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"processCheckRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"checkType": {
|
||||
"format": "int32",
|
||||
"default": 0,
|
||||
"enum": [
|
||||
0
|
||||
],
|
||||
"type": "integer"
|
||||
},
|
||||
"firstName": {
|
||||
"type": "string"
|
||||
},
|
||||
"surname": {
|
||||
"type": "string"
|
||||
},
|
||||
"dateOfBirth": {
|
||||
"format": "date-time",
|
||||
"type": "string"
|
||||
},
|
||||
"email": {
|
||||
"type": "string"
|
||||
},
|
||||
"phoneNumber": {
|
||||
"type": "string"
|
||||
},
|
||||
"reference": {
|
||||
"type": "string"
|
||||
},
|
||||
"contactViaEmail": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"contactViaSms": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"webhookUrl": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"example": {
|
||||
"checkType": 0,
|
||||
"firstName": "string",
|
||||
"surname": "string",
|
||||
"dateOfBirth": "string",
|
||||
"email": "string",
|
||||
"phoneNumber": "string",
|
||||
"reference": "string",
|
||||
"contactViaEmail": true,
|
||||
"contactViaSms": true,
|
||||
"webhookUrl": "string"
|
||||
}
|
||||
},
|
||||
"processCheckResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"succeeded": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"checkId": {
|
||||
"format": "uuid",
|
||||
"type": "string"
|
||||
},
|
||||
"errorCode": {
|
||||
"format": "int32",
|
||||
"default": 0,
|
||||
"enum": [
|
||||
0,
|
||||
1,
|
||||
2,
|
||||
3,
|
||||
4,
|
||||
5
|
||||
],
|
||||
"type": "integer"
|
||||
},
|
||||
"metaData": {
|
||||
"$ref": "#/definitions/metaData"
|
||||
}
|
||||
}
|
||||
},
|
||||
"requestModelError": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"field": {
|
||||
"type": "string"
|
||||
},
|
||||
"error": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"vettingStatusResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"format": "int32",
|
||||
"default": 0,
|
||||
"enum": [
|
||||
0,
|
||||
1,
|
||||
2,
|
||||
3,
|
||||
4,
|
||||
5,
|
||||
6,
|
||||
7,
|
||||
8
|
||||
],
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": {},
|
||||
"responses": {},
|
||||
"securityDefinitions": {
|
||||
"API Key": {
|
||||
"type": "apiKey",
|
||||
"in": "header",
|
||||
"name": "Ocp-Apim-Subscription-Key"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"API Key": []
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
{
|
||||
"name": "Identity"
|
||||
},
|
||||
{
|
||||
"name": "DBS"
|
||||
},
|
||||
{
|
||||
"name": "RightToWork"
|
||||
},
|
||||
{
|
||||
"name": "Pre-Employment"
|
||||
}
|
||||
],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://www.infovetted.com"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://www.infovetted.com/privacy-policy"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Security;Business Management"
|
||||
}
|
||||
],
|
||||
"x-ms-openai-manifest": {
|
||||
"modelDescription": "Right To Work and DBS checks provided",
|
||||
"humanName": "Vetting Checks",
|
||||
"contactEmail": "info@infovetted.com",
|
||||
"legalUrl": "https://www.infovetted.com/terms-and-conditions"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
{
|
||||
"properties": {
|
||||
"capabilities": [],
|
||||
"connectionParameters": {
|
||||
"api_key": {
|
||||
"type": "securestring",
|
||||
"uiDefinition": {
|
||||
"constraints": {
|
||||
"clearText": false,
|
||||
"required": "true",
|
||||
"tabIndex": 2
|
||||
},
|
||||
"description": "API Key from InfoVetted platform",
|
||||
"displayName": "API Key",
|
||||
"tooltip": "Provide your API KEY"
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#f9f9f9",
|
||||
"publisher": "InfoVetted",
|
||||
"stackOwner": "InfoVetted",
|
||||
"policyTemplateInstances": []
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
# InfoVetted Vetting Connector
|
||||
|
||||
InfoVetted provides a connector to request pre-employment vetting services such as Identity Verification (IDV), Right to Work (RTW), and Disclosure & Barring Service (DBS).
|
||||
|
||||
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](https://www.infovetted.com) to use the connector.
|
||||
|
||||
## Supported Operations
|
||||
|
||||
The connector supports the following operations:
|
||||
|
||||
### Process Check
|
||||
|
||||
Request a vetting check. The following check types are available:
|
||||
|
||||
- RightToWork = 0
|
||||
- StandardDBS = 1
|
||||
- EnhancedDBS = 2
|
||||
- BasicDBS = 3
|
||||
|
||||
Vetting status updates will be sent to the (optional) webhook address provided in the following format
|
||||
|
||||
**Webhook POST payload JSON:**
|
||||
|
||||
```
|
||||
{
|
||||
"CheckId": "",
|
||||
"Status": 0,
|
||||
"StatusDescription": ""
|
||||
}
|
||||
```
|
||||
|
||||
**Statuses:**
|
||||
|
||||
- NotStarted = 0,
|
||||
- InProgress = 1,
|
||||
- Complete = 2,
|
||||
- Deleted = 3,
|
||||
- PendingApproval = 4,
|
||||
- Rejected = 5,
|
||||
- Expired = 6,
|
||||
- Archived = 7,
|
||||
- Unknown = 8
|
||||
|
||||
### Vetting Status
|
||||
|
||||
Returns the vetting status of the requested check
|
||||
|
||||
**Statuses:**
|
||||
|
||||
- NotStarted = 0,
|
||||
- InProgress = 1,
|
||||
- Complete = 2,
|
||||
- Deleted = 3,
|
||||
- PendingApproval = 4,
|
||||
- Rejected = 5,
|
||||
- Expired = 6,
|
||||
- Archived = 7,
|
||||
- Unknown = 8
|
||||
|
||||
### PDF Export
|
||||
|
||||
Returns a PDF result for the completed vetting
|
||||
|
||||
## Obtaining Credentials
|
||||
|
||||
Your API Key can be obtained within the InfoVetted portal under **Settings** => **API Keys** => **Primary Key**.
|
||||
|
||||
[InfoVetted API Keys](https://portal.infovetted.com/apikeys)
|
||||
|
||||
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](https://www.infovetted.com/ "InfoVetted - Contact Us") or fire an email to info@infovetted.com
|
||||
|
||||
## Deployment Instructions
|
||||
|
||||
Please use [these instructions](https://docs.microsoft.com/en-us/connectors/custom-connectors/paconn-cli) to deploy this connector as custom connector in Microsoft Power Automate and Power Apps
|
||||
Загрузка…
Ссылка в новой задаче