Desarrolladores

GET/v3/get_proof_types

Listar categorías de justificantes

Obtenga los identificadores de las categorías de justificantes y los tipos de entidad antes de preparar la documentación acreditativa de identidad o domicilio.

En esta página
  1. Elija una categoría de justificantes
  2. Cumpla los requisitos aplicables
  3. Solicitud
  4. Respuesta
  5. Errores
  6. Disponibilidad y efectos secundarios

Elija una categoría de justificantes

Utilice la categoría y el tipo de entidad devueltos al preparar la documentación acreditativa requerida para una identidad. Esta lista describe categorías; no enumera los archivos que ha subido ni implica la aprobación de ningún justificante.

Cumpla los requisitos aplicables

Que una categoría figure en la lista no significa que cumpla los requisitos de todos los países, tipos de número o identidades de cliente. Lea los requisitos aplicables antes de subir la documentación acreditativa y trate los identificadores devueltos como valores opacos.

Solicitud

Utilice las credenciales de su cuenta de API habilitada a través de HTTPS. Se admiten la autenticación básica y los tokens de portador habilitados para la cuenta de API; se aplican las restricciones de la cuenta.

GET con cualquier parámetro documentado en la ruta de la URL.

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

Respuesta

Compruebe status.code en el cuerpo JSON, así como el estado HTTP. response es un arreglo de objetos con los campos id, name y entity_type. Estos valores proceden del catálogo actual de justificantes. Los identificadores son opacos; cópielos en lugar de construirlos o generarlos mediante una función hash. Puede devolverse un catálogo vacío como resultado satisfactorio. No defina de forma fija en el código una enumeración completa de tipos de entidad a partir de este ejemplo.

Estructura ilustrativa de la respuesta; no contiene datos en tiempo real de la cuenta ni constituye una cotización vigente.

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

Errores

  • Compruebe status.code y status.msg para detectar errores de autenticación o del servicio. Un catálogo vacío devuelto correctamente no implica la aprobación de un documento ni una exención de registro.

Disponibilidad y efectos secundarios

  • Esta consulta del catálogo o de los requisitos no crea una identidad, no sube un justificante, no registra un número ni realiza un pedido.
  • Una respuesta satisfactoria del catálogo no implica la aprobación de sus documentos ni confirma que se pueda activar un número seleccionado.