Sviluppatori

GET/v3/get_proof_types

Elenca le categorie di documenti giustificativi

Trova gli identificativi delle categorie di documenti giustificativi e i tipi di entità prima di preparare la documentazione comprovante l’identità o l’indirizzo.

Su questa pagina
  1. Scegli una categoria di documenti giustificativi
  2. Rispetta i requisiti effettivi
  3. Richiesta
  4. Risposta
  5. Errori
  6. Disponibilità ed effetti collaterali

Scegli una categoria di documenti giustificativi

Usa la categoria e il tipo di entità restituiti quando prepari la documentazione richiesta per un’identità. Questo elenco descrive le categorie, non i file che hai caricato, e non costituisce l’approvazione di alcun documento giustificativo.

Rispetta i requisiti effettivi

La presenza di una categoria nell’elenco non significa che soddisfi i requisiti di ogni paese, tipo di numero o identità del cliente. Leggi i requisiti applicabili prima di caricare la documentazione e tratta gli identificativi restituiti come valori opachi.

Richiesta

Usa le credenziali del tuo account API abilitato tramite HTTPS. Sono supportati l’autenticazione di base e i token di accesso di tipo 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_proof_types"

Risposta

Controlla status.code nel corpo JSON e lo stato HTTP. response è un array di oggetti con i campi id, name e entity_type. Questi valori provengono dal catalogo attuale dei documenti giustificativi. Gli identificativi sono opachi: copiali anziché costruirli o generarli tramite una funzione di hash. È possibile che venga restituito correttamente un catalogo vuoto. Non definire nel codice un’enumerazione completa dei tipi di entità sulla base di questo esempio.

Struttura della risposta a scopo illustrativo; non rappresenta dati dell’account in tempo reale né un preventivo attuale.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

Errori

  • Controlla status.code e status.msg per individuare errori di autenticazione o del servizio. Un catalogo vuoto restituito correttamente 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 giustificativo, non registra un numero e non effettua un ordine.
  • Una risposta del catalogo restituita correttamente non costituisce l’approvazione dei tuoi documenti né la conferma che un numero selezionato possa essere attivato.