Prozess abrufen

Warnung

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

Im API-Vertrag ist die Antwort auf POST /processes/v1 bereits das Endergebnis. Dieser Endpunkt dient zur erneuten Abfrage — zum Beispiel, wenn Sie einen zuvor gespeicherten Prozess einsehen oder eine frühere Transaktion prüfen möchten.

Endpunkt

Umgebung	URL
Produktion	GET https://api.id.unico.app/processes/v1/{processId}
Sandbox	GET https://api.id.uat.unico.app/processes/v1/{processId}

Anfrage

Header

Header	Wert
Authorization	Bearer <access_token>
APIKEY	Bereitgestellter API-Schlüssel.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
processId	string (UUID)	ja	Prozesskennung, die von Prozess erstellen zurückgegeben wird.

Beispiel

cURL

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

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.id.unico.app/processes/v1/${processId}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const result = await res.json();

Antworten

200 OK

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": { "result": "yes" },
  "identityFraudsters": { "result": "inconclusive" },
  "government": { "serpro": 87 },
  "liveness": 1
}

Feld	Typ	Beschreibung
id	string (UUID)	Prozesskennung.
status	integer	1 (in Verarbeitung), 2 (Abweichung), 3 (erfolgreich abgeschlossen), 4 (abgebrochen), 5 (Fehler).
unicoId.result	string	yes, no, inconclusive — siehe Identitätsverifizierung.
identityFraudsters.result	string	yes, inconclusive — siehe Risikoklassifizierung.
government.serpro	integer	Serpro-Ähnlichkeitspunktzahl (0–100, -1, -2). Siehe Serpro-Ähnlichkeit.
liveness	integer	1 (bestanden), 2 (nicht bestanden) — siehe Liveness.
score	integer	Probabilistischer Risiko-Score. Vorhanden, wenn unicoId.result = inconclusive und die Risiko-Score-Orchestrierung aktiv ist. Positive Werte weisen auf eine höhere Wahrscheinlichkeit hin, der Inhaber zu sein; negative Werte weisen auf ein höheres Risiko hin.

400 Bad Request

Der Pfadparameter processId fehlt oder ist fehlerhaft. Siehe Fehlercodes unten.

403 Forbidden

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

404 Not Found

Die processId existiert nicht oder gehört nicht zum authentifizierten Mandanten.

410 Gone

Der Prozess existiert, hat aber einen Fehler ergeben. Gibt nur id und status: 5 zurück.

429 Too Many Requests

Ratenlimit erreicht. Siehe Ratenlimits.

500 Internal Server Error

Unerwarteter Serverfehler.

Wann sollte dieser Endpunkt verwendet werden

Der API-Vertrag 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 gegangen ist (Netzwerkfehler, nachdem die Plattform die Arbeit abgeschlossen hat).
• Sie ein Back-Office-Tool erstellen, das historische Prozesse überprüft.

Fehlercodes

400 Bad Request

Code	Nachricht	Beschreibung
20023	O parâmetro processId não foi informado.	Der Prozess-ID-Parameter fehlt.
20002	O parâmetro APIKey não foi informado.	Der APIKEY-Parameter fehlt im Anfrage-Header.
20001	O parâmetro authtoken não foi informado.	Der Integrationstoken-Parameter fehlt im Anfrage-Header.

404 Not Found

Code	Nachricht	Beschreibung
50001	O processo informado não foi encontrado.	Der Prozess existiert nicht in der Datenbank.

403 Forbidden

Code	Nachricht	Beschreibung
30017	User does not have permission to perform this action.	Fehlerhafter JWT oder Benutzer ohne Berechtigung für diesen Vorgang.
10502	O token informado está expirado.	Das verwendete Zugriffstoken ist abgelaufen.
10501	O token informado é inválido.	Das Authentifizierungstoken ist ungültig.
10201	O AppKey informado é inválido.	Der APIKEY-Parameter wurde nicht eingegeben oder existiert nicht.

410 Gone

Der Prozess existiert, hat aber einen Fehler ergeben. Gibt nur id und status: 5 zurück.

500 Internal Server Error

Code	Nachricht	Beschreibung
99999	Internal failure! Try again later	Bei einem internen Fehler.