Sviluppatori

GET/v3/get_supporting_document_templates/{iso}

Elenca i modelli di documenti giustificativi

Trova gli ID dei modelli, i nomi e le indicazioni sul paese prima di preparare un documento giustificativo.

Su questa pagina
  1. Consulta il catalogo dei modelli
  2. Scegli un modello in base ai requisiti
  3. Se non viene restituito alcun modello
  4. Esamina una copia scaricata prima di utilizzarla
  5. Richiesta
  6. Risposta
  7. Errori
  8. Disponibilità ed effetti collaterali

Consulta il catalogo dei modelli

Ometti il segmento ISO facoltativo del percorso per elencare i modelli restituiti dal servizio. Specifica un codice ISO del paese per filtrare l'elenco. Il filtro cerca una corrispondenza con l'indicazione del paese del modello, che può essere dedotta da un nome e può essere vuota.

Scegli un modello in base ai requisiti

La presenza di un modello non significa che sia richiesto o accettato per ogni numero in quel paese. Verifica che l'ID del modello corrisponda ai requisiti applicabili ai documenti giustificativi. Questo elenco non genera, firma, carica né approva un documento compilato.

Se non viene restituito alcun modello

Un elenco filtrato vuoto può significare che non è stata trovata alcuna indicazione del paese corrispondente. Un elenco non filtrato vuoto può anche dipendere dall'indisponibilità dei dati a monte. Non considerare nessuno dei due risultati come prova che non sia richiesto alcun documento giustificativo.

Esamina una copia scaricata prima di utilizzarla

Un link per il download dal catalogo può restituire una copia con modifiche alla formattazione o agli elementi del marchio. Non presumere che si tratti di un accordo originale inalterato o che il suo download soddisfi un requisito di registrazione. Esamina il contenuto prima di compilare o firmare qualsiasi documento.

Quando la procedura guidata per i documenti del portale consente di preparare un accordo, utilizza la sua anteprima e la procedura di invio esplicito. Per gli altri moduli richiesti, verifica con MultiTEL quale sia il modulo attuale prima di compilarlo. Un modello scaricato non costituisce un allegato firmato, un documento probatorio caricato o l'approvazione di un numero.

Richiesta

Utilizza le credenziali del tuo account API abilitato tramite HTTPS. Sono supportati l'autenticazione Basic e i token bearer degli account API abilitati; si applicano le restrizioni dell'account.

GET con gli eventuali parametri documentati nel percorso dell'URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Parametri del percorso
NomeTipoObbligatorioDescrizione
isostringNoFiltro facoltativo per codice ISO del paese. Ometti questo intero segmento del percorso per ottenere l'elenco non filtrato. Il confronto non distingue tra maiuscole e minuscole. I valori sconosciuti o senza corrispondenza restituiscono un elenco vuoto anziché un errore esplicito di paese non valido.

Risposta

Controlla status.code nel corpo JSON oltre allo stato HTTP. response è un array di oggetti con i campi id, name, permanent, iso e url. permanent è di tipo boolean; iso può essere vuoto e può essere stato dedotto dal nome del modello. Considera le informazioni sul paese come un'indicazione, non come una decisione sull'idoneità. Un catalogo vuoto costituisce una risposta con esito positivo 200 e può anche essere restituito quando la ricerca a monte non produce dati. L'URL viene generato dal servizio; il suo nome host può differire da quello dell'esempio illustrativo.

Struttura della risposta a scopo illustrativo; non si tratta di dati dell'account in tempo reale né di un preventivo attuale.

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

Errori

  • Controlla status.code e status.msg per eventuali errori di autenticazione o del servizio. Un catalogo vuoto restituito con esito positivo non costituisce l'approvazione di un documento né un'esenzione dalla registrazione.

Disponibilità ed effetti collaterali

  • Questa consultazione del catalogo e dei requisiti non crea un'identità, non carica un documento probatorio, non registra un numero e non effettua un ordine.
  • Una risposta del catalogo con esito positivo non costituisce l'approvazione dei tuoi documenti né la conferma che un numero selezionato possa essere attivato.