Heg 'n stawende dokument aan

Heg 'n sjabloongebaseerde stawende dokument aan

Gebruik 'n sjabloon uit get_supporting_document_templates en 'n identiteit wat reeds aan jou rekening behoort. Laai die lêers daarvan op via create_encrypt_files met behulp van supporting_template_id. Gewone oplaaie van identiteits- of adresbewyse val in 'n ander kategorie en kan nie as plaasvervangers gebruik word nie.

Skep die stawende dokument

Gebruik 'n geaktiveerde MultiTEL API-rekening en die IP-adres wat daarvoor toegelaat word. Die voorbeelde gebruik HTTP Basic-aanmeldbesonderhede uit omgewingsveranderlikes; volg die stawingskonvensies vir jou rekeningtipe. Stuur versoeke oor HTTPS. Kontroleer sowel die HTTP-antwoord as die JSON-veld status.code; toepassingsfoute kan saam met HTTP 200 teruggestuur word. Die voorbeelde hieronder is fiktief.

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

Versoekvelde
Veld	Betekenis
`identity_id`	Vereiste identifiseerder van die identiteit wat aan jou rekening gekoppel is. Hierdie versoek heg die dokument aan 'n identiteit, nie direk aan 'n adres of telefoonnommer nie.
`template_id`	Vereiste identifiseerder van die stawende dokument se sjabloon; gebruik dieselfde gekose sjabloon as vir die stawende oplaai. Die aanhegtingsveld is template_id, terwyl die oplaaiveld supporting_template_id is.
`encrypted_file_ids`	Vereiste nieleë JSON-skikking van die teruggestuurde oplaai-identifiseerders. Elkeen moet aan die huidige rekening behoort, nog geldig wees en in die kategorie supporting_documents val.

Vormdata met herhaalde encrypted_file_ids[]-velde word ook aanvaar. Moenie lêergrepe na hierdie aanhegtingseindpunt stuur nie.

Geskepte stawende dokument

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

Dit bevestig die skepping van die stawende dokument, nie regulatoriese goedkeuring of die aktivering van 'n nommer nie. Die term permanent in die stroomopbron is nie 'n waarborg aan die kliënt oor die bewaringstydperk of uitwissingsbeleid nie.

Foute en herprobeerpogings

API-kode 500 dui op ontbrekende invoer, diensverskafferfoute of 'n ongeldige antwoord van die diensverskaffer. Kode 404 dui op 'n identiteit wat nie aan die rekening gekoppel is nie, 'n ongeldige sjabloon, oplaaie wat ontbreek, verval het of in die verkeerde kategorie val, of 'n leë stel bruikbare lêers. Kontroleer status.msg; HTTP 200 alleen is onvoldoende.

Laai die lêers op en heg dit aan binne die geldigheidstydperk van die teruggestuurde lêerverwysing. Kontroleer ná 'n onsekere antwoord die identiteit se stawende dokumente in die portaal voordat jy weer probeer. Hierdie hanteerder stel geen idempotensiesleutel beskikbaar nie.