finchnode-com

FinchNode Developer API API

Production access is free and self-serve with a FinchNode account at https://finchnode.com/signup. Live access requires production credentials, a supported source, and patient authorization and consent; availability varies by organization and scopes. See https://finchnode.com/#pricing for plan limit

GitHub OpenAPI

Operations 27

GET /tefca/config Read the synthetic TEFCA configuration #
POST /tefca/sessions Start an application-scoped synthetic TEFCA session #
GET /tefca/sessions/{id} Read a synthetic TEFCA session #
POST /tefca/sessions/{id}/discover Discover synthetic record groups #
POST /tefca/sessions/{id}/retrieve Retrieve selected synthetic record groups #
GET /tefca/sessions/{id}/export Export retrieved synthetic FHIR records #
POST /tefca/sessions/{id}/revoke Revoke a synthetic TEFCA session and clear results #
POST /agent-credentials Delegate a short-lived REST credential for one consented subject #
DELETE /agent-credentials/{credentialId} Revoke an app-owned API-delegated credential #
GET /health Check API availability #
GET /app Resolve the application and environment for the current key #
POST /connect/sessions Create a Hosted Connect session #
GET /connect/sessions/{sessionId} Retrieve Connect session and source-sync state #
POST /connect/sessions/{sessionId}/cancel Cancel an incomplete Connect session #
POST /connect/sessions/{sessionId}/simulate Simulate a sandbox Connect session with a scenario #
POST /sandbox/subjects/{subject}/events Apply a sandbox lifecycle event to a synthetic user #
POST /conformance/runs Start a conformance run #
GET /conformance/runs List this application's conformance runs #
GET /conformance/runs/{runId} Retrieve a conformance run #
POST /conformance/runs/{runId}/advance Stop waiting in the current phase #
POST /conformance/runs/{runId}/cancel Cancel a conformance run #
GET /conformance/reports/{token} Read a conformance report #
GET /users List pseudonymous users with active share consent #
GET /users/{subject}/records Retrieve a consent-filtered normalized health-record snapshot #
GET /users/{subject}/records/{category} List records in one consent category #
GET /users/{subject}/records/{category}/changes Read incremental upserts and deletion tombstones #
GET /consents/{receiptId} Retrieve a consent receipt and current status #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/finchnode-com/openapi/_original/finchnode-com-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-connect-session-schema.json
📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-conformance-run-schema.json
📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-conformance-report-schema.json
📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-tefca-session-schema.json
📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-consent-receipt-schema.json
📊
JSONSchema
https://artifacts.apis.io/finchnode-com/json-schema/finchnode-com-tefca-export-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/finchnode-com:finchnode-developer-api-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

finchnode-com-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: FinchNode Developer API
  version: '2026-09-22'
  summary: Consent-enforced access to normalized patient-authorized records.
  description: >-
    Production access is free and self-serve with a FinchNode account at
    https://finchnode.com/signup.
    Live access requires production credentials, a supported source, and patient
    authorization and consent; availability varies by organization and scopes. See https://finchnode.com/#pricing for plan limits (no usage metering).
    Create Hosted Connect sessions, observe truthful source-sync state, receive
    durable lifecycle webhooks, and read app-scoped normalized records. Every
    read is constrained by the key environment, the application's current
    allowlist, and active user consent. API keys must remain server-side.
servers:
  - url: https://api.finchnode.com/api/v1
    description: Production
  - url: http://localhost:5001/api/v1
    description: Local development
tags:
  - name: Platform
  - name: Connect
  - name: Records
  - name: Consent
  - name: Sandbox
    description: >-
      The scenario sandbox: complete a sandbox Connect session with a synthetic
      patient from a FinchNode scenario, then drive that patient's lifecycle.
      Requires a sandbox key (ck_test_...); a live key (ck_live_...) receives
      403 sandbox_only.
    x-finchnode-environment: sandbox
  - name: Conformance
    description: >-
      Conformance runs: test an integration end to end against a synthetic
      patient. FinchNode acts as the patient and as an adversary (a forced
      429, a consent revocation, and webhook probes) and grades each check.
      Requires a sandbox key (ck_test_...) on an application in sandbox
      status. A passing run is recommended before production, not required.
    x-finchnode-environment: sandbox
security:


# --- truncated at 32 KB (93 KB total) ---
# Full source: https://artifacts.apis.io/finchnode-com/openapi/_original/finchnode-com-api-openapi.yml