Allega un documento integrativo basato su un modello
Usa un modello ottenuto da get_supporting_document_templates e un’identità già appartenente al tuo account. Carica i file del documento tramite create_encrypt_files usando supporting_template_id. I normali caricamenti di documenti comprovanti l’identità o l’indirizzo appartengono a una categoria diversa e non possono essere usati al loro posto.
Crea il documento integrativo
Usa un account API MultiTEL abilitato e il relativo indirizzo IP autorizzato. Gli esempi usano credenziali HTTP Basic ricavate da variabili d’ambiente; segui le convenzioni di autenticazione previste per il tuo tipo di account. Invia le richieste tramite HTTPS. Controlla sia la risposta HTTP sia il campo del documento JSON status.code; gli errori applicativi possono arrivare con HTTP 200. Gli esempi seguenti sono fittizi.
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"
]
}| Campo | Significato |
|---|---|
identity_id | Identificativo obbligatorio dell’identità associata al tuo account. Questa richiesta allega il documento a un’identità, non direttamente a un indirizzo o a un numero di telefono. |
template_id | Identificativo obbligatorio del modello di documento integrativo; usa lo stesso modello selezionato per il caricamento del documento integrativo. Il campo per l’associazione è template_id, mentre quello per il caricamento è supporting_template_id. |
encrypted_file_ids | Array JSON obbligatorio e non vuoto degli identificativi restituiti dai caricamenti. Ogni caricamento deve appartenere all’account corrente, non essere scaduto e rientrare nella categoria supporting_documents. |
Sono accettati anche dati di modulo con campi encrypted_file_ids[] ripetuti. Non inviare i byte dei file a questo endpoint di associazione.
Documento integrativo creato
{
"status": {
"code": 200,
"msg": "Supporting document created successfully."
},
"response": {
"id": "77777777777777777777777777777777",
"template_id": "55555555555555555555555555555555",
"identity_id": "33333333333333333333333333333333",
"template_name": "Example supporting template"
}
}Questo conferma la creazione del documento integrativo, non l’approvazione normativa o l’attivazione del numero. Il termine permanente nella risorsa a monte non costituisce una garanzia per il cliente sulla durata della conservazione o sulla politica di eliminazione.
Errori e nuovi tentativi
Il codice API 500 indica dati di ingresso mancanti, errori dell’operatore o una risposta non valida dell’operatore. Il codice 404 indica un’identità non associata all’account, un modello non valido, caricamenti mancanti, scaduti o appartenenti alla categoria sbagliata, oppure un insieme vuoto di file utilizzabili. Controlla status.msg; il solo HTTP 200 non è sufficiente.
Carica e associa i file entro il periodo di validità dei riferimenti ai file restituiti. Dopo una risposta dall’esito incerto, controlla i documenti integrativi dell’identità nel portale prima di riprovare. Questo gestore non espone alcuna chiave di idempotenza.