[Text] 외국인등록증 진위 확인 | 에이픽 개발가이드

기능·제공 범위

인증: Bearer 키
요청: form-data
응답: JSON
요금·이용 조건: 기본 단가 40P · 건당

빠른 시작

서버의 APICK_API_KEY를 준비하고 입력값을 바꾸세요. 아래에서 경로별 입력·응답·실행 환경을 함께 확인할 수 있습니다.

요청과 응답

API 요청 예제직접 실행하지 않습니다POST /rest/identi_card/5

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

curl --fail-with-body --request POST 'https://apick.app/rest/identi_card/5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'rrn=1234561234567' \
  --form-string 'made_date=2020-01-01' \
  --form-string 'card_sn=10181111111'

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

const form = new FormData();
form.append("rrn", "1234561234567");
form.append("made_date", "2020-01-01");
form.append("card_sn", "10181111111");
const response = await fetch("https://apick.app/rest/identi_card/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 3 · requests 설치가 필요합니다. 키는 서버 환경변수로 읽습니다.

import os
import requests
parts = [
    ("rrn", (None, "1234561234567")),
    ("made_date", (None, "2020-01-01")),
    ("card_sn", (None, "10181111111")),
]
response = requests.request("POST", "https://apick.app/rest/identi_card/5",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

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

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'rrn' => '1234561234567',
    'made_date' => '2020-01-01',
    'card_sn' => '10181111111',
];
$curl = curl_init('https://apick.app/rest/identi_card/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);

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

curl --fail-with-body --request POST 'https://apick.app/rest/identi_card/5' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --connect-timeout 10 --max-time 120 \
  --form-string 'rrn=1234561234567' \
  --form-string 'made_date=2020-01-01' \
  --form-string 'card_sn=10181111111'

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

const form = new FormData();
form.append("rrn", "1234561234567");
form.append("made_date", "2020-01-01");
form.append("card_sn", "10181111111");
const response = await fetch("https://apick.app/rest/identi_card/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();
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);

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

import os
import requests
parts = [
    ("rrn", (None, "1234561234567")),
    ("made_date", (None, "2020-01-01")),
    ("card_sn", (None, "10181111111")),
]
response = requests.request("POST", "https://apick.app/rest/identi_card/5",
    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)

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

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'rrn' => '1234561234567',
    'made_date' => '2020-01-01',
    'card_sn' => '10181111111',
];
$curl = curl_init('https://apick.app/rest/identi_card/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);
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);

API 요청

POST/rest/identi_card/5

Bearer 인증 · multipart/form-data · JSON 응답

입력 항목

폼 항목·타입

필수

설명·예제

rrnstring

필수

외국인등록번호 (숫자 13자리)예: 1234561234567

made_datestring

필수

발급일자 (10자리, 예: 2020-01-01)예: 2020-01-01

card_snstring

선택

뒷면 일련번호 (11자리). 2011-01-01 이후 발급분은 필수예: 10181111111

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

응답 상태

{
  "data": {
    "ic_id": 121305,
    "type": 5,
    "result": 1,
    "msg": "귀하께서 조회하신 외국인등록번호 1234561234567,   발급일자 2020-01-01,   일련번호 10181111111\n 법무부가 보유한 정보와 일치합니다.\n\n\n※ 조회결과는 전산기록과 비교한 것이므로 위조제작이나 사진교체 등 위ㆍ변조 여부에 대한 판단 기준은 될 수 없습니다.",
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 40,
    "ms": 2020,
    "pl_id": 128605
  }
}

필드·타입

의미·조건

dataobject

조회 데이터

data.ic_idinteger

신분증 진위 확인 요청 ID

data.typeinteger

신분증 종류1: 주민등록증2: 운전면허증3: 여권4: 주민등록등본5: 외국인등록증

data.resultinteger

조회 결과0: 실패1: 성공2: 추가 확인 필요(msg 참고)3: 실패(timeout)

data.msgstring

메시지

data.successinteger

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

apiobject

API 호출 공통 데이터

api.successboolean

API 서버 정상 응답 여부

api.costinteger

API 호출 요금

api.msinteger

API 응답 시간

api.pl_idinteger

API 결제 로그 ID

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

추가 입력 조건·전송 규칙

Header

이름

필수

설명

Authorization

O

Bearer 인증키

응답 상세

서비스 고유 응답·필드 상세 설명

Body

이름

타입

설명

data

Object

조회 데이터

ic_id

Integer

신분증 진위 확인 요청 ID

type

Integer

신분증 종류
1: 주민등록증
2: 운전면허증
3: 여권
4: 주민등록등본
5: 외국인등록증

result

Integer

조회 결과
0: 실패
1: 성공
2: 추가 확인 필요(msg 참고)
3: 실패(timeout)

msg

String

메시지

success

Integer

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

api

Object

API 호출 공통 데이터

success

Boolean

API 서버 정상 응답 여부

cost

Integer

API 호출 요금

ms

Integer

API 응답 시간

pl_id

Integer

API 결제 로그 ID

경로별 응답 예시와 필드 명세는 위 API 요청 설명에 붙어 있습니다. JSON을 파일로 저장하기 전에는 Content-Type과 오류를 확인하세요.

상태·오류·재시도

HTTP 상태 → API 처리 여부 → 업무 상태 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

공통 폼 입력 오류

FORM_DATA_INVALID · HTTP 400: 필드 이름·타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.

FORM_DATA_FIELD_CONFLICT · HTTP 400: 같은 값과 중첩 경로를 동시에 지정하지 마세요.

MULTIPART_LIMIT_OR_PARSE_ERROR · HTTP 400/413: boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·제한·이용 조건

기능·제공 범위·요금·제한 전체 보기

Method

URL

POST

https://apick.app/rest/identi_card/5

일련번호는 카드 뒷면에 표기되어 있습니다.
2011.01.01 이전에 발급된 등록증은 공란으로 요청하면 됩니다.

연동 시 확인할 내용

예제는 경로별로 최소 요청과 오류 처리 포함 모드를 제공합니다. 실제 사용 환경의 시간 제한·취소·업무 성공 판정을 적용하세요.

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

요청 예시

form-data 전체 예제 보기

응답 예시


{
    "data": {
        "ic_id": 121305,
        "type": 5,
        "result": 1,
        "msg": "귀하께서 조회하신 외국인등록번호 1234561234567,   발급일자 2020-01-01,   일련번호 10181111111\n 법무부가 보유한 정보와 일치합니다.\n\n\n※ 조회결과는 전산기록과 비교한 것이므로 위조제작이나 사진교체 등 위ㆍ변조 여부에 대한 판단 기준은 될 수 없습니다.",
        "success": 1
    },
    "api": {
        "success": true,
        "cost": 40,
        "ms": 2020,
        "pl_id": 128605
    }
}

외국인등록증 진위 확인

기능·제공 범위

빠른 시작

요청과 응답

API 요청

입력 항목

응답과 성공 판정

Header

응답 상세

Body

상태·오류·재시도

요금·제한·이용 조건

연동 시 확인할 내용

요청 예시

응답 예시

개발가이드 검색

AI•LLM

전체상품

API 체험하기

요금정책

고객지원

개발가이드