Fejlesztők

POST/v3/create_supporting_document

Alátámasztó dokumentum csatolása

Sablonalapú alátámasztó feltöltések hozzárendelése egy személyazonossághoz.

Ezen az oldalon
  1. Sablonalapú alátámasztó dokumentum csatolása
  2. Az alátámasztó dokumentum létrehozása
  3. Létrehozott alátámasztó dokumentum
  4. Hibák és újrapróbálkozások

Sablonalapú alátámasztó dokumentum csatolása

Használjon egy sablont a következő forrásból: get_supporting_document_templates, valamint egy, már az Ön fiókjához tartozó személyazonosságot. A dokumentum fájljainak feltöltéséhez használja a következő műveletet: create_encrypt_files, a következő mező megadásával: supporting_template_id. A szokásos személyazonosságot vagy lakcímet igazoló feltöltések más kategóriába tartoznak, és nem használhatók ezek helyett.

Az alátámasztó dokumentum létrehozása

Használjon engedélyezett MultiTEL API-fiókot és az ahhoz engedélyezett IP-címet. A példák környezeti változókból származó HTTP Basic hitelesítési adatokat használnak; kövesse a fióktípusára vonatkozó hitelesítési szabályokat. A kéréseket HTTPS protokollon küldje. Ellenőrizze a HTTP-választ, valamint a JSON következő mezőjét is: status.code; alkalmazáshibák HTTP 200 válasz esetén is előfordulhatnak. Az alábbi példák kitaláltak.

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"
  ]
}
A kérés mezői
MezőJelentés
identity_idA fiókjához társított személyazonosság kötelező azonosítója. Ez a kérés egy személyazonossághoz csatolja a dokumentumot, nem közvetlenül egy címhez vagy telefonszámhoz.
template_idAz alátámasztó dokumentum sablonjának kötelező azonosítója; ugyanazt a kiválasztott sablont használja, mint az alátámasztó feltöltésnél. A csatolás mezője template_id, míg a feltöltés mezője supporting_template_id.
encrypted_file_idsA visszakapott feltöltési azonosítók kötelező, nem üres JSON-tömbje. Mindegyiknek az aktuális fiókhoz kell tartoznia, még érvényesnek kell lennie, és a supporting_documents kategóriába kell tartoznia.

Olyan űrlapadatok is elfogadhatók, amelyekben a következő mezők ismétlődnek: encrypted_file_ids[]. Ne küldje el a fájlok bájtjait erre a csatolási végpontra.

Létrehozott alátámasztó dokumentum

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

Ez az alátámasztó dokumentum létrehozását igazolja, nem hatósági jóváhagyást vagy a telefonszám aktiválását. A háttérszolgáltatás erőforrásában szereplő „állandó” kifejezés nem jelent az ügyfélnek nyújtott garanciát a tárolás időtartamára vagy a törlési szabályzatra vonatkozóan.

Hibák és újrapróbálkozások

Az API 500 kódja hiányzó bemeneti adatokat, távközlési szolgáltatói hibákat vagy érvénytelen szolgáltatói választ jelez. A 404 kód a fiókhoz nem társított személyazonosságot, érvénytelen sablont, hiányzó, lejárt vagy rossz kategóriájú feltöltéseket, illetve üres felhasználható fájlkészletet jelez. Ellenőrizze a következő mezőt: status.msg; önmagában a HTTP 200 nem elegendő.

A feltöltést és a csatolást a visszakapott fájlhivatkozás érvényességi idején belül végezze el. Bizonytalan válasz után az újrapróbálkozás előtt ellenőrizze a portálon a személyazonossághoz tartozó alátámasztó dokumentumokat. Ez a kéréskezelő nem biztosít idempotenciakulcsot.