Capture API
Methoden zum Starten einer Sitzung
| Methode | Beschreibung |
|---|---|
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(_:webAppToken:) | Öffnet die vorbereitete Selfie-Kamera und übergibt den process.webAppToken, der von Create Process zurückgegeben wird |
openDocument(_:delegate:) | Öffnet die vorbereitete Dokumentkamera mit einem DocumentEnums |
Aufnahmeoptionen / Parameter
PrepareInfo — Metadaten zur Identifikation der Benutzersitzung.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
externalUserId | String | ja | Benutzerkennung in Ihrem System. Wird vor der Übertragung mit SHA-256 gehasht. |
useCase | String | nein | Kennung 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.
| Feld | Typ | Beschreibung |
|---|---|---|
base64 | String | Aufgenommenes Bild in Base64 |
encrypted | String | JWT zur Übertragung an das Backend |
SuccessResult — Objekt, das von onSuccess in einer Unico API-Integration zurückgegeben wird.
| Feld | Typ | Beschreibung |
|---|---|---|
processId | String | Prozesskennung, die zur Abfrage des Validierungsergebnisses über die REST-API verwendet wird |
DocumentResult — Objekt, das bei erfolgreicher Dokumentaufnahme zurückgegeben wird. Gleiche Felder wie SelfieResult.