KEX-Antragsdokumente-Upload-API

⚠️ You'll find German domain-specific terms in the documentation, for translations and further explanations please refer to our glossary

General

This API enables the user to upload a document to an application. The service expects a POST request with a JSON document as request body.

⚠️ This API is continuously developed. Therefore we expect all users to align with the "Tolerant Reader Pattern", which requires clients to be tolerant towards compatible API changes when reading and processing the data. This means:

1. unknown properties must not result in errors

2. Strings with a restricted set of values (Enums) must support new unknown values

3. sensible usage of HTTP status codes, even if they are not explicitly documented

Uploading documents

The Antragsdokumente-Upload-API for KreditSmart cases can be accessed at the following URL:

https://www.europace2.de/kreditsmart/kex/antraege/dokumente

The following properties are available for the request body:

Request parameter	Description	Comment
antragsnummer	Identifier of the application on the Europace2 platform	Mandatory if no produktanbieterantragsnummer is submitted.
produktanbieterantragsnummer	Identifier of the application to the relevant Produktanbieter	Mandatory if no antragsnummer is submitted.
kommentar	Comment, that can be displayed in the GUI	Optional
tags	List of tags describing features of the uploaded document	Optional allowed values: QES
antragsdokument	The document to be uploaded	Mandatory
antragsdokument.fileName	The document's file name	Mandatory
antragsdokument.fileContent	The document's content as a base64 encoded string	Mandatory

The following HTTP headers will be expected:

Header Parameter	Description	Comment
Content-Type	Content type of the request body	Always has to be application/json

The request body size must not exceed 10 MB.

If the document already exists in the current application (with same name, comment and document hash), it will not be added again.

Authentication

An authentication is required for each request. This API is secured by the OAuth 2.0 client credentials flow using the Authorization-API. To use these APIs your OAuth2-Client needs the following scopes:

Scope	Label in Partnermanagement	Description
privatkredit:antrag:schreiben	KreditSmart-Anträge anlegen/verändern	Scope for updating a case

HTTP Status Codes

Error Code	Message	Description
201	Created	Request was successful
401	Unauthorized	Authentication failed
403	Forbidden	The API client misses a scope
413	Request Entity Too Large	Request body is too large

Examples

The examples shown here can be used for testing by curl in the following way:

curl -v -XPOST https://www.europace2.de/kreditsmart/kex/antraege/dokumente \
	-H 'Content-Type: application/json' \
	-H "Authorization: Bearer ${TOKEN}" \
	-d "${REQUEST_BODY}"

Adding a document with Produktanbieterantragsnummer

The document for an application with the Produktanbieterantragsnummer 12919351 can be uploaded with the following request-body:

{
  "produktanbieterantragsnummer": "12919351",
  "antragsdokument": {
    "fileName": "Kreditvertrag.pdf",
    "fileContent": "....."
  }
}

Adding a document with Antragsnummer

Alternatively, the Antragsnummer can be used instead of the Produktanbieterantragsnummer:

{
  "antragsnummer": "ABC123/1/1",
  "antragsdokument": {
    "fileName": "Kreditvertrag.pdf",
    "fileContent": "....."
  }
}

Adding a document with comment

The request can also contain a comment which is displayed to the users of KreditSmart in addition to the actual document:

{
  "antragsnummer": "ABC123/1/1",
  "kommentar": "Der Kreditvertrag wurde erstellt. Bitte prüfen und unterschreiben.",
  "antragsdokument": {
    "fileName": "Kreditvertrag.pdf",
    "fileContent": "....."
  }
}

Adding a document with tags

The request can also contain a list of tags describing features of a document:

{
  "antragsnummer": "ABC123/1/1",
  "tags": ["QES"],
  "antragsdokument": {
    "fileName": "Kreditvertrag.pdf",
    "fileContent": "....."
  }
}

Terms of use

The APIs are made available under the following Terms of Use.