본문으로 건너뛰기
ShieldID

개발자

실제로 쓰기 좋게 만든 신원 인증 API 문서입니다.

하나의 REST API, 직접 만들고 싶지 않은 부분을 위한 호스팅 페이지, 결과가 나오는 즉시 알 수 있는 서명된 웹훅을 제공합니다. Sandbox 키는 절대 과금되지 않으므로, ShieldID를 가장 빠르게 이해하는 방법은 직접 호출해 보는 것입니다.

sandbox에서 무료로 시작하기퀵스타트 읽기

5분 요약

호출 네 번, 하나의 개념 모델.

이 문서의 나머지 내용은 모두 이 흐름에 대한 세부 설명입니다.

  1. 세션 만들기

    반환 URL과 웹훅 URL을 담아 POST /v1/sessions를 호출하세요. 응답으로 session_id와 verification_url을 받습니다.

  2. 신청자에게 전달하기

    verification_url을 링크로 보내거나, 데스크톱에서 호스팅 페이지에 표시되는 QR 코드를 스캔하도록 안내하세요. 신청자는 자신의 휴대폰에서 인증을 마칩니다.

  3. 서명된 웹훅 수신하기

    세션이 VERIFIED 또는 FAILED 상태가 되면 ShieldID가 결과를 웹훅 URL로 POST합니다. 우리가 보낸 것임을 신뢰할 수 있도록 서명되어 있습니다.

  4. 결과 확인하기

    웹훅을 신뢰하거나 GET /v1/sessions/{id}/result를 직접 호출하세요. 어느 쪽이든 불투명한 단일 점수가 아니라 검사 항목별 판정을 받게 됩니다.

직접 체험해 보기

첫 번째 세션 만들기.

세 가지 언어로 작성한 동일한 요청입니다. 이는 개념 모델의 1단계에서 설명하는 호출입니다.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox 키(vk_sand_…)로 이 플로우를 그대로 무료로 실행할 수 있습니다. vk_live_ 키로 바꾸면 청구서 외에는 달라지는 것이 없습니다.

원하는 곳 찾기

나머지 개발자 문서입니다.

여섯 페이지입니다. 필요한 페이지만 읽으세요.

API 레퍼런스

모든 엔드포인트, 모든 필드, 대비할 수 있는 모든 오류를 다룹니다.
열기 API 레퍼런스

퀵스타트

Sandbox 키 발급부터 첫 서명된 웹훅까지 순서대로 안내합니다.
열기 퀵스타트

SDKs

웹 위젯, 호스팅 플로우, 그리고 앞으로 제공될 기능을 다룹니다.
열기 SDKs

Sandbox

테스트 모드의 작동 방식과 키를 받는 방법입니다.
열기 Sandbox

상태

피드가 시작되면 알려드릴 항목입니다.
열기 상태

Sandbox

서명하기 전에 전체 흐름을 먼저 테스트해 보세요.

sandbox 키(접두사 vk_sand_)는 프로덕션과 동일한 API, 호스팅 페이지, 웹훅 흐름을 실행합니다. 세션은 표시되는 모든 곳에 environment: "sandbox"로 기록되며, sandbox 세션은 어떤 요금제에서도 청구되지 않습니다.

sandbox 가이드 읽기
  • 실제 세션을 만들고, 본인 휴대폰으로 실제 신분증을 인증하고, 서명된 실제 웹훅을 받아 보세요
  • sandbox에서 하는 어떤 작업도 청구서에 반영되지 않습니다
  • 키 접두사만 바꾸면 프로덕션으로 전환됩니다. 요청 형식은 달라지지 않습니다

투명하게 만들어 갑니다

완료된 것과 아직 완료되지 않은 것입니다.

연동 도중에 직접 알게 되시는 것보다, 저희가 먼저 말씀드리는 편이 낫다고 생각합니다.

웹 위젯 완료 콜백

출시 예정

onComplete, onCancel, onStep은 현재 위젯 인터페이스에 존재하지만 아직 아무것도 이를 호출하지 않습니다. 반환 URL과 웹훅을 사용해 주세요. 두 가지 모두 지금 정상 작동합니다.

속도 제한 적용

출시 예정

모든 API 키에는 요금제에 따른 속도 제한이 기록되어 있지만, 아직 요청에 적용되지는 않습니다. 이를 감안해 계획해 주시고, ShieldID가 요청을 제한해 줄 것이라고 기대하지 마세요.

셀프 서비스 sandbox 가입

출시 예정

셀프 서비스 가입을 준비하는 동안에는 요청하시면 sandbox 키를 발급해 드립니다. 요청해 주시면 빠르게 처리해 드리겠습니다.

문의

개발자를 위한 명확한 답변.

시작하기

오후 한나절이면 라이브로 전환할 수 있습니다.

sandbox 키로 시작해서 본인 휴대폰으로 인증을 실행하고, 전송되는 웹훅을 확인해 보세요. 영업 상담은 필요하지 않습니다.

sandbox에서 무료로 시작하기퀵스타트 읽기

Sandbox 세션에는 요금이 청구되지 않습니다.