Introduction

The Rekord API gives you programmatic access to the Rekord platform — a system for assembling authoritative records from multiple data sources, managing decisioning workflows, and evaluating business rules against structured evidence.

What the API exposes

The API is organised around six core resources:

Resource
What it represents

The schema for your data — fields, types, validation, resolution policies

Materialised projections assembled from all available evidence

Immutable evidence — document extractions, integrations, manual entries

Edges connecting records across models

Decision boundaries scoping records, evidence, and rule evaluations

JSON Logic expressions that evaluate against a full decisioning context

Before you start

Base URL

https://api.rekord.io/v1

Protocol

HTTPS only, JSON request and response bodies

Authentication

Bearer token in the Authorization header

A workspace is an isolated environment containing your organisation's models, records, rules, and decisioning contexts. Every API token is scoped to exactly one workspace — the token determines which workspace your requests operate in and what permissions you have.

To get started, create an API token in the Rekord dashboard. See Authentication for token types, scopes, and rate limiting.

API basics

The Rekord API is RESTful and uses JSON for all requests and responses. It follows standard HTTP semantics — GET for reads, POST for creation, PATCH for partial updates, PUT for lifecycle transitions, and DELETE for removal.

Where to start

  • Core Concepts — understand the resources and how they relate to each other

  • Authentication — set up your API credentials and understand scopes

  • API Conventions — learn the querying, pagination, and error handling patterns that apply across all endpoints

Last updated