Idcheck

ID verification upload

POST /idcheck/upload/{id}/{step}/{type}

Upload base64-encoded photo for analysis and verification

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost reservation ID
step	path	string	true	Document side (front, back, selfie)
type	path	string	true	Document type (drivers, passport, id)
pms	query	QueryParamPMS	false	PMS integration name. If supplied, the API will assume the path parameter id is a confirmation code.
x-api-key	header	string	false	API Authentication Key
body	body	IDCheckUploadRequest	false	JSON object with DataURL or base64-encoded image

Enumerated Values

Parameter	Value
pms	api
pms	apaleo
pms	beds24
pms	booking
pms	cloudbeds
pms	guesty
pms	hostaway
pms	hostfully
pms	inforhms
pms	impala
pms	lavanda
pms	myvr
pms	opera
pms	smartbnb
pms	stayntouch
pms	streamline
pms	trackhs

Body parameter

{
  "imageBase64": "data:image/jpeg;base64,<base64-encoded image>"
}

Example responses

200 Response

{
  "code": "string",
  "error": "string",
  "card": {
    "first_name": "string",
    "last_name": "string",
    "full_name": "string",
    "birth_date": "string",
    "expiry_date": "string"
  }
}

Responses

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

Code samples

"""
Python Code Snippet
"""
import requests

input_body = {
  "imageBase64": "data:image/jpeg;base64,<base64-encoded image>"
}

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

r = requests.post('https://data.autohost.ai/v1/idcheck/upload/{id}/{step}/{type}', json=input_body, headers=headers)

print(r.json())

/*
TypeScript Code Snippet
*/

import fetch from 'node-fetch';
const inputBody = {
  "imageBase64": "data:image/jpeg;base64,<base64-encoded image>"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'string'
};

const response = await fetch('https://data.autohost.ai/v1/idcheck/upload/{id}/{step}/{type}', {
  method: 'post',
  body: JSON.stringify(inputBody),
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

ID verification status

GET /idcheck/status/{id}

Get verification results for photos that you uploaded

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost reservation ID
pms	query	QueryParamPMS	false	PMS integration name. If supplied, the API will assume the path parameter id is a confirmation code.
x-api-key	header	string	false	API Authentication Key

Enumerated Values

Parameter	Value
pms	api
pms	apaleo
pms	beds24
pms	booking
pms	cloudbeds
pms	guesty
pms	hostaway
pms	hostfully
pms	inforhms
pms	impala
pms	lavanda
pms	myvr
pms	opera
pms	smartbnb
pms	stayntouch
pms	streamline
pms	trackhs

Example responses

A verification status object

{
  "status": "passed"
}

{
  "status": "review",
  "errors": [
    "Name on document does not match reservation details"
  ]
}

500 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	A verification status object	IDCheckStatusResponse
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/idcheck/status/{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/idcheck/status/{id}', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

ID verification image

GET /idcheck/image/{id}/{step}

Get uploaded image for identification document on a reservation

Parameters

Name	In	Type	Required	Description
id	path	string	true	Autohost reservation ID
step	path	string	true	Document side (front, back, selfie)
pms	query	QueryParamPMS	false	PMS integration name. If supplied, the API will assume the path parameter id is a confirmation code.
x-api-key	header	string	false	API Authentication Key

Enumerated Values

Parameter	Value
pms	api
pms	apaleo
pms	beds24
pms	booking
pms	cloudbeds
pms	guesty
pms	hostaway
pms	hostfully
pms	inforhms
pms	impala
pms	lavanda
pms	myvr
pms	opera
pms	smartbnb
pms	stayntouch
pms	streamline
pms	trackhs

Example responses

Identification document image encoded using Base64

{
  "base64Image": "data:image/jpeg;base64,<base64-encoded image>"
}

500 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Identification document image encoded using Base64	IDCheckImageResponse
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/idcheck/image/{id}/{step}', 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/idcheck/image/{id}/{step}', {
  method: 'get',
  
  headers,
});
const responseJson = await response.json();
console.log(responseJson);

Schemas

IDCheckUploadRequest

{
  "imageBase64": "string"
}

Properties

Name	Type	Required	Restrictions	Description
imageBase64	string	false	none	none

QueryParamPMS

"api"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	api
anonymous	apaleo
anonymous	beds24
anonymous	booking
anonymous	cloudbeds
anonymous	guesty
anonymous	hostaway
anonymous	hostfully
anonymous	inforhms
anonymous	impala
anonymous	lavanda
anonymous	myvr
anonymous	opera
anonymous	smartbnb
anonymous	stayntouch
anonymous	streamline
anonymous	trackhs

IDCheckUploadResponse

{
  "code": "string",
  "error": "string",
  "card": {
    "first_name": "string",
    "last_name": "string",
    "full_name": "string",
    "birth_date": "string",
    "expiry_date": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
error	string	false	none	none
card	object	false	none	none
» first_name	string	false	none	none
» last_name	string	false	none	none
» full_name	string	false	none	none
» birth_date	string	false	none	none
» expiry_date	string	false	none	none

ErrorResponse

{
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none

IDCheckStatusResponse

{
  "status": "passed",
  "errors": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none
errors	[string]	false	none	none

Enumerated Values

Property	Value
status	passed
status	review
status	failed

IDCheckImageResponse

{
  "imageBase64": "string"
}

Properties

Name	Type	Required	Restrictions	Description
imageBase64	string	false	none	none

Autohost

Talk to Sales