Bifoga ett kompletterande dokument

Bifoga ett mallbaserat kompletterande dokument

Använd en mall från get_supporting_document_templates och en identitet som redan tillhör ditt konto. Ladda upp dokumentets filer via create_encrypt_files med supporting_template_id. Vanliga uppladdningar av identitets- eller adressbevis tillhör en annan kategori och kan inte användas i stället.

Skapa det kompletterande dokumentet

Använd ett aktiverat MultiTEL API-konto och dess tillåtna IP-adress. Exemplen använder autentiseringsuppgifter för HTTP Basic från miljövariabler; följ autentiseringsreglerna för din kontotyp. Skicka förfrågningar via HTTPS. Kontrollera både HTTP-svaret och JSON-fältet status.code; applikationsfel kan returneras med HTTP 200. Exemplen nedan är fiktiva.

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

Fält i förfrågan
Fält	Betydelse
`identity_id`	Obligatoriskt ID för identiteten som är kopplad till ditt konto. Den här förfrågan bifogar dokumentet till en identitet, inte direkt till en adress eller ett telefonnummer.
`template_id`	Obligatoriskt ID för mallen för kompletterande dokument; använd samma valda mall som vid uppladdningen av det kompletterande dokumentet. Fältet för att bifoga dokumentet är template_id, medan uppladdningsfältet är supporting_template_id.
`encrypted_file_ids`	Obligatorisk JSON-array med de returnerade uppladdnings-ID:na; arrayen får inte vara tom. Varje uppladdning måste tillhöra det aktuella kontot, fortfarande vara giltig och tillhöra kategorin supporting_documents.

Formulärdata med upprepade encrypted_file_ids[]-fält accepteras också. Skicka inte filernas byteinnehåll till denna ändpunkt för att bifoga dokument.

Skapat kompletterande dokument

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

Detta bekräftar att det kompletterande dokumentet har skapats, inte att det har godkänts enligt gällande regelverk eller att numret har aktiverats. Benämningen permanent i den bakomliggande resursen är inte en garanti gentemot kunden om lagringstid eller raderingspolicy.

Fel och nya försök

API-kod 500 anger att indata saknas, att ett operatörsfel har inträffat eller att operatörens svar är ogiltigt. Kod 404 anger att identiteten inte är kopplad till kontot, att mallen är ogiltig, att uppladdningar saknas, har upphört att gälla eller tillhör fel kategori, eller att uppsättningen användbara filer är tom. Kontrollera status.msg; enbart HTTP 200 räcker inte.

Ladda upp och bifoga medan den returnerade filreferensen fortfarande är giltig. Om svaret är oklart ska du kontrollera identitetens kompletterande dokument i portalen innan du försöker igen. Den här hanteraren tillhandahåller ingen idempotensnyckel.