Adjuntar un documento complementario basado en una plantilla
Utilice una plantilla de get_supporting_document_templates y una identidad que ya pertenezca a su cuenta. Cargue los archivos del documento mediante create_encrypt_files utilizando supporting_template_id. Las cargas habituales de comprobantes de identidad o domicilio pertenecen a otra categoría y no pueden utilizarse en su lugar.
Crear el documento complementario
Utilice una cuenta habilitada de la API de MultiTEL y la dirección IP permitida para ella. Los ejemplos utilizan credenciales de autenticación HTTP Basic obtenidas de variables de entorno; siga las convenciones de autenticación correspondientes a su tipo de cuenta. Envíe las solicitudes mediante HTTPS. Compruebe tanto la respuesta HTTP como el siguiente campo del objeto JSON: status.code; los errores de la aplicación pueden recibirse con HTTP 200. Los ejemplos siguientes son ficticios.
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 | Significado |
|---|---|
identity_id | Identificador obligatorio de la identidad asociada a su cuenta. Esta solicitud adjunta el documento a una identidad, no directamente a una dirección ni a un número de teléfono. |
template_id | Identificador obligatorio de la plantilla del documento complementario; utilice la misma plantilla seleccionada para la carga complementaria. El campo para adjuntar el documento es template_id, mientras que el campo para cargarlo es supporting_template_id. |
encrypted_file_ids | Matriz JSON obligatoria y no vacía con los identificadores devueltos de los archivos cargados. Cada archivo debe pertenecer a la cuenta actual, no haber caducado y tener la categoría supporting_documents. |
También se aceptan datos de formulario con campos encrypted_file_ids[] repetidos. No envíe los bytes de los archivos a este punto de acceso para adjuntar documentos.
Documento complementario creado
{
"status": {
"code": 200,
"msg": "Supporting document created successfully."
},
"response": {
"id": "77777777777777777777777777777777",
"template_id": "55555555555555555555555555555555",
"identity_id": "33333333333333333333333333333333",
"template_name": "Example supporting template"
}
}Esto confirma la creación del documento complementario, no su aprobación reglamentaria ni la activación del número. El término «permanente» en el recurso del sistema de origen no constituye una garantía para el cliente sobre la duración del almacenamiento ni la política de eliminación.
Errores y reintentos
El código 500 de la API indica que faltan datos de entrada, que hay errores del operador o que su respuesta no es válida. El código 404 indica que la identidad no está asociada a la cuenta, que la plantilla no es válida, que faltan archivos cargados, que estos han caducado o pertenecen a una categoría incorrecta, o que el conjunto de archivos utilizables está vacío. Compruebe status.msg; HTTP 200 por sí solo no es suficiente.
Cargue y adjunte los archivos dentro del período de validez de las referencias de archivo devueltas. Si recibe una respuesta que no permite determinar el resultado, compruebe los documentos complementarios de la identidad en el portal antes de volver a intentarlo. Este manejador no ofrece ninguna clave de idempotencia.