Pievienot papildu dokumentu

Pievienot papildu dokumentu, izmantojot veidni

Izmantojiet veidni no get_supporting_document_templates un identitāti, kas jau pieder jūsu kontam. Augšupielādējiet dokumenta failus, izmantojot create_encrypt_files un norādot supporting_template_id. Parastās identitāti vai adresi apliecinošo dokumentu augšupielādes ietilpst citā kategorijā, un tās nevar izmantot šo augšupielāžu vietā.

Izveidot papildu dokumentu

Izmantojiet iespējotu MultiTEL API kontu un tam atļauto IP adresi. Piemēros tiek izmantoti HTTP Basic autentifikācijas dati no vides mainīgajiem; ievērojiet sava konta tipa autentifikācijas noteikumus. Sūtiet pieprasījumus, izmantojot HTTPS. Pārbaudiet gan HTTP atbildi, gan JSON lauku status.code; lietojumprogrammas kļūdas var tikt atgrieztas arī ar HTTP 200. Tālāk sniegtie piemēri ir izdomāti.

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

Pieprasījuma lauki
Lauks	Nozīme
`identity_id`	Obligāts ar jūsu kontu saistītās identitātes identifikators. Šis pieprasījums pievieno dokumentu identitātei, nevis tieši adresei vai tālruņa numuram.
`template_id`	Obligāts papildu dokumenta veidnes identifikators; izmantojiet to pašu atlasīto veidni, kas izmantota papildu dokumenta augšupielādei. Pievienošanas lauks ir template_id, savukārt augšupielādes lauks ir supporting_template_id.
`encrypted_file_ids`	Obligāts netukšs JSON masīvs ar atgrieztajiem augšupielāžu identifikatoriem. Katrai augšupielādei jāpieder pašreizējam kontam, tās derīguma termiņš nedrīkst būt beidzies, un tai jābūt kategorijā supporting_documents.

Tiek pieņemti arī veidlapas dati ar atkārtotiem encrypted_file_ids[] laukiem. Nesūtiet failu baitus uz šo dokumentu pievienošanas galapunktu.

Izveidotais papildu dokuments

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

Tas apstiprina papildu dokumenta izveidi, nevis regulatīvu apstiprinājumu vai numura aktivizēšanu. Augšupējā resursā lietotais apzīmējums “pastāvīgs” nav klientam sniegta garantija par glabāšanas ilgumu vai dzēšanas politiku.

Kļūdas un atkārtoti mēģinājumi

API kods 500 norāda uz trūkstošiem ievaddatiem, operatora kļūdām vai nederīgu operatora atbildi. Kods 404 norāda uz identitāti, kas nav saistīta ar kontu, nederīgu veidni, trūkstošām augšupielādēm, augšupielādēm ar beigušos derīguma termiņu vai nepareizu kategoriju, vai tukšu izmantojamo failu kopu. Pārbaudiet status.msg; ar HTTP 200 vien nepietiek.

Augšupielādējiet un pievienojiet dokumentu atgrieztās faila atsauces derīguma termiņā. Ja atbilde ir neskaidra, pirms atkārtota mēģinājuma portālā pārbaudiet identitātes papildu dokumentus. Šis apstrādātājs nenodrošina idempotences atslēgu.