Skip to navigation

코드 대조

View as Markdown

사용자가 입력한 코드를 대조합니다.

틀린 코드는 에러가 아닙니다

코드가 맞지 않으면 200 과 함께 valid:false, status:"pending" 이 오고 remainingAttempts 가 하나 줄어듭니다. 사용자가 오타를 내는 건 정상 동작이지 잘못된 요청이 아닙니다 — 남은 횟수를 보여 주고 다시 받으면 됩니다.

4xx 로 가는 것은 더 시도해도 소용없는 경우뿐입니다: 만료(verification_expired), 시도 소진(max_attempts_reached), 이미 통과(already_verified).

통과하면 나머지가 닫힙니다

재발송으로 같은 번호에 여러 건이 살아 있었다면, 하나가 통과하는 순간 나머지는 canceled 가 됩니다. 쓴 코드가 다시 통하면 안 되기 때문입니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

verificationIdstringRequired

Request

This endpoint expects an object.
codestringRequired

사용자가 입력한 코드. 공백과 하이픈은 떼고 비교하므로 482-913 도 통합니다.

Response

대조 결과. valid 로 성패를 봅니다 — false 여도 200 입니다.

verificationIdstringOptional
statusenumOptional
Allowed values:
validbooleanOptional
remainingAttemptsintegerOptional
verifiedAtdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error