API Overview

The Veridien API is a REST interface to your property's data: availability and rates, guests and loyalty, bookings, and folios. It is the same engine that powers Veridien's own booking flows, exposed so you can build a custom booking engine, a guest mobile app, a loyalty integration, or any back-office automation on top of it.

It is a plain HTTP/JSON API. You authenticate with an API key, send and receive JSON, and rely on standard status codes. Everything is scoped to a single property, so a key can only ever read or change the data of the property it belongs to.

Built for real apps

This API drives the live booking-and-loyalty flow for Veridien properties end to end — search availability, hold inventory, register a guest, confirm a reservation with payment, post folio charges, and earn or redeem loyalty points. Follow the Quickstart to run that whole flow yourself.

Base URL

Every request goes to a single versioned base URL:

https://veridien.app/api/v1

Each path in this reference is relative to that base. The health check, for example, is https://veridien.app/api/v1/health.

Authentication

Requests authenticate with a Bearer API key in the Authorization header:

Authorization: Bearer vrdn_live_xxxxxxxxxxxxxxxxxxxx

Each key is bound to one property and carries a set of scopes that decide which endpoints it may call. Create and manage keys in the dashboard under Settings → API Keys. The public meta endpoints (/health, /openapi.json) need no key; everything else does.

See Authentication for the key format, the full scope list, and a working example.

Conventions at a glance

JSON in, JSON out. Send Content-Type: application/json on requests with a body. Field names are snake_case (room_type_id, check_in_date).
Money is strings. Amounts are decimal strings with two places ("249.00") to avoid floating-point rounding. Currency is a 3-letter ISO code.
Dates are strings. Calendar dates are YYYY-MM-DD. Timestamps are ISO 8601 (2026-06-19T08:30:00.000Z).
Errors are uniform. Every failure returns the same error envelope with a machine-readable code and a request_id.
Retries are safe. Mutating requests accept an Idempotency-Key so a retry never double-charges or double-books.

The full rules live in Conventions.

What you can do

Area	Endpoints
Catalog	Property details, room types, availability, and visibility-gated rates. See Property & Catalog.
Guests	Register or link a guest, read and update profiles, read loyalty, redeem points. See Guests & Loyalty.
Reservations	Hold inventory, confirm a hold into a paid reservation, list and read reservations, cancel. See Reservations.
Folios	Read a reservation's folio and post charges to it. See Folios.

Versioning

The API is versioned in the path (/api/v1). Backwards-incompatible changes ship under a new version; additive changes (new endpoints, new optional fields) are made within v1. Treat unknown response fields as additive and ignore them rather than failing.

OpenAPI schema

A machine-readable OpenAPI 3.1 description of every endpoint is served, unauthenticated, at:

GET https://veridien.app/api/v1/openapi.json

Use it to generate typed clients or to confirm exactly which endpoints and shapes are deployed. It is the source of truth and always matches the running API.