개발가이드

  • 개발가이드

외국인등록증 개인정보 마스킹

외국인등록증의 지정 정보를 추출하고 등록번호 뒷자리 6자리를 마스킹합니다.

정보

Method
URL
POST
https://apick.app/rest/identity_document_residence_card

요청

Header
이름
필수
설명
CL_AUTH_KEY
O
인증키(MD5)
FormData
이름
타입
필수
설명
image
File
O
20MB 이하 PNG 또는 JPEG 외국인등록증 이미지

응답

필수 정보 또는 마스킹 위치를 확정하지 못하면 무과금 실패하며 이미지와 부분 추출값을 반환하지 않습니다.

Body
이름
타입
설명
data.result.document_type
String
residence_card
data.result.fields.registration_number_front
String
외국인등록번호 앞 6자리
data.result.fields.registration_number_back_first
String
외국인등록번호 뒷자리 첫 숫자
data.result.fields.country_region
String
국가/지역
data.result.fields.residence_status
String
체류자격
data.result.masked_image
String
등록번호 뒷자리 6자리를 가린 PNG의 Base64 데이터
data.result.image_mime
String
image/png
data.result.elapsed_ms
Integer
OCR·추출·마스킹 처리 시간(ms)
data.success
Integer
과금 여부(0: 실패, 1: 성공)
api
Object
API 호출 공통 데이터

예시

요청 예시

curl -k -X POST "https://apick.app/rest/identity_document_residence_card" \
-H "CL_AUTH_KEY: $API_KEY" \
-F "image=@/C:/Users/user/Desktop/residence_card.jpg"
마스킹 이미지 저장 예시(Node.js)

const response = await fetch(url, options);
const body = await response.json();
require("fs").writeFileSync("masked.png", Buffer.from(body.data.result.masked_image, "base64"));
현재 페이지 북마크