API Documentation

This is the documentation of the House Check API. If you have any feedback, or are you missing functionality to support your use case?

Let us know via aron@housecheck.be

Getting started

To get started, create a new client in your settings, then read about how to make requests for the resources you need to access using our HTTP APIs.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

General Principles

Understand how to work with our API.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Webhooks

Learn how to programmatically configure webhooks for your app.

Read more

Resources

Orders

Learn about the order model and how to create, retrieve, update, delete, and list orders.

Products

Learn about the product model and how to create, retrieve, update, delete, and list products.