# [Image/PDF] 외국인등록증 진위 확인



외국인등록증의 진위여부를 확인합니다.



인증: Authorization: Bearer $APICK_API_KEY

본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다.

인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다.



## POST /rest/identi_card_image/5 응답 필드

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

- `data.ic_id` (integer): 이번 조회에 부여된 식별자입니다. 같은 요청의 결과를 추적하거나 문의할 때 사용하며, 값이 없으면 null입니다.

- `data.type` (integer): 신분증 종류입니다. 이 API는 항상 5(외국인등록증)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.

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

- `data.msg` (string): 처리 결과를 사람이 읽을 수 있는 문장으로 설명합니다. 성공·실패 사유가 담기며, 오류 코드는 별도 필드에서 확인합니다.

- `data.parsed` (object): OCR로 읽은 문서의 항목별 값 묶음입니다. 문서 종류에 따라 들어오는 키가 달라지며, 읽지 못한 항목은 빈 문자열이거나 생략됩니다. null 허용.

- `data.parsed.name` (string): 읽은 성명입니다. 판정에는 쓰이지 않습니다. 대상의 표시 이름입니다. 같은 API에서도 사람·상품·채널 이름을 뜻할 수 있습니다.

- `data.parsed.rrn1` (string): 주민등록번호 앞 6자리(생년월일)입니다. OCR이 읽은 값을 그대로 반환하며, 문서가 훼손되면 일부가 비어 있을 수 있습니다.

- `data.parsed.rrn2` (string): 주민등록번호 뒤 7자리입니다. 성별·지역 코드가 포함되며, 마스킹된 문서에서는 일부가 가려져 있을 수 있습니다.

- `data.parsed.rrn` (string): 읽은 외국인등록번호 13자리입니다. 판정에 이 값을 씁니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

- `data.parsed.made_date` (string): 읽은 발급일자입니다. 10자리(YYYY-MM-DD)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

- `data.parsed.card_sn` (string): 요청에 보낸 뒷면 일련번호입니다. 보내지 않았다면 빈 문자열입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.

- `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.

- `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.

- `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.

- `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.

- `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.

- `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.

- `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.

## API 요청: POST /rest/identi_card_image/5



### 입력

- `image` (file, 필수): 외국인등록증 앞면 이미지(JPG·PNG 등) 또는 PDF 파일 하나입니다. 50MB 이하이며, PDF는 첫 페이지만 확인합니다.

- `card_sn` (string, 조건부): 신분증 뒷면의 일련번호 11자리입니다. 2011-01-01 이후 발급된 문서는 필수이며, 값이 없으면 진위 확인이 실패할 수 있습니다.



### 응답 명세

```json

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "ic_id": {
          "type": "integer",
          "description": "이번 진위 확인 요청에 부여된 번호입니다. 결과 기록이나 문의 때 함께 전달하세요. 값을 읽지 못해 접수되지 않은 요청에는 없습니다."
        },
        "type": {
          "type": "integer",
          "description": "신분증 종류입니다. 이 API는 항상 5(외국인등록증)입니다."
        },
        "result": {
          "type": "integer",
          "description": "판정 결과입니다. 1일 때만 진위 확인 통과로 처리하세요.1: 일치0: 불일치2: 판정을 확정하지 못함(msg 안내 확인 후 다시 요청)3: 처리 시간 초과(잠시 후 다시 요청)"
        },
        "msg": {
          "type": "string",
          "description": "결과 안내 문구입니다. 등록번호·발급일자 같은 입력값이 함께 들어 있을 수 있으므로 화면이나 로그에 그대로 남기지 마세요. 판정은 result 값으로 하세요."
        },
        "parsed": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "읽은 성명입니다. 판정에는 쓰이지 않습니다."
            },
            "rrn1": {
              "type": "string",
              "description": "읽은 외국인등록번호 앞 6자리입니다."
            },
            "rrn2": {
              "type": "string",
              "description": "읽은 외국인등록번호 뒤 7자리입니다. 저장·로그에 남기지 마세요. 문서 예시는 가린 값입니다."
            },
            "rrn": {
              "type": "string",
              "description": "읽은 외국인등록번호 13자리입니다. 판정에 이 값을 씁니다."
            },
            "made_date": {
              "type": "string",
              "description": "읽은 발급일자입니다. 10자리(YYYY-MM-DD)입니다."
            },
            "card_sn": {
              "type": "string",
              "description": "요청에 보낸 뒷면 일련번호입니다. 보내지 않았다면 빈 문자열입니다."
            }
          },
          "description": "파일에서 읽은 값입니다. 판정에 쓴 값이 무엇인지 확인하거나, 실패했을 때 어느 항목을 읽지 못했는지 확인할 때 씁니다. 읽지 못한 항목은 null입니다.",
          "nullable": true
        },
        "success": {
          "type": "integer",
          "description": "처리 상태입니다. 1이면 판정이 끝난 정상 응답, 0이면 실패 응답(요금 차감 없음)입니다."
        },
        "error": {
          "type": "string",
          "description": "실패 사유 문구입니다. 정상 응답에는 없으며, 값이 있으면 아래 오류 응답 표에서 원인과 조치를 확인하세요."
        }
      },
      "description": "진위 확인 결과 묶음입니다. 실패하면 error 문구가 함께 들어 있으므로 먼저 error 유무를 확인하세요."
    },
    "api": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean",
          "description": "요청을 정상적으로 받아 처리했는지 여부입니다. true여도 진위 판정은 data.result로 따로 확인해야 합니다."
        },
        "cost": {
          "type": "integer",
          "description": "이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다."
        },
        "ms": {
          "type": "integer",
          "description": "요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. 네트워크 왕복 시간은 포함되지 않습니다."
        },
        "pl_id": {
          "type": "integer",
          "description": "포인트 차감 기록 번호입니다. 차감이 있었던 호출에만 값이 있으며 과금 문의 때 사용합니다."
        }
      },
      "description": "호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다."
    }
  }
}

```

### 정적 응답 예시

```json

{
  "data": {
    "ic_id": 110371,
    "type": 5,
    "result": 1,
    "msg": "",
    "parsed": {
      "name": "HONG GILDONG",
      "rrn1": "900101",
      "rrn2": "5******",
      "rrn": "9001015******",
      "made_date": "2020-01-01",
      "card_sn": "12345678901"
    },
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 60,
    "ms": 5712,
    "pl_id": 115878
  }
}

```

### curl

```curl

curl --fail-with-body --request POST 'https://apick.app/rest/identi_card_image/5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./residence_card.jpg' \
  --form-string 'card_sn=12345678901'

```

### Node.js (서버 ESM)

```javascript

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./residence_card.jpg")]), "residence_card.jpg");
form.append("card_sn", "12345678901");
const response = await fetch("https://apick.app/rest/identi_card_image/5", {
  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);

```

### python

```python

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

```

### php

```php

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./residence_card.jpg'),
    'card_sn' => '12345678901',
];
$curl = curl_init('https://apick.app/rest/identi_card_image/5');
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);

```

## 사용 예시 1. 등록증 사진과 일련번호로 확인

2011-01-01 이후 발급된 등록증은 앞면 사진과 함께 뒷면 일련번호를 보냅니다.

```bash

curl --fail-with-body --request POST 'https://apick.app/rest/identi_card_image/5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./residence_card.jpg' \
  --form-string 'card_sn=12345678901'

```

- `data.result`가 1이면 일치합니다. `data.parsed.rrn`·`made_date`에서 읽은 값을 확인할 수 있습니다.

## 사용 예시 2. 2011년 이전 발급 등록증

오래된 등록증은 일련번호 없이 사진만 보냅니다.

```bash

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

```

- `card_sn`을 11자리가 아닌 값으로 보내면 "입력 항목이 잘못됐습니다."(HTTP 400)입니다. 없으면 아예 빼고 보냅니다.

## 코드·오류

### 업무 실패 응답

입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요.

```json

{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}

```

## 상세 기능·요금

업로드 용량 제한: 50MB 첨부 이미지 합계는 최대 50MB입니다. 서버가 판독 가능한 크기로 최적화하며, 지나치게 큰 해상도는 정확도를 높이지 않고 처리시간만 늘릴 수 있습니다. 제한을 초과하면 HTTP 413과 REQUEST_TOO_LARGE 오류가 반환되며 과금되지 않습니다. 제공 정보 외국인등록증 앞면 이미지나 PDF 파일 하나를 보내면, 등록증에서 외국인등록번호와 발급일자를 읽어 진위 여부를 판정하고 읽은 값(data.parsed)과 판정 결과(data.result)를 함께 돌려줍니다. 뒷면 일련번호는 앞면 사진에서 읽지 않으므로, 2011-01-01 이후 발급된 등록증은 card_sn을 함께 보내야 합니다. 입력값을 이미 따로 받았다면 텍스트 입력 API(/rest/identi_card/5)가 더 정확합니다. 정보주체의 동의 등 적법한 처리 근거가 있을 때만 호출하세요. Method URL POST https://apick.app/rest/identi_card_image/5

## 상세 요청

Header 이름 필수 설명 Authorization 필수 Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키 등록번호와 발급일자가 선명하게 보이도록 앞면 한 장만 촬영하세요. 둘 중 하나라도 읽지 못하면 입력 오류로 끝납니다.

## 상세 응답

Body 필드 타입 설명 data Object 진위 확인 결과 묶음입니다. 실패하면 error 문구가 함께 들어 있으므로 먼저 error 유무를 확인하세요. ic_id Integer 이번 진위 확인 요청에 부여된 번호입니다. 결과 기록이나 문의 때 함께 전달하세요. 값을 읽지 못해 접수되지 않은 요청에는 없습니다. type Integer 신분증 종류입니다. 이 API는 항상 5(외국인등록증)입니다. result Integer 판정 결과입니다. 1일 때만 진위 확인 통과로 처리하세요.1: 일치0: 불일치2: 판정을 확정하지 못함(msg 안내 확인 후 다시 요청)3: 처리 시간 초과(잠시 후 다시 요청) msg String 결과 안내 문구입니다. 등록번호·발급일자 같은 입력값이 함께 들어 있을 수 있으므로 화면이나 로그에 그대로 남기지 마세요. 판정은 result 값으로 하세요. parsed Object 파일에서 읽은 값입니다. 판정에 쓴 값이 무엇인지 확인하거나, 실패했을 때 어느 항목을 읽지 못했는지 확인할 때 씁니다. 읽지 못한 항목은 null입니다. name String 읽은 성명입니다. 판정에는 쓰이지 않습니다. rrn1 String 읽은 외국인등록번호 앞 6자리입니다. rrn2 String 읽은 외국인등록번호 뒤 7자리입니다. 저장·로그에 남기지 마세요. 문서 예시는 가린 값입니다. rrn String 읽은 외국인등록번호 13자리입니다. 판정에 이 값을 씁니다. made_date String 읽은 발급일자입니다. 10자리(YYYY-MM-DD)입니다. card_sn String 요청에 보낸 뒷면 일련번호입니다. 보내지 않았다면 빈 문자열입니다. error String 실패 사유 문구입니다. 정상 응답에는 없으며, 값이 있으면 아래 오류 응답 표에서 원인과 조치를 확인하세요. success Integer 처리 상태입니다. 1이면 판정이 끝난 정상 응답, 0이면 실패 응답(요금 차감 없음)입니다. api Object 호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다. success Boolean 요청을 정상적으로 받아 처리했는지 여부입니다. true여도 진위 판정은 data.result로 따로 확인해야 합니다. cost Integer 이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다. ms Integer 요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. 네트워크 왕복 시간은 포함되지 않습니다. pl_id Integer 포인트 차감 기록 번호입니다. 차감이 있었던 호출에만 값이 있으며 과금 문의 때 사용합니다. 판정 순서: ① data.error가 있으면 data.parsed와 card_sn 길이를 확인 ② 없으면 data.result가 1인지 확인 ③ 0이면 data.parsed의 등록번호·발급일자와 일련번호를 다시 확인합니다. 불일치(0)도 판정이 끝난 정상 응답이므로 data.success가 1입니다. 실제 차감 금액은 api.cost로 확인하세요.

## 상세 코드·정책

오류 응답 HTTP data.error 원인·조치 400 입력 항목이 잘못됐습니다. 파일에서 등록번호·발급일자를 읽지 못했거나 card_sn이 11자리가 아닙니다. data.parsed를 확인하고 다시 요청하세요. 400 파일 유형이 맞지 않습니다. 이미지 또는 PDF 형식의 파일만 허용됩니다. 이미지나 PDF가 아닌 파일입니다. JPG·PNG 이미지나 PDF로 다시 보내세요. 424 첨부파일이 없습니다. image 항목에 파일 본문이 첨부되지 않았습니다. multipart/form-data로 파일을 첨부했는지 확인하세요. 424 지원되지 않는 이미지 유형입니다. JPG 형태로 변환하여 재시도 해주세요. 읽을 수 없는 이미지 형식입니다. JPG로 변환해 다시 요청하세요. 408 처리 시간 초과로 실패했습니다. 잠시후 다시 시도해 주세요. 제한 시간 안에 판정을 받지 못했습니다(data.result 3). 잠시 후 같은 파일로 다시 요청하세요. 424 알 수 없는 이유로 실패했습니다. 일시적인 처리 실패입니다. 잠시 후 다시 요청하세요. 오류 응답은 data.success 0, api.cost 0이며 요금이 차감되지 않습니다.

## 상세 예제

요청 예시 form-data 전체 예제 보기 응답 예시 { "data": { "ic_id": 110371, "type": 5, "result": 1, "msg": "", "parsed": { "name": "HONG GILDONG", "rrn1": "900101", "rrn2": "5******", "rrn": "9001015******", "made_date": "2020-01-01", "card_sn": "12345678901" }, "success": 1 }, "api": { "success": true, "cost": 60, "ms": 5712, "pl_id": 115878 } }