Request structure
Request URI
The request URI consists of the following parts:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
Parameter description in URI:
Paramete | Description |
|---|---|
URI-scheme | All APIs use HTTPS protocol. |
Host | Different environments have different host: Development: api-testing.klavi.ai Production: api.klavi.ai |
resource-path | Resource path, i.e. API access path,all API prefixes in this document is /link/external/v2/. For example, the resource-path of the "obtain the list of institutions" API is /link/external/v2/getInstitutionList. |
query-string | Query parameters are optional. Not every API has query parameters. Query parameters need to be preceded by a "?", The form is parameter name = parameter value, for example, ?limit = 10, which means no more than 10 pieces of data can be queried. |
Communication protocol
- All interfaces of Klavi Openbanking API communicate through HTTPS, providing a high security communication channel.
Request method
- Supported HTTP request methods:
- POST (recommended)
- GET
- For GET method, only content type: application/x-www-form-url encoded protocol format is supported. For POST method, only content type: application/JSON is supported at present.
Character encoding
- UTF-8 coding.