Skip to navigation

인증 취소

View as Markdown

진행 중인 인증을 취소합니다. 204 가 아니라 200 과 함께 리소스를 돌려줍니다 — 취소 시각이 필요하기 때문입니다. 이미 끝난 건은 422 already_settled 입니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

verificationIdstringRequired

Response

취소됨 — status 가 canceled 로 바뀝니다

verificationIdstringOptional
statusenumOptional
  • pending — 코드를 기다리는 중
  • verified — 통과. 1회용입니다 — 같은 건을 두 번 소비할 수 없습니다
  • expired — ttlSeconds 가 지남
  • max_attempts — 대조 5회를 모두 사용
  • canceled — 취소했거나, 같은 번호의 다른 건이 먼저 통과함
  • failed — 전달 자체가 실패(문자 발송 실패, 통화 미응답·실패)
channelenumOptional
Allowed values:
tostringOptional
fromstringOptional

발신에 쓴 계정 보유 번호.

codeLengthintegerOptional
remainingAttemptsintegerOptional

남은 대조 횟수. 건당 5회에서 시작합니다.

expiresAtdatetimeOptional
createdAtdatetimeOptional
verifiedAtdatetime or nullOptional
instructionobject or nullOptional

사용자에게 그대로 보여 줘야 하는 것. 발신형(sms·call)은 우리가 사용자에게 코드를 전달하므로 null 입니다. 수신형(sms_inbound)은 pending 인 동안만 채워집니다 — sendTo 로 body 를 보내라고 화면에 띄우면 됩니다. 건이 끝나면 null 이 됩니다.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error