Zum Hauptinhalt springen
Prozess abrufenGET

Rufen Sie einen bestehenden Prozess anhand seiner Kennung ab. Gemäß dem API-Contract wird das Ergebnis bereits synchron bei der Prozesserstellung zurückgegeben — verwenden Sie diesen Endpunkt für erneute Abfragen, Audits und Support.

MarkdownChatGPTClaude
Warnung

Bevor Sie den Prozess abrufen, prüfen Sie unsere Webhook-Konfiguration und Fallback-Strategien — hier klicken.

Endpunkt​

UmgebungURL
ProduktionGET https://api.id.unico.app/processes/v1/{processId}
SandboxGET https://api.id.uat.unico.app/processes/v1/{processId}

Anfrage​

Headers
HeaderWert
AuthorizationBearer <access_token>
APIKEYBereitgestellter API-Schlüssel.
Pfadparameter
ParameterTypErforderlichBeschreibung
processIdstring (UUID)jaProzesskennung, die von Prozess erstellen zurückgegeben wird.

Beispiel​

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

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.
statusinteger1 (in Bearbeitung), 2 (Abweichung), 3 (erfolgreich abgeschlossen), 4 (storniert), 5 (Fehler).
Mögliche Ergebniswerte
idCloud.resultBedeutungEmpfohlene Aktion
approvedEchte Person und validierte Identität.Mit dem Flow fortfahren.
deniedIdentität nicht validiert, Lebenderkennung fehlgeschlagen oder extremes Risiko erkannt.Flow beenden oder zu einem alternativen Flow weiterleiten.
critical-riskKritisches Risikoniveau erkannt.Flow beenden oder an die manuelle Prüfung weiterleiten.
high-riskHohes Risikoniveau erkannt.An die manuelle Prüfung oder einen alternativen Flow weiterleiten.
retryUnzureichende Erfassung oder Score zur Auswertung.Den Benutzer um eine neue Erfassung bitten.
inconclusiveNicht genügend Nachweise für ein Urteil.An die manuelle Prüfung oder einen alternativen Flow weiterleiten.

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"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
FeldTypBeschreibung
unicoId.resultstringyes, no, inconclusive — siehe Identitätsprüfung.
riskLevel.resultstringnot_approved, critical_risk, high_risk, inconclusive — siehe 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, liefert der Prozess Fehler 20532 anstelle eines idFace-Blocks.
identityFraudsters.resultstringVeraltet. Verwenden Sie stattdessen riskLevel. Kunden mit laufenden Integrationen können es weiterhin verwenden, während sie die Migration mit ihrem Projektteam koordinieren.
government.serprointegerSerpro-Ähnlichkeitswert (0–100, -1, -2). Nur in Brasilien verfügbar. Siehe Serpro-Ähnlichkeitsabgleich.
livenessinteger1 (bestanden), 2 (nicht bestanden) — siehe Lebenderkennung.
idAge.resultstringyes, no, inconclusive — siehe Altersverifizierung. Nur in Brasilien verfügbar.
scoreintegerProbabilistischer Risiko-Score. Vorhanden, wenn unicoId.result = inconclusive und die Risiko-Score-Orchestrierung aktiv ist. Positive Werte deuten auf eine höhere Wahrscheinlichkeit hin, dass es sich um den Inhaber handelt; negative Werte deuten auf ein höheres Risiko hin. Nur in Brasilien verfügbar.
cardholderVerification.resultstringapproved, unsure — siehe Cardholder Verification. Fehlt, solange status noch nicht 3 (abgeschlossen) ist. Nur in Brasilien verfügbar.
MexicoKunden in Mexiko erhalten möglicherweise den Block der RENAPO-Verifizierung

Die Antwort behält dieselbe Struktur und ergänzt den idGov-Block.

Integrationen in Mexiko mit aktivierter RENAPO-Verifizierung erhalten einen zusätzlichen idGov-Block mit dem Eintrag, den RENAPO zur CURP des Benutzers führt. Er ist eine separate Antwort neben dem Identitätsergebnis.

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
FeldTypBeschreibung
idGovobjectRENAPO-Eintrag zur CURP. Fehlt, wenn die Capability nicht aktiviert ist. {}, wenn RENAPO nicht geantwortet hat. Nur Mexiko. Siehe RENAPO-Verifizierung.

Wann dieser Endpunkt verwendet werden sollte​

Der API-Contract gibt Ergebnisse synchron zurück, daher benötigen die meisten Integrationen diesen Endpunkt nicht. Verwenden Sie ihn, wenn:

  • Sie nur die processId gespeichert haben und das vollständige Ergebnis später abrufen müssen (Audit, Support).
  • Sie vermuten, dass die ursprüngliche Antwort während der Übertragung verloren ging (Netzwerkfehler, nachdem die Plattform die Arbeit abgeschlossen hat).
  • Sie ein Back-Office-Tool erstellen, das historische Prozesse überprüft.

Fehlercodes​

CodeNachrichtBeschreibung
20023O parâmetro processId não foi informado.Der processId-Parameter fehlt.
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.

Flows​

Ein Recipe ist die Kombination von Fähigkeiten (Lebenderkennung, Identitätsprüfung, Risikosignale, Dokumente ...), die in der APIKey Ihres Projekts konfiguriert ist. Es definiert, was Unico in jedem Prozess ausführt und wie die Ergebnisse im einzelnen result konsolidiert werden — Sie müssen auf Ihrer Seite nichts orchestrieren.

Unico pflegt einen Katalog vordefinierter, benannter und versionierter Recipes (z. B. byunico-idlive-idunico-oneresponse-std). Einige sind exklusiv für Brasilien, etwa solche, die Score, Serpro oder Altersverifizierung einschließen.

Welche Fähigkeiten führt Ihr Prozess aus?

Die Kombination von Fähigkeiten — der Flow Ihres Projekts — wird in Ihrer APIKey-Konfiguration festgelegt. Prüfen Sie die vordefinierten Recipes oder wenden Sie sich an Ihren Unico-Projektansprechpartner, um sie anzupassen.

Zuletzt aktualisiert am