Vývojáři

POST/v3/create_proof

Připojení dokladu totožnosti nebo adresy

Přiřaďte nahrané soubory dokladů ke správné totožnosti nebo adrese.

Na této stránce
  1. Připojení dokladu totožnosti nebo adresy
  2. Vytvoření dokladu
  3. Uložení identifikátoru dokladu
  4. Chyby a nahrané soubory s vypršelou platností

Připojení dokladu totožnosti nebo adresy

Tento krok proveďte až po vytvoření totožnosti nebo adresy a po nahrání požadovaných souborů prostřednictvím create_encrypt_files se zvoleným typem dokladu. Použijte aktuální identifikátor z get_proof_types, který odpovídá požadavku a kategorii entity.

Uložte si identity_id a address_id z create_document; UUID profilu je jiný identifikátor. Kompatibilita dodatečného připojení dokladu adresy u nově vytvořených profilů se stále prověřuje. Pokud je adresa odmítnuta, před dalším pokusem zkontrolujte informace v portálu nebo se obraťte na podporu.

Vytvoření dokladu

Použijte aktivovaný účet rozhraní API MultiTEL a IP adresu, která je pro něj povolena. Příklady používají přihlašovací údaje pro ověřování HTTP Basic z proměnných prostředí; dodržujte pravidla ověřování pro svůj typ účtu. Požadavky odesílejte přes HTTPS. Zkontrolujte jak odpověď HTTP, tak i hodnotu v odpovědi JSON v poli status.code; chyby aplikace mohou být vráceny i s HTTP 200. Níže uvedené příklady jsou smyšlené.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @proof-request.json \
  https://api.multitel.net/v3/create_proof
{
  "entity_type": "identities",
  "entity_id": "33333333333333333333333333333333",
  "proof_type_id": "11111111111111111111111111111111",
  "encrypted_file_ids": [
    "22222222222222222222222222222222"
  ]
}
Pole požadavku
PoleVýznam
entity_typePoužijte identities nebo addresses. Vyberte kategorii odpovídající cílové entitě i nahraným souborům.
entity_idIdentifikátor totožnosti nebo adresy patřící vašemu účtu. Použijte identifikátor vrácený v rámci vašeho postupu zpracování dokumentů; nenahrazujte jej telefonním číslem ani identifikátorem nesouvisejícího dokumentu.
proof_type_idIdentifikátor zvoleného typu dokladu. Musí odpovídat nahraným souborům a požadavku.
encrypted_file_idsNeprázdné pole ve formátu JSON obsahující identifikátory souborů vrácené funkcí create_encrypt_files. Soubory musí patřit stejnému účtu, nesmí jim vypršet platnost a musí odpovídat kategorii entity. Nejde o seznam cest k místním souborům.

Přijímána jsou také formulářová data s opakovanými výskyty pole encrypted_file_ids[]. Upřednostněte skutečné pole ve formátu JSON nebo formulářové pole; pole zakódované ve formátu JSON neposílejte jako běžnou skalární hodnotu formuláře.

Uložení identifikátoru dokladu

{
  "status": {
    "code": 200,
    "msg": "Proof created successfully."
  },
  "response": {
    "id": "44444444444444444444444444444444",
    "entity_type": "identities",
    "entity_id": "33333333333333333333333333333333",
    "proof_type_id": "11111111111111111111111111111111",
    "proof_type_name": "Example identity proof"
  }
}

Úspěšná odpověď potvrzuje vytvoření vazby na doklad. Nepotvrzuje schválení totožnosti či adresy, ověření splnění všech požadavků dané země ani aktivaci telefonního čísla.

Chyby a nahrané soubory s vypršelou platností

Kód API 500 se používá při chybějících povinných vstupech, selháních operátora a neplatné odpovědi operátora. Kód 404 se používá, pokud cílová entita není přiřazena k aktuálnímu účtu, typ dokladu je neplatný, nahraný soubor nelze pro tento účet a kategorii najít nebo mu vypršela platnost, případně nezůstaly žádné použitelné identifikátory souborů. Přečtěte si status.msg společně s kódem.

Požadovaný soubor, kterému vypršela platnost, před připojením znovu nahrajte se správnou kategorií dokladu. Pokud je kterýkoli z dodaných souborů neplatný, tato obslužná funkce se zastaví ještě před odesláním požadavku na vytvoření dokladu. Klíč idempotence není k dispozici: po vypršení časového limitu zkontrolujte existující dokument v portálu, než připojení zopakujete.