Zum Hauptinhalt springen

Capture API

Methoden zum Starten einer Sitzung
MethodeBeschreibung
prepareSelfieCamera(_:config:)Bereitet die Selfie-Kamera vor
prepareSelfieCamera(_:config:prepareInfo:)Bereitet die Selfie-Kamera mit PrepareInfo-Metadaten vor
prepareDocumentCamera(_:config:)Bereitet die Dokumentkamera vor
open(_:)Öffnet die vorbereitete Selfie-Kamera
openDocument(_:delegate:)Öffnet die vorbereitete Dokumentkamera mit einem DocumentEnums
Aufnahmeoptionen / Parameter

PrepareInfo — Metadaten zur Identifikation der Benutzersitzung.

FeldTypErforderlichBeschreibung
externalUserIdStringjaBenutzerkennung in Ihrem System. Wird vor der Übertragung mit SHA-256 gehasht.
useCaseStringneinKennung für den aktuell laufenden Kontext oder Ablauf. Wird im Klartext übertragen.

DocumentEnums — siehe Enums.

Ergebnistypen und Felder

SelfieResult — Objekt, das bei erfolgreicher Selfie-Aufnahme zurückgegeben wird.

FeldTypBeschreibung
base64StringAufgenommenes Bild in Base64
encryptedStringJWT zur Übertragung an das Backend

DocumentResult — Objekt, das bei erfolgreicher Dokumentaufnahme zurückgegeben wird. Gleiche Felder wie SelfieResult.