본문으로 건너뛰기
ShieldID

SDKs

신원 확인 SDK, 그리고 SDK가 필요 없는 방법.

대부분의 통합에는 SDK가 전혀 필요하지 않습니다. 호스팅 페이지가 모든 일을 처리하니까요. 웹 위젯은 흐름을 자체 페이지 안에서 유지하고 싶을 때 사용합니다. 네이티브 모바일 SDK는 그다음 순서입니다.

SDK가 필요 없는 방법

호스팅 페이지는 어떤 플랫폼에서도 SDK가 필요 없습니다.

POST /v1/sessions는 verification_url을 반환합니다. 이메일, SMS, 앱 내 리디렉션, 화면의 QR 코드 등 제품에서 이미 링크를 보내는 방식 그대로 신청자에게 전달하면, ShieldID가 신청자의 휴대폰에서 촬영, 라이브니스 확인, 셀카 촬영을 처리합니다.

  • 웹 앱, 네이티브 앱의 시스템 브라우저 또는 WebView, 이메일 링크, 키오스크 QR 코드에서 작동하며 설치할 것이 없습니다
  • 적격 요금제에서는 화이트 라벨 브랜딩을 지원하므로 외부 서비스로 넘어간 느낌이 들지 않습니다
  • 결과는 return_url 리디렉션과 서명된 웹훅을 통해 전달되므로 클라이언트 측 콜백 연결이 필요 없습니다

웹 위젯

자체 페이지에 흐름을 삽입하세요.

신청자를 페이지 밖으로 보내는 대신, 페이지 안의 iframe 내부에 호스팅 검증 흐름을 렌더링하는 작은 스크립트입니다.

현재 사용 가능한 기능

  • TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme })는 세션을 만들고 선택한 요소에 마운트합니다
  • 호스팅 페이지와 동일한 촬영 흐름을 accentColor 및 로고와 함께 자체 레이아웃 안에서 실행합니다
  • 세션 생성과 흐름 인라인 표시는 현재 사용할 수 있습니다

완료 콜백

출시 예정

onComplete, onCancel, onStep, 그리고 iframe 자동 크기 조정은 위젯 인터페이스에 포함되어 있지만, 현재 플로우 안에서는 아직 어떤 것도 실행되지 않습니다. 이 기능들이 호출된다는 전제로 로직을 만들지 마시고, 현재 사용할 수 있는 반환 URL과 웹훅을 이용해 주세요.

브라우저에서의 API 키에 대한 참고 사항

위젯의 init() 호출은 클라이언트 측 JavaScript에서 원시 apiKey를 받도록 문서화되어 있습니다. 하지만 프로덕션 환경에서는 권장하지 않습니다. 소스 보기를 하는 누구에게나 키가 노출되기 때문입니다. 대신 백엔드에서 POST /v1/sessions로 세션을 생성하고, 그 결과로 받은 verification_url을 위젯에 전달해 렌더링하세요. 호스팅 플로우와 같은 권장 방식이며, 링크로 연결하는 대신 페이지에 임베드하는 것만 다릅니다.

html
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
  // Recommended: create the session on your backend first (see API reference),
  // then pass its verification_url straight through — never a raw API key.
  TLVerify.init({
    containerId: "shieldid-verify",
    verificationUrl: "{{ session.verification_url }}", // from your backend
    theme: { accentColor: "#0B5CD8" },
  });
</script>

모바일

네이티브 SDK가 곧 출시됩니다.

현재는 iOS나 Android용 SDK가 없습니다. SDK가 나올 때까지는 앱의 시스템 브라우저나 WebView에서 호스팅 인증 페이지를 열어 주세요. 웹 신청자가 거치는 것과 같은 플로우이며, 앱이 실행되는 모든 플랫폼에서 지금 바로 사용할 수 있습니다.

출시 예정네이티브 iOS 및 Android SDK

방식 선택하기

세 가지 연동 방식을 솔직하게 비교합니다.

임베드해야 할 특별한 이유가 없다면 호스팅 페이지부터 시작하세요.

각 연동 방식으로 현재 사용할 수 있는 기능입니다.
기능호스팅 페이지웹 위젯모바일 SDK
SDK도, 클라이언트 측 코드도 필요 없음예아니요출시 예정
내 페이지 안에 유지됨링크로 열림임베디드 iframe출시 예정
코드에서 완료 콜백 사용반환 URL + 웹훅출시 예정출시 예정
내 브랜딩 적용해당 요금제에서 제공해당 요금제에서 제공출시 예정
현재 사용 가능예예아니요

문의

SDK 및 위젯 FAQ.

개발 시작하기

호스팅 페이지가 가장 빠른 방법입니다.

API 호출 한 번, 링크 하나면 되고 SDK는 필요 없습니다. 지금 sandbox 키로 사용해 보세요.