Method: vdc.getProofingStatus

Punkt końcowy do pobierania bieżącego stanu weryfikacji.

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
Pola
requestMetadata

object (RequestMetadata)

Metadane dotyczące żądania, wymagane we wszystkich żądaniach.
deviceReferenceId

string

Identyfikator odpowiadający urządzeniu i klucz tożsamości powiązany z urządzeniem. NIE jest to identyfikator urządzenia, co oznacza, że jeśli użytkownik ma 2 osobne dane logowania na tym samym urządzeniu, ten identyfikator będzie się różnić.

Ten identyfikator jest podawany we wszystkich żądaniach i może służyć do ich korelowania.
proofingId

string

Nieprzejrzysty identyfikator reprezentujący weryfikację z określonym pakietem dowodów na konkretnym urządzeniu.

Przykład: UUID

Treść odpowiedzi

Odpowiedź zawierająca bieżący stan korekty.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
Pola
responseMetadata

object (ResponseMetadata)

Metadane dotyczące odpowiedzi, wymagane we wszystkich odpowiedziach.
proofingStatus

object (ProofingStatus)

Bieżący stan weryfikacji.

ProofingStatus

Obiekt reprezentujący różne stany, w jakich może znajdować się weryfikacja.

Zapis JSON 
{

  // 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.
}
Pola
Pole zbiorcze status. Typ oneof zawierający różne stany możliwe w przypadku weryfikacji. status może mieć tylko jedną z tych wartości:
pending

object (Pending)

Stan oczekujący, który oznacza, że wydawca nie podjął jeszcze decyzji.
accepted

object (Accepted)

Stan zaakceptowany, który oznacza, że wystawca zaakceptował weryfikację.
rejected

object (Rejected)

Stan odrzucony, który oznacza, że wydawca odrzucił weryfikację.
challenged

object (Challenged)

Stan „Wymagany test”, który oznacza, że wydawca chce, aby użytkownik przeszedł test zabezpieczający, zanim podejmie decyzję dotyczącą weryfikacji.
canceled

object (Canceled)

Stan anulowania, który oznacza, że użytkownik anulował korektę.
revoked

object (Revoked)

Stan unieważniony, który oznacza, że wydawca unieważnił weryfikację.
expired

object (Expired)

Stan wygasły, który oznacza, że weryfikacja nie została zakończona (prawdopodobnie z powodu nieukończenia zadania) przed terminem wyznaczonym przez wystawcę.

Oczekuje

Ten typ nie ma pól.

Obiekt reprezentujący stan oczekiwania. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Zaakceptowano

Ten typ nie ma pól.

Obiekt reprezentujący zaakceptowany stan korekty.

Odrzucono

Obiekt reprezentujący odrzucony stan weryfikacji.

Zapis JSON 
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
Pola
primaryRejection

object (Rejection)

Główny powód odrzucenia weryfikacji.
additionalRejections[]

object (Rejection)

Dodatkowe powody (jeśli istnieją), dla których weryfikacja ma stan odrzucenia.

Odrzucenie

Obiekt zawierający szczegóły konkretnej przyczyny odrzucenia, która spowodowała, że weryfikacja ma stan odrzucony.

Zapis JSON 
{
  "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.
}
Pola
rejectionDescription

string

Opis odrzucenia, który pomoże pracownikom pomocy technicznej w debugowaniu. Pamiętaj, że użytkownicy nigdy tego nie zobaczą. Może zawierać opis bez danych poufnych, który jest używany podczas debugowania.

Ostrzeżenie: w tym komunikacie nie umieszczaj żadnych informacji umożliwiających identyfikację konkretnej osoby.
issuerRejectionIdentifier

string

Ten identyfikator jest specyficzny dla wydawcy i jest generowany przez wydawcę. Jest on używany tylko do debugowania w celu identyfikacji odrzucenia. Jest to identyfikator, pod którym wydawca zna to odrzucenie.
Pole zbiorcze reason. Typ oneof obejmujący różne powody odrzucenia weryfikacji. reason może mieć tylko jedną z tych wartości:
evidenceMismatch

object (EvidenceMismatch)

Wskazuje, że weryfikacja została odrzucona z powodu niezgodności dowodów.

Przykłady użycia: - Niezgodność selfie zrobionego w aplikacji z obrazem w systemie wydawcy. – Niezgodność obrazu dokumentu przechwyconego w aplikacji z obrazem w systemie wydawcy.
evidenceIncomplete

object (EvidenceIncomplete)

Wskazuje, że weryfikacja została odrzucona z powodu niekompletnych dowodów.

Przykłady użycia: – wystawca nie otrzymał wszystkich wymaganych dowodów.
lowRiskScore
(deprecated)

object (LowRiskScore)

(DEPRECATED: use riskCheckFailure or livenessCheckFailure accordingly)

Oznacza, że weryfikacja została odrzucona z powodu niskiego wyniku ryzyka.

Przykłady zastosowań: – Portfel podaje niski wskaźnik ryzyka. – Wydawca zablokował tego użytkownika z powodu wielokrotnych nieudanych prób.
recordNotFound

object (RecordNotFound)

Oznacza, że weryfikacja została odrzucona, ponieważ rekord nie istnieje w systemie wystawcy.

Przykłady użycia: – rekord nie został znaleziony w systemie wystawcy. – określony rekord został wyłączony;
recordInvalid

object (RecordInvalid)

Wskazuje, że weryfikacja została odrzucona, ponieważ rekord w systemie wystawcy jest w nieprawidłowym stanie.

Przykłady użycia: - The record is in a canceled state. – rekord stracił ważność;
maxProvisioningsReached

object (MaxProvisioningsReached)

Wskazuje, że weryfikacja została odrzucona, ponieważ dokument został udostępniony na maksymalną dozwoloną liczbę urządzeń.
riskCheckFailure

object (RiskCheckFailure)

Wskazuje, że weryfikacja została odrzucona z powodu niepowodzenia weryfikacji oceny ryzyka.

Przykłady zastosowania: – Portfel podaje wysoki wynik ryzyka, co oznacza wysokie ryzyko oszustwa. – Wydawca ocenia, że żądanie wiąże się z wysokim ryzykiem oszustwa.
livenessCheckFailure

object (LivenessCheckFailure)

Wskazuje, że weryfikacja została odrzucona z powodu niepowodzenia testu weryfikacji tożsamości.

Przykłady użycia: - Portfel podał niski wynik weryfikacji tożsamości.

EvidenceMismatch

Obiekt wskazujący odrzucenie z powodu niezgodności dowodów.

Zapis JSON 
{
  "evidenceType": string
}
Pola
evidenceType

string

Opis dowodu, który nie pasuje. Używane tylko do debugowania.

EvidenceIncomplete

Obiekt wskazujący odrzucenie z powodu niekompletnych dowodów.

Zapis JSON 
{
  "evidenceType": string
}
Pola
evidenceType

string

Opis niekompletnych dowodów. Używane tylko do debugowania.

LowRiskScore

Ten typ nie ma pól.

Obiekt wskazujący odrzucenie z powodu niskiego wyniku ryzyka. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

RecordNotFound

Ten typ nie ma pól.

Obiekt wskazujący odrzucenie z powodu braku rekordu. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

RecordInvalid

Obiekt wskazujący odrzucenie nieprawidłowego rekordu.

Zapis JSON 
{
  "invalidityReason": string
}
Pola
invalidityReason

string

Opis przyczyny, dla której rekord jest nieprawidłowy.

MaxProvisioningsReached

Obiekt wskazujący odrzucenie z powodu osiągnięcia maksymalnej liczby udostępnień.

Zapis JSON 
{
  "maxNumberOfProvisioningsAllowed": integer
}
Pola
maxNumberOfProvisioningsAllowed

integer

Maksymalna dozwolona liczba udostępnień określona w zasadach wydawcy.

RiskCheckFailure

Ten typ nie ma pól.

Obiekt wskazujący odrzucenie z powodu niepowodzenia weryfikacji ryzyka. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

LivenessCheckFailure

Ten typ nie ma pól.

Obiekt wskazujący odrzucenie z powodu niepowodzenia weryfikacji tożsamości. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Z utrudnieniami

Obiekt reprezentujący stan weryfikacji, który został zakwestionowany.

Zapis JSON 
{
  "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.
}
Pola
challengeDescription

string

Opis problemu, który pomoże pracownikom pomocy technicznej w jego debugowaniu. Pamiętaj, że użytkownicy nigdy tego nie zobaczą. Może zawierać opis bez danych poufnych, który jest używany podczas debugowania.

Ostrzeżenie: w tym komunikacie nie umieszczaj żadnych informacji umożliwiających identyfikację konkretnej osoby.
Pole zbiorcze challenge. Typ oneof obejmujący różne testy zabezpieczające, które użytkownik może musieć przejść. challenge może mieć tylko jedną z tych wartości:
physicalLocationVisit

object (PhysicalLocationVisit)

Test, w którym użytkownik musi odwiedzić fizyczną lokalizację, np. biuro wydawcy, aby go ukończyć.
issuerUrlVisit

object (IssuerUrlVisit)

Opcja testu zabezpieczającego, w której użytkownik musi odwiedzić adres URL podany przez wydawcę i wykonać test zabezpieczający pod tym adresem.
additionalTimeRequired

object (AdditionalTimeRequired)

Opcja wyzwania, w przypadku której weryfikacja dowodu wymaga więcej czasu.

PhysicalLocationVisit

Ten typ nie ma pól.

Obiekt reprezentujący opcję weryfikacji, w której użytkownik musi odwiedzić fizyczną lokalizację, np. biuro wydawcy, aby ukończyć weryfikację. To wyzwanie jest poza zakresem Google. Ze względów bezpieczeństwa, jeśli wydawca obsługuje ten typ weryfikacji, musi podać Google szczegóły lokalizacji podczas wprowadzania.

IssuerUrlVisit

Ten typ nie ma pól.

Obiekt reprezentujący opcję weryfikacji, w której użytkownik musi odwiedzić adres URL podany przez wystawcę i wykonać weryfikację pod tym adresem. To wyzwanie jest poza zakresem Google. Ze względów bezpieczeństwa, jeśli wystawca obsługuje ten typ weryfikacji, musi podać adres URL Google podczas procesu wprowadzania.

AdditionalTimeRequired

Obiekt reprezentujący opcję weryfikacji, w której przypadku sprawdzenie dowodu wymaga dodatkowego czasu. Opcjonalnie można podać szacowany czas ukończenia.

Zapis JSON 
{
  "estimatedCompletion": string
}
Pola
estimatedCompletion

string (int64 format)

Szacowany czas zakończenia korekty. Sprawdź, czy jest dostępna. Ma on format sygnatury czasowej, która jest wyrażona jako liczba milisekund od początku epoki systemu Unix.

Anulowano

Ten typ nie ma pól.

Obiekt reprezentujący anulowany stan weryfikacji. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Unieważniono

Ten typ nie ma pól.

Obiekt reprezentujący cofnięty stan weryfikacji. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.

Wygasła

Ten typ nie ma pól.

Obiekt reprezentujący wygasły stan weryfikacji. Ta wiadomość jest obecnie celowo pusta. W przyszłości możemy dodać nowe pola.