Changelog
Version history for the API and this documentation.
Versions
| Artifact | Version | Notes |
|---|---|---|
| API | v1 | Current and only documented major version (path prefix /v1). |
| Documentation | 1.0.0 | Initial portal generated from the source Postman collection. |
| Source spec | openapi.yaml 1.0.0 | Derived OpenAPI 3.0 description (see downloads). |
Change history
| Date | Version | Change |
|---|---|---|
| 2026-06-03 | 1.0.0 | Initial documentation: Overview, Getting Started, nine guides, interactive API reference, recipes, error handling, security, and operational appendix. Derived OpenAPI 3.0 spec and sanitized Postman collection published. |
๐ Note
Prior API change history is not captured in the source material and is To be confirmed. Add entries here as the API evolves.
Deprecated fields / endpoints
No deprecations are declared in the source material. To be confirmed with the platform team.
Known naming inconsistencies (carried from the API)
These are preserved exactly as defined by the API and are not documentation errors:
- Create FI uses singular
/financialInstitution; other FI operations use plural/financial-institutions. - Account-type update posts to
/onboarding/accounts(not/account-types). - Transaction capability create/list use plural
/transaction-capabilities; update/activation use singular/transaction-capability. - Terminal-key endpoints are at
/v1/terminal-key, outside the/onboardingnamespace. - Field spellings such as
standarizedAccountTypeandsubTentContactEmailare kept as defined.