Autohost

Autohost Idcheck API

The Idcheck API from Autohost — 3 operation(s) for idcheck.

GitHub OpenAPI
Business capability
Identity Verification AE-160.30

Operations 3

POST /idcheck/upload/{id}/{step}/{type} ID verification upload #
GET /idcheck/status/{id} ID verification status #
GET /idcheck/image/{id}/{step} ID verification image #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/autohost/openapi/autohost-idcheck-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-reservation-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-reservation-summary-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-payment-event-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-reservation-screens-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-background-check-results-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/autohost/json-schema/autohost-reservation-payments-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-idcheck-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

autohost-idcheck-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Autohost Idcheck API
  version: '1'
  description: 'Operations tagged Idcheck 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: Idcheck
paths:
  /idcheck/upload/{id}/{step}/{type}:
    post:
      operationId: idcheck-upload
      summary: ID verification upload
      description: Upload base64-encoded photo for analysis and verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IDCheckUploadRequest'
            examples:
              dataurl:
                value:
                  imageBase64: data:image/jpeg;base64,<base64-encoded image>
              base64:
                value:
                  imageBase64: <base64-encoded image>
        description: JSON object with DataURL or base64-encoded image
      parameters:
      - name: id
        in: path
        description: Autohost reservation ID
        required: true
        schema:
          type: string
      - name: step
        in: path
        description: Document side (front, back, selfie)
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: Document type (drivers, passport, id)
        required: true
        schema:
          type: string
      - name: pms
        in: query
        description: PMS integration name. If supplied, the API will assume the path parameter `id` is a confirmation code.
        required: false
        allowEmptyValue: false
        schema:
          $ref: '#/components/schemas/QueryParamPMS'
      - name: x-api-key
        in: header
        description: API Authentication Key
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A analysis object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IDCheckUploadResponse'
        '500':
          description: An error message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Idcheck
  /idcheck/status/{id}:
    get:
      operationId: idcheck-status
      summary: ID verification status
      description: Get verification results for photos that you uploaded
      parameters:
      - name: id
        in: path
        description: Autohost reservation ID
        required: true
        schema:
          type: string
      - name: pms
        in: query
        description: PMS integration name. If supplied, the API will assume the path parameter `id` is a confirmation code.
        required: false
        allowEmptyValue: false
        schema:
          $ref: '#/components/schemas/QueryParamPMS'
      - name: x-api-key
        in: header
        description: API Authentication Key
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A verification status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IDCheckStatusResponse'
              examples:
                success:
                  value:
                    status: passed
                failure:
                  value:
                    status: review
                    errors:
                    - Name on document does not match reservation details
        '500':
          description: An error message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Idcheck
  /idcheck/image/{id}/{step}:
    get:
      operationId: idcheck-image
      summary: ID verification image
      description: Get uploaded image for identification document on a reservation
      parameters:
      - name: id
        in: path
        description: Autohost reservation ID
        required: true
        schema:
          type: string
      - name: step
        in: path
        description: Document side (front, back, selfie)
        required: true
        schema:
          type: string
      - name: pms
        in: query
        description: PMS integration name. If supplied, the API will assume the path parameter `id` is a confirmation code.
        required: false
        allowEmptyValue: false
        schema:
          $ref: '#/components/schemas/QueryParamPMS'
      - name: x-api-key
        in: header
        description: API Authentication Key
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Identification document image encoded using Base64
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IDCheckImageResponse'
              examples:
                DataURL:
                  value:
                    base64Image: data:image/jpeg;base64,<base64-encoded image>
        '500':
          description: An error message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Idcheck
components:
  schemas:
    IDCheckUploadResponse:
      properties:
        code:
          type: string
        error:
          type: string
        card:
          type: object
          properties:
            first_name:
              type: string
            last_name:
              type: string
            full_name:
              type: string
            birth_date:
              type: string
            expiry_date:
              type: string
    QueryParamPMS:
      type: string
      enum:
      - api
      - apaleo
      - beds24
      - booking
      - cloudbeds
      - guesty
      - hostaway
      - hostfully
      - inforhms
      - impala
      - lavanda
      - myvr
      - opera
      - smartbnb
      - stayntouch
      - streamline
      - trackhs
    IDCheckStatusResponse:
      properties:
        status:
          type: string
          enum:
          - passed
          - review
          - failed
        errors:
          type: array
          items:
            type: string
    ErrorResponse:
      properties:
        error:
          type: string
    IDCheckUploadRequest:
      properties:
        imageBase64:
          type: string
    IDCheckImageResponse:
      properties:
        imageBase64:
          type: string
x-refined-from:
- autohost-openapi.json
- developer.autohost.ai_openapi.json