get_document_description
Endpoint: POST https://v7.fb-vertragscheck.fb-preview.de/external/get/document
Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/get/document/request/schema
| property | default | description | options |
|---|---|---|---|
|
[ token ]
* required
string |
Token für die Autentifizierung mit der Schnittstelle
|
mime-type: application/json, text/json
{
"token": "a1s2d3f4g5h6j7k8l9"
}
mime-type: application/json, text/json
{
"token": "a1s2d3f4g5h6j7k8l9"
}
Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/get/document/response/schema
| property | default | description | options | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
[ status ]
* required
string |
Status des Aufrufs
OK: Anfrage erfolgreich ERROR: Anfrage verlief fehlerhaft |
|||||||||||||||||||||
|
[ errors ]
array |
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!
|
|||||||||||||||||||||
|
[ protocoldata ]
array |
Informationen zum Dateiabruf
|
|||||||||||||||||||||
|
||||||||||||||||||||||
mime-type: application/json, text/json
{
"status": "OK",
"errors": [
"Bitte geben Sie eine gültige Telefonnummer ein."
],
"protocoldata": [
{
"mime_type": "application\/pdf",
"buffer": "AS3RDCFG5HZTFRBHJUZTFRD89SDFBH09NJH4G",
"filename": "Beratungsdokumentation.pdf",
"encoded": "base64"
}
]
}