Zum Hauptinhalt springen

Prozess erstellen

Dieser Endpunkt deckt drei Produkte ab, die denselben Pfad teilen, sich aber in Body-Parametern, Fähigkeiten und Antwortfeldern unterscheiden:

  • Einführung -- validiert, wer der Benutzer ist, indem sein Gesicht mit der Identitätsdatenbank von Unico verglichen wird (subject.duiType + subject.code erforderlich).
  • Transaktional -- verifiziert, dass es sich um dieselbe Person eines vorherigen Prozesses handelt, durch Gesicht-zu-Gesicht-Vergleich (referenceProcessId ODER references-Array mit Selfie / Prozess-ID erforderlich).
  • Cardholder Verification -- bestätigt, dass eine Karte zu ihrem angegebenen Inhaber gehört, ohne jegliche Selfie-Aufnahme (subject.code + card erforderlich). Optional wird ein zuvor validierter Prozess über referenceProcessId wiederverwendet, um die Prüfung auszulösen; ohne dieses Feld fällt die Antwort standardmäßig auf unsure zurück. Siehe die Fähigkeit Cardholder Verification.

Das aktive Produkt wird durch den APIKEY bestimmt, der im Anfrage-Header gesendet wird.

Für den vollständigen Integrationsablauf siehe API-Übersicht.

Endpunkt

UmgebungURL
ProduktionPOST https://api.id.unico.app/processes/v1
SandboxPOST https://api.id.uat.unico.app/processes/v1

Anfrage

Headers
HeaderWert
AuthorizationBearer <access_token> (siehe Authentifizierung)
APIKEYBereitgestellter API-Schlüssel -- definiert das aktive Produkt und die aktivierten Fähigkeiten.
Content-Typeapplication/json
Body-Parameter
FeldTypErforderlichBeschreibung
subject.duiTypeintegerjaDokumenttypkennung. Siehe duiType-Werte unten.
subject.codestringjaIdentifikatorwert gemäß subject.duiType. Keine Punkte oder Bindestriche.
subject.namestringneinVollständiger Name.
subject.genderstringneinM oder F.
subject.birthDatestring (ISO 8601)neinGeburtsdatum (YYYY-MM-DD).
subject.emailstringneinE-Mail-Adresse.
subject.phonestringneinTelefonnummer im E.164-Format.
subject.clientReferencestringbedingtEindeutiger Bezeichner des Benutzers in Ihrem System. Erforderlich für die Fähigkeit Mehrfachkonten. Eindeutig in Ihrer Datenbank, maximal 256 Zeichen, keine Leerzeichen.
useCasestringneinOperationskontext, z. B. Onboarding.
subsidiaryIdstringneinFilial-ID — nur erforderlich, wenn mehrere Filialen vorhanden sind.
imageBase64stringjaVom Frontend erfasstes Selfie, in Base64.
duiType-Werte
LandCodeBeschreibung
BR1Brasilianische CPF
MX2Mexikanische CURP
US4US-amerikanische SSN
BR5Brasilianischer Reisepass
AR6Argentinischer Reisepass
AR7Argentinische DNI
NG8Nigerianische NIN
CL9Chilenische RUN
EC10Ecuadorianische NI
US11US-amerikanischer Reisepass
GT12Guatemaltekische CUI
UY13Uruguayische CI
BR14Brasilianische CNPJ
ZZ15E-Mail-Adresse
ID16Indonesische NIK
ZZ17Telefonnummer
US18US-amerikanischer Führerschein
NG20Nigerianische Bankverifizierungsnummer (BVN)
US21US-amerikanische Passkarte
US22US-amerikanischer Polycarbonat-Reisepass
US23US-amerikanische ID-Karte
TR24Türkische Identifikationsnummer (TCKN)
MX25Mexikanische RFC (Persona Física)
CO26Kolumbianische NIT
PE27Peruanische RUC
CA28Kanadische SIN
DK29Dänische CPR
GB30Britische Sozialversicherungsnummer (NINO)
PL31Polnische PESEL
SE32Schwedische Personennummer (PNR)
CH33Schweizer AHV/AVS-Nummer
AT34Österreichische Steuernummer (STNR)
FI35Finnische Personenkennung (HETU)
BE36Belgische Nationalnummer (NN)
IT37Italienischer Codice Fiscale (CF)
SE38Schwedische Koordinierungsnummer (Samordningsnummer)
NO39Norwegische nationale Identitätsnummer (Fødselsnummer)
PE40Peruanische DNI
DE41Deutsche Steuer-Identifikationsnummer (IdNr)
NL42Niederländische Bürgerservicenummer (BSN)
NG43Nigerianisches BVN-Token (gehasht)
NG44Nigerianisches NIN-Token (gehasht)
PT45Portugiesische Steueridentifikationsnummer (NIF)
FR46Französische Steuerreferenznummer (SPI)
IE47Irische Sozialversicherungsnummer (PPSN)
LU48Luxemburgische nationale Identifikationsnummer (Matricule)
AR49Argentinischer Führerschein (Licencia Nacional de Conducir)
ES50Spanische Ausländer-Identifikationsnummer (NIE)
ES51Spanischer Personalausweis (DNI)
CL52Chilenischer Reisepass
CO53Kolumbianischer Reisepass
PE54Peruanischer Reisepass
CO55Kolumbianischer Führerschein (Licencia de Conducción)
CO56Kolumbianischer Bürgerausweis (Cédula de Ciudadanía)
CL57Chilenischer Führerschein (Licencia de Conducir)
MX58Mexikanischer Führerschein (Licencia de Conducir)
0Nicht angegeben
3Interner Unico-Identifikator
Bildanforderungen
  • Mindestauflösung: 640 x 480 (HD-Standard)
  • Maximale Dateigröße: 800 KB (JPEG92-Komprimierung empfohlen)
  • Akzeptierte Formate: PNG, JPEG, WebP
  • JWT-Tokens des SDK laufen nach 10 Minuten ab und können nur einmal verwendet werden

Beispiel

curl -X POST https://api.id.unico.app/processes/v1 \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"subject": {
"duiType": 1,
"code": "12345678909",
"name": "Luke Skywalker",
"gender": "M",
"birthDate": "2000-05-20",
"email": "[email protected]",
"phone": "5519725570707"
},
"useCase": "Onboarding",
"imageBase64": "/9j/4AAQSkZJR..."
}'

Antworten

200 OK

Der Contract ist einheitlich — das Feld idCloud.result trägt das konsolidierte Urteil der verwendeten Fähigkeiten.

Unico konsolidiert die Ergebnisse der ausgeführten Fähigkeiten in einem einzigen idCloud.result, bereit, um den nächsten Schritt Ihres Flows zu entscheiden — ohne dass Sie einzelne Ergebnisse orchestrieren müssen.

{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"idCloud": {
"result": "approved"
}
}
FeldTypBeschreibung
idstring (UUID)Prozesskennung. Verwenden Sie sie mit Prozess abrufen für erneute Abfragen.
statusinteger1 (in Bearbeitung), 3 (erfolgreich abgeschlossen), 5 (Fehler).
Mögliche Ergebniswerte
idCloud.resultMeaningRecommended action
approvedReal person and validated identity.Proceed with the flow.
deniedIdentity not validated, liveness check failed, or extreme risk identified.End the flow or redirect to an alternative flow.
critical-riskCritical risk level identified.End the flow or route to manual review.
high-riskHigh risk level identified.Route to manual review or an alternative flow.
retryInsufficient capture or score to evaluate.Ask the user for a new capture.
inconclusiveNot enough evidence for a verdict.Route to manual review or an alternative flow.

Die zurückgegebenen Werte hängen vom Recipe ab, das in Ihrem APIKey konfiguriert ist. Siehe Flows für die Ergebniswerte, die jedes Recipe zurückgeben kann.

BrazilKunden in Brasilien erhalten möglicherweise die Antwort nach Fähigkeit

Die Gesamtstruktur der Antwort bleibt gleich — das einzelne Ergebnis ist der Standard.

Integrationen in Brasilien erhalten möglicherweise die offenen Ergebnisse pro Fähigkeit. Jede in der APIKey aktivierte Fähigkeit fügt der Antwort einen eigenen Block hinzu — Felder für deaktivierte Fähigkeiten werden weggelassen.

{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": {
"result": "yes"
},
"riskLevel": {
"result": "inconclusive"
},
"idFace": {
"personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
"result": "FOUND"
},
"government": {
"serpro": 87
},
"liveness": 1
}
Antwortfelder hängen von Ihrem APIKey ab

Das obige Beispiel zeigt alle möglichen Capability-Felder. Ihre tatsächliche Antwort enthält nur Felder für die in Ihrer APIKey-Konfiguration aktivierten Capabilities — Felder für deaktivierte Capabilities werden vollständig weggelassen. Wenden Sie sich an Ihren Unico-Projektmanager, um Capabilities zu aktivieren oder anzupassen.

FeldTypBeschreibung
unicoId.resultstringyes, no, inconclusive -- siehe Identitätsprüfung.
riskLevel.resultstringapproved, reproved, risk-critical, risk-high, inconclusive -- siehe mögliche Werte unten oder Betrugseinstufung nach Risiko.
idFace.resultstringFOUND — siehe Gesichts-Identifikator.
idFace.personIdstringStabiler, opaker Bezeichner für das Gesicht, zurückgegeben zusammen mit idFace.result = FOUND. Kann kein Gesicht im Bild identifiziert werden, schlägt die Anfrage mit Fehler 20532 fehl, anstatt einen idFace-Block zurückzugeben.
identityFraudsters.resultstringVeraltet. Verwenden Sie stattdessen riskLevel. Kunden mit laufenden Integrationen können es weiterhin verwenden, während sie die Migration mit dem verantwortlichen Projektteam koordinieren.
government.serprointegerSerpro-Ähnlichkeitswert (0--100, -1, -2). Nur in Brasilien verfügbar. Siehe Serpro-Ähnlichkeitsabgleich.
livenessinteger1 (bestanden), 2 (nicht bestanden) -- siehe Lebenderkennung.
riskLevel.result — mögliche Werte
WertBedeutung
approvedEs handelt sich um das Gesicht des Ausweisinhabers, und es wurden keine Hinweise auf Betrug gefunden.
reprovedEine Ablehnung wird empfohlen, da mehrere Betrugsindikatoren erkannt wurden.
risk-criticalEine Ablehnung wird empfohlen, die endgültige Entscheidung liegt jedoch in Ihrem Ermessen. Kritisches Risiko bedeutet, dass mindestens 2 starke Betrugsnachweise gefunden wurden.
risk-highEine Ablehnung wird ebenfalls empfohlen, die Entscheidung verbleibt jedoch bei Ihnen. Hohes Risiko bedeutet, dass mindestens ein starker Betrugsnachweis gefunden wurde.
inconclusiveEs wurden keine starken Betrugsnachweise gefunden. Daher ist es nicht möglich zu beurteilen, ob ein relevantes Risiko vorliegt oder nicht.
Information

Wenn unicoId.result = inconclusive und die Risiko-Score-Orchestrierung aktiv ist, kann der Prozess status: 1 (in Bearbeitung) zurückgeben. Fragen Sie Prozess abrufen ab oder verwenden Sie Webhooks, um das Endergebnis zu erhalten.

Fehlercodes

CodeNachrichtBeschreibung
40221This flow does not support reusing a prior process (referenceProcessId or bioTokenId) without an image; send an image (imageBase64, or references[0] with type IMAGE_BASE64) instead.Der Wiederverwendungs-Flow (referenceProcessId/bioTokenId, ohne Bild) wurde abgelehnt, da die Prozesswiederverwendung für diesen API-Schlüssel nicht aktiviert ist.
20900O base64 informado não é válido.Der base64-Parameter ist ungültig. Mögliche Ursachen: Es handelt sich nicht um ein Bild oder es liegt ein Injektionsversuch vor.
20807A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.Die Auflösung des hochgeladenen Bildes ist zu niedrig.
20532No face detected in image.Im übermittelten Bild konnte kein Gesicht erkannt werden.
20513The referenced process was not found.Die referenceProcessId verweist auf einen Prozess, der nicht existiert oder nicht mehr zugänglich ist.
20512The referenced process is not available for reuse.Der referenzierte Prozess existiert, ist aber nicht zur Wiederverwendung verfügbar.
20509The subject.name field is invalid.subject.name enthält ungültige Zeichen.
20508The subject.gender field is invalid.subject.gender muss M oder F sein.
20507O parâmetro subject.code é inválido.Nicht standardgemäßer oder nicht existierender CPF.
20506O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.Bildgröße überschreitet 800 KB; auf JPEG92 komprimieren.
20505O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.Das Base64-Format ist ungültig oder wird nicht unterstützt.
20065The referenceProcessId field is invalid.Die referenceProcessId ist keine gültige UUID.
20062The useCase field is invalid.Nicht erkannter Wert im Feld useCase.
20024The referenceProcessId field is missing.Der referenceProcessId-Parameter wurde nicht angegeben und references wurde nicht als Alternative gesendet. Gilt nicht für Cardholder Verification -- ihr referenceProcessId wird nie als erforderlich validiert; eine nicht erfüllte Wiederverwendungsvoraussetzung liefert stattdessen unsure.
20533The card field is missing.Cardholder Verification: Das Objekt card wurde nicht angegeben.
20534The card.bin field is missing.Cardholder Verification: card.bin wurde nicht angegeben.
20535The card.last4 field is missing.Cardholder Verification: card.last4 wurde nicht angegeben.
20536The card data is invalid.Cardholder Verification: Die Kartendaten wurden als ungültig zurückgewiesen.
20021The subject.phone field is invalid.Format von subject.phone ist ungültig (IDD + Vorwahl + Nummer, 13 Zeichen).
20019The subject.birthDate field is invalid.subject.birthDate liegt außerhalb des ISO-8601-Formats (YYYY-MM-DD).
20009O parâmetro imagebase64 não foi informado.Der Selfie-Bildparameter fehlt.
20008The subject.email field is invalid.Ungültiges E-Mail-Format in subject.email.
20006O parâmetro subject.name não foi informado.Der subject.name-Parameter fehlt.
20005O parâmetro subject.code não foi informado.Der subject.code-Parameter fehlt.
20004O parâmetro subject não foi informado.Der subject-Parameter fehlt.
20003The request body is missing or invalid.Null oder ungültiger Payload.
20002O parâmetro APIKey não foi informado.Der APIKEY-Parameter fehlt im Anfrage-Header.
20001O parâmetro authtoken não foi informado.Der Integrationstoken-Parameter fehlt im Anfrage-Header.
10508The JWT with the captured face has already been used.Das JWT kann nur einmal verwendet werden.
10507The JWT with the captured face is expired.JWT abgelaufen; muss innerhalb von 10 Minuten gesendet werden.
10506The imageBase64 field is not a valid JWT from SDK.Das imageBase64 ist kein gültiges vom SDK generiertes JWT.

Nächste Schritte

  • Zum Abfragen eines Einführungsprozess-Ergebnisses siehe Prozess abrufen.
  • Um alle Recipe-Kombinationen und ihre möglichen Ergebniswerte zu sehen, siehe Flows.
  • Für Dokument- und Altersverifizierungs-Operationen siehe die entsprechenden Seiten in diesem Abschnitt.