> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 신분증 인식 및 정보 검증 API 연동 설명

> Identity Authentication 集成指南 - XHuoAPI

본 문서에서는 신분증 인식 및 정보 검증 API 연동 설명을 소개합니다. 이 API는 신분증 이미지 또는 이름과 신분증 번호를 입력하여 이름과 신분증 번호의 진위 및 일관성을 검증할 수 있습니다. 본 인터페이스는 이름과 신분증 번호의 진위 및 일관성을 검증하는 데 사용되며, 이름과 신분증 번호를 입력하거나 신분증 인물 사진을 전달하여 필요한 검증 정보를 제공할 수 있습니다.

## 신청 절차

API를 사용하려면 먼저 [신분증 인식 및 정보 검증 API](https://api.xhuoapi.ai/documents/67f96afa-60b8-4cbb-a4bf-0cbfcf139a23) 해당 페이지에서 서비스를 신청해야 합니다. 페이지에 들어가면 "Acquire" 버튼을 클릭합니다. 아래 그림과 같이:

![](https://cdn.xhuoapi.ai/q6ytrc.png)

로그인 또는 등록이 되어 있지 않으면 자동으로 로그인 페이지로 이동하여 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다.

첫 신청 시 무료 사용 한도가 제공되어 해당 API를 무료로 사용할 수 있습니다.

## 기본 사용

먼저 기본 사용 방법을 이해해야 합니다. 신분증 이미지 링크를 입력하면 처리된 검증 결과를 얻을 수 있습니다. 먼저 간단히 `image_url` 필드를 전달해야 하며, 다음으로 화면에 해당 내용을 입력할 수 있습니다. 아래 그림과 같이:

<p>
  <img src="https://cdn.xhuoapi.ai/qxy9rh.png" width="500" className="m-auto" />
</p>

여기서 요청 헤더를 설정했습니다. 포함된 내용은 다음과 같습니다:

* `accept`: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 `application/json`으로 JSON 형식으로 입력합니다.
* `authorization`: API 호출을 위한 키, 신청 후 바로 드롭다운에서 선택할 수 있습니다.

또한 요청 본문을 설정했습니다. 포함된 내용은 다음과 같습니다:

* `image_url`: 처리할 신분증 이미지 링크입니다.
* `encryption`: 선택 사항, 민감한 필드 암호화 매개변수(암호문 전송이 필요한 경우).

선택 후 오른쪽에 해당 코드가 생성된 것을 확인할 수 있습니다. 아래 그림과 같이:

<p>
  <img src="https://cdn.xhuoapi.ai/uw90il.png" width="500" className="m-auto" />
</p>

"Try" 버튼을 클릭하면 테스트를 진행할 수 있으며, 위 그림과 같이 다음과 같은 결과를 얻을 수 있습니다:

```json theme={null}
{
  "result": "0",
  "description": "이름과 신분증 번호 일치",
  "name": "신분증 이름",
  "id_card": "신분증 번호",
  "sex": "신분증 성별",
  "nation": "신분증 민족",
  "birth": "신분증 생일",
  "address": "신분증 주소"
}
```

반환 결과는 여러 필드로 구성되어 있으며, 설명은 다음과 같습니다:

* `result`, 인증 결과 코드, 요금 상황은 다음과 같습니다.
  * 유료 결과 코드:
    * 0: 이름과 신분증 번호 일치
    * -1: 이름과 신분증 번호 불일치
  * 무료 결과 코드:
    * -2: 불법 신분증 번호(길이, 검증 자리 등 불일치)
    * -3: 불법 이름(길이, 형식 등 불일치)
    * -4: 증명서 데이터베이스 서비스 예외
    * -5: 증명서 데이터베이스에 해당 신분증 기록 없음
    * -6: 권위 있는 비교 시스템 업그레이드 중, 잠시 후 다시 시도하십시오.
    * -7: 인증 횟수가 당일 제한을 초과했습니다.
* `description`, 여기서 이름과 신분증 번호 검증 결과입니다.
* `name`, 신분증에 있는 이름 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.
* `id_card`, 신분증에 있는 신분증 번호 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.
* `sex`, 신분증에 있는 성별 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.
* `nation`, 신분증에 있는 민족 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.
* `birth`, 신분증에 있는 생일 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.
* `address`, 신분증에 있는 주소 정보, 신분증 이미지를 업로드하지 않으면 비어 있습니다.

신분증의 이름과 신분증 번호 정보가 일치하고 유효함을 확인할 수 있으며, 또한 OCR 기술을 사용하여 다른 정보를 추출하여 보여주었습니다.

또한 해당 연동 코드를 생성하려면 생성된 코드를 직접 복사할 수 있습니다. 예를 들어 CURL의 코드는 다음과 같습니다:

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
```

Python의 연동 코드는 다음과 같습니다:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/ocr"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## 사용자 정의 정보 검증

우리는 신분증 이미지 정보를 유출하지 않고 검증할 수 있는 방법도 제공합니다. 이름 `name`과 신분증 번호 `id_card`만 전달하여 이름과 신분증 번호의 진위 및 일관성을 검증할 수 있습니다. 아래는 입력한 구체적인 정보입니다:

<p>
  <img src="https://cdn.xhuoapi.ai/mc5bbw.png" width="500" className="m-auto" />
</p>

실행 후 다음과 같은 결과를 얻었습니다:

```json theme={null}
{
    "address": "",
    "birth": "",
    "description": "이름과 신분증 번호 일치",
    "id_card": "신분증 번호",
    "name": "신분증 이름",
    "nation": "",
    "result": "0",
    "sex": ""
 }
```

이렇게 결과를 보면 다른 개인 정보가 유출되지 않으며, 이름과 신분증 번호의 진위 및 일관성을 검증할 수 있습니다.

## 오류 처리

API를 호출할 때 오류가 발생하면 API는 해당 오류 코드와 정보를 반환합니다. 예를 들어:

* `400 token_mismatched`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `400 api_not_implemented`: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
* `401 invalid_token`: 인증되지 않음, 잘못되었거나 누락된 인증 토큰입니다.
* `429 too_many_requests`: 너무 많은 요청, 비율 제한을 초과했습니다.
* `500 api_error`: 내부 서버 오류, 서버에서 문제가 발생했습니다.

### 오류 응답 예시

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 결론

본 문서를 통해 신분증 인식 및 정보 검증 API를 사용하여 입력된 이미지 또는 이름과 신분증 번호 정보를 검증하는 방법을 이해하셨습니다. 본 문서가 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주십시오.