🇺🇸 English

<aside>

</aside>

Intro : 소개

TomoIDV는 방한 외국인의 자국 발행 신분증 기반 eKYC flow를 제공하는 API Service 입니다.

이 문서는 TomoIDV API를 사용하기 위한 OAuth2 인증, KYC 정책 선택, KYC 시작, KYC flow, 결과 조회까지 하나의 온보딩 흐름으로 정의합니다.

sequenceDiagram
	participant ClientApp as Client App
	participant ClientServer as Client Server
	participant IDVServer as TomoIDV Server
	participant IDVApp as TomoIDV App

	ClientServer->>+IDVServer: [1] Get Access Token (POST /v1/oauth2/token)
	IDVServer-->>-ClientServer: 200 OK
	ClientApp->>+ClientServer: Start IDV
	ClientServer->>+IDVServer: [2] Start IDV(Get IDV URL) (POST /v1/idv/start)
	IDVServer-->>-ClientServer: 200 OK
	ClientServer-->>-ClientApp: 200 OK
	ClientApp->>IDVApp: [3] Launch IDV App
	IDVApp-->>ClientApp: [4] Return to Origin App
	ClientServer->>+IDVServer: [5] Get Kyc (POST /v1/idv/result)
	IDVServer->>-ClientServer: 200 OK

Requirement

• TLS 1.3 (TLS 1.1, TLS 1.2는 지원하지않습니다.)

API 사용 준비

1. Client id, Secret key 발급

API를 사용하기 위해서는 client id, secret key를 발급 받아야합니다. 이는 OAuth2.0 인증에 사용되며, Console 에서 발급합니다. 발급과정은 아래 Register client 문서를 참고해주시기 바랍니다. client id와 secret key를 발급 받으면, Access token을 발급 받을 수 있습니다. 이 Access Token을 이용하여 TomoIDV API를 사용하실 수 있습니다.

Register client 문서

2. API Base Url

TomoIDV는 Sandbox, Production 두 가지 Domain(Base url)을 사용하고 있습니다. Sandbox Console 에서 만들어진 client id는 Sandbox Base URL, Production Console 에서 만들어진 client id는 Production Base URL을 사용 할 수 있습니다.

3. 공통 요청 Header

모든 API 요청에 다음 헤더를 포함합니다.