Vývojáři

GET/v3/get_proof_types

Výpis kategorií dokladů

Zjistěte identifikátory kategorií dokladů a typy subjektů před přípravou dokladů totožnosti nebo adresy.

Na této stránce
  1. Vyberte kategorii dokladu
  2. Řiďte se příslušnými požadavky
  3. Požadavek
  4. Odpověď
  5. Chyby
  6. Dostupnost a vedlejší účinky

Vyberte kategorii dokladu

Při přípravě dokladů požadovaných pro danou identitu použijte vrácenou kategorii a typ subjektu. Tento seznam popisuje kategorie, nikoli vámi nahrané soubory, a neznamená schválení žádného dokladu.

Řiďte se příslušnými požadavky

Uvedení kategorie v seznamu neznamená, že vyhovuje požadavkům pro každou zemi, typ čísla nebo identitu zákazníka. Před nahráním dokladů si přečtěte příslušné požadavky a vrácené identifikátory používejte beze změn, aniž byste z jejich podoby vyvozovali význam.

Požadavek

Použijte přihlašovací údaje svého aktivovaného účtu API prostřednictvím HTTPS. Podporována je základní autentizace a aktivované tokeny typu bearer pro účet API; platí omezení účtu.

GET s případným zdokumentovaným parametrem v cestě URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

Odpověď

Zkontrolujte status.code v těle JSON i stav HTTP. response je pole objektů s položkami id, name a entity_type. Tyto hodnoty pocházejí z aktuálního katalogu dokladů. Identifikátory nemají odvoditelný význam; zkopírujte je, místo abyste je sestavovali nebo vytvářeli pomocí hašování. Úspěšná odpověď může obsahovat i prázdný katalog. Na základě tohoto příkladu nezapisujte do kódu pevný úplný výčet typů subjektů.

Ukázková struktura odpovědi; nejde o živá data účtu ani aktuální cenovou nabídku.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

Chyby

  • Zkontrolujte status.code a status.msg, zda neuvádějí chyby autentizace nebo služby. Úspěšné vrácení prázdného katalogu neznamená schválení dokumentu ani výjimku z povinnosti registrace.

Dostupnost a vedlejší účinky

  • Toto vyhledání v katalogu či požadavcích nevytvoří identitu, nenahraje doklad, nezaregistruje číslo ani neodešle objednávku.
  • Úspěšná odpověď s katalogem neznamená schválení vašich dokumentů ani potvrzení, že lze vybrané číslo aktivovat.