Připojení doplňujícího dokumentu

Připojení doplňujícího dokumentu založeného na šabloně

Použijte šablonu z get_supporting_document_templates a identitu, která již patří vašemu účtu. Její soubory nahrajte prostřednictvím create_encrypt_files s použitím supporting_template_id. Běžné nahrané doklady totožnosti nebo adresy patří do jiné kategorie a nelze je použít jako náhradu.

Vytvoření doplňujícího dokumentu

Použijte aktivovaný účet rozhraní API MultiTEL a jeho povolenou IP adresu. Příklady používají přihlašovací údaje pro ověřování HTTP Basic z proměnných prostředí; řiďte se pravidly ověřování pro svůj typ účtu. Požadavky odesílejte přes HTTPS. Zkontrolujte odpověď HTTP i hodnotu v objektu JSON status.code; chyby aplikace mohou přijít i s odpovědí 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 @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Pole požadavku
Pole	Význam
`identity_id`	Povinný identifikátor identity přiřazené k vašemu účtu. Tento požadavek připojuje dokument k identitě, nikoli přímo k adrese nebo telefonnímu číslu.
`template_id`	Povinný identifikátor šablony doplňujícího dokumentu; použijte stejnou vybranou šablonu jako při nahrávání doplňujících souborů. Pole pro připojení je template_id, zatímco pole pro nahrání je supporting_template_id.
`encrypted_file_ids`	Povinné neprázdné pole ve formátu JSON obsahující vrácené identifikátory nahraných souborů. Každý soubor musí patřit aktuálnímu účtu, mít dosud platný odkaz a být v kategorii supporting_documents.

Přijímají se také formulářová data s opakovanými poli encrypted_file_ids[]. Na tento koncový bod pro připojení dokumentu neposílejte bajty souborů.

Vytvořený doplňující dokument

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Tím se potvrzuje vytvoření doplňujícího dokumentu, nikoli schválení regulačním orgánem nebo aktivace čísla. Označení „trvalý“ v nadřazeném zdroji nepředstavuje pro zákazníka záruku doby uchovávání ani zásad mazání.

Chyby a opakování požadavků

Kód API 500 označuje chybějící vstupy, chyby operátora nebo neplatnou odpověď operátora. Kód 404 označuje identitu nepřiřazenou k účtu, neplatnou šablonu, chybějící nahrané soubory, soubory s prošlou platností či nesprávnou kategorií nebo prázdnou sadu použitelných souborů. Zkontrolujte status.msg; samotný stav HTTP 200 nestačí.

Soubory nahrajte a připojte během vrácené doby platnosti odkazů na soubory. Pokud je výsledek odpovědi nejasný, před opakováním požadavku zkontrolujte v portálu doplňující dokumenty dané identity. Tato obslužná funkce nezpřístupňuje žádný klíč idempotence.