외국인등록증 텍스트 추출(OCR) API 개발가이드

알아둘 점

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

요청과 응답

API 요청

POST/rest/ocr_identi5

Bearer 인증
multipart/form-data
JSON 응답

요청 예제

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@/C:/Users/user/Desktop/sample_idcard.png'

curl --fail-with-body --request POST 'https://apick.app/rest/ocr_identi5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --connect-timeout 10 --max-time 120 \
  --form 'image=@/C:/Users/user/Desktop/sample_idcard.png'

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

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("/C:/Users/user/Desktop/sample_idcard.png")]), "sample_idcard.png");
const response = await fetch("https://apick.app/rest/ocr_identi5", {
  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("/C:/Users/user/Desktop/sample_idcard.png")]), "sample_idcard.png");
const response = await fetch("https://apick.app/rest/ocr_identi5", {
  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", ("sample_idcard.png", open("/C:/Users/user/Desktop/sample_idcard.png", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi5",
    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", ("sample_idcard.png", open("/C:/Users/user/Desktop/sample_idcard.png", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr_identi5",
    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('/C:/Users/user/Desktop/sample_idcard.png'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi5');
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('/C:/Users/user/Desktop/sample_idcard.png'),
];
$curl = curl_init('https://apick.app/rest/ocr_identi5');
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": "HONGGILDONG",
      "rrn1": "123456",
      "rrn2": "1234567",
      "rrn": "1234561234567",
      "made_date": "2018-09-21"
    },
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 12,
    "ms": 447,
    "pl_id": 337
  }
}

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

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

파라미터

설명

imagefile필수

외국인등록증 이미지 파일

응답 필드 14개

응답 필드

설명

dataobject

조회 데이터

data.resultobject

추출 결과

data.result.namestring

이름

data.result.rrn1string

외국인등록번호 앞자리

data.result.rrn2string

외국인등록번호 뒷자리

data.result.rrnstring

외국인등록번호

data.result.made_datestring

발급일자

data.successinteger

과금 여부0: 실패1: 성공3: 실패(timeout)

data.raw_textstring

이미지에서 판독한 전체 텍스트. 이미지 품질과 문서 내용에 따라 빈 문자열일 수 있습니다.

apiobject

API 호출 공통 데이터

api.successboolean

API 서버 정상 응답 여부

api.costinteger

API 호출 요금

api.msinteger

API 응답 시간

api.pl_idinteger

API 결제 로그 ID

응답 처리

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

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

원문 응답 필드 표 보기

Body

이름

타입

설명

data

Object

조회 데이터

result

Object

추출 결과

name

String

이름

rrn1

String

외국인등록번호 앞자리

rrn2

String

외국인등록번호 뒷자리

rrn

String

외국인등록번호

made_date

String

발급일자

success

Integer

과금 여부
0: 실패
1: 성공
3: 실패(timeout)

api

Object

API 호출 공통 데이터

success

Boolean

API 서버 정상 응답 여부

cost

Integer

API 호출 요금

ms

Integer

API 응답 시간

pl_id

Integer

API 결제 로그 ID

오류 코드

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

HTTP 상태전송·인증·입력 오류
api.successAPI 처리 여부
data · result업무 결과와 오류 문구
api.cost이번 요청의 과금

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

코드

HTTP

의미·조치

유효하지 않은 API키 입니다.

401

Authorization: Bearer 헤더의 인증키를 확인하세요.

허용되지 않은 IP주소 입니다.

401

마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.

비활성화된 계정입니다.

401

계정 이용 상태를 고객지원으로 문의하세요.

사용 가능한 포인트이 부족합니다.

200

HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.

무료 포인트로 사용할 수 없는 서비스입니다.

200

최소 1회 결제 후 이용할 수 있습니다. 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 · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

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

연동 팁

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

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

요청 예시

form-data 전체 예제 보기

응답 예시


{
    "data": {
        "result": {
            "name": "HONGGILDONG",
            "rrn1": "123456",
            "rrn2": "1234567",
            "rrn": "1234561234567",
            "made_date": "2018-09-21"
        },
        "success": 1
    },
    "api": {
        "success": true,
        "cost": 12,
        "ms": 447,
        "pl_id": 337
    }
}

외국인등록증 텍스트 추출(OCR) API

알아둘 점

요청과 응답

API 요청

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

응답 필드 14개

응답 처리

Body

오류 코드

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

폼 입력 오류 error.code

요금·이용 조건

연동 팁

요청 예시

응답 예시

개발가이드 검색

AI•LLM

전체상품

API 체험하기

요금정책

고객지원

개발가이드

외국인등록증 텍스트 추출(OCR) API

알아둘 점

요청과 응답

API 요청

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

응답 필드 14개

응답 처리

Body

오류 코드

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

폼 입력 오류 error.code

요금·이용 조건

연동 팁

요청 예시

응답 예시

관련 API