Platform API (/v1)

Endpoints

This page lists every endpoint of the /api/v1 surface, 54 in total. It is generated from the platform's route tree each time this site is built. A production release builds it from the same commit as the app, so it describes the routes that release serves.

Each endpoint shows the role its caller must hold, the minimum token scope, the query parameters it accepts, its rate limit and its known errors. The known-errors list is a minimum, not an exhaustive list. It is derived from the authentication layer and the handler code the generator can read, so an endpoint can return codes it does not show. Some of the codes it does show apply only in certain configurations. IP_BLOCKED needs an IP allowlist, for example, and the PAT_* codes apply only to token callers. Handle what you might receive, not only what you expect.

Versioning. Within /v1 the platform may ADD response fields and ADD optional request parameters. It does not remove or retype an existing field, and does not remove an operation, inside a version. A breaking change takes a new prefix.

Session

`GET /api/v1/session`


Access	The credential itself. A data-room-restricted token is admitted here.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Query parameters	None accepted. Any query parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `ORGANIZATION_REQUIRED`, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Organisation

`GET /api/v1/org`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `ORG_NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Team

`GET /api/v1/team`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/team`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`PATCH /api/v1/team/{membershipId}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`write` or higher
Path parameters	`membershipId`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`DELETE /api/v1/team/{membershipId}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`write` or higher
Path parameters	`membershipId`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Access grants

`POST /api/v1/grants`


Access	Data room. The caller must be able to access the data room named in the request.
Required role	Organisation owner or admin
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`BAD_REQUEST` 400, `FORBIDDEN` 403, `GRANTEE_NOT_FOUND`, `GRANTEE_NOT_IN_DATAROOM`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/403/404/429/503. A known minimum, not exhaustive. See error codes.

`DELETE /api/v1/grants/{id}`


Access	Data room. The caller must be able to access the data room named in the request.
Required role	Organisation owner or admin
Token scope	`write` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`BAD_REQUEST` 400, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/403/404/429/503. A known minimum, not exhaustive. See error codes.

Folders

`GET /api/v1/folders`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Files

`GET /api/v1/files`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Facts

`GET /api/v1/facts`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Q&A

`GET /api/v1/qa`


Access	Data room. The caller must be able to access the data room named in the request.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`dataroomId`, `fileId`, `limit`, `offset`, `status`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`BAD_REQUEST` 400, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/403/404/429/503. A known minimum, not exhaustive. See error codes.

Chat

`POST /api/v1/chat`


Access	Data room. The caller must be able to access the data room named in the request.
Required role	Deal team: organisation owner, admin or member
Token scope	`write` or higher
Query parameters	None accepted. Any query parameter is rejected with `400`.
Rate limit	`30` requests per minute per identity
AI budget	Draws on the organisation's daily AI budget
Known errors	`AI_BUDGET_UNAVAILABLE` 503, `AI_DAILY_BUDGET_EXCEEDED` 429, `ai_disabled` 403, `BAD_REQUEST` 400, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAID_PLAN_REQUIRED` 402, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/403/404/429/503. A known minimum, not exhaustive. See error codes.

Agents

`POST /api/v1/agents/{name}/invoke`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Path parameters	`name`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`5` requests per minute per identity
AI budget	Draws on the organisation's daily AI budget
Known errors	`AI_BUDGET_UNAVAILABLE` 503, `AI_DAILY_BUDGET_EXCEEDED` 429, `ai_disabled` 403, `BAD_REQUEST`, `CONFLICT`, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Activity and engagement

`GET /api/v1/activity`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`counterparty`, `cursor`, `limit`, `since`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/activity/engagement`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`counterparty`, `cursor`, `limit`, `weeks`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/activity/engagement/document/pages`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`fileId`, `range`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`FILE_NOT_FOUND`, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/activity/engagement/documents`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`counterparty`, `cursor`, `fileId`, `limit`, `weeks`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/activity/rollups`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Deal team: organisation owner, admin or member
Token scope	`read` or higher
Query parameters	`counterparty`, `cursor`, `limit`, `weeks`. Any other parameter is rejected with `400`.
Rate limit	`60` requests per minute per identity
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Portfolio monitoring

Request and response schemas for the loan-domain routes, and the ingestion contract they share, are in the loan API reference.

`POST /api/v1/monitoring/charts/data`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`ADDON_NOT_PURCHASED`, `FORBIDDEN` 403, `INVALID_BODY`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503, `VALIDATION_FAILED`. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/charts/nl-to-dsl`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	`20` requests per minute per identity
AI budget	Draws on the organisation's daily AI budget
Known errors	`ADDON_NOT_PURCHASED`, `AI_BUDGET_UNAVAILABLE` 503, `AI_DAILY_BUDGET_EXCEEDED` 429, `FORBIDDEN` 403, `INVALID_BODY`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503, `VALIDATION_FAILED`. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/exports`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/exports`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503, `UNKNOWN_EXPORT_TYPE`. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/exports/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/exports/admin/history`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/exports/admin/history/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	Organisation owner or admin
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_ROLE_CEILING` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/borrowers`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/borrowers/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/actual-payments`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/borrowers`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/collateral`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/collateral-valuations`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/loans`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/bulk/scheduled-repayments`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/collateral`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `REFERENCED_ENTITY_NOT_FOUND`, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/collateral-valuations`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `REFERENCED_ENTITY_NOT_FOUND`, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/collateral-valuations/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/collateral/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/counts`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/imports`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/imports`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IDEMPOTENCY_KEY_REUSED`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503, `UNKNOWN_KIND`. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/imports/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`DELETE /api/v1/monitoring/loan/imports/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/imports/{id}/commit`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`COMMIT_FAILED`, `FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/imports/{id}/verify`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/loans`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `REFERENCED_ENTITY_NOT_FOUND`, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/loans/{externalId}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`externalId`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`PATCH /api/v1/monitoring/loan/loans/{externalId}/status`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Path parameters	`externalId`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IDEMPOTENCY_CONFLICT`, `INVALID_STATUS_TRANSITION`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/payments`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`CHECK_VIOLATION`, `FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `REFERENCED_ENTITY_NOT_FOUND`, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/payments/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/payments/{id}/cancel`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`POST /api/v1/monitoring/loan/scheduled-repayments`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`write` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `ID_CONFLICT`, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `PORTFOLIO_NOT_FOUND`, `RATE_LIMITED` 429, `REFERENCED_ENTITY_NOT_FOUND`, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/loan/scheduled-repayments/{id}`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Path parameters	`id`
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `NOT_FOUND`, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

`GET /api/v1/monitoring/movers`


Access	Organisation. Answers for the organisation the credential belongs to.
Required role	No role requirement of its own. The endpoint may still refuse (see Known errors)
Token scope	`read` or higher
Query parameters	Not validated against a fixed list. Send only the parameters you intend.
Rate limit	The platform-wide default
Known errors	`FORBIDDEN` 403, `IP_BLOCKED` 403, `MFA_CHALLENGE_REQUIRED` 403, `MFA_SETUP_REQUIRED` 403, `PAT_DATAROOM_SCOPE` 403, `PAT_SCOPE_INSUFFICIENT` 403, `RATE_LIMITED` 429, `SESSION_EXPIRED` 401, `UNAUTHORIZED` 401/429/503. A known minimum, not exhaustive. See error codes.

Authentication

How to authenticate against the Waafir /v1 Platform API with a personal access token. Covers the bearer header, token scopes, the role requirement and role ceiling, data-room-restricted tokens, and what each refusal means.

Error codes

The known error codes of the Waafir /v1 Platform API, the HTTP statuses they come with, and what to do about each. A known minimum, generated from the platform's route tree.