Joindre un document justificatif

Joindre un document justificatif fondé sur un modèle

Utilisez un modèle provenant de get_supporting_document_templates et une identité qui appartient déjà à votre compte. Téléversez les fichiers du document via create_encrypt_files en utilisant supporting_template_id. Les justificatifs d’identité ou de domicile ordinaires téléversés relèvent d’une autre catégorie et ne peuvent pas les remplacer.

Créer le document justificatif

Utilisez un compte API MultiTEL activé et l’adresse IP autorisée pour ce compte. Les exemples utilisent des identifiants d’authentification HTTP Basic issus de variables d’environnement ; suivez les conventions d’authentification propres à votre type de compte. Envoyez les requêtes via HTTPS. Vérifiez à la fois la réponse HTTP et, dans le contenu JSON, le champ status.code ; des erreurs applicatives peuvent être renvoyées avec un statut HTTP 200. Les exemples ci-dessous sont fictifs.

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

Champs de la requête
Champ	Signification
`identity_id`	Identifiant obligatoire de l’identité associée à votre compte. Cette requête rattache le document à une identité, et non directement à une adresse ou à un numéro de téléphone.
`template_id`	Identifiant obligatoire du modèle de document justificatif ; utilisez le même modèle que celui sélectionné pour le téléversement des fichiers justificatifs. Le champ de rattachement est template_id, tandis que le champ de téléversement est supporting_template_id.
`encrypted_file_ids`	Tableau JSON obligatoire et non vide contenant les identifiants renvoyés lors du téléversement. Chacun doit appartenir au compte actuel, être encore valide et relever de la catégorie supporting_documents.

Les données de formulaire comportant des champs encrypted_file_ids[] répétés sont également acceptées. N’envoyez pas le contenu binaire des fichiers à ce point de terminaison de rattachement.

Document justificatif créé

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

Cela confirme la création du document justificatif, et non son approbation réglementaire ou l’activation du numéro. Le terme « permanent » figurant dans la ressource en amont ne constitue pas une garantie envers le client quant à la durée de conservation ou à la politique de suppression.

Erreurs et nouvelles tentatives

Le code API 500 indique des données d’entrée manquantes, des erreurs de l’opérateur ou une réponse non valide de l’opérateur. Le code 404 indique une identité non associée au compte, un modèle non valide, des fichiers téléversés manquants, expirés ou relevant d’une mauvaise catégorie, ou un ensemble de fichiers utilisables vide. Vérifiez status.msg ; le seul statut HTTP 200 ne suffit pas.

Téléversez et rattachez les fichiers pendant la période de validité des références de fichiers renvoyées. Si la réponse ne permet pas de déterminer le résultat avec certitude, consultez les documents justificatifs de l’identité dans le portail avant de réessayer. Ce gestionnaire ne met aucune clé d’idempotence à disposition.