Dokumentacja integracji API weryfikacji zdjęć z dowodu osobistego

​

Proces aplikacji

​

Podstawowe użycie

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

• image_url: link do zdjęcia dowodu osobistego, które ma być przetworzone.
• config: opcjonalne opcje konfiguracyjne, pole typu boolean, domyślnie wszystkie ustawione na false, wspiera copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (próg 0-100).

{
  "sim": 99.76,
  "result": "Success",
  "description": "Sukces",
  "name": "Imię na dowodzie",
  "sex": "Płeć na dowodzie",
  "nation": "Narodowość na dowodzie",
  "birth": "Data urodzenia na dowodzie",
  "address": "Adres zamieszkania na dowodzie",
  "id_num": "Numer dowodu",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}

• sim, podobieństwo, zakres wartości [0.00, 100.00]. Zaleca się, aby podobieństwo większe lub równe 70 uznawano za tę samą osobę, można dostosować próg w zależności od konkretnego scenariusza (próg 70 ma wskaźnik błędnych akceptacji na poziomie jednego na tysiąc, próg 80 ma wskaźnik błędnych akceptacji na poziomie jednego na dziesięć tysięcy).
• result, kod błędu biznesowego, w przypadku sukcesu zwraca Success, w przypadku błędu proszę odwołać się do poniższej listy kodów błędów w sekcji FailedOperation.
• description, wynik weryfikacji imienia i numeru dowodu.
• name, informacja o imieniu na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• sex, informacja o płci na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• nation, informacja o narodowości na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• birth, informacja o dacie urodzenia na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• address, informacja o adresie zamieszkania na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• id_num, informacja o numerze dowodu na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
• portrait, kodowanie base64 zdjęcia z dowodu, jeśli wycięcie zdjęcia się nie powiedzie, porównywane będzie całe zdjęcie dowodu i zwróci puste.
• warnings, informacje o ostrzeżeniach, gdy w konfiguracji ustawiono informacje o ostrzeżeniach, porównanie twarzy zostanie zatrzymane, a wynik zwróci błąd (FailedOperation.OcrWarningOccurred) z tymi informacjami o ostrzeżeniach.
• quality, wynik jakości zdjęcia, gdy w konfiguracji żądania ustawiono ostrzeżenie o rozmyciu, ten parametr ma znaczenie, zakres wartości (0-100), obecnie domyślny próg to 50 punktów, poniżej 50 punktów wywoła ostrzeżenie o rozmyciu.
• encryption, informacje o szyfrowaniu danych wrażliwych.

curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'

import requests

url = "https://api.acedata.cloud/identity/idcard/check-1e"

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)

​

Obsługa błędów

• 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

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

​

Wnioski