Method: vdc.getProofingStatus

교정의 현재 상태를 가져오는 엔드포인트입니다.

HTTP 요청

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
필드
requestMetadata

object (RequestMetadata)

모든 요청에 필요한 요청에 관한 메타데이터입니다.

deviceReferenceId

string

기기 및 기기와 연결된 ID 키에 해당하는 ID입니다. 이는 기기 ID가 아닙니다. 즉, 사용자가 동일한 기기에서 두 개의 별도 사용자 인증 정보를 사용하는 경우 이 ID는 서로 다릅니다.

이 ID는 모든 요청에 제공되며 요청을 상호 연관시키는 데 사용할 수 있습니다.

proofingId

string

특정 기기의 특정 증거 번들로 증명을 나타내는 불투명 식별자입니다.

예: UUID

응답 본문

교정의 현재 상태가 포함된 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
필드
responseMetadata

object (ResponseMetadata)

모든 응답에 필요한 응답에 관한 메타데이터입니다.

proofingStatus

object (ProofingStatus)

교정의 현재 상태입니다.

ProofingStatus

교정의 다양한 상태를 나타내는 객체입니다.

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.
}
필드
통합 필드 status. 교정의 가능한 여러 상태를 포함하는 oneof입니다. status은 다음 중 하나여야 합니다.
pending

object (Pending)

발급자가 아직 결정을 내리지 않았음을 나타내는 대기 상태입니다.

accepted

object (Accepted)

허용된 상태로, 발급자가 증빙을 수락했음을 나타냅니다.

rejected

object (Rejected)

거부됨 상태로, 발급자가 인증을 거부했음을 나타냅니다.

challenged

object (Challenged)

챌린지 상태입니다. 발급자가 본인 인증에 대한 결정을 내리기 전에 사용자가 챌린지를 완료하기를 원함을 나타냅니다.

canceled

object (Canceled)

취소됨 상태로, 사용자가 교정을 취소했음을 나타냅니다.

revoked

object (Revoked)

취소된 상태로, 발급자가 증명을 취소했음을 나타냅니다.

expired

object (Expired)

만료된 상태로, 발급자가 설정한 기한 전에 인증에 대한 결정이 내려지지 않았음을 나타냅니다 (챌린지가 완료되지 않았기 때문일 수 있음).

대기 중

이 유형에는 필드가 없습니다.

대기 중 상태를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

수락됨

이 유형에는 필드가 없습니다.

승인된 증빙 상태를 나타내는 객체입니다.

거부됨

거부된 교정 상태를 나타내는 객체입니다.

JSON 표현
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
필드
primaryRejection

object (Rejection)

이 교정의 상태가 거부된 기본 이유입니다.

additionalRejections[]

object (Rejection)

교정 상태가 거부된 추가 이유(있는 경우)입니다.

Rejection

교정 상태가 거부됨이 된 특정 거부 이유에 관한 세부정보가 포함된 객체입니다.

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.
}
필드
rejectionDescription

string

지원 담당자가 디버깅할 수 있도록 이 거부에 대한 설명입니다. 사용자에게 표시되지 않습니다. 디버깅에 사용되는 설명적이고 민감하지 않은 텍스트를 포함할 수 있습니다.

경고: 이 메시지에 개인 식별 정보를 포함하지 마세요.

issuerRejectionIdentifier

string

이 식별자는 발급기관에 고유하며 발급기관에서 생성합니다. 거부를 식별하기 위한 디버깅 목적으로만 사용됩니다. 발급자가 이 거부를 인식하는 식별자입니다.

통합 필드 reason. 교정 작업이 거부될 수 있는 다양한 이유 간의 oneof입니다. reason은 다음 중 하나여야 합니다.
evidenceMismatch

object (EvidenceMismatch)

증빙 자료가 일치하지 않아 증빙이 거부되었음을 나타냅니다.

사용 예: - 앱에서 캡처한 셀카와 발급자 시스템의 이미지가 일치하지 않습니다. - 앱 캡처 문서 이미지와 발급자 시스템의 이미지가 일치하지 않습니다.

evidenceIncomplete

object (EvidenceIncomplete)

증빙 자료가 불완전하여 증빙이 거부되었음을 나타냅니다.

사용 예: - 발급자가 필수 증빙 서류를 모두 수신하지 못했습니다.

lowRiskScore
(deprecated)

object (LowRiskScore)

(지원 중단됨: riskCheckFailure 또는 livenessCheckFailure를 적절하게 사용하세요.)

위험 점수가 낮아 인증이 거부되었음을 나타냅니다.

사용 예: - 지갑에서 제공한 위험 점수가 낮습니다. - 반복된 실패로 인해 발급자가 이 사용자를 잠갔습니다.

recordNotFound

object (RecordNotFound)

발급자 시스템에 기록이 없어 증빙이 거부되었음을 나타냅니다.

사용 예: - 레코드가 발급자 시스템에 없습니다. - 특정 레코드가 선택 해제됩니다.

recordInvalid

object (RecordInvalid)

발급자 시스템의 기록이 잘못된 상태이므로 증빙이 거부되었음을 나타냅니다.

사용 예: - 레코드가 취소된 상태입니다. - 레코드가 만료되었습니다.

maxProvisioningsReached

object (MaxProvisioningsReached)

허용되는 최대 기기 수에 문서를 프로비저닝하여 교정이 거부되었음을 나타냅니다.

riskCheckFailure

object (RiskCheckFailure)

위험 점수 확인 실패로 인해 증빙이 거부되었음을 나타냅니다.

사용 예: - 지갑에서 제공한 위험 점수가 높으며 이는 사기 위험이 높음을 나타냅니다. - 발급자가 요청에 사기 위험이 높다고 평가합니다.

livenessCheckFailure

object (LivenessCheckFailure)

활성 상태 확인 실패로 인해 인증이 거부되었음을 나타냅니다.

사용 예: - 지갑에서 제공한 활성도 점수가 낮습니다.

EvidenceMismatch

증빙 불일치 거부를 나타내는 객체입니다.

JSON 표현
{
  "evidenceType": string
}
필드
evidenceType

string

일치하지 않는 증거에 대한 설명입니다. 디버그 목적으로만 사용됩니다.

EvidenceIncomplete

증거가 불완전하여 거부되었음을 나타내는 객체입니다.

JSON 표현
{
  "evidenceType": string
}
필드
evidenceType

string

증거에 대한 설명이 불완전합니다. 디버그 목적으로만 사용됩니다.

LowRiskScore

이 유형에는 필드가 없습니다.

위험 점수가 낮아 거부되었음을 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

RecordNotFound

이 유형에는 필드가 없습니다.

레코드를 찾을 수 없음을 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

RecordInvalid

잘못된 레코드 거부를 나타내는 객체입니다.

JSON 표현
{
  "invalidityReason": string
}
필드
invalidityReason

string

레코드가 잘못된 이유에 대한 설명입니다.

MaxProvisioningsReached

최대 프로비저닝에 도달했음을 나타내는 거부 객체입니다.

JSON 표현
{
  "maxNumberOfProvisioningsAllowed": integer
}
필드
maxNumberOfProvisioningsAllowed

integer

발급자 정책에 따라 허용되는 최대 프로비저닝 수입니다.

RiskCheckFailure

이 유형에는 필드가 없습니다.

위험 확인 실패 거부를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

LivenessCheckFailure

이 유형에는 필드가 없습니다.

활성 확인 실패 거부를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

지원 필요

이의 제기된 증명 상태를 나타내는 객체입니다.

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.
}
필드
challengeDescription

string

지원 담당자가 디버깅할 수 있는 문제에 관한 설명입니다. 사용자에게 표시되지 않습니다. 디버깅에 사용되는 설명적이고 민감하지 않은 텍스트를 포함할 수 있습니다.

경고: 이 메시지에 개인 식별 정보를 포함하지 마세요.

통합 필드 challenge. 사용자가 완료해야 할 수 있는 다양한 챌린지 간의 oneof입니다. challenge은 다음 중 하나여야 합니다.
physicalLocationVisit

object (PhysicalLocationVisit)

사용자가 본인 확인을 완료하기 위해 발급 기관의 사무실과 같은 실제 위치를 방문해야 하는 본인 확인입니다.

issuerUrlVisit

object (IssuerUrlVisit)

사용자가 발급자가 제공한 URL을 방문하여 해당 URL에서 챌린지를 완료해야 하는 챌린지 옵션입니다.

additionalTimeRequired

object (AdditionalTimeRequired)

이 교정 작업을 검토하는 데 시간이 더 필요한 챌린지 옵션입니다.

PhysicalLocationVisit

이 유형에는 필드가 없습니다.

사용자가 본인 확인을 완료하기 위해 발급자 사무실과 같은 실제 위치를 방문해야 하는 본인 확인 옵션을 나타내는 객체입니다. 이 챌린지는 Google의 지원 범위를 벗어납니다. 보안상의 이유로 발급자가 이 챌린지 유형을 지원하는 경우 온보딩 중에 Google에 위치 세부정보를 제공해야 합니다.

IssuerUrlVisit

이 유형에는 필드가 없습니다.

사용자가 발급자가 제공한 URL을 방문하여 해당 URL에서 챌린지를 완료해야 하는 챌린지 옵션을 나타내는 객체입니다. 이 챌린지는 Google의 지원 범위를 벗어납니다. 보안상의 이유로 발급자가 이 챌린지 유형을 지원하는 경우 온보딩 중에 Google에 URL을 제공해야 합니다.

AdditionalTimeRequired

증빙을 검토하는 데 추가 시간이 필요한 챌린지 옵션을 나타내는 객체입니다. 예상 완료 시간을 선택적으로 제공할 수 있습니다.

JSON 표현
{
  "estimatedCompletion": string
}
필드
estimatedCompletion

string (int64 format)

교정 작업이 완료될 것으로 예상되는 시간입니다. 검토가 가능한 경우 검토합니다. 형식은 타임스탬프이며 타임스탬프는 Unix 에포크 이후의 밀리초 수로 표시됩니다.

취소됨

이 유형에는 필드가 없습니다.

취소된 교정 상태를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

취소됨

이 유형에는 필드가 없습니다.

취소된 증빙 상태를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.

만료됨

이 유형에는 필드가 없습니다.

만료된 교정 상태를 나타내는 객체입니다. 이 메시지는 현재 의도적으로 비어 있습니다. 향후 새 필드가 추가될 수 있습니다.