Lisadokumendi lisamine

Malli alusel koostatud lisadokumendi lisamine

Kasutage malli, mille tagastab get_supporting_document_templates ning identiteeti, mis juba kuulub teie kontole. Laadige dokumendi failid üles funktsiooni create_encrypt_files kaudu, kasutades parameetrit supporting_template_id. Tavalised isikut või aadressi tõendavate dokumentide üleslaadimised kuuluvad teise kategooriasse ning neid ei saa nende üleslaadimiste asemel kasutada.

Lisadokumendi loomine

Kasutage aktiveeritud MultiTEL API kontot ja sellele lubatud IP-aadressi. Näidetes kasutatakse keskkonnamuutujatest saadud HTTP Basic autentimisandmeid; järgige oma kontotüübi autentimistavasid. Saatke päringud protokolli HTTPS kaudu. Kontrollige nii HTTP vastust kui ka JSON välja status.code; rakenduse vead võidakse tagastada ka olekuga HTTP 200. Allolevad näited on väljamõeldud.

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"
  ]
}

Päringu väljad
Väli	Tähendus
`identity_id`	Teie kontoga seotud identiteedi kohustuslik tunnus. See päring lisab dokumendi identiteedile, mitte otse aadressile või telefoninumbrile.
`template_id`	Lisadokumendi malli kohustuslik tunnus; kasutage sama valitud malli, mida kasutasite lisadokumendi üleslaadimisel. Dokumendi lisamise väli on template_id, üleslaadimise väli aga supporting_template_id.
`encrypted_file_ids`	Kohustuslik mittetühi JSON massiiv tagastatud üleslaadimiste tunnustega. Iga üleslaadimine peab kuuluma praegusele kontole, selle kehtivusaeg ei tohi olla lõppenud ning see peab kuuluma kategooriasse supporting_documents.

Lubatud on ka vormiandmed korduvate encrypted_file_ids[] väljadega. Ärge saatke sellesse dokumendi lisamise lõpp-punkti faili baite.

Loodud lisadokument

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

See kinnitab lisadokumendi loomist, mitte regulatiivset heakskiitu ega numbri aktiveerimist. Ülemise süsteemi ressursis kasutatud mõiste „püsiv” ei ole kliendile antud garantii säilitamisaja ega kustutamispoliitika kohta.

Vead ja korduskatsed

API kood 500 tähistab puuduvaid sisendandmeid, sideoperaatori vigu või sideoperaatori kehtetut vastust. Kood 404 tähistab kontoga sidumata identiteeti, kehtetut malli, puuduvaid, aegunud või valesse kategooriasse kuuluvaid üleslaadimisi või tühja kasutuskõlblike failide kogumit. Kontrollige välja status.msg; üksnes olekust HTTP 200 ei piisa.

Laadige dokument üles ja lisage see tagastatud failiviite kehtivusaja jooksul. Ebaselge vastuse korral kontrollige enne uuesti proovimist portaalis identiteedi lisadokumente. See töötleja ei paku idempotentsusvõtit.