주민등록등본 텍스트 추출(OCR) API 개발가이드

알아둘 점

업로드 용량 제한: 50MB
첨부 이미지 합계는 최대 50MB입니다. 서버가 판독 가능한 크기로 최적화하며, 지나치게 큰 해상도는 정확도를 높이지 않고 처리시간만 늘릴 수 있습니다.
제한을 초과하면 HTTP 413과 REQUEST_TOO_LARGE 오류가 반환되며 과금되지 않습니다.

이용 전 확인

주민등록등본 사진에서 신청인 이름과 문서확인번호를 뽑아 줍니다. 제출받은 등본의 문서확인번호를 기록하거나 진위 확인 절차에 넘길 때 씁니다.

이미지를 판독한 호출 한 건당 12P가 차감됩니다. 파일이 없거나 이미지가 아니거나 판독에 실패하면 data.error로 응답하며 과금되지 않습니다.

항목을 찾지 못하면 그 값은 null입니다. 판독이 끝난 호출은 일부 항목이 null이어도 과금되므로, 사용자에게 주민등록등본 전체가 반듯하고 선명하게 나오도록 촬영을 안내하세요. 결과는 사용자가 확인·수정할 수 있게 보여 주는 것을 권장합니다.

요청과 응답

API 요청

POST/rest/ocr_identi4

Bearer 인증
multipart/form-data
JSON 응답

요청 예제

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi4' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./resident_register.jpg'

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi4' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --connect-timeout 10 --max-time 120 \
  --form 'image=@./resident_register.jpg'

POSIX 셸 · APICK_API_KEY 환경변수를 먼저 설정하세요. Windows에서는 Unicode 지원 cURL을 사용하세요.

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./resident_register.jpg")]), "resident_register.jpg");
const response = await fetch("https://apick.app/rest/ocr_identi4", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./resident_register.jpg")]), "resident_register.jpg");
const response = await fetch("https://apick.app/rest/ocr_identi4", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
if (result.error || result.data?.error || result.result?.error || result.success === false || result.api?.success === false) {
  throw new Error(JSON.stringify(result));
}
console.log(result);

Node.js 22+ · 서버에서 실행하는 ESM 예제입니다. 키를 브라우저에 넣지 마세요.

import os
import requests
parts = [
    ("image", ("resident_register.jpg", open("./resident_register.jpg", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi4",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

import os
import requests
parts = [
    ("image", ("resident_register.jpg", open("./resident_register.jpg", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi4",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
if result.get("error") or (isinstance(result.get("data"), dict) and result["data"].get("error")) or (isinstance(result.get("result"), dict) and result["result"].get("error")) or result.get("success") is False or (result.get("api") or {}).get("success") is False:
    raise RuntimeError(result)
print(result)

Python 3 · requests 설치가 필요합니다. 키는 서버 환경변수로 읽습니다.

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./resident_register.jpg'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi4');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./resident_register.jpg'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi4');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
if (!empty($result["error"]) || !empty($result["data"]["error"]) || !empty($result["result"]["error"]) || ($result["success"] ?? true) === false || ($result["api"]["success"] ?? true) === false) {
    throw new RuntimeException($body);
}
print_r($result);

PHP 8 · cURL 확장이 필요합니다. 키는 서버 환경변수로 읽습니다.

응답 예시200

{
  "data": {
    "result": {
      "name": "홍길동",
      "doc_num1": "1234",
      "doc_num2": "5678",
      "doc_num3": "9012",
      "doc_num4": "3456",
      "type": 1
    },
    "raw_text": "주민등록표\n(등본)\n…\n문서확인번호 : 1234-5678-9012-3456\n신청인 : 홍길동\n…",
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 12,
    "ms": 591,
    "pl_id": 335
  }
}

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

요청 파라미터 1개 · 필수 1

파라미터

설명

imagefile필수

분석할 이미지 파일입니다. JPG·PNG·WEBP를 지원하며, 파일 크기·해상도 제한은 요청 표를 확인하세요.

응답 필드 15개

응답 필드

설명

dataobject

요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.

data.resultobject

조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.

data.raw_textstring

이미지에서 읽은 전체 텍스트입니다. 항목이 null일 때 직접 확인하는 용도로 씁니다.

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이거나 필드가 생략됩니다.

하위 필드 6개 더 보기

응답 필드

설명

data.result.namestring

신청인 이름입니다. 찾지 못하면 null입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. null 허용.

data.result.doc_num1string

문서확인번호 첫째 묶음입니다. 예: 1234-5678-9012-3456이면 1234.

data.result.doc_num2string

문서확인번호 둘째 묶음입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.result.doc_num3string

문서확인번호 셋째 묶음입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.result.doc_num4string

문서확인번호 넷째 묶음입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

data.result.typeinteger

결과의 유형 구분입니다. 서비스에 따라 벤처기업 업종, 발급 문서 종류 등을 뜻하므로 같은 응답의 다른 필드와 함께 해석하세요.

입력 조건·전송 규칙

항목

설정

메서드·주소

POST https://apick.app/rest/ocr_identi4

인증 헤더

Authorization: Bearer — 내 계정의 API 인증키

본문 형식

multipart/form-data

요청 예시

form-data 전체 예제 보기

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 주민등록등본 문서확인번호 읽기

제출받은 등본의 문서확인번호를 기록하거나 진위 확인 절차에 넘길 때 씁니다.

요청POST/rest/ocr_identi4

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi4' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./resident_register.jpg'

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./resident_register.jpg")]), "resident_register.jpg");
const response = await fetch("https://apick.app/rest/ocr_identi4", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

import os
import requests
parts = [
    ("image", ("resident_register.jpg", open("./resident_register.jpg", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi4",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./resident_register.jpg'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi4');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

doc_num1~doc_num4를 하이픈으로 이어 16자리 문서확인번호를 만듭니다.
data.result.name은 등본을 발급받은 신청인 이름입니다.

예시 2. 스캔 PDF를 이미지로 바꿔 보내기

등본을 PDF로 받았다면 첫 페이지를 PNG로 바꿔 보냅니다. 이 API는 이미지 파일만 받습니다.

요청POST/rest/ocr_identi4

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi4' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./resident_register_page1.png'

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./resident_register_page1.png")]), "resident_register_page1.png");
const response = await fetch("https://apick.app/rest/ocr_identi4", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

import os
import requests
parts = [
    ("image", ("resident_register_page1.png", open("./resident_register_page1.png", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi4",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./resident_register_page1.png'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi4');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

data.error가 "이미지 형식의 파일만 허용됩니다"이면 PDF를 그대로 보낸 경우입니다(과금 없음).

응답 처리

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

응답 형식 이 경로는 문자열 data.error로 실패를 전달하며 별도 data.code를 보장하지 않습니다. 파일 형식 오류는 HTTP 400, 첨부 누락·문서 처리 실패는 HTTP 424입니다.

{
  "data": {
    "result": {
      "name": "홍길동",
      "doc_num1": "1234",
      "doc_num2": "5678",
      "doc_num3": "9012",
      "doc_num4": "3456",
      "type": 1
    },
    "raw_text": "주민등록표\n(등본)\n…\n문서확인번호 : 1234-5678-9012-3456\n신청인 : 홍길동\n…",
    "success": 1
  },
  "api": { "success": true, "cost": 12, "ms": 591, "pl_id": 335 }
}

원문 응답 필드 표 보기

필드

타입

설명

data.result.name

string

신청인 이름입니다. 찾지 못하면 null입니다.

data.result.doc_num1

string

문서확인번호 첫째 묶음입니다. 예: 1234-5678-9012-3456이면 1234.

data.result.doc_num2

string

문서확인번호 둘째 묶음입니다.

data.result.doc_num3

string

문서확인번호 셋째 묶음입니다.

data.result.doc_num4

string

문서확인번호 넷째 묶음입니다.

data.result.type

integer

발급 종류입니다. 현재 항상 1입니다.

data.raw_text

string

이미지에서 읽은 전체 텍스트입니다. 항목이 null일 때 직접 확인하는 용도로 씁니다.

data.success

integer

1이면 판독 성공(과금)입니다.

api.cost

integer

차감된 포인트입니다. 실패하면 0입니다.

오류 코드

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

HTTP 상태전송·인증·입력 오류
api.successAPI 처리 여부
data · result업무 결과와 오류 문구
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

의미

대처

첨부파일이 없습니다.

image 파일이 없습니다.

파일 필드 이름이 image인지 확인합니다.

파일 유형이 맞지 않습니다. 이미지 형식의 파일만 허용됩니다.

이미지가 아닌 파일입니다.

JPG·PNG 이미지로 보냅니다.

지원되지 않는 이미지 유형입니다. JPG 형태로 변환하여 재시도 해주세요.

읽을 수 없는 이미지 형식입니다.

JPG로 변환해 다시 보냅니다.

알 수 없는 이유로 실패했습니다.

일시적인 실패입니다.

잠시 후 다시 요청합니다.

모든 오류는 과금되지 않습니다.

인증·포인트 오류 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·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 12P · 건당

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

연동 팁

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

추가 예제·서비스별 연동 안내

호출 예시

같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다.

JavaScript 예시

form-data 전체 예제 보기

Python 예시

form-data 전체 예제 보기

주민등록등본 텍스트 추출(OCR) API

빼곡한 등본도 사진 한 장이면 데이터로

도입 효과

이런 곳에서 많이 씁니다

알아둘 점

이용 전 확인

요청과 응답

API 요청

요청 파라미터 1개 · 필수 1

응답 필드 15개

입력 조건·전송 규칙

요청 예시

사용 예시

예시 1. 주민등록등본 문서확인번호 읽기

예시 2. 스캔 PDF를 이미지로 바꿔 보내기

응답 처리

오류 코드

업무 실패 응답 data.error

서비스 코드·조건

오류 코드

인증·포인트 오류 result.error 문구

폼 입력 오류 error.code

요금·이용 조건

연동 팁

호출 예시

JavaScript 예시

Python 예시

개발가이드 검색

AI•LLM

전체상품

API 체험하기

요금정책

고객지원

개발가이드

주민등록등본 텍스트 추출(OCR) API

빼곡한 등본도 사진 한 장이면 데이터로

도입 효과

이런 곳에서 많이 씁니다

알아둘 점

이용 전 확인

요청과 응답

API 요청

요청 파라미터 1개 · 필수 1

응답 필드 15개

입력 조건·전송 규칙

요청 예시

사용 예시

예시 1. 주민등록등본 문서확인번호 읽기

예시 2. 스캔 PDF를 이미지로 바꿔 보내기

응답 처리

오류 코드

업무 실패 응답 data.error

서비스 코드·조건

오류 코드

인증·포인트 오류 result.error 문구

폼 입력 오류 error.code

요금·이용 조건

연동 팁

호출 예시

JavaScript 예시

Python 예시

관련 API