Background Check

Background Check - Submit

POST /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

input_body = {
  "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
}

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', json=input_body, 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}

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);

Schemas

BackgroundCheckSubmitRequest

{
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "country": "st",
  "state": "string",
  "city": "string",
  "gender": "M",
  "phone": "string",
  "email": "user@example.com",
  "year_of_birth": 1900,
  "date_of_birth": "2019-08-24"
}

Properties

Name	Type	Required	Restrictions	Description
first_name	string	false	none	First name
last_name	string	false	none	Last name
middle_name	string	false	none	Middle name (optional)
country	string	false	none	ISO 3166-1 alpha-2 country code
state	string	false	none	ISO 3166-2 state code (e.g. US-NY)
city	string	false	none	City
gender	string	false	none	Gender type (optional)
phone	string	false	none	E.164 phone number (e.g. +15555555555)
email	string(email)	false	none	Email address
year_of_birth	integer	false	none	Year of birth (e.g. 1990)
date_of_birth	string(date)	false	none	ISO 8601 date (e.g. 1990-01-01)

Enumerated Values

Property	Value
gender	M
gender	F
gender	X

BackgroundCheckSubmitResponse

{
  "id": "string",
  "status": "PENDING",
  "start_date": "2019-08-24T14:15:22Z",
  "type": "globalcheck"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Background check report ID
status	string	false	none	Background check report status
start_date	string(date-time)	false	none	Background check report start date
type	string	false	none	Background check report type

Enumerated Values

Property	Value
status	PENDING
status	REVIEW
status	FINISHED
status	FAILED
type	globalcheck

ErrorResponse

{
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none

BackgroundCheckResultsResponse

{
  "id": "string",
  "status": "PENDING",
  "risk_status": "CLEARED",
  "type": "globalcheck",
  "start_date": "2019-08-24T14:15:22Z",
  "stop_date": "2019-08-24T14:15:22Z",
  "pdf": "http://example.com",
  "report_items": [
    {
      "name": "string",
      "status": "FINISHED",
      "items": [
        {
          "title": "string",
          "subtitle": "string",
          "description": "string",
          "tags": [
            "string"
          ],
          "image": "http://example.com",
          "images": [
            "http://example.com"
          ],
          "link": "http://example.com"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Background check report ID
status	string	false	none	Background check report status
risk_status	string	false	none	Background check risk status
type	string	false	none	Background check report type
start_date	string(date-time)	false	none	Date when the background check was started
stop_date	string(date-time)	false	none	Date when the background check was finished
pdf	string(uri)	false	none	URL to the PDF report
report_items	[object]	false	none	List of report sections
» name	string	false	none	Name of the report section
» status	string	false	none	none
» items	[object]	false	none	List of report section items
»» title	string	false	none	Name of the report item
»» subtitle	string	false	none	Subtitle of the report item
»» description	string	false	none	Description of the report item
»» tags	[string]	false	none	List of tags
»» image	string(uri)	false	none	URL to an image
»» images	[string]	false	none	List of images
»» link	string(uri)	false	none	URL for more information

Enumerated Values

Property	Value
status	PENDING
status	REVIEW
status	FINISHED
status	FAILED
risk_status	CLEARED
risk_status	REVIEW
type	globalcheck
status	FINISHED
status	FAILED
status	PENDING
status	NO_RESULTS

Autohost

Talk to Sales