Method: vdc.cancelProofing

Ein Endpunkt, um ein Proofing abzubrechen.

Dieses Proofing muss den Status „Ausstehend“, „Angefochten“ oder „Abgebrochen“ haben. Andernfalls muss eine invalidState ErrorResponse zurückgegeben werden.

HTTP-Anfrage

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

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

Dieses Proofing muss den Status „Ausstehend“, „Angefochten“ oder „Abgebrochen“ haben. Andernfalls muss eine invalidState ErrorResponse zurückgegeben werden.

Antworttext

Eine Antwort auf eine Anfrage zum Abbrechen eines Proofings.

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

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

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.