> ## 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.

# Informacje o weryfikacji danych osobowych i okresu ważności API

> Identity Authentication 集成指南 - XHuoAPI

Niniejszy dokument przedstawia sposób integracji z API weryfikacji danych osobowych i okresu ważności, które można wykorzystać do sprawdzenia autentyczności i zgodności imienia, numeru dowodu osobistego oraz okresu ważności dowodu.

## Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do strony [API weryfikacji danych osobowych i okresu ważności](https://api.xhuoapi.ai/documents/667017a4-017f-4af0-870e-807034f70632) i złożyć wniosek o odpowiednią usługę. Po wejściu na stronę, kliknij przycisk „Acquire”, jak pokazano na obrazku:

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

Jeśli nie jesteś zalogowany lub zarejestrowany, automatycznie zostaniesz przekierowany na stronę logowania, aby zarejestrować się i zalogować. Po zalogowaniu lub rejestracji automatycznie wrócisz na bieżącą stronę.

Podczas pierwszej aplikacji przyznawana jest darmowa pula, która pozwala na bezpłatne korzystanie z tego API.

## Podstawowe użycie

Najpierw zapoznaj się z podstawowym sposobem użycia, polegającym na wprowadzeniu linku do zdjęcia dowodu osobistego, aby uzyskać przetworzone wyniki weryfikacji. Najpierw musisz przekazać prosty parametr `name`, a następnie możemy wypełnić odpowiednie dane na interfejsie, jak pokazano na obrazku:

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

Można zauważyć, że ustawiliśmy nagłówki żądania, w tym:

* `accept`: format odpowiedzi, który chcesz otrzymać, tutaj wpisano `application/json`, czyli format JSON.
* `authorization`: klucz do wywołania API, po złożeniu wniosku można go bezpośrednio wybrać z rozwijanej listy.

Dodatkowo ustawiono ciało żądania, w tym:

* `name`: imię.
* `id_card`: numer dowodu osobistego.
* `image_url`: link do zdjęcia twarzy, które ma być przetworzone.
* `validity_end`: data wygaśnięcia dowodu osobistego, format: YYYYMMDD, na długi okres użyj „00000000”;
* `validity_begin`: data rozpoczęcia ważności dowodu osobistego, format: YYYYMMDD.
* `encryption`: opcjonalnie, parametr szyfrowania dla wrażliwych danych (jeśli wymagane przesłanie zaszyfrowanych danych).

Po dokonaniu wyboru, można zauważyć, że po prawej stronie wygenerowano odpowiedni kod, jak pokazano na obrazku:

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

Kliknij przycisk „Try”, aby przeprowadzić test, jak pokazano na powyższym obrazku, a otrzymasz następujący wynik:

```json theme={null}
{
  "result": "0",
  "description": "zgodne"
}
```

Zwracany wynik zawiera wiele pól, które są opisane poniżej:

* `result`, kod wyniku weryfikacji, sytuacja dotycząca opłat jest następująca.
  * Kody wyników płatnych:
    * 0: imię i numer dowodu osobistego są zgodne
    * -1: imię i numer dowodu osobistego są niezgodne
  * Kody wyników bezpłatnych:
    * -2: nieprawidłowy numer dowodu osobistego (długość, suma kontrolna itp. są niepoprawne)
    * -3: nieprawidłowe imię (długość, format itp. są niepoprawne)
    * -4: błąd usługi bazy dokumentów
    * -5: brak rekordu dowodu osobistego w bazie dokumentów
    * -6: system porównawczy w trakcie aktualizacji, spróbuj ponownie później
    * -7: liczba weryfikacji przekroczyła dzienny limit.
* `description`, wynik weryfikacji imienia i numeru dowodu osobistego.

Można zauważyć, że imię, numer dowodu osobistego oraz okres ważności dowodu osobistego są autentyczne i zgodne.

Dodatkowo, jeśli chcesz wygenerować odpowiedni kod integracyjny, możesz go bezpośrednio skopiować, na przykład kod CURL wygląda następująco:

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
```

Kod integracyjny w Pythonie wygląda następująco:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/check-2e"

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

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

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

## Obsługa błędów

Podczas wywoływania API, jeśli wystąpią błędy, API zwróci odpowiedni kod błędu i informacje. Na przykład:

* `400 token_mismatched`: Zły wniosek, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
* `400 api_not_implemented`: Zły wniosek, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
* `401 invalid_token`: Nieautoryzowany, nieprawidłowy lub brakujący token autoryzacyjny.
* `429 too_many_requests`: Zbyt wiele żądań, przekroczono limit.
* `500 api_error`: Błąd wewnętrzny serwera, coś poszło nie tak na serwerze.

### Przykład odpowiedzi błędu

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "pobieranie nie powiodło się"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Wnioski

Dzięki temu dokumentowi zrozumiałeś, jak korzystać z API weryfikacji danych osobowych i okresu ważności do sprawdzania autentyczności i zgodności imienia, numeru dowodu osobistego oraz okresu ważności dowodu. Mamy nadzieję, że ten dokument pomoże Ci lepiej zintegrować i korzystać z tego API. W razie jakichkolwiek pytań, prosimy o kontakt z naszym zespołem wsparcia technicznego.