연동 정보 설정 페이지
API 키
해당 프로젝트의 API 키를 확인하고 관리할 수 있습니다.
API 키 설정
x-api-key 헤더에 포함하여 전송해야 합니다.
API 키 활용API 키를 사용하여 제출건 조회, 승인/거절 처리, 토큰 관리 등 다양한 API 기능을 사용할 수 있습니다.
웹훅 설정
웹훅(Webhook) 기능은 고객사의 시스템과 실시간 데이터 연동을 지원하는 기능입니다. 특정 이벤트 발생 시 고객사에서 설정한 엔드포인트(Endpoint URL)로 HTTP POST 요청을 전송하여 별도의 API 호출 없이 실시간 알림을 수신하고 데이터를 처리할 수 있도록 지원합니다.
웹훅 설정
웹훅 URL 설정
고객사 시스템에서 웹훅 데이터를 수신할 엔드포인트 URL을 설정합니다. 웹훅 이벤트 발생 시 설정된 URL로 HTTP POST 요청이 전송됩니다.방화벽 설정 방법고객사의 방화벽 또는 보안 그룹 설정에서 다음 IP 주소를 허용 목록에 추가하세요:
- 웹훅 IP:
52.78.194.237
웹훅 IP 및 URL 관리해당 페이지에서만 각 프로젝트별로 고정된 웹훅 IP를 확인할 수 있으며, 웹훅 URL 변경 이력은 저장되지 않고 있으므로 해당 웹훅 URL 관리에 유념해주시기 바랍니다.
알림 사용자 관리
알림 사용자 관리를 통해 이름과 이메일을 추가하면, 다음날 아침에 어제 발송한 웹훅들에 대한 정보를 이메일로 받을 수 있습니다. 설정 방법:- 이름과 이메일 주소를 입력합니다.
- 추가 버튼을 클릭하여 알림 사용자를 등록합니다.
- 등록된 사용자는 매일 아침 전날 발송된 웹훅 정보를 이메일로 수신합니다.
일일 웹훅 리포트등록된 알림 사용자에게는 매일 아침 전날(00:00 ~ 23:59 UTC)에 발송된 모든 웹훅 이벤트에 대한 요약 정보가 이메일로 전송됩니다. 이를 통해 웹훅 전송 현황을 모니터링할 수 있습니다.
리턴 URL
사용자가 KYC를 완료하면 설정한 URL로 리디렉션됩니다.
리턴 URL 설정
리턴 URL 암호화
리턴 URL 암호화 기능을 활성화하면, 리턴 URL의 파라미터가 암호화되어 전달됩니다.
리턴 URL 암호화 설정
encrypted 파라미터에 암호화되어 포함됩니다.
암호화된 리턴 URL 예시:
리턴 URL 암호화 활용민감한 정보(이메일, 사용자 ID 등)를 포함한 리턴 URL을 사용하는 경우, 암호화 기능을 활성화하여 보안을 강화할 수 있습니다. 복호화 시 AES-256-ECB 방식을 사용합니다.
암호화 가이드
리턴 URL 암호화 데이터 복호화 방법을 확인하세요.
리턴 URL 활용KYC 완료 후 사용자를 고객사의 서비스 페이지로 자동 리디렉션하여, 승인/거절 상태에 따라 맞춤형 안내 페이지를 제공할 수 있습니다.
결과 페이지 스킵
KYC 결과를 사용자가 보는 것을 스킵하고 본인이 원하는 URL로 리디렉션할 수 있습니다. 결과 페이지 스킵 기능을 활성화하면, KYC 결과 페이지를 건너뛰고 바로 리턴 URL로 이동합니다. 활용 시나리오:- 고객사에서 자체 결과 페이지를 제공하고 싶을 때
- 결과에 대한 부분을 리턴 URL의 동적 필드 파라미터를 통해 유연하게 제공하고 싶을 때
결과 페이지 스킵과 동적 필드 조합결과 페이지 스킵 기능을 활성화하고 동적 필드에서
kycStatus, submissionId 등의 파라미터를 선택하면, 리턴 URL에 KYC 결과 정보가 포함되어 전달됩니다. 이를 통해 고객사에서 자체 결과 페이지를 구성할 수 있습니다.동적 필드
동적 필드의 field들을 클릭하여 원하는 field가 URL에 추가되도록 설정할 수 있습니다. 동적 필드를 통해 고객사가 리턴 URL에서 다음 정보를 받을 수 있습니다:| 필드 | 설명 |
|---|---|
| kycStatus | KYC 결과 상태 (approved, pending, rejected) |
| userid | 사용자 ID |
| 사용자 이메일 주소 | |
| submissionId | 제출 ID (Submission ID) |
| cf1, cf2, cf3 | 커스텀 필드 1, 2, 3 |
- 동적 필드 설정 화면에서 전달하고 싶은 필드를 클릭하여 선택합니다.
- 선택한 필드들은 리턴 URL의 쿼리 파라미터로 자동 추가됩니다.
동적 필드 활용동적 필드를 활용하면 리턴 URL에 KYC 결과 정보를 포함하여 전달할 수 있습니다. 이를 통해 고객사 시스템에서 별도의 API 호출 없이도 KYC 결과를 즉시 처리할 수 있습니다.
웹훅 이벤트 종류
웹훅을 통해 전송되는 주요 이벤트 종류는 다음과 같습니다:| 이벤트 | 설명 |
|---|---|
| approved | KYC 인증이 승인되었을 때 발생 |
| rejected | KYC 인증이 거절되었을 때 발생 |
| pending | 수동 검수가 필요한 상태로 변경되었을 때 발생 |
| retry | 재시도가 발생했을 때 발생 |
| updated | 제출건 정보가 업데이트되었을 때 발생 |
| delete | 제출건이 삭제되었을 때 발생 |
| submit | 새로운 제출이 완료되었을 때 발생 |
| token | 토큰 관련 이벤트 발생 시 |
| injection | 데이터 주입 시 발생 |
| aml | AML 검사 결과 발생 시 |
| aml-ongoing | AML 온고잉 모니터링 결과 발생 시 |
활용 사례
고객 온보딩 프로세스 자동화
고객 온보딩 프로세스 자동화
금융기관에서 신규 고객의 KYC 인증이 완료되면 웹훅을 통해 즉시 알림을 받아 계좌 개설, 카드 발급, 서비스 활성화 등의 후속 프로세스를 자동으로 진행할 수 있습니다. 리턴 URL과 동적 필드를 활용하여 승인/거절 상태에 따라 고객에게 맞춤형 안내 페이지를 제공할 수 있습니다.
운영팀 실시간 모니터링 및 대응
운영팀 실시간 모니터링 및 대응
KYC 제출이 거절되거나 특정 위험 요소가 감지되었을 때 웹훅을 통해 운영팀에게 즉시 알림을 전송하여 빠른 대응이 가능합니다. 알림 사용자 관리 기능을 통해 매일 아침 전날 웹훅 전송 현황을 확인할 수 있습니다.
자체 결과 페이지 제공
자체 결과 페이지 제공
결과 페이지 스킵 기능과 동적 필드를 활용하여 고객사에서 자체 결과 페이지를 구성할 수 있습니다. 리턴 URL에 KYC 결과 정보를 포함하여 전달하므로, 별도의 API 호출 없이도 즉시 결과를 처리할 수 있습니다.