Background Check

background-check-submit

POST /background-check/submit

Background Check - Submit

Start a background check

Parameters

Name	In	Type	Required	Description
type	query	string	true	Background check type
x-api-key	header	string	true	API Authentication Key
body	body	BackgroundCheckSubmitRequest	false	JSON object with candidate details

Enumerated Values

Parameter	Value
type	globalcheck

Body parameter

{
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Smith",
  "country": "US",
  "state": "CA",
  "city": "Los Angeles",
  "email": "user@example.com",
  "phone": "+14155555555",
  "year_of_birth": 1985
}

Example responses

A analysis object

{
  "id": "98efb578c68591e90f8a05d0d52224a7c70df4fbd3faabc92bb011ab28ac5e7d",
  "start_date": "2023-07-30T18:25:56.536Z",
  "status": "PENDING",
  "type": "globalcheck"
}

500 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A analysis object	BackgroundCheckSubmitResponse
500	Internal Server Error	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'x-api-key': 'string'
}

params = {
  'type': 'globalcheck'
}

r = requests.post('https://data.autohost.ai/v1/background-check/submit', headers=headers, params=params)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Smith",
  "country": "US",
  "state": "CA",
  "city": "Los Angeles",
  "email": "user@example.com",
  "phone": "+14155555555",
  "year_of_birth": 1985
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/background-check/submit', {
  method: 'post',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

background-check-results

GET /background-check/results/{id}

Background Check - Results

Get background check results

Parameters

Name	In	Type	Required	Description
id	path	string	true	Background check report ID
x-api-key	header	string	true	API Authentication Key

Example responses

A verification status object

{
  "id": "98efb578c68591e90f8a05d0d52224a7c70df4fbd3faabc92bb011ab28ac5e7d",
  "start_date": "2023-07-30T18:25:56.536Z",
  "stop_date": "2023-07-30T18:29:56.536Z",
  "status": "FINISHED",
  "risk_status": "CLEARED",
  "type": "globalcheck",
  "pdf": "https://www.example.com/report.pdf",
  "report_items": [
    {
      "name": "Social Accounts",
      "status": "FINISHED",
      "items": [
        {
          "title": "Found 10 registered accounts",
          "description": "List of registered accounts:\\n- Apple\\n- Booking\\n- Facebook\\n- Github\\n- Google\\n- Instagram\\n- Spotify\\n- Telegram\\n- Whatsapp\\n- Yahoo",
          "tags": [
            "social"
          ]
        }
      ]
    },
    {
      "name": "Phone Verification",
      "status": "FINISHED",
      "items": [
        {
          "title": "Phone number is valid",
          "subtitle": "054-000-0000",
          "description": "- Country: Israel\\n- Carrier: HOT Telecom\\n- Line Type: mobile",
          "tags": [
            "phone"
          ]
        }
      ]
    },
    {
      "name": "Avatars",
      "status": "FINISHED",
      "items": [
        {
          "title": "Found 7 profile pictures",
          "subtitle": "Review to see if any of these are the same person",
          "images": [
            "https://www.example.com/avatar1.jpg",
            "https://www.example.com/avatar2.jpg"
          ],
          "tags": [
            "avatar"
          ]
        }
      ]
    }
  ]
}

500 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A verification status object	BackgroundCheckResultsResponse
500	Internal Server Error	An error message	ErrorResponse

Code samples

"""
Python Code Snippet
"""
import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': 'string'
}

r = requests.get('https://data.autohost.ai/v1/background-check/results/{id}', headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';

const headers = {
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/background-check/results/{id}', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Autohost

Talk to Sales