Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/interhyp-protocol-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Interhyp Submission Protocol API
version: 2.0.0
contact:
name: Interhyp AG (Team Provider Excellence)
email: support_submission_api@interhyp.de
license:
name: Interhyp AG
description: '### This document describes the RESTful API and resources provided by Interhyp AG.<p> The RESTful API provides access to resources associated to submission process via *URI* paths, a client application will make an HTTP request using standard HTTP methods like *GET, PUT, POST and DELETE* and parse the response in *JSON* format.<p>
### API Audience<p> The API is intended to be consumed by clients who want to integrate Interhyp submission process in their own workflow.
+ **Bank Partners**
### API design Principles <p> During API design a set of principles were taken into consideration.
+ **API First**
+ **Mobile First**
### API client <p> As an API client you should adhere to the following robustness principle
+ **Tolerant Reader** Be tolerant with unknown fields in the payload. This is required to avoid new API versions if new fields were added, i.e. ignore new fields but do not eliminate them from payload if needed for subsequent *PUT* requests
+ Be prepared to handle HTTP status codes not explicitly specified in endpoint definitions.'
servers:
- url: https://api-test.interhyp.de/submission
description: Test-Staging
- url: https://api.interhyp.de/submission
description: Production
security:
- BearerAuth: []
tags:
- name: protocol
description: access to submission protocol
paths:
/v2/submissions/protocol:
get:
deprecated: true
summary: Delivers all submissions protocol for a provider
description: Delivers a collection of submission protocol for a specific provider filtered by the date of protocol.<p> *By Default*, we will return the first *20* matching records. However, this is not a hard limitation! a parameter called `limit` can be used to tell the API how many records you want to return all at once *(max 40)*.<p> To get further matching records, a parameter called `after` or `before` can be used to tell the API the start of each page using specified cursor.<p> To navigate through the query result, a reference to the following navigations are included in the response *(next, prev, first, last, self)*.
operationId: getSubmissionsProtocol
tags:
- protocol
parameters:
- $ref: '#/components/parameters/since'
- $ref: '#/components/parameters/until'
- $ref: '#/components/parameters/protocol-type-filter'
- $ref: '#/components/parameters/sbms-protocol-limit'
- $ref: '#/components/parameters/cursor-after'
- $ref: '#/components/parameters/cursor-before'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: A paged array of submissions protocol
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionProtocol'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/UnexpectedError'
components:
schemas:
ProtocolItemType:
type: string
description: open ended enum contains possible protocol item types, possible values are (DOCUMENT, DATA, STATUS, NEW_SUBMISSION)
example: DOCUMENT
x-extensible-enum:
- DOCUMENT
- DATA
- STATUS
- NEW_SUBMISSION
ClientError:
type: object
required:
- rootCause
allOf:
- $ref: '#/components/schemas/UnexpectedError'
- properties:
message:
type: string
exception:
type: string
EmbeddedSubmissionProtocol:
type: object
properties:
protocol:
type: array
items:
$ref: '#/components/schemas/ProtocolItem'
SubmissionProtocolItem:
type: object
properties:
submission:
$ref: '#/components/schemas/SubmissionProtocolRefItem'
protocol:
$ref: '#/components/schemas/SubmissionProtocolRef'
Paging:
properties:
cursor:
$ref: '#/components/schemas/Cursor'
previous:
type: string
format: uri
next:
type: string
format: uri
first:
type: string
format: uri
last:
type: string
format: uri
self:
type: string
format: uri
SubmissionRef:
type: object
allOf:
- $ref: '#/components/schemas/ResourceRef'
- properties:
id:
type: string
description: Submission id
ProtocolItem:
type: object
properties:
type:
$ref: '#/components/schemas/ProtocolItemType'
id:
type: string
createdAt:
type: string
format: date-time
author:
type: string
discriminator:
propertyName: type
mapping:
DOCUMENT: '#/components/schemas/SubmissionDocumentUpdate'
DATA: '#/components/schemas/SubmissionDataUpdate'
STATUS: '#/components/schemas/SubmissionStatusUpdate'
NEW_SUBMISSION: '#/components/schemas/NewSubmission'
ResourceRef:
required:
- href
properties:
href:
type: string
description: Link to retrieve a specific resource
example: http://some-domain/some/link/to/somewhere
SubmissionProtocolRefItem:
type: object
allOf:
- $ref: '#/components/schemas/SubmissionRef'
- properties:
legacyId:
description: Legacy submission id
type: string
Unauthorized:
allOf:
- $ref: '#/components/schemas/ClientError'
Cursor:
properties:
before:
type: string
after:
type: string
BadRequest:
allOf:
- $ref: '#/components/schemas/ClientError'
UnexpectedError:
required:
- status
- message
- timestamp
- path
- traceId
properties:
timestamp:
type: string
format: date-time
status:
type: integer
format: int32
error:
type: string
path:
type: string
traceId:
type: string
errorCode:
type: integer
format: int32
SubmissionProtocol:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SubmissionProtocolItem'
paging:
$ref: '#/components/schemas/Paging'
SubmissionProtocolRef:
type: object
allOf:
- $ref: '#/components/schemas/ResourceRef'
- properties:
embedded:
$ref: '#/components/schemas/EmbeddedSubmissionProtocol'
parameters:
until:
name: until
in: query
description: A UTC date-time value that points to the end of the range of time-based data. <br> If not provided, current date-time is used. Defined by date-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
required: false
schema:
type: string
format: date-time
example: 2019-12-29 10:22:50+00:00
protocol-type-filter:
name: protocolType
in: query
required: false
schema:
type: string
enum:
- document
- data
- status
- new_submission
description: query parameter to restrict submissions associated to the provided protocol type.
cursor-after:
name: after
in: query
description: Cursor that points to the end of the page of data that has been returned.
required: false
schema:
type: string
embed:
name: embed
in: query
style: form
required: false
schema:
type: boolean
description: Flag to expand or embed sub-resources in the response resource.<br> By default is set to `FALSE` where only a **ref** to the sub-resources will be returned.<br> By set it to `TRUE` the sub-resources content will be embedded in the response which might affect the payload size
sbms-protocol-limit:
name: limit
in: query
description: Specifies how many items to return at one time (max 40). <br> A query may return fewer than the value of limit due to filtering.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 40
default: 20
since:
name: since
in: query
description: A UTC date-time value that points to the start of the range of time-based data. <br> Defined by date-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
required: true
schema:
type: string
format: date-time
example: 2019-12-29 10:22:50+00:00
cursor-before:
name: before
in: query
description: Cursor that points to the start of the page of data that has been returned.
required: false
schema:
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT