- Permintaan HTTP
- Isi permintaan
- Isi respons
- ProofingStatus
- Tertunda
- Diterima
- Ditolak
- Penolakan
- EvidenceMismatch
- EvidenceIncomplete
- LowRiskScore
- RecordNotFound
- RecordInvalid
- MaxProvisioningsReached
- RiskCheckFailure
- LivenessCheckFailure
- Tantangan
- PhysicalLocationVisit
- IssuerUrlVisit
- AdditionalTimeRequired
- Dibatalkan
- Dicabut
- Sudah berakhir
Endpoint untuk mengambil status verifikasi saat ini.
Permintaan HTTP
POST https://example.issuer.com/api/v1/vdc/getProofingStatus
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{
"requestMetadata": {
object ( |
| Kolom | |
|---|---|
requestMetadata |
Metadata tentang permintaan, yang diperlukan dalam semua permintaan. |
deviceReferenceId |
ID yang sesuai dengan perangkat dan kunci identitas yang terkait dengan perangkat. ID ini BUKAN ID perangkat, artinya jika pengguna memiliki dua kredensial terpisah di perangkat yang sama, ID ini akan berbeda di antara keduanya. ID ini diberikan di semua permintaan, dan dapat digunakan untuk mengorelasikan permintaan. |
proofingId |
ID buram yang merepresentasikan pembuktian dengan sekumpulan bukti tertentu, untuk perangkat tertentu. Contoh: UUID |
Isi respons
Respons yang berisi status pembuktian saat ini.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "responseMetadata": { object ( |
| Kolom | |
|---|---|
responseMetadata |
Metadata tentang respons, yang diperlukan dalam semua respons. |
proofingStatus |
Status pembuktian saat ini. |
ProofingStatus
Objek yang merepresentasikan berbagai status yang dapat dimiliki pembuktian.
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union status. Oneof yang berisi berbagai kemungkinan status untuk pembuktian. status hanya dapat berupa salah satu dari berikut: |
|
pending |
Status menunggu keputusan, yang menunjukkan bahwa penerbit belum membuat keputusan. |
accepted |
Status diterima, yang menunjukkan bahwa penerbit menerima verifikasi. |
rejected |
Status ditolak, yang menunjukkan bahwa penerbit telah menolak verifikasi. |
challenged |
Status verifikasi, yang menunjukkan bahwa penerbit ingin pengguna menyelesaikan verifikasi sebelum penerbit membuat keputusan terkait verifikasi. |
canceled |
Status dibatalkan, yang menunjukkan bahwa pengguna telah membatalkan pembuktian. |
revoked |
Status dicabut, yang menunjukkan bahwa penerbit telah mencabut verifikasi. |
expired |
Status habis masa berlaku, yang menunjukkan bahwa verifikasi tidak memiliki keputusan yang dibuat (kemungkinan karena tantangan tidak diselesaikan) sebelum batas waktu, yang ditetapkan oleh penerbit. |
Tertunda
Jenis ini tidak memiliki kolom.
Objek yang mewakili status menunggu keputusan. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
Diterima
Jenis ini tidak memiliki kolom.
Objek yang merepresentasikan status verifikasi yang diterima.
Ditolak
Objek yang merepresentasikan status verifikasi yang ditolak.
| Representasi JSON |
|---|
{ "primaryRejection": { object ( |
| Kolom | |
|---|---|
primaryRejection |
Alasan utama mengapa bukti ini berstatus ditolak. |
additionalRejections[] |
Alasan tambahan, jika ada, mengapa verifikasi memiliki status ditolak. |
Penolakan
Objek yang berisi detail tentang alasan penolakan tertentu, yang menyebabkan bukti memiliki status ditolak.
| Representasi JSON |
|---|
{ "rejectionDescription": string, "issuerRejectionIdentifier": string, // Union field |
| Kolom | |
|---|---|
rejectionDescription |
Deskripsi penolakan ini untuk membantu perwakilan dukungan melakukan proses debug. Perhatikan bahwa nama ini tidak pernah ditampilkan kepada pengguna. Dapat berisi teks deskriptif dan tidak sensitif yang digunakan untuk proses debug. Peringatan: Jangan sertakan PII apa pun dalam pesan ini. |
issuerRejectionIdentifier |
ID ini khusus untuk penerbit dan dibuat oleh penerbit. ID ini hanya digunakan untuk tujuan debug guna mengidentifikasi penolakan. Ini adalah ID yang diketahui penerbit untuk penolakan ini. |
Kolom union reason. Oneof antara berbagai alasan penolakan pembuktian. reason hanya dapat berupa salah satu dari berikut: |
|
evidenceMismatch |
Menunjukkan bahwa verifikasi ditolak karena bukti tidak cocok. Contoh penggunaan: - Ketidakcocokan antara selfie yang diambil aplikasi dan gambar di sistem penerbit. - Ketidakcocokan gambar dokumen rekaman aplikasi dan gambar dalam sistem penerbit. |
evidenceIncomplete |
Menunjukkan bahwa verifikasi ditolak karena bukti tidak lengkap. Contoh penggunaan: - Tidak semua bukti yang diperlukan diterima oleh penerbit. |
lowRiskScore |
(TIDAK DIGUNAKAN LAGI: gunakan riskCheckFailure atau livenessCheckFailure) Menunjukkan bahwa verifikasi ditolak karena skor risiko rendah. Contoh penggunaan: - Skor risiko yang diberikan dompet rendah. - Penerbit telah mengunci pengguna ini karena upaya yang gagal berulang kali. |
recordNotFound |
Menunjukkan bahwa verifikasi ditolak karena data tidak ada di sistem penerbit. Contoh penggunaan: - Catatan tidak ditemukan di sistem penerbit. - Rekaman tertentu tidak diikutsertakan. |
recordInvalid |
Menunjukkan bahwa pembuktian ditolak karena data dalam sistem penerbit berada dalam status tidak valid. Contoh penggunaan: - Rekaman dalam status dibatalkan. - Masa berlaku rekaman sudah berakhir. |
maxProvisioningsReached |
Menunjukkan bahwa pemeriksaan ditolak karena penyediaan dokumen ke jumlah maksimum perangkat yang diizinkan. |
riskCheckFailure |
Menunjukkan bahwa verifikasi ditolak karena pemeriksaan skor risiko gagal. Contoh penggunaan: - Skor risiko yang diberikan dompet tinggi, yang menunjukkan risiko penipuan yang tinggi. - Penerbit mengevaluasi bahwa permintaan memiliki risiko penipuan yang tinggi. |
livenessCheckFailure |
Menunjukkan bahwa verifikasi ditolak karena kegagalan pemeriksaan keaktifan. Contoh penggunaan: - Skor keaktifan yang diberikan dompet rendah. |
EvidenceMismatch
Objek yang menunjukkan penolakan karena ketidakcocokan bukti.
| Representasi JSON |
|---|
{ "evidenceType": string } |
| Kolom | |
|---|---|
evidenceType |
Deskripsi bukti yang tidak cocok. Hanya digunakan untuk tujuan debug. |
EvidenceIncomplete
Objek yang menunjukkan penolakan karena bukti tidak lengkap.
| Representasi JSON |
|---|
{ "evidenceType": string } |
| Kolom | |
|---|---|
evidenceType |
Deskripsi bukti yang tidak lengkap. Hanya digunakan untuk tujuan debug. |
LowRiskScore
Jenis ini tidak memiliki kolom.
Objek yang menunjukkan penolakan skor risiko rendah. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
RecordNotFound
Jenis ini tidak memiliki kolom.
Objek yang menunjukkan penolakan karena data tidak ditemukan. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
RecordInvalid
Objek yang menunjukkan penolakan rekaman yang tidak valid.
| Representasi JSON |
|---|
{ "invalidityReason": string } |
| Kolom | |
|---|---|
invalidityReason |
Deskripsi alasan data tidak valid. |
MaxProvisioningsReached
Objek yang menunjukkan penolakan karena jumlah penyediaan maksimum tercapai.
| Representasi JSON |
|---|
{ "maxNumberOfProvisioningsAllowed": integer } |
| Kolom | |
|---|---|
maxNumberOfProvisioningsAllowed |
Jumlah maksimum penyediaan yang diizinkan, sebagaimana ditetapkan oleh kebijakan penerbit. |
RiskCheckFailure
Jenis ini tidak memiliki kolom.
Objek yang menunjukkan penolakan kegagalan pemeriksaan risiko. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
LivenessCheckFailure
Jenis ini tidak memiliki kolom.
Objek yang menunjukkan penolakan kegagalan pemeriksaan keaktifan. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
Menghadapi tantangan
Objek yang mewakili status verifikasi yang dibantah.
| Representasi JSON |
|---|
{ "challengeDescription": string, // Union field |
| Kolom | |
|---|---|
challengeDescription |
Deskripsi tantangan bagi perwakilan dukungan untuk melakukan proses debug. Perhatikan bahwa nama ini tidak pernah ditampilkan kepada pengguna. Dapat berisi teks deskriptif dan tidak sensitif yang digunakan untuk proses debug. Peringatan: Jangan sertakan PII apa pun dalam pesan ini. |
Kolom union challenge. Salah satu tantangan yang harus diselesaikan pengguna. challenge hanya dapat berupa salah satu dari berikut: |
|
physicalLocationVisit |
Verifikasi di mana pengguna harus mengunjungi lokasi fisik, seperti kantor penerbit, untuk menyelesaikan verifikasi. |
issuerUrlVisit |
Opsi tantangan yang mengharuskan pengguna membuka URL yang disediakan oleh penerbit, dan menyelesaikan tantangan di URL tersebut. |
additionalTimeRequired |
Opsi tantangan jika diperlukan lebih banyak waktu untuk meninjau pembuktian ini. |
PhysicalLocationVisit
Jenis ini tidak memiliki kolom.
Objek yang merepresentasikan opsi verifikasi di mana pengguna harus mengunjungi lokasi fisik, seperti kantor penerbit, untuk menyelesaikan verifikasi. Tantangan ini berada di luar band Google. Untuk alasan keamanan, jika penerbit mendukung jenis tantangan ini, mereka harus memberikan detail lokasi kepada Google selama proses aktivasi.
IssuerUrlVisit
Jenis ini tidak memiliki kolom.
Objek yang merepresentasikan opsi tantangan di mana pengguna harus membuka URL yang disediakan oleh penerbit, dan menyelesaikan tantangan di URL tersebut. Tantangan ini berada di luar band Google. Untuk alasan keamanan, jika penerbit mendukung jenis tantangan ini, mereka harus memberikan URL ke Google selama proses aktivasi.
AdditionalTimeRequired
Objek yang merepresentasikan opsi tantangan yang memerlukan waktu tambahan untuk meninjau bukti. Perkiraan waktu penyelesaian dapat diberikan secara opsional.
| Representasi JSON |
|---|
{ "estimatedCompletion": string } |
| Kolom | |
|---|---|
estimatedCompletion |
Estimasi waktu penyelesaian pemeriksaan draf. Peninjauan jika tersedia. Formatnya adalah stempel waktu dan stempel waktu ditampilkan sebagai jumlah milidetik sejak epoch Unix. |
Dibatalkan
Jenis ini tidak memiliki kolom.
Objek yang mewakili status pembuktian yang dibatalkan. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
Dicabut
Jenis ini tidak memiliki kolom.
Objek yang mewakili status pembuktian yang dibatalkan. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.
Telah Berakhir
Jenis ini tidak memiliki kolom.
Objek yang mewakili status verifikasi yang telah berakhir. Pesan ini sengaja dikosongkan saat ini. Kolom baru dapat ditambahkan pada masa mendatang.