Prozess erstellen

MarkdownChatGPTClaude

Dies ist der Einstiegspunkt jeder Unico API-Integration. Ihr Back-End ruft ihn auf, um einen Prozess zu erstellen; Ihr Front-End verwendet die zurückgegebenen Tokens, um das iFrame zu rendern, den Nutzer weiterzuleiten oder ein natives SDK zu initialisieren.

Den vollständigen Integrationsablauf finden Sie unter Flows.

Endpunkt

Umgebung	URL
Produktion	POST https://api.idcloud.unico.app/client/v1/process
Sandbox	POST https://api.idcloud.uat.unico.app/client/v1/process

Request

Headers

Header	Wert
Authorization	Bearer <access_token> (siehe Authentifizierung)
Content-Type	application/json

Body-Parameter

Feldanforderungen hängen vom Flow ab

Ob ein Feld erforderlich, optional oder nicht anwendbar ist, hängt vom flow ab, den Sie integrieren — prüfen Sie unter Flows das jeweilige Rezept, das Sie verwenden, bevor Sie die Anforderung eines Feldes allein aus dieser Tabelle ableiten.

Feld	Typ	Beschreibung
callbackUri	string	URL, an die der Nutzer nach Abschluss der Journey weitergeleitet wird. Verwenden Sie / für native SDK-Flows, bei denen der Callback in der App verarbeitet wird.
flow	string	Flow-Kennung — bestimmt, welche Funktionen ausgeführt werden. Beispiele: idunicodocs, idunicosign, idchecktrust, idtoken, idsmart. Siehe Verfügbare Flows.
purpose	string	Geschäftlicher Zweck. Zulässige Werte: creditprocess, biometryonboarding, carpurchase, ageverification.
person.duiType	enum	Dokumenttyp. Siehe duiType-Werte unten.
person.duiValue	string	Dokumentnummer, ohne Formatierung.
person.friendlyName	string	Anzeigename des Nutzers in der Journey-UI. Maximal 50 Zeichen.
person.phone	string	Telefonnummer im Format Landesvorwahl + Ortsvorwahl + Nummer, ohne Trennzeichen. Erforderlich beim Versand von Benachrichtigungen per SMS oder WhatsApp.
person.email	string	E-Mail-Adresse. Erforderlich für Flows mit elektronischer Signatur.
person.​notifications	array	Benachrichtigungskanäle für den Versand des Journey-Links. Jeder Eintrag hat notificationChannel: NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS oder NOTIFICATION_CHANNEL_EMAIL.
references	array	Referenzeingaben für 1:1-Validierung- und Intelligente-Revalidierung-Flows. Jeder Eintrag enthält referenceType (REFERENCE_TYPE_IMAGE_BASE64 oder REFERENCE_TYPE_PROCESS_ID) und referenceContent (base64-kodiertes Bild oder Prozess-UUID). Senden Sie höchstens einen Eintrag — ein längeres Array wird mit 400 abgelehnt, und referenceContent darf nicht leer sein.
useCase	string	Szenario der Intelligenten Revalidierung. Erforderlich für 🇧🇷 idsmart, idsmart_r2, idsmart_tp1. Beispiele: USE_CASE_LOGIN, USE_CASE_FIN_TRANSACTIONS.
clientReference	string	Eindeutige Kennung des Nutzers in Ihrem System. Erforderlich für die Funktion Mehrfachkonten. Eindeutig in Ihrer Datenbasis, maximal 256 Zeichen, keine Leerzeichen.
companyBranchId	string (UUID)	Niederlassungs-ID. Nur erforderlich, wenn dem Service-Account mehr als eine Niederlassung zugeordnet ist.
expiresIn	string	Gültigkeitsfenster des Prozesses ab Erstellung. Format: "3600s". Standardmäßig 7 Tage, wenn nicht angegeben.
flowConfig	object	Konfigurationsüberschreibungen pro Flow.
flowConfig.​biometryCapture.​enabledBackCamera	boolean	Verwendet die Rückkamera des Geräts. Nicht kompatibel mit Dokumentenerfassungs- oder elektronischen Signatur-Flows.
contextualization	object	Transaktionskontext, der dem Nutzer während der Journey angezeigt wird, um die Erfassung zu erklären. Verfügbar für Kunden in jeder Region — nicht auf ein bestimmtes Land beschränkt.
contextualization.​company_name	string	Während der Journey angezeigter Firmenname. Maximal 20 Zeichen.
contextualization.​currency	string	Dem Nutzer angezeigter Währungscode. Zulässige Werte: BRL, MXN, USD.
contextualization.​price	number	Dem Nutzer angezeigter Transaktionsbetrag.
contextualization.​locale	object	Während der Journey angezeigter lokalisierter Text. Schlüssel: ptBr, enUs, esMx — dies sind die einzigen unterstützten Sprachen für den Text, unabhängig von der Region des Kunden.
contextualization.locale.{ptBr|enUs|esMx}.reason	string	Kurzer, während der Journey angezeigter Grund für die Erfassung. Maximal 50 Zeichen.
contextualization.locale.{ptBr|enUs|esMx}.title	string	Titel des während der Journey angezeigten Kundenhinweises. Maximal 100 Zeichen. Muss zusammen mit text angegeben werden. HTML-Tags werden entfernt.
contextualization.locale.{ptBr|enUs|esMx}.text	string	Text des während der Journey angezeigten Kundenhinweises. Maximal 210 Zeichen. Muss zusammen mit title angegeben werden. HTML-Tags werden entfernt.
imageBase64	string	Das direkt gesendete Selfie. Akzeptiert das Erfassungs-JWT des SDK.
document.purpose	enum	Zweck des Dokuments. Feste Werteliste: DOCUMENT_PURPOSE_ONBOARDING, DOCUMENT_PURPOSE_CREDIT_PROCESS, DOCUMENT_PURPOSE_CAR_PURCHASE, DOCUMENT_PURPOSE_PAY_BY_PAYCHECK, DOCUMENT_PURPOSE_FGTS. Wird nur mit Face Document Match-Flows verwendet.
document.​files[].​data	bytes	Neue Dokumentenerfassung, base64-kodiert. Weltweit verfügbar, nicht auf Brasilien beschränkt. Schließt sich gegenseitig mit document.documentId aus.
document.documentId	string (UUID)	Verwendet ein bereits von derselben Person erfasstes Dokument wieder, anstatt eine neue Erfassung durchzuführen. Schließt sich gegenseitig mit document.files[] aus.
expectedResult	object	Simuliert das Ergebnis einer Funktion in Test-/Sandbox-Umgebungen und markiert die Antwort mit simulated: true. Siehe Ergebnisse simulieren (Test Mock).

duiType-Werte

Land	Wert	Beschreibung
AR	DUI_TYPE_AR_PASSPORT	Argentinischer Reisepass
AR	DUI_TYPE_AR_DNI	Argentinische DNI
AR	DUI_TYPE_AR_LNC	Argentinischer Führerschein (Licencia Nacional de Conducir)
AT	DUI_TYPE_AT_STNR	Österreichische Steuernummer (STNR)
BE	DUI_TYPE_BE_NN	Belgische Nationalnummer (NN)
BR	DUI_TYPE_BR_CPF	Brasilianische CPF
BR	DUI_TYPE_BR_PASSPORT	Brasilianischer Reisepass
BR	DUI_TYPE_BR_CNPJ	Brasilianische CNPJ
CA	DUI_TYPE_CA_SIN	Kanadische SIN
CH	DUI_TYPE_CH_AHV	Schweizer AHV/AVS-Nummer
CL	DUI_TYPE_CL_RUN	Chilenische RUN
CL	DUI_TYPE_CL_PASSPORT	Chilenischer Reisepass
CL	DUI_TYPE_CL_LICENCIA_CONDUCIR	Chilenischer Führerschein (Licencia de Conducir)
CO	DUI_TYPE_CO_NIT	Kolumbianische NIT
CO	DUI_TYPE_CO_PASSPORT	Kolumbianischer Reisepass
CO	DUI_TYPE_CO_LICENCIA_CONDUCCION	Kolumbianischer Führerschein (Licencia de Conducción)
CO	DUI_TYPE_CO_CC	Kolumbianischer Bürgerausweis (Cédula de Ciudadanía)
DE	DUI_TYPE_DE_IDNR	Deutsche Steuer-Identifikationsnummer (IdNr)
DK	DUI_TYPE_DK_CPR	Dänische CPR
EC	DUI_TYPE_EC_NI	Ecuadorianische NI
ES	DUI_TYPE_ES_NIE	Spanische Ausländer-Identifikationsnummer (NIE)
ES	DUI_TYPE_ES_DNI	Spanischer Personalausweis (DNI)
FI	DUI_TYPE_FI_HETU	Finnische Personenkennung (HETU)
FR	DUI_TYPE_FR_SPI	Französische Steuerreferenznummer (SPI)
GB	DUI_TYPE_GB_NINO	Britische Sozialversicherungsnummer (NINO)
GT	DUI_TYPE_GT_CUI	Guatemaltekische CUI
ID	DUI_TYPE_ID_NIK	Indonesische NIK
IE	DUI_TYPE_IE_PPSN	Irische Sozialversicherungsnummer (PPSN)
IT	DUI_TYPE_IT_CF	Italienischer Codice Fiscale (CF)
LK	DUI_TYPE_LK_NIC	Sri-lankische NIC
LU	DUI_TYPE_LU_MATRICULE	Luxemburgische nationale Identifikationsnummer (Matricule)
MX	DUI_TYPE_MX_CURP	Mexikanische CURP
MX	DUI_TYPE_MX_RFC_PERSONA_FISICA	Mexikanische RFC (Persona Física)
MX	DUI_TYPE_MX_LICENCIA_CONDUCIR	Mexikanischer Führerschein (Licencia de Conducir)
NG	DUI_TYPE_NG_NIN	Nigerianische NIN
NG	DUI_TYPE_NG_BVN	Nigerianische Bankverifizierungsnummer (BVN)
NG	DUI_TYPE_NG_BVN_TOKEN	Nigerianisches BVN-Token (gehasht)
NG	DUI_TYPE_NG_NIN_TOKEN	Nigerianisches NIN-Token (gehasht)
NL	DUI_TYPE_NL_BSN	Niederländische Bürgerservicenummer (BSN)
NO	DUI_TYPE_NO_FNR	Norwegische nationale Identitätsnummer (Fødselsnummer)
PE	DUI_TYPE_PE_RUC	Peruanische RUC
PE	DUI_TYPE_PE_DNI	Peruanische DNI
PE	DUI_TYPE_PE_PASSPORT	Peruanischer Reisepass
PL	DUI_TYPE_PL_PESEL	Polnische PESEL
PT	DUI_TYPE_PT_NIF	Portugiesische Steueridentifikationsnummer (NIF)
SE	DUI_TYPE_SE_PNR	Schwedische Personennummer (PNR)
SE	DUI_TYPE_SE_SAMORDNINGSNUMMER	Schwedische Koordinierungsnummer (Samordningsnummer)
TR	DUI_TYPE_TR_TCKN	Türkische Identifikationsnummer (TCKN)
US	DUI_TYPE_US_SSN	US-amerikanische SSN
US	DUI_TYPE_US_PASSPORT	US-amerikanischer Reisepass
US	DUI_TYPE_US_DRIVER_LICENSE	US-amerikanischer Führerschein
US	DUI_TYPE_US_PASSPORT_CARD	US-amerikanische Passkarte
US	DUI_TYPE_US_POLYCARBONATE_PASSPORT	US-amerikanischer Polycarbonat-Reisepass
US	DUI_TYPE_US_ID_CARD	US-amerikanische ID-Karte
UY	DUI_TYPE_UY_CI	Uruguayische CI
ZZ	DUI_TYPE_ZZ_EMAIL	E-Mail-Adresse
ZZ	DUI_TYPE_ZZ_PHONE_NUMBER	Telefonnummer

Einen Prozess ohne Dokument erstellen

Wenn der Flow ein optionales Dokument erlaubt, können Sie person.duiType und person.duiValue weglassen. Nach der Erfassung wartet der Prozess in AWAITING_FOR_DOCUMENT, bis Ihr Back-end das Dokument mit Prozessdokument festlegen sendet.

Beispiel

cURL

curl -X POST https://api.idcloud.unico.app/client/v1/process \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "idunicodocs_r2",
    "purpose": "biometryonboarding",
    "clientReference": "pedido-88216",
    "callbackUri": "https://your-app.example.com/onboarding/callback",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678909"
    }
  }'

Node.js

import fetch from 'node-fetch';

const res = await fetch('https://api.idcloud.unico.app/client/v1/process', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    flow: 'idunicodocs_r2',
    purpose: 'biometryonboarding',
    clientReference: 'pedido-88216',
    callbackUri: 'https://your-app.example.com/onboarding/callback',
    person: {
      duiType: 'DUI_TYPE_BR_CPF',
      duiValue: '12345678909',
    },
  }),
});

const { process: proc } = await res.json();
// proc.userRedirectUrl, proc.token, proc.webAppToken

Antworten

200 OK

{
  "process": {
    "id": "b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
    "flow": "idunicodocs_r2",
    "state": "PROCESS_STATE_CREATED",
    "result": "PROCESS_RESULT_UNSPECIFIED",
    "purpose": "biometryonboarding",
    "clientReference": "pedido-88216",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678909"
    },
    "capacities": [
      "PROCESS_CAPACITY_IDLIVE",
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDDOCS"
    ],
    "authenticationInfo": {
      "authenticationId": ""
    },
    "companyData": {
      "branchId": "",
      "countryCode": "BRA"
    },
    "callbackUri": "https://your-app.example.com/onboarding/callback",
    "userRedirectUrl": "https://cadastro.unico.app/flow?id=b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…",
    "webAppToken": "eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0…",
    "simulated": false
  }
}

Feld	Typ	Beschreibung
process.id	string (UUID)	Prozesskennung. Verwenden Sie sie, um das Ergebnis über Prozess abrufen abzurufen.
process.state	enum	PROCESS_STATE_CREATED — Prozess erstellt, Journey noch nicht gestartet. PROCESS_STATE_FAILED — Prozesserstellung fehlgeschlagen.
process.result	enum	Verifizierungsergebnis. Nur vorhanden, wenn state = PROCESS_STATE_FINISHED — siehe Flows für die Ergebniswerte, die ein bestimmter Flow zurückgeben kann.
process.flow	string	Bei der Erstellung übermittelte Flow-Kennung.
process.purpose	string	Bei der Erstellung übermittelter geschäftlicher Zweck.
process.callbackUri	string	Bei der Erstellung übermittelte Callback-URI.
process.​clientReference	string	Ihre bei der Erstellung übermittelte interne Kennung. Nur vorhanden, wenn im Request angegeben.
process.​companyBranchId	string (UUID)	Niederlassungs-ID. Nur vorhanden, wenn im Request angegeben.
process.​userRedirectUrl	string	URL, an die der Nutzer weitergeleitet wird (Web-Redirect- und iFrame-Integrationen). Diese URL nicht verändern.
process.token	string	JWT zur Initialisierung des Web-SDK-iFrames.
process.webAppToken	string	JWT zur Initialisierung nativer SDKs (Android, iOS, Flutter).
process.createdAt	string (date-time)	Zeitstempel der Prozesserstellung.
process.expiresAt	string (date-time)	Zeitstempel, nach dem der Prozess abläuft und nicht mehr abgeschlossen werden kann.
process.capacities	array	Für diesen Prozess konfigurierte Funktionen.
process.​authenticationInfo	object	Authentifizierungsinformationen für den Prozess (zum Erstellungszeitpunkt leer).
process.person	object	Echo des bei der Erstellung übermittelten person-Objekts.
process.​companyData.​branchId	string (UUID)	Dem Prozess zugeordnete Niederlassungs-ID.
process.​companyData.​countryCode	string	Der Niederlassung zugeordneter Ländercode (z. B. BR, MX).

Fehlercodes

400 Bad Request

Code	Nachricht	Beschreibung
3	invalid flow	Wenn der angegebene Flow nicht existiert.
3	invalid person: friendly name exceeds 50 characters.	Wenn der Anzeigename 50 Zeichen überschreitet.
3	invalid purpose	Wenn der angegebene Zweck ungültig ist.
3	invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:	Wenn die angegebene callbackUri ungültig ist.
3	invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL	Wenn die angegebene E-Mail-Adresse ungültig ist und eine E-Mail-Benachrichtigung konfiguriert ist.
3	invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP	Wenn die angegebene Telefonnummer ungültig ist und eine SMS- oder WhatsApp-Benachrichtigung konfiguriert ist.
3	idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value	Wenn die angegebene Kennung (duiValue) ungültig ist.
3	invalid expiresIn argument	Wenn der Wert von expiresIn ungültig ist.
3	invalid company_name argument in process contextualization, max length is 20	Wenn contextualization.​company_name 20 Zeichen überschreitet.
3	title and text must be provided together in process contexts	Wenn für eine Locale nur title oder nur text angegeben wird.
3	invalid title argument in process contexts, max length is 100	Wenn title einer Locale 100 Zeichen überschreitet.
3	invalid text argument in process contexts, max length is 210	Wenn text einer Locale 210 Zeichen überschreitet.
3	invalid reason argument in process contexts, max length is 50	Wenn reason einer Locale 50 Zeichen überschreitet.
3	The references array must contain at most one element.	Wenn mehr als ein Eintrag in references gesendet wird.
3	The references[].referenceContent field is missing.	Wenn referenceContent leer ist.
3	The references[].referenceType field must be IMAGE_BASE64 or PROCESS_ID.	Wenn referenceType keinen der unterstützten Werte hat.
3	A reference is required for this flow.	Wenn der Flow eine Referenz erfordert und keine gesendet wurde. Senden Sie references[0] mit referenceType PROCESS_ID oder IMAGE_BASE64.
9	The referenceProcessId field is invalid.	Wenn der Referenzprozess nicht existiert oder nicht wiederverwendet werden kann. Nennt das gesendete Feld — bioTokenId, falls Sie dieses gesendet haben.
3	INVALID_IMAGE	Wenn das Bild kein gültiges base64 ist oder wie ein Injection-Versuch aussieht.
3	INVALID_DUI	Wenn die Dokumentnummer nicht dem Standard entspricht oder nicht existiert.
3	IMAGE_TOO_LARGE	Wenn das Bild die maximale Größe von 800 KB überschreitet.
3	UNSUPPORTED_IMAGE_FORMAT	Wenn das Bildformat nicht PNG, JPEG oder WebP ist.
3	MISSING_IMAGE	Wenn das Bild für diesen Flow erforderlich ist und nicht gesendet wurde.
3	MISSING_NAME	Wenn der Name für diesen Flow erforderlich ist und nicht gesendet wurde.
3	MISSING_DUI	Wenn die Dokumentnummer für diesen Flow erforderlich ist und nicht gesendet wurde.
3	MISSING_PERSON	Wenn das person-Objekt für diesen Flow erforderlich ist und nicht gesendet wurde.
3	INVALID_REQUEST	Wenn der Request-Body null ist oder nicht interpretiert werden kann.
3	TOKEN_ALREADY_USED	Wenn das Erfassungstoken bereits verwendet wurde. Es ist nur einmal verwendbar.
3	TOKEN_EXPIRED	Wenn das Erfassungstoken abgelaufen ist. Es muss innerhalb von 10 Minuten verwendet werden.
3	INVALID_BUNDLE	Wenn der Request nicht den Sicherheitsanforderungen entspricht.
3	INVALID_NAME	Wenn der Name länger als das erlaubte Maximum ist.
3	INVALID_EMAIL	Wenn die E-Mail-Adresse fehlerhaft oder zu lang ist.
3	INVALID_PHONE	Wenn die Telefonnummer länger als 20 Zeichen ist.
3	INVALID_DUI_TYPE	Wenn der Dokumenttyp keinem der unterstützten Werte entspricht.
3	INVALID_CLIENT_REFERENCE	Wenn clientReference zu lang ist oder ein Leerzeichen oder # enthält.
3	INVALID_CONSENT_TYPE	Wenn consentType nicht NONE, DIRECT oder INDIRECT ist.
3	INVALID_USE_CASE	Wenn useCase nicht erkannt wird oder zu lang ist.
3	INVALID_DEVICE_TRUST_TOKEN	Wenn das Device-Trust-Token ungültig ist oder bereits verwendet wurde.
3	TOO_MANY_REFERENCES	Wenn mehr als ein Eintrag in references gesendet wird.
3	INVALID_REFERENCE_TYPE	Wenn referenceType nicht IMAGE_BASE64 oder PROCESS_ID ist.
3	INVALID_REFERENCE_PROCESS	Wenn die Referenzprozess-ID keine gültige Kennung ist.
3	REFERENCE_PROCESS_NOT_FOUND	Wenn der referenzierte Prozess nicht existiert.
3	REFERENCE_PROCESS_NOT_READY	Wenn der referenzierte Prozess kein wiederverwendbares Ergebnis hat oder bereits verwendet wurde.
3	REFERENCE_SELFIE_NOT_FOUND	Wenn der referenzierte Prozess kein wiederverwendbares Selfie enthält.
3	INVALID_CAPTURE_TOKEN	Wenn das erfasste Bild kein gültiges, von einem Erfassungs-SDK erzeugtes Token ist.
3	INVALID_CAPTURE_SIGNATURE	Wenn die Signatur des Erfassungstokens nicht validiert werden kann.
3	PRIOR_CAPTURE_NOT_FOUND	Wenn die frühere Erfassung, auf der dieser Request aufbaut, nicht gefunden werden konnte. Starten Sie den Prozess neu.
3	PRIOR_CAPTURE_IN_PROGRESS	Wenn die frühere Erfassung noch nicht abgeschlossen ist. Versuchen Sie es in Kürze erneut.
3	PRIOR_CAPTURE_FAILED	Wenn die frühere Erfassung nicht abgeschlossen werden konnte. Starten Sie den Prozess neu.
3	INVALID_DOCUMENT	Wenn eine Dokumentdatei unlesbar, passwortgeschützt oder in einem nicht unterstützten Format ist.
3	INVALID_AUTH_PROCESS	Wenn document.authProcessId ungültig, abgelaufen ist oder einer anderen Person gehört.
3	INVALID_DOCUMENT_PURPOSE	Wenn document.purpose keinem der unterstützten Werte entspricht.
3	PROCESS_REUSE_NOT_ENABLED	Wenn der Flow die Wiederverwendung eines früheren Prozesses ohne Bild nicht erlaubt. Senden Sie statt dessen ein Bild.
9	PROCESS_FAILED	Wenn der Prozess während der Erstellung einen endgültigen Fehler erreicht hat.
9	Tenant API key is not configured	Wenn der API-Schlüssel nicht korrekt konfiguriert ist.

401 Unauthorized

Bearer-Token fehlt, ist abgelaufen oder ungültig. Siehe Authentifizierung.

Nachricht	Beschreibung
Jwt header is an invalid JSON	Wenn das verwendete Access-Token ungültige Zeichen enthält.
Jwt is expired	Wenn das verwendete Access-Token abgelaufen ist.

403 Forbidden

Code	Nachricht	Beschreibung
7	INVALID_API_KEY	Wenn der API-Schlüssel ungültig ist oder fehlt.
7	INVALID_AUTH_TOKEN	Wenn das Authentifizierungstoken ungültig ist.
7	PERMISSION_DENIED	Wenn die Anmeldedaten gültig, aber für diese Aktion nicht berechtigt sind.
7	TOKEN_TENANT_MISMATCH	Wenn das Erfassungstoken für einen anderen Mandanten ausgestellt wurde.
7	MISSING_ACCESS_TOKEN	Wenn der Authorization-Header fehlt.

404 Not Found

Code	Nachricht	Beschreibung
5	NO_RESULTS_FOUND	Wenn ein vom Request referenziertes Dokument nicht gefunden werden konnte.

429 Too Many Requests

Rate-Limit erreicht. Wenn Ihr System einen HTTP-429-Fehler erhält, müssen Sie Mechanismen implementieren, um kaskadierende Ausfälle zu verhindern und eine Verschärfung der Einschränkung zu vermeiden.

Best Practices:

• Abkühlphase (Backoff): Stoppen oder drosseln Sie nachfolgende Anfragen aus Ihrem System sofort. Wiederholen Sie fehlgeschlagene Anfragen nicht kontinuierlich in einer engen Schleife.
• Warteschlange & Drosselung: Puffern oder reihen Sie ausgehende Anfragen auf Ihrer Seite ein, um den Datenverkehr zu kontrollieren, bevor Sie sie erneut senden.
• Exponentieller Backoff mit Jitter: Erhöhen Sie beim erneuten Versuch die Wartezeit zwischen den Versuchen exponentiell (z. B. 1 s, 2 s, 4 s, 8 s) und fügen Sie eine kleine zufällige Verzögerung ("Jitter") hinzu, um einen Herdeneffekt zu vermeiden, bei dem alle in der Warteschlange befindlichen Anfragen exakt zur gleichen Millisekunde erneut versucht werden.

Warnung

Das kontinuierliche Ansprechen eines rate-limitierten Endpunkts ohne Backoff kann die Einschränkungsperiode verlängern und den operativen Durchsatz Ihres Systems erheblich beeinträchtigen. Eine ordnungsgemäße Drosselung der Anfragen auf Ihrer Seite gewährleistet eine reibungslosere und widerstandsfähigere Integration.

Informationen zu Standardlimits, Erhöhung von Anfragen und weiteren Details finden Sie unter Rate Limits.

500 Internal Server Error

Code	Nachricht	Beschreibung
13	Internal failure! Try again later	Wenn ein interner Fehler auftritt.

Nächste Schritte

• Nachdem der Nutzer die Journey abgeschlossen hat, rufen Sie Prozess abrufen auf, um das Ergebnis abzurufen, oder warten Sie auf den Webhook.
• Um alle Rezeptkombinationen und deren mögliche Ergebniswerte zu sehen, siehe Flows.
• Um ein Ergebnis ohne echte biometrische Erfassung zu testen, siehe Ergebnisse simulieren (Test Mock).