find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/autohost:autohost-background-check-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Autohost Background Check API
  version: '1'
  description: 'Operations tagged Background Check across 2 of this provider''s published API definitions: autohost-openapi.json, developer.autohost.ai_openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Background Check
paths:
  /background-check/submit:
    post:
      operationId: background-check-submit
      summary: Background Check - Submit
      description: Start a background check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundCheckSubmitRequest'
            examples:
              example:
                value:
                  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
        description: JSON object with candidate details
      parameters:
      - name: type
        in: query
        description: Background check type
        required: true
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - globalcheck
      - name: x-api-key
        in: header
        description: API Authentication Key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A analysis object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckSubmitResponse'
              examples:
                example:
                  value:
                    id: 98efb578c68591e90f8a05d0d52224a7c70df4fbd3faabc92bb011ab28ac5e7d
                    start_date: '2023-07-30T18:25:56.536Z'
                    status: PENDING
                    type: globalcheck
        '500':
          description: An error message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Background Check
  /background-check/results/{id}:
    get:
      operationId: background-check-results
      summary: Background Check - Results
      description: Get background check results
      parameters:
      - name: id
        in: path
        description: Background check report ID
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: API Authentication Key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A verification status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckResultsResponse'
              examples:
                example:
                  value:
                    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':
          description: An error message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Background Check
components:
  schemas:
    BackgroundCheckSubmitResponse:
      properties:
        id:
          type: string
          description: Background check report ID
        status:
          type: string
          description: Background check report status
          enum:
          - PENDING
          - REVIEW
          - FINISHED
          - FAILED
        start_date:
          type: string
          format: date-time
          description: Background check report start date
        type:
          type: string
          description: Background check report type
          enum:
          - globalcheck
    BackgroundCheckResultsResponse:
      properties:
        id:
          type: string
          description: Background check report ID
        status:
          type: string
          description: Background check report status
          enum:
          - PENDING
          - REVIEW
          - FINISHED
          - FAILED
        risk_status:
          type: string
          description: Background check risk status
          enum:
          - CLEARED
          - REVIEW
        type:
          type: string
          description: Background check report type
          enum:
          - globalcheck
        start_date:
          type: string
          format: date-time
          description: Date when the background check was started
        stop_date:
          type: string
          format: date-time
          description: Date when the background check was finished
        pdf:
          type: string
          format: uri
          description: URL to the PDF report
        report_items:
          type: array
          description: List of report sections
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the report section
              status:
                type: string
                enum:
                - FINISHED
                - FAILED
                - PENDING
                - NO_RESULTS
              items:
                type: array
                description: List of report section items
                items:
                  type: object
                  properties:
                    title:
                      type: string
                      description: Name of the report item
                    subtitle:
                      type: string
                      description: Subtitle of the report item
                    description:
                      type: string
                      description: Description of the report item
                    tags:
                      type: array
                      description: List of tags
                      items:
                        type: string
                        description: Tag
                    image:
                      type: string
                      format: uri
                      description: URL to an image
                    images:
                      type: array
                      description: List of images
                      items:
                        type: string
                        format: uri
                        description: URL to an image
                    link:
                      type: string
                      format: uri
                      description: URL for more information
    ErrorResponse:
      properties:
        error:
          type: string
    BackgroundCheckSubmitRequest:
      properties:
        first_name:
          type: string
          description: First name
          required: true
        last_name:
          type: string
          description: Last name
          required: true
        middle_name:
          type: string
          description: Middle name (optional)
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code
          required: true
          maxLength: 2
          minLength: 2
        state:
          type: string
          description: ISO 3166-2 state code (e.g. US-NY)
          minLength: 2
        city:
          type: string
          description: City
        gender:
          type: string
          description: Gender type (optional)
          enum:
          - M
          - F
          - X
        phone:
          type: string
          description: E.164 phone number (e.g. +15555555555)
          required: true
        email:
          type: string
          format: email
          description: Email address
          required: true
        year_of_birth:
          type: integer
          description: Year of birth (e.g. 1990)
          minimum: 1900
          maximum: 2100
        date_of_birth:
          type: string
          description: ISO 8601 date (e.g. 1990-01-01)
          format: date
x-refined-from:
- autohost-openapi.json
- developer.autohost.ai_openapi.json