Method: vdc.getProofingStatus

Ein Endpunkt, um den aktuellen Status eines Proofings abzurufen.

HTTP-Anfrage

POST https://example.issuer.com/api/v1/vdc/getProofingStatus

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
Felder
requestMetadata

object (RequestMetadata)

Die Metadaten zur Anfrage, erforderlich in allen Anfragen.
deviceReferenceId

string

Die zum Gerät gehörende ID und der mit dem Gerät verknüpfte Identitätsschlüssel. Dabei handelt es sich NICHT um eine Geräte-ID. Wenn ein Nutzer zwei verschiedene Ausweisdokumente auf demselben Gerät verwendet, unterscheidet sich diese ID bei beiden voneinander.

Die ID wird bei allen Anfragen angegeben und kann dazu verwendet werden, Anfragen zu korrelieren.
proofingId

string

Eine intransparente Kennung, die eine Prüfung mit einem speziellen Nachweisbündel für ein bestimmtes Gerät darstellt.

Beispiel: UUID

Antworttext

Eine Antwort mit dem aktuellen Status eines Proofings.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
Felder
responseMetadata

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.
proofingStatus

object (ProofingStatus)

Der aktuelle Status des Proofings.

ProofingStatus

Ein Objekt, das die verschiedenen Statuswerte darstellt, die ein Proofing haben kann.

JSON-Darstellung 
{

  // Union field status can be only one of the following:
  "pending": {
    object (Pending)
  },
  "accepted": {
    object (Accepted)
  },
  "rejected": {
    object (Rejected)
  },
  "challenged": {
    object (Challenged)
  },
  "canceled": {
    object (Canceled)
  },
  "revoked": {
    object (Revoked)
  },
  "expired": {
    object (Expired)
  }
  // End of list of possible types for union field status.
}
Felder
Union-Feld status. Ein „oneof“, das die verschiedenen möglichen Statuswerte für ein Proofing enthält. Für status ist nur einer der folgenden Werte zulässig:
pending

object (Pending)

Der Status „Ausstehend“ – der Aussteller hat noch keine Entscheidung getroffen.
accepted

object (Accepted)

Der Status „Angenommen“ – der Aussteller hat das Proofing angenommen.
rejected

object (Rejected)

Der Status „Abgelehnt“ – der Aussteller hat das Proofing abgelehnt.
challenged

object (Challenged)

Der Status „Weitere Informationen erforderlich“ – der Aussteller möchte den Nutzer eine bestimmte Aufgabe lösen lassen, bevor der Aussteller über das Proofing entscheidet.
canceled

object (Canceled)

Der Status „Abgebrochen“ – der Nutzer hat das Proofing abgebrochen.
revoked

object (Revoked)

Der Status „Widerrufen“ – der Aussteller hat das Proofing widerrufen.
expired

object (Expired)

Der Status „Abgelaufen“ – vor Ablauf einer vom Aussteller gesetzten Frist wurde keine Entscheidung über das Proofing getroffen (wahrscheinlich weil eine Aufgabe nicht gelöst wurde).

Ausstehend

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Ausstehend“ darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Akzeptiert

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Angenommen“ eines Proofings darstellt.

Abgelehnt

Ein Objekt, das den Status „Abgelehnt“ eines Proofings darstellt.

JSON-Darstellung 
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
Felder
primaryRejection

object (Rejection)

Der Hauptgrund, warum dieses Proofing den Status „Abgelehnt“ hat.
additionalRejections[]

object (Rejection)

Zusätzliche Gründe (soweit vorhanden), warum das Proofing den Status „Abgelehnt“ hat.

Ablehnung

Ein Objekt mit Details zu einem bestimmten Ablehnungsgrund, aus dem ein Proofing den Status „Abgelehnt“ hat.

JSON-Darstellung 
{
  "rejectionDescription": string,
  "issuerRejectionIdentifier": string,

  // Union field reason can be only one of the following:
  "evidenceMismatch": {
    object (EvidenceMismatch)
  },
  "evidenceIncomplete": {
    object (EvidenceIncomplete)
  },
  "lowRiskScore": {
    object (LowRiskScore)
  },
  "recordNotFound": {
    object (RecordNotFound)
  },
  "recordInvalid": {
    object (RecordInvalid)
  },
  "maxProvisioningsReached": {
    object (MaxProvisioningsReached)
  },
  "riskCheckFailure": {
    object (RiskCheckFailure)
  },
  "livenessCheckFailure": {
    object (LivenessCheckFailure)
  }
  // End of list of possible types for union field reason.
}
Felder
rejectionDescription

string

Eine Beschreibung dieser Ablehnung, die Mitarbeitern des Supports bei der Fehlerbehebung hilft. Beachte, dass dieser Text niemals Nutzern angezeigt wird. Er kann beschreibenden nicht sensiblen Text für die Fehlerbehebung enthalten.

Warnung: Diese Nachricht darf keine personenidentifizierbaren Informationen enthalten.
issuerRejectionIdentifier

string

Diese Kennung ist ausstellerspezifisch und wird vom Aussteller generiert. Sie wird nur zum Zweck der Fehlerbehebung verwendet, um die Ablehnung zu identifizieren. Dies ist die Kennung, anhand derer der Aussteller diese Ablehnung erkennt.
Union-Feld reason. Ein oneof mit den verschiedenen Gründen, warum ein Proofing abgelehnt werden könnte. Für reason ist nur einer der folgenden Werte zulässig:
evidenceMismatch

object (EvidenceMismatch)

Gibt an, dass das Proofing aufgrund von Diskrepanzen bei den Nachweisen abgelehnt wurde.

Beispiele für die Verwendung: – Das mit der App aufgenommene Selfie stimmt nicht mit dem Bild im System des Ausstellers überein. – Das mit der App aufgenommene Bild des Dokuments stimmt nicht mit dem Bild im System des Ausstellers überein.
evidenceIncomplete

object (EvidenceIncomplete)

Gibt an, dass das Proofing aufgrund von unvollständigen Nachweisen abgelehnt wurde.

Beispiele für die Verwendung: – Der Aussteller hat nicht alle erforderlichen Nachweise erhalten.
lowRiskScore
(deprecated)

object (LowRiskScore)

VERALTET: Verwenden Sie stattdessen „riskCheckFailure“ oder „livenessCheckFailure“.

Gibt an, dass das Proofing aufgrund einer niedrigen Risikobewertung abgelehnt wurde.

Beispiele für die Verwendung: – Das Wallet hat eine niedrige Risikobewertung zurückgegeben. – Der Aussteller hat diesen Nutzer aufgrund von wiederholten Fehlversuchen gesperrt.
recordNotFound

object (RecordNotFound)

Gibt an, dass das Proofing abgelehnt wurde, weil der Datensatz nicht im System des Ausstellers vorhanden ist.

Beispiele für die Verwendung: – Der Datensatz wurde nicht im System des Ausstellers gefunden. – Ein bestimmter Datensatz ist deaktiviert.
recordInvalid

object (RecordInvalid)

Gibt an, dass das Proofing abgelehnt wurde, weil der Datensatz im System des Ausstellers einen ungültigen Status hat.

Beispiele für die Verwendung: – Der Datensatz hat den Status „Abgebrochen“. – Der Datensatz ist abgelaufen.
maxProvisioningsReached

object (MaxProvisioningsReached)

Gibt an, dass das Proofing abgelehnt wurde, weil das Dokument bereits auf der maximal zulässigen Anzahl an Geräten eingesetzt wurde.
riskCheckFailure

object (RiskCheckFailure)

Gibt an, dass das Proofing aufgrund eines Fehlers bei der Risikobewertung abgelehnt wurde.

Beispiele für die Verwendung: – Das Wallet hat eine hohe Risikobewertung zurückgegeben, was ein hohes Betrugsrisiko darstellt. – Der Aussteller geht davon aus, dass die Anfrage ein hohes Betrugsrisiko birgt.
livenessCheckFailure

object (LivenessCheckFailure)

Gibt an, dass das Proofing aufgrund eines Fehlers bei der Aktivitätsprüfung abgelehnt wurde.

Beispiele für die Verwendung: – Das Wallet hat eine niedrige Liveness-Bewertung zurückgegeben.

EvidenceMismatch

Ein Objekt, das eine Ablehnung aufgrund von Diskrepanzen bei den Nachweisen angibt.

JSON-Darstellung 
{
  "evidenceType": string
}
Felder
evidenceType

string

Eine Beschreibung des Nachweises, bei dem die Diskrepanz vorliegt. Wird nur zur Fehlerbehebung verwendet.

EvidenceIncomplete

Ein Objekt, das eine Ablehnung aufgrund von unvollständigen Nachweisen angibt.

JSON-Darstellung 
{
  "evidenceType": string
}
Felder
evidenceType

string

Eine Beschreibung der unvollständigen Nachweise. Wird nur zur Fehlerbehebung verwendet.

LowRiskScore

Dieser Typ hat keine Felder.

Ein Objekt, das eine Ablehnung aufgrund einer niedrigen Risikobewertung angibt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

RecordNotFound

Dieser Typ hat keine Felder.

Ein Objekt, das eine Ablehnung aufgrund eines nicht gefundenen Datensatzes angibt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

RecordInvalid

Ein Objekt, das eine Ablehnung aufgrund eines ungültigen Datensatzes angibt.

JSON-Darstellung 
{
  "invalidityReason": string
}
Felder
invalidityReason

string

Eine Beschreibung, warum der Datensatz ungültig ist.

MaxProvisioningsReached

Ein Objekt, das eine Ablehnung angibt, weil die maximal zulässige Anzahl an Bereitstellungen erreicht wurde.

JSON-Darstellung 
{
  "maxNumberOfProvisioningsAllowed": integer
}
Felder
maxNumberOfProvisioningsAllowed

integer

Die maximal zulässige Anzahl an Bereitstellungen, die in der Richtlinie des Ausstellers festgelegt ist.

RiskCheckFailure

Dieser Typ hat keine Felder.

Ein Objekt, das eine Ablehnung aufgrund eines fehlgeschlagenen Risikochecks angibt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

LivenessCheckFailure

Dieser Typ hat keine Felder.

Ein Objekt, das eine Ablehnung aufgrund eines fehlgeschlagenen Aktivitätschecks angibt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Herausforderung

Ein Objekt, das den Status „Weitere Informationen erforderlich“ eines Proofings darstellt.

JSON-Darstellung 
{
  "challengeDescription": string,

  // Union field challenge can be only one of the following:
  "physicalLocationVisit": {
    object (PhysicalLocationVisit)
  },
  "issuerUrlVisit": {
    object (IssuerUrlVisit)
  },
  "additionalTimeRequired": {
    object (AdditionalTimeRequired)
  }
  // End of list of possible types for union field challenge.
}
Felder
challengeDescription

string

Eine Beschreibung der Aufgabe, die Mitarbeitern des Supports bei der Fehlerbehebung hilft. Beachte, dass dieser Text niemals Nutzern angezeigt wird. Er kann beschreibenden nicht sensiblen Text für die Fehlerbehebung enthalten.

Warnung: Diese Nachricht darf keine personenidentifizierbaren Informationen enthalten.
Union-Feld challenge. Ein oneof mit den verschiedenen Aufgaben, die ein Nutzer möglicherweise lösen muss. Für challenge ist nur einer der folgenden Werte zulässig:
physicalLocationVisit

object (PhysicalLocationVisit)

Eine Aufgabe, bei der ein Nutzer einen bestimmten Ort (z. B. das Büro eines Ausstellers) aufsuchen und dort eine Aufgabe lösen muss.
issuerUrlVisit

object (IssuerUrlVisit)

Eine Aufgabenoption, bei der ein Nutzer eine vom Aussteller angegebene URL aufrufen und dort eine Aufgabe lösen muss.
additionalTimeRequired

object (AdditionalTimeRequired)

Eine Option, bei der mehr Zeit für die Überprüfung des Korrekturlesens benötigt wird.

PhysicalLocationVisit

Dieser Typ hat keine Felder.

Ein Objekt, das eine Aufgabenoption darstellt, bei der ein Nutzer einen bestimmten Ort (z. B. das Büro eines Ausstellers) aufsuchen und dort eine Aufgabe lösen muss. Diese Aufgabe liegt außerhalb des Einflussbereichs von Google. Wenn der Aussteller diesen Aufgabentyp unterstützt, muss er aus Sicherheitsgründen Google die Standortdaten beim Onboarding nennen.

IssuerUrlVisit

Dieser Typ hat keine Felder.

Ein Objekt, das eine Aufgabenoption darstellt, bei der ein Nutzer eine vom Aussteller angegebene URL aufrufen und dort eine Aufgabe lösen muss. Diese Aufgabe liegt außerhalb des Einflussbereichs von Google. Wenn der Aussteller diesen Aufgabentyp unterstützt, muss er aus Sicherheitsgründen Google die URL beim Onboarding nennen.

AdditionalTimeRequired

Ein Objekt, das die Option „Weitere Informationen erforderlich“ darstellt, bei der zusätzliche Zeit für die Überprüfung des Proofings erforderlich ist. Die geschätzte Bearbeitungszeit kann optional angegeben werden.

JSON-Darstellung 
{
  "estimatedCompletion": string
}
Felder
estimatedCompletion

string (int64 format)

Die geschätzte Zeit, zu der die Korrektur abgeschlossen ist. Das Format ist ein Zeitstempel, der als Anzahl der Millisekunden seit der Unix-Epoche angegeben wird.

Abgebrochen

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Abgebrochen“ eines Proofings darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Aufgehoben

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Widerrufen“ eines Proofings darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Abgelaufen

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Abgelaufen“ eines Proofings darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.