본문 바로가기
개발가이드등기부등본eKYC 본인확인

eKYC 본인확인 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

사진이 있는 신분증(주민등록증·운전면허증·여권·외국인등록증) 사진과, 고개를 좌우로 돌린 짧은 촬영 영상(또는 얼굴 사진)을 함께 받아 ① 신분증 사진이 실물 카메라 촬영본인지(화면 캡처·편집 여부) ② 지금 실제 사람이 움직였는지(라이브니스) ③ 신분증 얼굴과 촬영한 얼굴이 같은 사람인지 한 번에 판정합니다. 등본·주민등록등초본처럼 사진이 없는 서류는 대상이 아닙니다.

POSThttps://apick.app/rest/kyc_session전체 2개 경로
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
2개

왜 eKYC 본인확인인가

신분증과 얼굴 촬영으로 같은 사람인지 확인합니다

신분증 사진만 받으면 남의 신분증을 올리는 것을 막을 수 없습니다. 신분증과 짧은 얼굴 영상을 함께 보내면 실제 촬영인지, 지시한 대로 움직였는지, 신분증 속 얼굴과 같은 사람인지까지 판정해 돌려줍니다.

도입 효과

  • 정지 사진·재생 영상은 판정 전에 거절
  • 지시 동작 수행 여부를 영상으로 확인
  • 신분증 얼굴과 같은 사람인지 점수로 판정

이런 곳에서 많이 씁니다

  • 비대면 계좌 개설·대출 신청 본인확인
  • 중고거래 고액 거래 상대 확인
  • 임대차·근로 계약 전 본인확인
가입하고 API 키 받기API 키 하나로 바로 호출 · 실패한 요청은 과금되지 않습니다

알아둘 점

업로드 용량 제한: 60MB
한 요청에서 신분증 사진은 최대 20MB(PNG·JPEG), 얼굴 영상은 최대 30MB(MP4·MOV·WebM·3GP, 1~60초), 얼굴 사진은 최대 10MB입니다. 촬영 세션 서명이 함께 와야 하며 파일은 판정 직후 삭제됩니다.
제한을 초과하면 HTTP 413과 REQUEST_TOO_LARGE 오류가 반환되며 과금되지 않습니다.

한눈에 보는 흐름

  1. 촬영 시작 전 POST /rest/kyc_session 으로 1회용 촬영 세션을 받습니다. 서버가 좌우 방향(왼쪽→오른쪽 또는 오른쪽→왼쪽)을 정해 줍니다.
  2. 촬영이 끝나면 화면에서 확인한 프레임 지문을 POST /rest/kyc_seal 로 보내 서버 서명(kyc1.…)을 받습니다.
  3. 신분증 사진과 촬영 결과를 POST /rest/kyc_verify 로 보냅니다. 서명이 유효하고 세션이 처음 쓰일 때만 판정합니다.
  4. 응답의 data.result가 1(통과)·0(실패)·2(담당자 확인)입니다. 항목별 근거 수치는 data.document·data.liveness·data.face에 담깁니다.

웹 촬영 화면은 이 사이트의 /js/apick-kyc-sdk.js 를 쓰면 됩니다. 아래 웹 SDK 절을 보세요.

이용 전 확인

신분증은 PNG·JPEG 사진(최대 20MB) 만 받습니다. 사진이 있는 신분증(주민등록증·운전면허증·여권·외국인등록증)을 카메라로 찍은 사진을 보내세요.

얼굴은 ASMR 영상(MP4·MOV·WebM·3GP, 1~60초, 최대 30MB) 또는 얼굴 사진(JPEG·PNG, 최대 10MB) 을 받습니다. 영상이 있으면 움직임을 실제로 분석하고, 사진만 있으면 얼굴 대조만 합니다(liveness 판정이 담당자 확인으로 내려갑니다).

촬영 세션이 없거나, 서명이 맞지 않거나, 이미 쓴 세션이면 차감 없이 거절합니다. 시간 초과·처리 실패도 과금하지 않습니다.

판정까지 진행된 요청은 결과(통과·불통과·담당자 확인)와 관계없이 건당 과금됩니다. 정지 사진처럼 확정 판정이 어려운 경우도 위조·대조 분석을 끝냈으므로 정상 응답으로 보고 요금을 받습니다.

보낸 사진·영상은 판정이 끝나면 바로 삭제하며 저장하지 않습니다. 응답에도 이미지·얼굴 특징값을 담지 않고 판정 수치만 줍니다.

건당 200P 입니다.

꼼수·미리 찍은 사진을 막는 장치

우회 시도
막는 방법
미리 찍어 둔 영상·사진을 그대로 보냄
1회용 촬영 세션 + 서버 서명(kyc_seal)이 없으면 거절합니다. 세션은 처음 쓴 순간 소비되어 다시 쓸 수 없습니다.
정지 사진을 카메라 앞에 대고 촬영
영상 프레임의 연속 움직임·장면 전환과 좌우 무게중심 이동을 함께 봅니다. 움직임이 없으면 실패합니다.
녹화 영상을 재생해 카메라 앞에 비춤
SDK 는 좌우 챌린지 방향을 화면에 지시하고, 촬영 중 화면 전환·탭 이탈을 감지하면 촬영을 무효화합니다. 화면 공유(getDisplayMedia)로는 카메라를 열 수 없게 막습니다.
화면 캡처로 만든 신분증 사진
촬영 메타데이터(카메라 기기·촬영 시각)와 화면 캡처 표시·편집 프로그램 표시를 확인합니다. 화면 캡처로 판단되면 실패합니다.
다른 계정·다른 사람이 촬영분을 옮겨 씀
세션 서명은 계정 단위로 묶여 있어 다른 계정에서는 서명 검증이 실패합니다.

서버 판정이 최종입니다. SDK 의 사전 이동 확인은 통과 확률을 높이는 보조 장치일 뿐, 서버가 다시 움직임·얼굴 일치를 확인합니다.

판정 읽는 법

data.result
뜻
권장 처리
1
세 항목(신분증 실물성·라이브니스·얼굴 대조)이 모두 기준을 넘었습니다.
자동 통과
2
자동으로 확정하기 어려운 항목이 있습니다(신분증 메타데이터 없음, 점수 경계, 영상 움직임 자료 없음 등).
담당자 확인 또는 재촬영 요청
0
위조·화면 캡처·움직임 없음·얼굴 불일치 중 하나 이상이 확인됐습니다.
거절

data.reason은 실패·확인 사유 코드(SCREEN_CAPTURE, LIVENESS_MOTION, LIVENESS_PAN, LOW_SIMILARITY 등)이고, data.message는 사용자에게 보여 줄 문구입니다.

웹 SDK

브라우저에서 신분증 촬영 + 얼굴 촬영 + 서명 + 판정을 한 화면에서 진행합니다. 스크립트는 /js/apick-kyc-sdk.js 입니다.

모드
document
설명
모드 A
"camera"
신분증 사진도 카메라로 촬영하고, 이어서 얼굴 촬영을 진행합니다.
모드 B
"upload"
신분증은 파일로 올리고 얼굴만 촬영합니다.
사용 예시
<script src="https://apick.app/js/apick-kyc-sdk.js"></script>
<div id="kyc"></div>
<script>
const kyc = new ApickKyc({ apiKey: "내 API 인증키" });
kyc.start(document.getElementById("kyc"), { document: "camera" }, (event) => {
  if (event.type === "done") {
    // event.detail.result.result === 1 이면 통과
    console.log(event.detail.result);
  }
  if (event.type === "error") console.log("실패:", event.detail.message);
}).catch(() => {});
</script>

보안 장치(1회용 세션·좌우 챌린지·탭 이탈 감지·화면 공유 차단·좌우 이동 확인)는 SDK 가 자동으로 켭니다. 꺼 두면 서버 판정에서 라이브니스가 실패할 수 있습니다. 카메라는 https 에서만 열립니다.

요청과 응답

1API 요청
POST/rest/kyc_session
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 21개 · 필수 5
파라미터
설명
challengestring선택
좌우 방향을 직접 지정합니다. turn_left_right·turn_right_left. 생략하면 서버가 무작위로 정합니다.
data[result][session_id]string선택
1회용 세션 식별자(32자)입니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
data[result][challenge]string선택
좌우 지시 방향입니다. SDK 가 이 방향으로 고개를 돌리게 안내합니다.
data[result][nonce]string선택
서명에 묶이는 1회용 값입니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
data[result][expires_at]integer선택
세션 만료 시각(밀리초)입니다. 기본 15분입니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
session_idstring필수
kyc_session 이 준 세션 식별자입니다. 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
예시
입력값
noncestring필수
kyc_session 이 준 nonce 값입니다. 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
예시
입력값
frames[0]string필수
촬영 중 확인한 프레임 지문입니다. 6~128자 hex, 1~60개입니다.
예시
입력값
sessionstring필수
촬영 세션 서명(/rest/kyc_session 발급 → /rest/kyc_seal 서명)
예시
입력값
document_imagefile필수
사진이 있는 신분증 사진(PNG·JPEG, 최대 20MB)입니다. multipart/form-data로 전송하며, 파일 경로가 아니라 파일 본문을 첨부합니다.
face_videofile선택
고개를 좌우로 돌린 촬영 영상(MP4·MOV·WebM·3GP, 1~60초, 최대 30MB)입니다. face_image 와 둘 중 하나는 필수입니다.
face_imagefile선택
촬영 영상 대신 보내는 정지 얼굴 사진(JPEG·PNG, 최대 10MB)입니다. 라이브니스는 담당자 확인으로 내려갑니다.
thresholdnumber선택
얼굴 일치 기준 점수 (범위: 0.2 ~ 0.8, 기본값 0.4) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
data[result]integer선택
1 통과, 0 실패, 2 담당자 확인입니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
data[verified]boolean선택
result == 1 과 같습니다. true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data[reason]string선택
사유 코드입니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
data[message]string선택
사용자에게 보여 줄 문구입니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
data[document]object선택
신분증 실물성 — verdict·reason·camera_capture·edited·screen_capture·capture_age_days.
data[liveness]object선택
라이브니스 — verdict·duration_seconds·motion(움직이는 프레임 비율)·pan_shift(좌우 이동)·failed·manual.
data[face]object선택
얼굴 대조 — verdict·similarity(가장 높은 점수)·similarity_avg·matched_frames·frames·threshold.
data[similarity]number선택
가장 높은 얼굴 유사도(MCP 연동 편의 필드)입니다. 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
응답 필드 35개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.verifiedboolean
'verified' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.resultinteger
조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.reasonstring
'reason' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.messagestring
안내 문구입니다. 오류 원인과 다음 행동을 설명합니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.session_idstring
'session_id' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.documentobject
'document' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.livenessobject
'liveness' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.faceobject
'face' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.elapsed_msinteger
'elapsed_ms' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.similaritynumber
'similarity' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.successinteger
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_idinteger
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
하위 필드 18개 더 보기
응답 필드
설명
data.document.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.document.reasonstring
'reason' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.document.camera_captureboolean
'camera_capture' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.editedboolean
'edited' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.screen_captureboolean
'screen_capture' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.capture_age_daysnumber
'capture_age_days' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.liveness.duration_secondsnumber
'duration_seconds' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.motionnumber
'motion' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.pan_shiftnumber
'pan_shift' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.failedarray
'failed' 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다.
data.liveness.manualarray
'manual' 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다.
data.face.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.face.similaritynumber
'similarity' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.similarity_avgnumber
'similarity_avg' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.matched_framesinteger
'matched_frames' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.framesinteger
'frames' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.thresholdnumber
'threshold' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
2API 요청
POST/rest/kyc_verify
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 5개 · 필수 2
파라미터
설명
sessionstring필수
촬영 세션 서명(/rest/kyc_session 발급 → /rest/kyc_seal 서명)
예시
입력값
document_imagefile필수
사진이 있는 신분증 사진(PNG·JPEG, 최대 20MB)입니다. multipart/form-data로 전송하며, 파일 경로가 아니라 파일 본문을 첨부합니다.
face_videofile선택
고개를 좌우로 돌린 촬영 영상(MP4·MOV·WebM·3GP, 1~60초, 최대 30MB)입니다. face_image 와 둘 중 하나는 필수입니다.
face_imagefile선택
촬영 영상 대신 보내는 정지 얼굴 사진(JPEG·PNG, 최대 10MB)입니다. 라이브니스는 담당자 확인으로 내려갑니다.
thresholdnumber선택
얼굴 일치 기준 점수 (범위: 0.2 ~ 0.8, 기본값 0.4) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
응답 필드 35개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.verifiedboolean
'verified' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.resultinteger
조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.reasonstring
'reason' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.messagestring
안내 문구입니다. 오류 원인과 다음 행동을 설명합니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.session_idstring
'session_id' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.documentobject
'document' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.livenessobject
'liveness' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.faceobject
'face' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.elapsed_msinteger
'elapsed_ms' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.similaritynumber
'similarity' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.successinteger
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_idinteger
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
하위 필드 18개 더 보기
응답 필드
설명
data.document.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.document.reasonstring
'reason' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.document.camera_captureboolean
'camera_capture' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.editedboolean
'edited' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.screen_captureboolean
'screen_capture' 여부를 true/false로 나타냅니다. 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.document.capture_age_daysnumber
'capture_age_days' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.liveness.duration_secondsnumber
'duration_seconds' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.motionnumber
'motion' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.pan_shiftnumber
'pan_shift' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.liveness.failedarray
'failed' 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다.
data.liveness.manualarray
'manual' 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다.
data.face.verdictstring
'verdict' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.face.similaritynumber
'similarity' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.similarity_avgnumber
'similarity_avg' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.matched_framesinteger
'matched_frames' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.framesinteger
'frames' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.face.thresholdnumber
'threshold' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
입력 조건·전송 규칙

요청 — 촬영 세션

항목
설정
메서드·주소
POST https://apick.app/rest/kyc_session
인증 헤더
Authorization: Bearer 내 계정의 API 인증키
본문 형식
multipart/form-data 또는 빈 본문
응답
요청 예시

요청 — 촬영 결과 서명

SDK 가 화면에서 확인한 프레임 지문(프레임마다 40자 SHA-256 지문, 최대 60개)을 보냅니다. 서버가 세션과 묶어 서명합니다.

응답의 data.result.session(kyc1.…)을 판정 요청의 session 에 그대로 넣습니다.

요청 — 본인 확인 판정

항목
설정
메서드·주소
POST https://apick.app/rest/kyc_verify
인증 헤더
Authorization: Bearer 내 계정의 API 인증키
본문 형식
multipart/form-data. 서버간 연동은 같은 이름의 data: URI 문자열을 JSON 으로 보내도 됩니다.
응답
응답 예시
{
    "data": {
        "verified": true,
        "result": 1,
        "reason": "MATCH",
        "message": "본인 확인에 성공했습니다.",
        "session_id": "9f2c1b7e0a5d4c3b8e1f6a2d7c0b4e5a",
        "document": { "verdict": "pass", "reason": "CAMERA_CAPTURE", "camera_capture": true, "edited": false, "screen_capture": false, "capture_age_days": 0.1 },
        "liveness": { "verdict": "pass", "duration_seconds": 4.2, "motion": 0.82, "pan_shift": 1.9, "failed": [], "manual": [] },
        "face": { "verdict": "pass", "similarity": 0.612, "similarity_avg": 0.55, "matched_frames": 4, "frames": 5, "threshold": 0.4 },
        "elapsed_ms": 6210,
        "similarity": 0.612,
        "success": 1
    },
    "api": { "success": true, "cost": 200, "ms": 6240, "pl_id": 108712 }
}

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
서비스 코드·조건

오류와 대처

실패하면 data.error에 문구가 담기고 api.cost는 0입니다.

HTTP
data.error
대처
400
촬영 세션(session)이 없습니다. …
먼저 kyc_session 과 kyc_seal 을 호출하세요.
400
신분증 사진(document_image)이 없습니다.
document_image 를 보내세요.
400
얼굴 사진 또는 촬영 영상(face_image, face_video)이 없습니다.
face_video 또는 face_image 중 하나를 보내세요.
413
얼굴 영상은 30MB, 얼굴 사진은 10MB 이하여야 합니다.
촬영 길이·해상도를 줄이세요(SDK 기본값으로 촬영하면 넘지 않습니다).
422
촬영 영상에서 실제 사람의 움직임을 확인하지 못했습니다. …
안내에 따라 고개를 좌우로 크게 돌려 다시 촬영하세요.
422
화면 캡처로 만든 신분증 사진은 사용할 수 없습니다. …
실물 신분증을 카메라로 촬영하세요.
422
이미 사용했거나 만료된 촬영 세션입니다. …
촬영 세션은 1회만 쓸 수 있습니다. 새 세션을 받으세요.
422
신분증 사진과 촬영한 얼굴이 일치하지 않습니다.
다른 사람의 신분증인지 확인하고 다시 촬영하세요.
424
본인 확인 서비스를 사용할 수 없습니다. … / 영상 처리 시간이 길어 …
잠시 뒤 한 번 더 요청하세요(과금 없음).
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 200P · 건당(판정이 진행된 요청만)

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.
추가 예제·서비스별 연동 안내

호출 예시

키는 환경변수 APICK_API_KEY 에서 읽습니다.

JavaScript (Node.js 18 이상)
Python (requests)

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.