Giter Club home page Giter Club logo

unterlagen-api's Introduction

Unterlagen API

Overview

The Unterlagen API facilitates the uploading of customer documents to the Europace Documents Repository (Unterlagenakte) and their subsequent transfer to banking partners. This API is compatible with both BaufiSmart and KreditSmart platforms.

⚠️ Caution: Banks use the Documents Push API to access released documents.

⚠️ Note: Documents like "Kreditentscheidunginformation" or the "Selbstauskunft" cannot be retrieved. These documents are available at Antraege API.

Use cases

  • Upload customer documents that are essential for credit assessments
  • Modify categories and assignments for already uploaded documents
  • Release documents to banking partners

advisor loanProvider mortgageLoan consumerLoan

authentication GitHub release

Open API / Swagger Documentation

  • Postman
  • V1 HTML V1 YAML
  • V2 HTML V2 YAML

Authentication

🔐 Use OAuth2 for API access (Full details). Required scopes:

Scope API Use case
unterlagen:dokument:lesen as advisor, get metadata and uploaded document.
unterlagen:dokument:schreiben as advisor, upload documents and start categorization. Categorization is mandatory to release categorized documents to loan providers. Furthermore and updating metadata.
unterlagen:unterlage:lesen as advisor, get categorization information and the assignment information in the case. Get Unterlagenanforderungen (list of needed proofs).
unterlagen:unterlage:schreiben as advisor, changing the Unterlagenkategorie and assignment in the case (customer, mortgage, solution) and deleting documents
unterlagen:unterlage:freigeben as advisor, share documents for an application
unterlagen:freigabe:lesen as advisor and loan officer, retrieving the metadata and released documents for an application.
unterlagen:freigabe:schreiben as loan officer, after processing the notification of a new share, set the sharing state (Freigabestatus).

Document Upload via API V2

V2 of our Unterlagen-API can be used to upload documents. This new version is easier to integrate and offers additional functions, such as adding a category when uploading. This API works async and returns immediately a documentId. The document status is visible in Get Documents

Request:

  • caseId: The case ID where the document is to be added.
  • file: The file to be uploaded. (Supported types: pdf, jpg, png, tiff)
  • displayName: [Optional] The name to display on the frontend.
  • category: [Optional] The document category (See also Categories)
  • assignmentId: [Optional] The assignment ID of a document (The possible assignments and their ids can be requested via the "moeglicheZuordnungen" end point.)

Response

  • id: document id

Form Data:

curl --location --request POST 'https://api.europace2.de/v2/dokumente' \
--header 'Authorization: Bearer [YourAccessToken]' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@/path/to/file' \
--form 'caseId=A23WYC' \
--form 'displayName=Ausweis Mustermann' \
--form 'category=Ausweis' \
--form 'assignmentId=7496f579-32c4-4a88-b5ae-9d99cd71727d'

URL Upload

curl --location --request POST 'https://api.europace2.de/v2/dokumente' \
--header 'Authorization: Bearer [YourAccessToken]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "caseId": "A23WYC",
  "url": "https://picsum.photos/595/842",
  "displayName": "Ausweis Mustermann",
  "category": "Ausweis",
  "assignmentId": "7496f579-32c4-4a88-b5ae-9d99cd71727d"
}'

Document API V1

How to add documents to a case

To work with documents, the unterlagen api needs a public reachable document ressource url.

If you have already a cloud ressource, you can directly use it like shown in step 3. If you have not, please use the europace temporary cloud storage /dokumente/transferspeicher which create a presigned url shown in step 1 and 2.

How to use cloud storage (Tranferspeicher)

Note ⚠️: This endpoint is deprecated and will be removed in future versions. Please migrate to V2 Upload as soon as possible

Step 1: create presigned url

example request:

curl --location --request POST 'https://api.europace2.de/v1/dokumente/transferspeicher' \
--header 'Authorization: Bearer jwtToken'

example response:

{
    "uploadData": {
        "url": "https://s3.eu-central-1.amazonaws.com/filecachestack-filecache8e64047f-1sk2qs95dbtr1",
        "fields": {
            "key": "9a7ac6f2-2666-4d37-97e7-83ed8ba45184",
            "bucket": "filecachestack-filecache8e64047f-1sk2qs95dbtr1",
            "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
            "X-Amz-Credential": "Credential-Token",
            "X-Amz-Date": "20200221T123511Z",
            "X-Amz-Security-Token": "Security-Token",
            "Policy": "eyJleHBpcmF0aW9uIjoiMjAyMC0wMi0yMVQxMzozNToxMVoiLCJjb25kaXRpb25zIjpbWyJjb250Z",
            "X-Amz-Signature": "90758c081db7d8f3ac92c0c41a8becc308c074291994e6f48ea99321ba93c9ee"
        }
    },
    "downloadUrl": "https://filecachestack-filecache8e64047f-1sk2qs95dbtr1.s3.eu-central-1.amazonaws.com/9a7ac6f2-2666-4d37-97e7-83ed8ba45184?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=Credential&X-Amz-Date=20200221T123511Z&X-Amz-Expires=900&X-Amz-Security-Token=Security-Token&X-Amz-SignedHeaders=host"
}

The created urls for uploading and downloading are valid for 60 minutes and can be accessed multiple times.

Step 2: upload document file to europace cloud storage

Requirements:

  • you can upload PDF and image files (JPG, PNG, tif). BMP and GIF did'nt work
  • the maximum file-size is 100 megabytes

The request uses the data from "uploadData" from step 1. The "url" forms the target of the request, the elements of the "fields" list form parameters. The last parameter "file" is the path to the document to be uploaded.

example request:

curl --location --request POST 'https://s3.eu-central-1.amazonaws.com/filecachestack-filecache8e64047f-1sk2qs95dbtr1' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------198537869835208851079266' \
--form 'key=9a7ac6f2-2666-4d37-97e7-83ed8ba45184' \
--form 'bucket=filecachestack-filecache8e64047f-1sk2qs95dbtr1' \
--form 'X-Amz-Algorithm=AWS4-HMAC-SHA256' \
--form 'X-Amz-Credential=Credential-Token' \
--form 'X-Amz-Date=20200221T123511Z' \
--form 'X-Amz-Security-Token=Security-Token' \
--form 'Policy=eyJleHBpcmF0aW9uIjoiMjAyMC0wMi0yMVQxMzozNToxMVoiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDAwMDAwMDBdLHsia2V5IjoiOWE3YWM2ZjItMjY2Ni00ZDM3LTk3ZTctODNlZDhiYTQ1MTg0In0seyJidWNrZXQiOiJmaWxlY2FjaGVzdGFjay1tdHAtZmlsZWNhY2hlbXRwOGU2NDA0N2YtMXNrMnFzOTVkYnRyMSJ9LHsiWC1BbXotQWxnb3JpdGhtIjoiQVdTNC1ITUFDLVNIQTI1NiJ9LHsiWC1BbXotQ3JlZGVudGlhbCI6IkFTSUFRQkhPSEdOR1pNNUY2Sk43LzIwMjAwMjIxL2V1LWNlbnRyYWwtMS9zMy9hd3M0X3JlcXVlc3QifSx7IlgtQW16LURhdGUiOiIyMDIwMDIyMVQxMjM1MTFaIn0seyJYLUFtei1TZWN1cml0eS1Ub2tlbiI6IklRb0piM0pwWjJsdVgyVmpFR1VhREdWMUxXTmxiblJ5WVd3dE1TSkdNRVFDSUFVb2gwam4xVTl5N0hhY2F2cTRCMEt5YnVudW54dUlPVGJSWjRPaFRCR1ZBaUJYUW5WYkpxSDl4MHZUay93YStydW1FVDgyWTF5d0FMc1A1ME5meXA4RXhpcjlBUWd1RUFBYUREQXdNalkwTnpBM056Y3dPU0lNMFdLKzFrSzlTaDhpa05TV0t0b0JrU3FzTklkY3hjMk5XSTJhVnpBa0RsMTBsL1Q1blFqNXZBbFFwS1ptMEp1UkFyTUJ1UEJtdWFFUE9VclBnSHhXN2tsSUpFcDVsV0JxMG5aVzRhcWYvL3VsSUlselRTazlCYmZNbDVhNXFuNVlvcXQ3WjBsZERWVFE0UGtkMFBWazhQTUxTT0c2WU9jdnNwZGtFU1lLU1JZN0x6d2ZIekxNcUUzaGxzbC9lRCtQK3ZUOE9ISGtSZXZscld1VjlLdWg0ZVpJb3ErOEhZemxBeE50WTRPUUc1Smxkem9nQ2ZxZmYza2lJamFmYWd4NGIwTnlvaWNNcC93VXl0TVFieFpndWJVaTM4V0Q2NHl3ZEhnem9lMHl1d3lUL08vQzRHdzZSM3N3L3B5LzhnVTY0Z0hJOVBNbW5nT1UvdUUwc09SbUkzWHpCSkpYcTc5VGs1UGl4d2pNc05HeENpRnBTZjFDdHMvQUcxTktpQi9HQTFscUREVDZuSHNhQ21HN2IvanJNcDZJb1hGOXEyNjFaSzQ4KzVrQ2x0THArMjZUMHl2d0NqWGthTW9zbWtHM01tVjBadGYxMkZJQmxVQVh2MGp2M3BFNjNtdUk0eTB0RnEvWXIybVFmQmxpaFJMZUZMWXJRU2dGSHVGb2Qvdy9Cdjd2ajdtUldoVWZ0TjBwVHFudWVMT1NPKzY0ZjdtZXhQLzVxSXg0NEhxUlNqYUhLb2J1LzVSajFFOW1HbFdsdjBNZWdlNThtaUlNY1YwMnFlK1FkdG9XVG9oekZEZ1BYaWxiZTFhYk8rN2lLVi91In1dfQ==' \
--form 'X-Amz-Signature=90758c081db7d8f3ac92c0c41a8becc308c074291994e6f48ea99321ba93c9ee' \
--form 'file=@/Pfad/zum/Dokument.pdf'

Step 3: deploy document to unterlagen api

The freely accessible ressource url or the "downloadUrl" from response of step 1 is used for deployment.

Requirements:

  • API User has scope unterlagen:dokument:schreiben
  • document is freely accessible with ressource url

Parameters:

  • anzeigename: filename in the frontend
  • vorgangsNummer: case id, where the document will add

example request:

curl --location --request POST 'https://api.europace2.de/v1/dokumente' \
--header 'Authorization: Bearer jwtToken' \
--header 'Content-Type: application/json' \
--data-raw '{
	"anzeigename" : "Kontoauszug.jpg",
	"vorgangsNummer" : "MA9PSX",
	"url" : "https://filecachestack-filecache8e64047f-1sk2qs95dbtr1.s3.eu-central-1.amazonaws.com/9a7ac6f2-2666-4d37-97e7-83ed8ba45184?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=Credential&X-Amz-Date=20200221T123511Z&X-Amz-Expires=900&X-Amz-Security-Token=Security-Token&X-Amz-SignedHeaders=host"
}'

How to get documents of a case

Requirements:

  • API user has scope unterlagen:dokument:lesen
  • the case is accessible for API user

Get metadata for all documents of case Z75226. Example request:

curl --location --request GET 'https://api.europace2.de/v1/dokumente/?vorgangsNummer=Z75226' \
--header 'Authorization: Bearer access-token'

Example Response:

[
    {
        "id": "61c0c61a8b34173cc62e7896",
        "schluessel": "149934dcb4937c9b8ac038b64a7515c966c5c78194c6dc7bd118eaea9f9fee7aa18c022a7c617d05b0b07e7105a8be251bef09029220761cde925089956286",
        "anzeigename": "2016_Muster_Einkommensteuerbescheid",
        "filename": "2016_Muster_Einkommensteuerbescheid.pdf",
        "erstellungsdatum": "2021-12-20T19:06:18.756+01:00",
        "type": "application/pdf",
        "size": 126066,
        "vorgangsNummer": "KX64LP",
        "verschluesselt": false,
        "kategorisierungsStatus": {
            "status": "DONE"
        },
        "_links": {
            "self": {
                "href": "https://api.europace2.de/v1/dokumente/61c0c61a8b34173cc62e7896",
                "type": "application/json"
            },
            "preview": {
                "href": "https://api.europace2.de/v1/dokumente/61c0c61a8b34173cc62e7896/preview?page={page}{&size}",
                "type": "image/jpeg"
            },
            "kategorisierung": {
                "href": "https://api.europace2.de/v1/dokumente/61c0c61a8b34173cc62e7896/kategorisierung",
                "type": "application/json"
            },
            "download": {
                "href": "https://api.europace2.de/v1/dokumente/61c0c61a8b34173cc62e7896/content",
                "type": "application/pdf"
            },
            "publicDownload": {
                "href": "https://www.europace2.de/dokumentenverwaltung/download/?id=149934dcb4937c9b8ac038b64a7515c966c5c78194c6dc7bd118eaea9f9fee7aa18c022a7c617d05b0b07e7105a8be251bef09029220761cde925089956286",
                "type": "application/pdf"
            }
        }
    },
    ...
]

Pages, shares, categorization, assignments and preview images

As follows you will get an overview of methods and model. For further details please take a look at the Open API Specification

Pages

Seite

Shares and download application documents

Unterlage

Categorization, assignments and preview images

Sonstiges

Push notifications / webhook

As loan officer you maybe don't want to poll the API all the time to fetch all the shared documents. Instead you can implement a webhook to receive notifications for new shared documents. See here for further informations: Unterlagen Push API

Table of categories

The categories used in the API are mapped as strings and can currently take the values below.

All categories can be set manually (if the Vorgang/Antrag requires a Unterlagen).

ID Anzeigename Beschreibung Description
Abgeschlossenheit Abgeschlossenheitsbescheinigung Abgeschlossenheitsbescheinigung, Abgeschlossenheitsbestätigung, Antrag auf Abgeschlossenheit, Aufteilungsplan
Abloesevollmacht Ablösevollmacht Ablösevollmacht, Kreditwechselservice (KWS)
Abtretung Abtretungen Abtretungsanzeige, Abtretung von Bausparverträgen, Bauträger-Finanzierungsbestätigungen, Gehaltsabtretungen, Kraftfahrzeuge (KFZ-Brief), Lebensversicherungen, Mietforderungen, Rückgewähransprüche
Altersvorsorge Private oder betriebliche Altersvorsorge Renten- und Lebensversicherungen, Betriebsrenten und Pensionsfonds
Anmeldebestaetigung Anmeldebestätigung Meldeamt Anmeldebestätigung vom Einwohnermeldeamt, Ersatzformulare, Geburts- und Sterbeurkunden, Erbschein, Erklärung zur Selbstnutzung
Anschriftenaenderung Formular Anschriftenänderung Formular zur Anschriftenänderung, Ummeldung, Einzug
Ausweis Ausweisdokument, Reisepass Personalausweis, Ausweisdokument, Reisepass, Aufenthaltstitel, Niederlassungserlaubnis
BWA BWA, Bilanz, GuV BWA, Bilanz, GuV oder E/A-Rechnung, EÜR, Jahresabschluss, Überschuss, Gewinn/Verlust Rechnung, Handelsregisterauszug
Bauantrag Bauantrag, Bauanzeige Antrag oder Anzeige für Baugenehmigung, Bauantrag, Baugesuch
Baubeschreibung Baubeschreibung Baubeschreibung, Objektbeschreibung, Leistungsbeschreibung
Baugenehmigung Baugenehmigung Baugenehmigung, Baustellenschild, Baubeginnanzeige, Anzeige über Baufertigstellung, Bauherrenerklärung, Gebührenbescheid, Genehmigungsfreistellung
Baulasten Baulastenverzeichnis Auskunft aus dem oder Eintragung in das Baulastenverzeichnis, Altlasten
Bauplan Bauplan, Grundriss Baupläne, Grundrisse, Ansichten, Entwürfe, Bauzeichnung, Schnitt
Baurechtsauskunft Baurechtliche Auskunft Baurechtliche Auskunft, Einholung von Auskünften, Auflagen, Baurechtsnachweis, Wasserrecht, B-Plan Änderung
Bauspar_Jahreskontoauszug Jahreskontoauszug zum Bausparvertrag Jahreskontoauszug, Eigenkapitalnachweis Bausparen
Bausparantrag Neuer Bausparantrag Bausparen, Neuabschluss BSV Antrag
Bausparvertrag Bestehender Bausparvertrag Bestehender Bausparvertrag, Zuteilungsschreiben, Bausparurkunde, Jahreskontoauszug
Begleitschreiben Begleitschreiben, Schriftverkehr Anschreiben, Übergabeschreiben an Pooler, E-Mails, Informationen an Produktanbieter
Beratungsdokument Beratungsdokumente für Vertrieb Checklisten, Deckblätter und Inhaltsverzeichnisse, andere Vertriebs-Dokumente
Beratungsprotokoll Beratungsprotokoll, Ratenschutz Beratungsprotokolle, Beratungsdokumentation, Ratenschutzversicherung, Restschuldversicherung, Restkreditversicherung, RSV
Berechnungen Bauwerksberechnungen, Wohnfläche Bauwerksberechnungen, Wohnfläche oder Kubatur, Umbauter Raum
Besichtigungsauftrag Auftrag Objektbesichtigung Auftrag zur Objektbesichtigung, Gutachtenauftrag, Bewertungsauftrag
Besichtigungsbericht Besichtigungsbericht Besichtigungsbericht, Besichtigungsprotokoll
DVV_VVI DVV / VVI Darlehensvermittlungsvertrag und Vorvertragliche Informationen, §491a BGB
Darlehensantrag Immobiliendarlehens-Antrag oder -Vertrag Antrag für Immobiliendarlehen, Prolongation, Zinsanpassung, Konditionsänderung, Baufinanzierungsantrag, Bestehender Altvertrag oder Angebot, auch von Fremdbanken, Drittmittel, Bestandsvertrag
ESM Europäisches Standardisiertes Merkblatt Europäisches Standardisiertes Merkblatt, ESIS
Ehevertrag Ehevertrag Gütertrennung, Ehevertrag, Heiratssurkunde
Einkommensteuer Einkommensteuer Lohn- und Einkommensteuer, Steuererklärung, EkSt
Einkommensteuerbescheid Einkommensteuerbescheid Einkommensteuerbescheid, EkSt Bescheid, Lohnsteuerbescheid, Festsetzung
Elterngeldbescheid Elterngeldbescheid Elterngeldbescheid, Antrag auf Elterngeld, Baukindergeld
Empfangsbestaetigung Empfangsbestätigung Empfangsbestätigung für ESIS, DVV/VVI, Merkblätter, u.a.
Energieausweis Energieausweis Energieausweis EnEV, Gebäudepass
Erbbaurechtsvertrag Erbbaurechtsvertrag Erbbaurechtsvertrag oder Erklärung zum Erbrecht
Erlaeuterungsprotokoll Erläuterungsprotokoll Erläuterungsprotokoll, Erläuterungen zur Darlehensvermittlung
Eroeffnung_Girokonto Eröffnung Girokonto Kontoeröffnungen Girokonto, Gehaltskonto
Erschliessung Erschließungsnachweis Bescheinigung zu Erschließungsbeiträgen, Erschließungsbestätigung, Anliegerbeiträge, Wasser, Gas, Telekom
Expose Exposé Exposé, Zusammenfassung
Faelligkeitsmitteilung Fälligkeitsmitteilung Notar Fälligkeitsmitteilung des Notars
Finanzierungsvorschlag Finanzierungsvorschlag unverbindlicher Finanzierungsvorschlag, Finanzierungsangebot des Vertriebes
Finanzierungsvorschlag_Antwort Antwortschreiben zum Finanzierungsvorschlag Antwortschreiben zum Finanzierungsvorschlag
Finanzierungszusage Finanzierungszusage Finanzierungszusage - auch vorläufig, Drittmittel-Bestätigung, Kreditbestätigung, Förderzusage, Genehmigungsschreiben, Darlehenszusage, Grundsatzzusage, Vollvalutierungsbestätigung
Foerderdarlehen Förderdarlehen, -Antrag, -Zusage Neuer oder Bestehender Antrag, Vertrag oder Angebot für Förderdarlehen, Landesbanken, Investitionsbanken, Förderzusage
Freistellungsvereinbarung Freistellungsvereinbarung Bauträger Freistellungsvereinbarung Bauträger, Freistellungserklärung, Freigabeversprechen, §3 MaBV, Globalfreistellung
Gebaeudeversicherung Gebäudeversicherung Jahresrechnung, Nachtrag oder Vertrag zur Wohngebäudeversicherung, Nachweis des Versicherungsschutzes, Rohbau- oder Feuerversicherung, Haftpflicht
Gehaltsabrechnung Lohn/Gehaltsabrechnung Lohn/Gehaltsabrechnung oder Bezügemitteilung, Rentenabrechnung, Sold, Einkommensnachweis
Grundbuchauszug Grundbuchauszug Grundbuchauszug, Auskunftseinwilligung, Eintragungsbekanntmachung, Erbbaugrundbuch, Mitteilungen vom Grundbuchamt/Amtsgericht
Grunderwerbsteuer Grunderwerbsteuer, Grundsteuer Steuerbescheid zur Grunderwerbsteuer, Grundsteuerbescheid
Grundschuldbestellung Grundschuldbestellung oder Löschung Grundschuldbestellungsurkunde oder Grundschuldbrief, vollstreckbar, Aufgebotsverfahren, Löschungsbewilligung, Pfandfreigabe, Treuhandauftrag, Schuldanerkenntnis, Schuldversprechen
Inkasso Kündigung, Forderung Inkasso, Mahnung, Forderung, Kündigung, §489 BGB, Vorfälligkeit, Zwangsversteigerung
Kaufvertrag Notarieller Immobilien-Kaufvertrag Notarieller Kaufvertrag (Urkunde oder Entwurf), Anlagen und Begleitnotizen zum Kaufvertrag, Tauschvertrag, Schenkungsurkunde, Übertragungsvertrag, Kaufabsichtserklärung
KfW_Antrag KfW Antrag Antrag KfW Fördermittel, Wohneigentumsförderung, inkl. KfW Beiblatt zur Baufinanzierung, Einwilligungserklärung
KfW_Antragsbestaetigung KfW Bestätigung zum Antrag (online) Formular KfW Bestätigung zum Antrag, Onlinebestätigung
KfW_Durchfuehrungsbestaetigung KfW Bestätigung nach Durchführung Formular KfW Bestätigung nach Durchführung, Durchführungsbestätigung
Kontoauszug Kontoauszug, Finanzstatus, Eigenkapital Kontoauszug zu Girokonten, Kreditkarten, Depots, Portfolios oder Darlehen, Finanzstatus, Kreditkartenumsatz, Schenkungen, Eigenkapitalnachweis
Kostenaufstellung Kostenaufstellung Aufstellung der Bau- oder Modernisierungskosten, Eigenleistungen, Angebote, Kostenvoranschlag, Reservierungsvereinbarung
Krankenversicherungsnachweis Krankenversicherungsnachweis Nachweis zur Privaten Krankenversicherung, Änderungsmitteilung, Bescheinigung, Versicherungsschein
Leerseite Leerseite Seite ohne Inhalt
Legitimationspruefung Formular Legitimationsprüfung Legitimationsprüfung, Identitätsprüfung
Lohnsteuerbescheinigung Lohnsteuerbescheinigung Ausdruck der elektronischen Lohnsteuerbescheinigung
Mietvertrag Mietvertrag Mietvertrag, Vermietungsbestätigung, Pacht
Nachrangdarlehen Privatdarlehen, -Antrag, -Zusage Antrag, Angebot für nachrangige Darlehen, Kreditbestätigung Nachrangdarlehen, Privatdarlehenvertrag
Objektfotos Objektfotos Objektfotos, Bilder, Photos (innen, außen oder Baufortschritt)
Plankarten Flurkarte, Lageplan Flurkarte, Lageplan, Bebauungsplan, Fortführungserklärung, BORIS, Bodenrichtwerte, Liegeschaftskarte, Katasterkarte
Privatkreditvertrag Ratenkreditvertrag Privatkredit, Ratenkreditvertrag oder -Antrag, Neuabschluss und Ablösung von Krediten, Bestehende und Abzulösende Konsumkredite, Leasing, Ratenschutz, RSV
Ratenschutzversicherung Ratenschutz-, Restschuldversicherung Ratenschutzversicherung, Restschuldversicherung, Restkreditversicherung, RSV
Rechnung_Quittung Rechnungen, Verbrauchsgüterkaufvertrag Rechnungen zu Bauvorhaben oder Nebenkosten, Betriebskosten, Notarkosten, Erschließungsbeiträge, Maklergebühren, Kaufvertrag für Konsumgüter und Autos
Rentenbescheid Rentenbescheid Rentenbescheid oder Rentenanpassung der gesetzlichen Altersrente
Renteninformation Renteninformation Renteninformation zur zukünftigen gesetzlichen Altersrente
Saldenmitteilung Ablöseschreiben, Saldenmitteilung Saldenmitteilung, Zinsbescheinigung, Valutenbescheinigung, Ablöseinformation
Scheidungsbeschluss Scheidungsbeschluss Scheidungsurteil oder Beschluss
Scheidungsfolgevereinbarung Scheidungsfolgevereinbarung Notarielle Scheidungsfolgevereinbarung (Urkunde oder Entwurf), Trennungsvereinbarung
Selbstauskunft Selbstauskunft, Schufa Selbstauskunft, Erfassungsbogen, Datenschutzklausel, Einwilligung zu Auskünften und Werbung, Schufa, Datenschutzhinweise, Bankauskunft
SEPA_Mandat SEPA Lastschriftmandat SEPA-Lastschriftmandat
Sicherungsvereinbarung Sicherungsvereinbarung für Grundschuld Formular Sicherungsvereinbarung für Grundschuld, Abtretung der Rückgewähransprüche
Sonstige_Einnahmen Sonstige Einnahmen Sonstige Einnahmen (Waisenrente, Krankengeld, Pflegegeld, Einspeisevergütung, u.a.)
Teilungserklaerung Notarielle Teilungserklärung Notarielle Teilungserklärung (Urkunde oder Entwurf), Anlagen (Pläne, Verwaltervertrag, Mieteraufstellung, Eigentümerversammlung, Wirtschaftsplan), Neufassung, Abschrift, Vollmacht
Uebergabeprotokoll Übergabeprotokoll Übergabeprotokoll an Produktanbieter
Ueberweisungsbeleg Überweisungsbeleg Überweisungsbeleg oder Kontoumsatzdetails, Einzahlungsbeleg, Buchungsnachweis, Ausdruck Online Banking
Unterhaltsnachweis Unterhaltsnachweis Unterhaltsnachweis, Beschluss, Urkunde, amtliches Schreiben, Jugendamt, persönliche Erklärung zum Unterhalt, Kindergeldbescheid
Unterlage_Arbeitgeber Arbeitgeber Unterlagen Dokument vom Arbeitgeber, Arbeitsvertrag, Bescheinigung Elternzeit, Ernennungsurkunde, Weiterbeschäftigung
Vermittlerabfrage Vermittlerabfrage Vermittlerabfrage
Vermoegensuebersicht Vermögensübersicht Vermögensaufstellung, Vermögensübersicht, Immobilienaufstellung
Werkvertrag Werkvertrag, Bauvertrag Werkvertrag, Bauvertrag, Bauwerkvertrag, Architektenvertrag, Bauträgervertrag, Freistellung Steuerabzug §48 EStG
Wertgutachten Wertgutachten Vollgutachten, Kurzgutachten, Objektbewertung
Wertindikation Wertindikation Formular Wertindikation Sprengnetter
Zahlungsabruf Zahlungsabruf und Baufortschritt Zahlungsabruf, Baufortschrittsanzeige, Bautenstandsbericht, Bauprotokoll, Auszahlungsanweisung, Verwendungsnachweis, Erklärung zur Sofortigen Auszahlung
Zahlungsplan Zahlungsplan Zahlungsplan, Zahlplan, Teilzahlungen, Auszahlungsplan
Zustellungsvollmacht Zustellungsvollmacht Formular Zustellungsvollmacht
Zustimmungserklaerung Zustimmungserklärung Zustimmung zur Darlehensaufnahme, Besicherung, Zustimmung des Ehepartners, Objektwechsel, Rangrücktritt, Stillhalteerklärung
Sonstiges Sonstiges note: is never the result of automatic detection

Support

If you have any questions or problems, please contact [email protected].

Terms of use

The APIs are provided under the following Terms of Use.

unterlagen-api's People

Contributors

caspii avatar dbohry avatar dennismsdev avatar dos-meta avatar epsha avatar fritzduchardt avatar gomil avatar helge-s avatar hungryharry avatar konefuzius avatar konfusio avatar marcuspflanz avatar matthiasfuessel avatar mikekrueger75 avatar schmidthappens avatar stockf avatar yunabraska avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

unterlagen-api's Issues

/dokumente/transferspeicher'(post).responses.201.UploadWithUrl.requestBody is not of type `string`

Fehlerbeschreibung

Die API kann nicht mit einem validierenden OpenAPI-Generator übersetzt werden. Die Übersetzung bricht mit folgender Fehlermeldung ab:

Exception in thread "main" org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
 | Error count: 1, Warning count: 0
Errors: 
	-attribute paths.'/dokumente/transferspeicher'(post).responses.201.UploadWithUrl.requestBody is not of type `string`

Das passiert mit der aktuellsten stabilen Version 4.3.1.

Hinweise

Ich kenne mich nicht so gut mit OpenAPI aus, aber meiner Meinung nach darf hier keine Property url definiert werden:

unterlagen-api/swagger.yaml

Lines 130 to 134 in 88c9fe5

links:
UploadWithUrl:
operationId: uploadDokument
requestBody:
url: '$response.body#/downloadUrl'

Laut OpenAPI-Spec darf das Feld requestBody eines Link Objects nur einen festen Wert oder eine Runtime Expression enthalten. Ihr versucht aber einen strukturierten Body zu definieren.

Kategorisierung direkt nach Upload starten

Derzeit sind zwei HTTP requests für hochladen und starten der Kategorisierung nötig. Weil Netzwerke nie perfekt sind, kann es daher vorkommen, dass der POST zum starten der Kategorisierung fehlschlägt.

Meine Vorschlag wäre es, einen zusätzliche flag beim Upload hinzuzufügen, der die Kategorisierung automatisch startet, sobald der Upload fertig ist.

kleinere Ungereimtheiten in der API (Version (1.0.30))

Findings während der Implementierung des Uploads auf unserer Seite

  • POST /dokumente/freigabe hat laut doke HTTP status 201 im success case, aktuell ist es aber 200
  • der Error Response liefert aktuell nicht die Zeitzone im Timestamp, nicht wie die anderen Endpoints obwohl laut swagger.yaml der datentyp gleich ist
    -- Dokument["erstellungsdatum"] -> '2019-12-12T09:20:43.3+01:00'
    -- Error['timestamp'] -> '2019-12-12T09:20:43.3'

Fragen/Feedback zu v0.3

POST /dokument

  • Requestbody parameter "vorgangsNummer" -> Ist das API-sprech für die BS-internen Teilvorgangsnummern? Falls nicht: Dokumente werden TeilVorgaengen zugeordnet und dann ggf. für andere Teilvorgänge freigegeben.
  • Responses parameter "vorgangsNummern" -> siehe oben + warum wird das im Gegensatz zur Antragsnummer überhaupt zurückgegeben?
  • Parameter "beschreibung" -> was soll da drin stehen?
  • Beim Hochladen muss das Dokument einem Teilvorgang oder einem Antrag zugeordnet werden. Kann man das in der API deutlich machen? Momentan sind beide Parameter optional.

PUT /dokument

  • Was ist der Use Case dahinter? Können wir darauf erstmal verzichten?

GET /dokument

  • Müssen wir die Klassifizierungsergebnisse bzw den Status (falls es gerade läuft) hier auch ausliefern können? Bzw gibt es für die Klassifizierung einen extra Pfad?

GET /dokumente/{id}/klassifizierung/{klassifizierungsId}

  • Was ist der Unterschied zwischen den Parametern "klasse" und "zuordnung.name"?
  • Parameter "bereichsnummer" -> ergibt der sich nicht implizit aus der Reihenfolge im Array? Wozu brauchen wir den überhaupt?
  • Parameter "zuordnung.antragsnummer" -> Können wir das hier bestimmen? Eine Unterlage kann Unterlagenanforderungen von mehreren Anträgen erfüllen. Imo ergibt sich die Frage nach der Zuordnung eher aus Sicht der Unterlagenanforderung bzw des Antrags. Oder welche Frage wird hier genau beantwortet?

Starte Klassifizierung

  • Reicht hier ein Call oder brauchen wir noch Statusabfragen, wenn es mal länger dauert?

Korrigiere Klassifizierungsbereich

  • Wollen wir hier einzelne Unterlagen korrigieren oder nicht eher komplette Klassifizierungen?
  • Hier ist es imo wichtig, die API mit Smartcat abzustimmen, falls nicht ohnehin schon passiert.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.