Das Selfie abrufenGET

Lesen Sie das für einen Prozess aufgenommene Selfie über die id, die Human Plugin beim Erstellen zurückgegeben hat.

Markdown

GET /v1/processes/{id}/selfie

id ist die UUID aus der Antwort auf das Erstellen. Die Anfrage hat weder Body noch Query-Parameter.

curl http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie

Human Plugin behält keine Kopie des Selfies: Jeder Aufruf holt es erneut ab.

Antwort

200 OK, mit dem Bild in Base64 und seinem Typ:

{
  "fileContents": "/9j/4AAQSkZJRgABAQAAAQABAAD…",
  "contentType": "image/jpeg"
}

So speichern Sie es als Datei:

curl -s http://human-plugin.internal:8080/v1/processes/17e4546e-6109-4240-8c0b-4ba98474a104/selfie \
  | jq -r .fileContents | base64 -d > selfie.jpg

Verfügbarkeit

• Ein Selfie gibt es nur für einen Prozess, der eines hatte: in imageBase64 gesendet oder von der Person aufgenommen.
• Bei einem Journey-Flow existiert das Selfie erst, nachdem die Person es aufgenommen hat. Bis dahin wird die Anfrage mit 400 und einer message abgelehnt, die mit process state must be finished beginnt. Lesen Sie zuerst den Prozess und rufen Sie das Selfie ab, sobald er PROCESS_STATE_FINISHED ist.
• Das Selfie ist nach dem Abschluss des Prozesses nur für begrenzte Zeit verfügbar. Wenn Sie es später brauchen, speichern Sie es aus dieser Antwort.

Umgang mit dem Bild

Das Selfie sind biometrische Daten. Human Plugin speichert oder protokolliert es nie, und die Antwort wird mit Cache-Control: no-store gesendet. Halten Sie es auch aus den Logs Ihres Gateways und Ihrer Anwendung heraus.

Fehler

Status	message	Bedeutung
400	process state must be finished…	Ein Journey-Prozess, dessen Aufnahme noch nicht abgeschlossen ist. Lesen Sie zuerst den Prozess
404	PROCESS_NOT_FOUND	Die id ist keine UUID oder unbekannt
404	SELFIE_NOT_FOUND	Der Prozess hat kein Selfie: Er hatte keine Aufnahme, ist vor dem Start fehlgeschlagen, oder das Selfie ist nicht mehr verfügbar
4xx	Die message der Ablehnung	Die Anfrage wurde abgelehnt. Der Grund steht in message und details
502	UPSTREAM_UNAVAILABLE	Das Selfie konnte nicht rechtzeitig abgerufen werden. Später erneut versuchen
503	DATABASE_UNAVAILABLE	Die Datenbank ist ausgefallen. Später erneut versuchen

Lesezugriffe können gefahrlos wiederholt werden. Ein 404 ändert sich bei einem erneuten Versuch nicht.

Weiter

Prozesslebenszyklus