API 요청
POST
/rest/identi_card/4요청 파라미터 5개 · 필수 5
파라미터
설명
doc_num1문서확인번호 1구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
- 예시
1234
doc_num2문서확인번호 2구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
- 예시
5678
doc_num3문서확인번호 3구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
- 예시
9012
doc_num4문서확인번호 4구획 (4~5자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
- 예시
3456
type발급 경로 구분 (1: 인터넷으로 발급한 등본, 2: 그 밖의 경로로 발급한 등본)
- 예시
1
응답 필드 12개
응답 필드
설명
data요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.ic_id이번 조회에 부여된 식별자입니다. 같은 요청의 결과를 추적하거나 문의할 때 사용하며, 값이 없으면 null입니다.
data.type신분증·문서 종류입니다. 이 API는 항상 4이며, 요청의 발급 경로 구분(type)과는 다른 값입니다.1: 주민등록증2: 운전면허증3: 여권4: 주민등록등본5: 외국인등록증
data.result조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.msg처리 결과를 사람이 읽을 수 있는 문장으로 설명합니다. 성공·실패 사유가 담기며, 오류 코드는 별도 필드에서 확인합니다.
data.success업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
data.error오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
apiAPI 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successAPI 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.cost이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.ms서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_id포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
