- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- ProofingStatus
- Oczekuje
- Zaakceptowano
- Odrzucono
- Odrzucenie
- EvidenceMismatch
- EvidenceIncomplete
- LowRiskScore
- RecordNotFound
- RecordInvalid
- MaxProvisioningsReached
- RiskCheckFailure
- LivenessCheckFailure
- Challenged
- PhysicalLocationVisit
- IssuerUrlVisit
- AdditionalTimeRequired
- Anulowano
- Cofnięto
- Ważność minęła
Punkt końcowy do pobierania bieżącego stanu korekty.
Żą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 ( |
| Pola | |
|---|---|
requestMetadata |
Wymagane. Metadane dotyczące żądania, wymagane we wszystkich żądaniach. |
deviceReferenceId |
Wymagane. 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 korelacji. |
proofingId |
Wymagane. Nieprzezroczysty 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 ( |
| Pola | |
|---|---|
responseMetadata |
Wymagane. Metadane odpowiedzi, wymagane we wszystkich odpowiedziach. |
proofingStatus |
Wymagane. Bieżący stan korekty. |
ProofingStatus
Obiekt reprezentujący różne stany, w jakich może znajdować się weryfikacja.
| Zapis JSON |
|---|
{ // Union field |
| Pola | |
|---|---|
Pole zbiorcze status. Wymagane. Typ oneof zawierający różne stany możliwe w przypadku weryfikacji. status może mieć tylko jedną z tych wartości: |
|
pending |
Stan oczekujący, który oznacza, że wydawca nie podjął jeszcze decyzji. |
accepted |
Stan zaakceptowany, który oznacza, że wystawca zaakceptował weryfikację. |
rejected |
Stan odrzucenia, który oznacza, że wydawca odrzucił weryfikację. |
challenged |
Stan „Wymagany test”, który oznacza, że wydawca chce, aby użytkownik przeszedł test zabezpieczający, zanim podejmie decyzję dotyczącą weryfikacji. |
canceled |
Stan anulowania, który oznacza, że użytkownik anulował korektę. |
revoked |
Stan unieważniony, który oznacza, że wydawca unieważnił weryfikację. |
expired |
Stan wygasły, który oznacza, że weryfikacja nie została zakończona (prawdopodobnie z powodu nieukończenia weryfikacji) przed terminem wyznaczonym przez wydawcę. |
Oczekujące
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 weryfikacji.
Odrzucono
Obiekt reprezentujący odrzucony stan weryfikacji.
| Zapis JSON |
|---|
{ "primaryRejection": { object ( |
| Pola | |
|---|---|
primaryRejection |
Główny powód odrzucenia weryfikacji. |
additionalRejections[] |
Dodatkowe przyczyny, jeśli istnieją, dla których weryfikacja ma stan odrzucony. |
Odrzucenie
Obiekt zawierający szczegóły dotyczące konkretnej przyczyny odrzucenia, która spowodowała, że weryfikacja ma stan odrzucony.
| Zapis JSON |
|---|
{ "rejectionDescription": string, "issuerRejectionIdentifier": string, // Union field |
| Pola | |
|---|---|
rejectionDescription |
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 |
Ten identyfikator jest specyficzny dla wydawcy i jest generowany przez niego. Jest on używany wyłącznie do debugowania w celu zidentyfikowania odrzucenia. Jest to identyfikator, pod którym wydawca zna to odrzucenie. |
Pole zbiorcze reason. Wymagane. Typ oneof obejmujący różne powody odrzucenia weryfikacji. reason może mieć tylko jedną z tych wartości: |
|
evidenceMismatch |
Wskazuje, że weryfikacja została odrzucona z powodu niezgodności dowodów. Przykłady użycia: - Niezgodność selfie zrobionego w aplikacji ze zdjęciem w systemie wydawcy. – Niezgodność obrazu dokumentu przechwyconego przez aplikację z obrazem w systemie wydawcy. |
evidenceIncomplete |
Informuje, że weryfikacja została odrzucona z powodu niekompletnych dowodów. Przykłady użycia: – wystawca nie otrzymał wszystkich wymaganych dowodów. |
lowRiskScore |
(DEPRECATED: use riskCheckFailure or livenessCheckFailure accordingly) Oznacza, że weryfikacja została odrzucona z powodu niskiego wyniku ryzyka. Przykłady zastosowania: – Portfel podaje niską ocenę ryzyka. – Wydawca zablokował tego użytkownika z powodu wielokrotnych nieudanych prób. |
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 |
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 |
Wskazuje, że weryfikacja została odrzucona, ponieważ dokument został udostępniony na maksymalną dozwoloną liczbę urządzeń. |
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 |
Wskazuje, że weryfikacja została odrzucona z powodu niepowodzenia testu weryfikacji tożsamości. Przykłady zastosowania: - Portfel podał niski wynik weryfikacji tożsamości. |
EvidenceMismatch
Obiekt wskazujący na odrzucenie z powodu niezgodności dowodów.
| Zapis JSON |
|---|
{ "evidenceType": string } |
| Pola | |
|---|---|
evidenceType |
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 |
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 |
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 |
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 zakwestionowany stan weryfikacji.
| Zapis JSON |
|---|
{ "challengeDescription": string, // Union field |
| Pola | |
|---|---|
challengeDescription |
Wymagane. Opis problemu, 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. |
Pole zbiorcze challenge. Wymagane. Typ wyzwania, które użytkownik może musieć ukończyć. challenge może mieć tylko jedną z tych wartości: |
|
physicalLocationVisit |
Wyzwanie, w którym użytkownik musi odwiedzić fizyczną lokalizację, np. biuro wydawcy, aby je ukończyć. |
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 |
Opcja weryfikacji, w przypadku której na sprawdzenie dowodu tożsamości potrzeba 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 wydawcę 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 przypadku której na sprawdzenie dowodu wymagany jest dodatkowy czas. Możesz opcjonalnie podać szacowany czas ukończenia.
| Zapis JSON |
|---|
{ "estimatedCompletion": string } |
| Pola | |
|---|---|
estimatedCompletion |
Szacowany czas zakończenia korekty. Jest to sygnatura czasowa wyrażona w milisekundach od początku epoki uniksowej. |
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.