Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Interhyp documents API

access to submission documents

Interhyp documents API is one of 8 APIs that Interhyp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.0.2, at version 2.0.0.

Requests are made against 2 base URLs: https://api-test.interhyp.de/submission, https://api.interhyp.de/submission.

2 operations 2 paths 13 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2.0.0
Base URL
https://api.interhyp.de/submission/v2
Authentication
HTTP Bearer
License
Interhyp AG
Resource Areas
1

Authentication & Security 1

Interhyp documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

documents 2

access to submission documents

GET
/v2/submissions/{submissionId}/documents/metadatadeprecated
Delievers all submission relevant documents metadata
getDocumentsMetadata 3 params → 200202400401404500
GET
/v2/submissions/{submissionId}/documents/{documentId}/binariesdeprecated
Delievers specific submission document in pdf format
getDocumentBinary 3 params → 200202400401404409500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are UnexpectedError (6 properties), DocumentItem (5 properties), DocumentCategory (2 properties), ResourceRef (1 property). Each schema is shown below with its type and property counts.

DocumentCategory
object
2 properties
NotFound
DocumentValidity
object
1 property 2 required
UnexpectedError
object
6 properties 5 required
Documents
object
1 property 1 required
ClientError
object
1 required
DocumentItem
object
5 properties 3 required
BadRequest
ResourceRef
object
1 property 1 required
Conflict
Unauthorized
Binary
string
DocumentCategoryTag
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interhyp-documents-api-openapi.yml Raw ↑

Other APIs Interhyp publishes across the network.

Interhyp commands API
Interhyp financing-application API
Interhyp info API
Interhyp logbook API
Interhyp pre-submission-checks API
Interhyp protocol API
Interhyp submissions API