Een ondersteunend document koppelen

Een ondersteunend document op basis van een sjabloon koppelen

Gebruik een sjabloon uit get_supporting_document_templates en een identiteit die al aan uw account toebehoort. Upload de bestanden van het document via create_encrypt_files met gebruik van supporting_template_id. Gewone uploads van identiteits- of adresbewijzen vallen in een andere categorie en kunnen hiervoor niet worden gebruikt.

Het ondersteunende document aanmaken

Gebruik een ingeschakeld MultiTEL-account voor de API en het daarvoor toegestane IP-adres. De voorbeelden gebruiken aanmeldgegevens voor HTTP Basic uit omgevingsvariabelen; volg de authenticatieconventies voor uw accounttype. Verstuur verzoeken via HTTPS. Controleer zowel het antwoord op HTTP-niveau als het volgende veld in JSON: status.code; toepassingsfouten kunnen worden geretourneerd met HTTP 200. De onderstaande voorbeelden zijn fictief.

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

Verzoekvelden
Veld	Betekenis
`identity_id`	Verplichte identificatiecode van de identiteit die aan uw account is gekoppeld. Dit verzoek koppelt het document aan een identiteit, niet rechtstreeks aan een adres of telefoonnummer.
`template_id`	Verplichte identificatiecode van het sjabloon voor het ondersteunende document; gebruik hetzelfde geselecteerde sjabloon als voor de ondersteunende upload. Het veld voor het koppelen is template_id, terwijl het veld voor het uploaden supporting_template_id is.
`encrypted_file_ids`	Verplichte, niet-lege JSON-array met de geretourneerde uploadidentificatiecodes. Elke upload moet aan het huidige account toebehoren, nog geldig zijn en tot de categorie supporting_documents behoren.

Formuliergegevens met herhaalde encrypted_file_ids[]-velden worden ook geaccepteerd. Verstuur geen bestandsbytes naar dit eindpunt voor het koppelen van documenten.

Aangemaakt ondersteunend document

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

Dit bevestigt dat het ondersteunende document is aangemaakt, niet dat een toezichthouder het heeft goedgekeurd of dat het nummer is geactiveerd. De term permanent in de bovenliggende resource biedt klanten geen garantie over de bewaartermijn of het verwijderingsbeleid.

Fouten en nieuwe pogingen

Code 500 van de API duidt op ontbrekende invoer, fouten bij de telecomaanbieder of een ongeldig antwoord van de telecomaanbieder. Code 404 duidt op een identiteit die niet aan het account is gekoppeld, een ongeldig sjabloon, ontbrekende of verlopen uploads, uploads in de verkeerde categorie of een lege verzameling bruikbare bestanden. Controleer status.msg; alleen HTTP 200 is niet voldoende.

Upload en koppel de bestanden binnen de geretourneerde geldigheidsduur van de bestandsverwijzingen. Als het antwoord geen uitsluitsel geeft over het resultaat, controleer dan de ondersteunende documenten van de identiteit in het portaal voordat u het opnieuw probeert. Deze handler stelt geen idempotentiesleutel beschikbaar.