Skip to content

Commit

Permalink
added assignment_id (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
@YunaBraska
YunaBraska authored Jun 6, 2024
1 parent 39aa850 commit bde3b62
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,18 @@ platforms.
🔐 Use OAuth2 for API access ([Full details](https://docs.api.europace.de/common/authentifizierung/authorization-api/)).
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, updating metadata and deleting uploaded documents. |
| `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) |
| `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). |
| 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
_🏗️ Only works with BaufiSmart. KreditSmart will be supported soon._

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.
Expand Down Expand Up @@ -78,7 +79,8 @@ curl --location --request POST 'https://api.europace2.de/v2/dokumente' \
--form 'file=@/path/to/file' \
--form 'caseId=A23WYC' \
--form 'displayName=Ausweis Mustermann' \
--form 'category=Ausweis'
--form 'category=Ausweis' \
--form 'assignmentId=7496f579-32c4-4a88-b5ae-9d99cd71727d'
```

**URL Upload**
Expand All @@ -91,7 +93,8 @@ curl --location --request POST 'https://api.europace2.de/v2/dokumente' \
"caseId": "A23WYC",
"url": "https://picsum.photos/595/842",
"displayName": "Ausweis Mustermann",
"category": "Ausweis"
"category": "Ausweis",
"assignmentId": "7496f579-32c4-4a88-b5ae-9d99cd71727d"
}'
```

Expand Down

0 comments on commit bde3b62

Please sign in to comment.