Nachweispaket abrufen
Gibt das während der biometrischen Erfassung erzeugte Nachweispaket zurück — ein Paket, das die erfassten Bilder, Metadaten und Erfassungsartefakte enthält, mit denen nachgewiesen wird, dass die Lebenderkennung unter kontrollierten Bedingungen durchgeführt wurde.
Nur für abgeschlossene Prozesse verfügbar (state = PROCESS_STATE_FINISHED).
Endpunkt
| Umgebung | URL |
|---|---|
| Produktion | GET https://api.idcloud.unico.app/client/v1/process/{processId}/evidenceset |
| Sandbox | GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}/evidenceset |
Request
| Header | Wert |
|---|---|
Authorization | Bearer <access_token> (siehe Authentifizierung) |
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
processId | string (UUID) | ja | Prozesskennung, die von Prozess erstellen zurückgegeben wird. |
Beispiel
- cURL
- Node.js
curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/evidenceset \
-H "Authorization: Bearer $TOKEN" \
| jq -r .fileContents | base64 --decode > evidence-set.pdf
import { writeFile } from 'node:fs/promises';
async function getEvidenceSet(processId) {
const response = await fetch(
`https://api.idcloud.unico.app/client/v1/process/${processId}/evidenceset`,
{ headers: { Authorization: `Bearer ${accessToken}` } }
);
if (!response.ok) throw new Error(`Get Evidence Set failed with ${response.status}`);
const { fileContents } = await response.json();
// fileContents ist die PDF-Datei, base64-kodiert
return Buffer.from(fileContents, 'base64');
}
// PDF auf der Festplatte speichern
await writeFile(`evidence-set-${processId}.pdf`, await getEvidenceSet(processId));
// Oder an den Browser senden (Express)
app.get('/processes/:id/evidence-set', async (req, res) => {
const pdf = await getEvidenceSet(req.params.id);
res
.type('application/pdf') // contentType nicht weiterleiten: Die API gibt "x-pdf" zurück
.set('Content-Disposition', 'inline; filename="evidence-set.pdf"')
.send(pdf);
});
Antworten
{
"fileContents": "JVBERi0xLjMNCi...",
"contentType": "x-pdf"
}
| Feld | Typ | Beschreibung |
|---|---|---|
fileContents | string (base64) | Das PDF des Nachweispakets, base64-kodiert. |
contentType | string | Gibt derzeit x-pdf zurück. |
x-pdf ist kein gültiger MIME-Typ, und Browser erkennen ihn nicht. Leiten Sie contentType nicht an den Browser weiter. Dekodieren Sie fileContents aus base64 und stellen Sie die Bytes als application/pdf bereit, wie im obigen Node.js-Beispiel.
Fehlercodes
Die API stellt für diesen Endpunkt keine spezifischen code- oder message-Werte bereit.
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
Der Pfadparameter processId fehlt oder ist fehlerhaft formatiert.
Bearer-Token fehlt, ist abgelaufen oder ungültig. Siehe Authentifizierung.
Prozess nicht gefunden, oder das Nachweispaket ist noch nicht verfügbar (Prozess nicht abgeschlossen).
| Code | Nachricht | Beschreibung |
|---|---|---|
99999 | Internal failure! Try again later | Wenn ein interner Fehler auftritt. |
Nächste Schritte
- Für das vollständige Prozessergebnis siehe Prozess abrufen.
- Für das erfasste Selfie siehe Selfie abrufen.