API
Base URL https://finreg.unicornprivate.com. Authentication: Authorization: Bearer fr_live_... (keys are created by an admin in Team and API). Limit: 600 requests per minute per account. Errors: JSON {"error": {"code", "message"}} with HTTP status 400, 401, 402, 403, 404, 409, 429. Without an active trial or subscription every endpoint except /v1/status and /v1/usage answers 402 subscription_required.
| Method | Path | Description |
|---|---|---|
GET | /v1/status | Engine and source status (no key) |
GET | /v1/profiles | Regulatory profiles of the account (one, or one per client with the Partner plan) |
GET | /v1/feed | Publications for a profile. Query: profile (id, default the first), authority, impact (high, medium, low), kind, unread=1, before (the next value of the previous page), limit (max 100) |
GET | /v1/items/{id} | One publication with analysis in the language of the account |
GET | /v1/deadlines | Dates in relevant publications and open obligations with due date. Query: profile |
GET | /v1/obligations | Obligations register. Query: profile |
POST | /v1/obligations | Create: {title, profileId?, itemId?, ownerEmail?, dueDate? (YYYY-MM-DD), note?} |
PATCH | /v1/obligations/{id} | Change: {title?, status? (open, in_progress, done, not_applicable), ownerEmail?, dueDate?, note?}. Every change is logged. |
GET | /v1/obligations/{id}/history | Log of changes: user, field, old and new value, time |
GET | /v1/usage | Plan, subscription status, trial end and add-ons in use |
Summaries and classifications are produced automatically and can contain errors. The field url always links the official publication.