This documents the request shape and verified behavior of the regional research route. The route is feature-flagged OFF (XRPLME_REGIONAL_PAID_ROUTE unset) and is not publicly exposed. It is not an offer of live paid research.
POST /rr/v1/research
{
"countries": ["vietnam", "japan", "singapore"],
"dimensions": ["formation", "immigration", "labor", "operating_environment"],
"objective": "short free-text statement of what to compare",
"depth": "standard" | "deep"
}
While the feature flag is unset the route does not accept live requests; the shape above is documented for the staging prototype.
| Limit | Value |
|---|---|
| Maximum countries | 3 — accepted: vietnam, japan, singapore |
| Maximum dimensions | 4 — accepted: formation, immigration, labor, operating_environment |
| Objective length | maximum 300 characters |
| Depth values | standard, deep |
| Route timeout | 45 seconds → 504 on timeout |
| Output cap | 262144 bytes (256 KB) |
| Rate limiting | 10 requests/minute and 100 requests/day per key |
When enabled, an unpaid request returns an invoice with the payment requirements (HTTP 402). A report is released only after the payment is verified and settled on a validated ledger. Settlement requires a validated tesSUCCESS transaction; pending, failed, or unvalidated transactions do not release a report. With the flag unset, no payment verification or settlement code runs.