Method: vdc.proofUser

Ein Endpunkt, um einen Nutzer mit einer vom Aussteller angegebenen Liste von Nachweisen für eine digitale Kennung und ein bestimmtes Gerät zu prüfen.

HTTP-Anfrage

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string,
  "evidence": [
    {
      object (ProofingEvidence)
    }
  ],

  // Union field proofing_context can be only one of the following:
  "reverificationContext": {
    object (ReverificationContext)
  }
  // End of list of possible types for union field proofing_context.
}
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
evidence[]

object (ProofingEvidence)

Die Liste der Nachweise, die zur Überprüfung eines Nutzers für eine digitale Kennung erforderlich sind.
Union-Feld proofing_context. Der Kontext für die Korrektur. Bei der ersten Korrektur leer. Für proofing_context ist nur einer der folgenden Werte zulässig:
reverificationContext

object (ReverificationContext)

Der Kontext für die erneute Überprüfung.

Antworttext

Eine Bestätigung auf eine Anfrage zur Prüfung eines Nutzers für ein digitales Ausweisdokument, die über die Bearbeitung der Prüfung informiert.

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

JSON-Darstellung 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingId": string
}
Felder
responseMetadata

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.
proofingId

string

Die intransparente Kennzeichnung, die eine Prüfung mit einem speziellen Nachweisbündel für ein bestimmtes Gerät darstellt. Dies ist dieselbe Ausweis-ID, die in der Anfrage gesendet wurde.

ProofingEvidence

Ein Objekt, das einen einzelnen Nachweis darstellt.

JSON-Darstellung 
{

  // Union field evidence_type can be only one of the following:
  "preAuthorizationCode": {
    object (Evidence)
  }
  // End of list of possible types for union field evidence_type.
}
Felder
Union-Feld evidence_type. Ein oneof, das angibt, wie der Nachweis vorgelegt wird. Für evidence_type ist nur einer der folgenden Werte zulässig:
preAuthorizationCode

object (Evidence)

Vorautorisierungscode, der vom Aussteller gesendet wurde.

Belege

Ein Objekt, das einen einzelnen Nachweis darstellt.

JSON-Darstellung 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string,
  "unencryptedInteger": integer
  // End of list of possible types for union field presencetype.
}
Felder
Union-Feld presencetype. Ein oneof, das angibt, wie der Nachweis vorgelegt wird. Für presencetype ist nur einer der folgenden Werte zulässig:
encryptedData

object (EncryptedData)

Der verschlüsselte Wert und die Verschlüsselungsmetadaten, die zum Entschlüsseln des Werts erforderlich sind.
unencryptedValue

string

Der base64-codierte Wert des Nachweises.
unencryptedInteger

integer

Ganzzahlwert des Nachweises.

ReverificationContext

Der Kontext, der erforderlich ist, um die erneute Überprüfung der Anmeldedaten auszulösen.

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

string

Die ID des Berechtigungsnachweises, für den die erneute Bestätigung durchgeführt wird.