Hoppa till huvudinnehåll
Denna artikel kommer att introducera en identitetsinformation och giltighetsverifiering API integration beskrivning, som kan användas för att verifiera äktheten och överensstämmelsen av namn, ID-nummer och ID-giltighet.

Ansökningsprocess

För att använda API:et måste du först gå till Identitetsinformation och giltighetsverifiering API motsvarande sida för att ansöka om den tjänst som behövs. När du kommer till sidan, klicka på “Acquire” knappen, som visas i bilden nedan: Om du inte har loggat in eller registrerat dig, kommer du automatiskt att omdirigeras till inloggningssidan som bjuder in dig att registrera dig och logga in. Efter inloggning och registrering kommer du automatiskt att återvända till den aktuella sidan. Vid första ansökan kommer det att finnas en gratis kvot som ges, så att du kan använda API:et gratis.

Grundläggande användning

Först bör du förstå den grundläggande användningsmetoden, vilket är att ange en länk till ID-bild, så får du verifieringsresultatet efter bearbetning. Först behöver du enkelt skicka ett name fält, och vi kan sedan fylla i motsvarande innehåll på gränssnittet, som visas i bilden nedan:

Här kan vi se att vi har ställt in Request Headers, inklusive:
  • accept: vilken format av svar du vill ta emot, här anges som application/json, det vill säga JSON-format.
  • authorization: nyckeln för att anropa API:et, efter ansökan kan du direkt välja från rullgardinsmenyn.
Dessutom har vi ställt in Request Body, inklusive:
  • name: namn.
  • id_card: ID-nummer.
  • image_url: länk till ansiktsbilden som ska bearbetas.
  • validity_end: ID-giltighetens utgångsdatum, format: YYYYMMDD, för långvarig användning använd “00000000” istället;
  • validity_begin: ID-giltighetens startdatum, format: YYYYMMDD.
  • encryption: valfritt, känsliga fält krypteringsparameter (om krypterad data behöver skickas).
När du har valt kan du se att motsvarande kod också genererades till höger, som visas i bilden nedan:

Klicka på “Try” knappen för att utföra testet, som visas i bilden ovan, här får vi följande resultat:
{
  "result": "0",
  "description": "Överensstämmer"
}
Det returnerade resultatet har flera fält, som beskrivs nedan:
  • result, verifieringsresultatkod, avgiftsstruktur som följer.
    • Avgiftsresultatkod:
      • 0: Namn och ID-nummer överensstämmer
      • -1: Namn och ID-nummer överensstämmer inte
    • Ingen avgiftsresultatkod:
      • -2: Ogiltigt ID-nummer (längd, kontrollsiffra etc. är felaktiga)
      • -3: Ogiltigt namn (längd, format etc. är felaktiga)
      • -4: Tjänst för dokumentdatabas är felaktig
      • -5: Ingen ID-post finns i dokumentdatabasen
      • -6: Auktoritativ jämförelsesystem uppgraderas, vänligen försök igen senare
      • -7: Antalet verifieringar har överskridit dagens gräns.
  • description, här är resultatet av verifieringen av namn och ID-nummer.
Det kan ses att namnet, ID-numret och ID-giltigheten i ID-kortet har äkthet och överensstämmelse. Om du vill generera motsvarande integrationskod kan du direkt kopiera den som genererats, till exempel CURL-koden nedan:
curl -X POST 'https://api.acedata.cloud/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": "***"
}'
Python integrationskoden ser ut så här:
import requests

url = "https://api.acedata.cloud/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)

Felhantering

När du anropar API:et, om du stöter på fel, kommer API:et att returnera motsvarande felkod och information. Till exempel:
  • 400 token_mismatched: Bad request, kan bero på saknade eller ogiltiga parametrar.
  • 400 api_not_implemented: Bad request, kan bero på saknade eller ogiltiga parametrar.
  • 401 invalid_token: Obehörig, ogiltig eller saknad auktoriseringstoken.
  • 429 too_many_requests: För många förfrågningar, du har överskridit hastighetsgränsen.
  • 500 api_error: Intern serverfel, något gick fel på servern.

Exempel på felrespons

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "hämtning misslyckades"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Slutsats

Genom detta dokument har du fått en förståelse för hur man använder identitetsinformation och giltighetsverifiering API för att verifiera äktheten och överensstämmelsen av namn, ID-nummer och ID-giltighet. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda API:et. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.