Lister les modèles de pièces justificatives

Parcourir le catalogue de modèles

Omettez le segment de chemin ISO facultatif pour lister les modèles renvoyés par le service. Fournissez un code ISO de pays pour filtrer la liste. Le filtre utilise l’indication de pays du modèle, qui peut être déduite d’un nom et peut être vide.

Choisir un modèle en fonction des exigences

La présence d’un modèle ne signifie pas qu’il est obligatoire ou accepté pour tous les numéros de ce pays. Faites correspondre l’identifiant du modèle aux exigences applicables en matière de pièces justificatives. Cette liste ne génère, ne signe, ne téléverse ni n’approuve de document rempli.

Si aucun modèle n’est renvoyé

Une liste filtrée vide peut signifier qu’aucune indication de pays correspondante n’a été trouvée. Une liste non filtrée vide peut également refléter l’indisponibilité des données en amont. Ne considérez aucun de ces résultats comme la preuve qu’aucune pièce justificative n’est requise.

Examiner une copie téléchargée avant de l’utiliser

Un lien de téléchargement du catalogue peut renvoyer une copie dont la mise en forme ou les éléments de marque ont été modifiés. Ne supposez pas qu’il s’agit d’un accord original inchangé ni que son téléchargement satisfait à une exigence d’enregistrement. Examinez le contenu avant de remplir ou de signer un document.

Lorsque l’assistant de documents du portail propose la préparation d’accords, utilisez son aperçu et son processus de soumission explicite. Pour les autres formulaires requis, confirmez auprès de MultiTEL quel est le formulaire en vigueur avant de le remplir. Un modèle téléchargé ne constitue ni une pièce jointe signée, ni un justificatif téléversé, ni une approbation d’un numéro.

Requête

Utilisez les identifiants de votre compte API activé via HTTPS. L’authentification Basic et les jetons bearer des comptes API activés sont pris en charge ; les restrictions du compte s’appliquent.

GET avec tout paramètre documenté dans le chemin de l’URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"

Réponse

Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. response est un tableau d’objets comportant les champs id, name, permanent, iso et url. permanent est de type boolean ; iso peut être vide et peut avoir été déduit du nom du modèle. Considérez les informations sur le pays comme une indication, et non comme une décision d’éligibilité. Un catalogue vide correspond à une réponse réussie 200 et peut également résulter d’une recherche en amont qui ne renvoie aucune donnée. L’URL est générée par le service ; son nom d’hôte peut différer de celui de l’exemple fourni à titre d’illustration.

Structure de réponse fournie à titre d’illustration ; il ne s’agit ni de données de compte en temps réel ni d’un devis actuel.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

Erreurs

• Vérifiez status.code et status.msg pour détecter les erreurs d’authentification ou de service. Un catalogue vide renvoyé avec succès ne constitue ni une approbation d’un document ni une dispense d’enregistrement.

Disponibilité et effets de bord

• Cette consultation du catalogue et des exigences ne crée pas d’identité, ne téléverse pas de justificatif, n’enregistre pas de numéro et ne passe pas de commande.
• Une réponse réussie du catalogue ne constitue ni une approbation de vos documents ni une confirmation qu’un numéro sélectionné peut être activé.