Pridėti papildomą dokumentą

Pridėti pagal šabloną parengtą papildomą dokumentą

Naudokite šabloną iš get_supporting_document_templates ir tapatybės įrašą, kuris jau priklauso jūsų paskyrai. Jo failus įkelkite per create_encrypt_files naudodami supporting_template_id. Įprastai įkeliami tapatybę ar adresą patvirtinantys dokumentai priklauso kitai kategorijai ir negali būti naudojami vietoj šių failų.

Sukurti papildomą dokumentą

Naudokite aktyvią MultiTEL API paskyrą ir jai leidžiamą IP adresą. Pavyzdžiuose naudojami HTTP Basic prisijungimo duomenys iš aplinkos kintamųjų; laikykitės jūsų paskyros tipui taikomų autentifikavimo taisyklių. Užklausas siųskite per HTTPS. Tikrinkite ir HTTP atsakymą, ir JSON lauką status.code; programos klaidos gali būti grąžintos su HTTP 200. Toliau pateikti pavyzdžiai yra išgalvoti.

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

Užklausos laukai
Laukas	Reikšmė
`identity_id`	Privalomas su jūsų paskyra susieto tapatybės įrašo identifikatorius. Ši užklausa prideda dokumentą prie tapatybės įrašo, o ne tiesiogiai prie adreso ar telefono numerio.
`template_id`	Privalomas papildomo dokumento šablono identifikatorius; naudokite tą patį pasirinktą šabloną, kurį naudojote įkeldami papildomo dokumento failus. Pridėjimo laukas yra template_id, o įkėlimo laukas – supporting_template_id.
`encrypted_file_ids`	Privalomas netuščias JSON masyvas su grąžintais įkeltų failų identifikatoriais. Kiekvienas įkeltas failas turi priklausyti dabartinei paskyrai, jo galiojimas turi būti nepasibaigęs ir jis turi priklausyti supporting_documents kategorijai.

Taip pat priimami formos duomenys su pasikartojančiais encrypted_file_ids[] laukais. Nesiųskite failų baitų į šį dokumentų pridėjimo galinį tašką.

Sukurtas papildomas dokumentas

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

Tai patvirtina papildomo dokumento sukūrimą, o ne reguliavimo reikalavimų atitikties patvirtinimą ar numerio aktyvavimą. Pirminiame ištekliuje vartojamas terminas „nuolatinis“ klientui negarantuoja saugojimo trukmės ar ištrynimo politikos.

Klaidos ir pakartotiniai bandymai

API kodas 500 reiškia trūkstamus įvesties duomenis, operatoriaus klaidas arba netinkamą operatoriaus atsakymą. Kodas 404 reiškia su paskyra nesusietą tapatybės įrašą, netinkamą šabloną, trūkstamus, nebegaliojančius ar netinkamos kategorijos įkeltus failus arba tuščią tinkamų naudoti failų rinkinį. Patikrinkite status.msg; vien HTTP 200 nepakanka.

Įkelkite ir pridėkite failus, kol galioja grąžintos failų nuorodos. Jei atsakymas neaiškus, prieš bandydami dar kartą portale patikrinkite tapatybės įrašo papildomus dokumentus. Ši apdorojimo funkcija nesuteikia idempotentiškumo rakto.