API Reference

The Nora /v2 API is a JSON-over-HTTPS REST API. Two resources make up the entire public surface: parties (end-user entities) and intents (onramp, offramp, approve-burn).

Base URLs

Authentication

Every request sends a single header:

X-API-Key: sk_test_...

Keys bind to (organization, instance) — no other auth header is needed. See Authentication.

Response envelope

Success: the resource shape directly (no data wrapper).

{ "id": "…", "status": "active" }

Failure: /v2 endpoints return JSON errors. The exact shape varies by endpoint family:

• /v2/parties/* returns { error: string, code?: string } where error is a human-readable message.
• /v2/intents/* returns { code: string, message: string, validationErrors?: [...], details?: object } — a richer envelope with structured validation info.

See Error handling for the full taxonomy.

Idempotency

POST /v2/intents/onramp and POST /v2/intents/offramp accept an idempotency-key header (UUID). Same key + same body within the dedup window → same response. Different body with the same key → 409. See Idempotency.

POST /v2/intents/:id/approve-burn is the exception — the on-chain txSignature is the dedup key, and no separate header is sent.

Versioning

/v2 is the current stable surface. Breaking changes ship under a new version prefix; no silent changes to existing endpoints.

Resources

• Parties — create end-user entities, bind wallets.
• Intents — onramp, offramp, approve-burn, fetch, list.