# FinchNode Developer API API

**Canonical:** https://apis.io/apis/finchnode-com/finchnode-developer-api-api/  
**Provider:** finchnode-com — https://apis.io/providers/finchnode-com/  
**Base URL:** https://api.finchnode.com/api/v1  
**Documentation:** https://finchnode.com/llms.txt

FinchNode Developer API API is one of 2 APIs that [finchnode-com](https://apis.io/providers/finchnode-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/finchnode-com/openapi/_original/finchnode-com-api-openapi.yml
- **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

## Other finchnode-com APIs (1)

- [FinchNode Developer API](https://apis.io/apis/finchnode-com/finchnode-developer-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/finchnode-com/finchnode-developer-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/finchnode-com/.