API 요청
POST
/rest/identi_card_image/5요청 파라미터 2개 · 필수 1
파라미터
설명
image외국인등록증 앞면 이미지(JPG·PNG 등) 또는 PDF 파일 하나입니다. 50MB 이하이며, PDF는 첫 페이지만 확인합니다.
card_sn신분증 뒷면의 일련번호 11자리입니다. 2011-01-01 이후 발급된 문서는 필수이며, 값이 없으면 진위 확인이 실패할 수 있습니다.
- 예시
12345678901
응답 필드 19개
응답 필드
설명
data요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.ic_id이번 조회에 부여된 식별자입니다. 같은 요청의 결과를 추적하거나 문의할 때 사용하며, 값이 없으면 null입니다.
data.type신분증 종류입니다. 이 API는 항상 5(외국인등록증)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.result조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.msg처리 결과를 사람이 읽을 수 있는 문장으로 설명합니다. 성공·실패 사유가 담기며, 오류 코드는 별도 필드에서 확인합니다.
data.parsedOCR로 읽은 문서의 항목별 값 묶음입니다. 문서 종류에 따라 들어오는 키가 달라지며, 읽지 못한 항목은 빈 문자열이거나 생략됩니다. null 허용.
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이거나 필드가 생략됩니다.
하위 필드 6개 더 보기
응답 필드
설명
data.parsed.name읽은 성명입니다. 판정에는 쓰이지 않습니다. 대상의 표시 이름입니다. 같은 API에서도 사람·상품·채널 이름을 뜻할 수 있습니다.
data.parsed.rrn1주민등록번호 앞 6자리(생년월일)입니다. OCR이 읽은 값을 그대로 반환하며, 문서가 훼손되면 일부가 비어 있을 수 있습니다.
data.parsed.rrn2주민등록번호 뒤 7자리입니다. 성별·지역 코드가 포함되며, 마스킹된 문서에서는 일부가 가려져 있을 수 있습니다.
data.parsed.rrn읽은 외국인등록번호 13자리입니다. 판정에 이 값을 씁니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.parsed.made_date읽은 발급일자입니다. 10자리(YYYY-MM-DD)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.parsed.card_sn요청에 보낸 뒷면 일련번호입니다. 보내지 않았다면 빈 문자열입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
