Atributos Adicionales

Es posible el enviar algún atributo adicional en el JSON del consumo de servicio.

usuarioAppPropietaria

{
    "datoConsultar":"19123402",
    "tipoDocumento":"cc",
    "usuarioAppPropietaria":"Pedro Perez Martínez"
}

Valor	Tipo	Descripción
usuarioAppPropietaria	String	identificar al usuario que realizó la petición desde el sistema que consume el web service. En el correo de alerta, aparecerá como “Usuario Aplicación Empresa”

fechaExpedicion

{
    "datoConsultar":"19123402",
    "tipoDocumento":"cc",
    "fechaExpedicion":"12/11/1990"
}

Valor	Tipo	Descripción
fechaExpedicion	String	Si desea consultar las fuentes que requieren fecha de expedición del documento se tiene que agregar este atributo y la fecha debe estar en el siguiente formato dd/MM/yyyy

Agregado automatico como contraparte

{
    "datoConsultar":"19123402",
    "tipoDocumento":"cc",
    "tipoContraparte":"EMPLEADO",
    "pais":"COLOMBIA",
    "ciudad":"BOGOTA",
    "direccion":"kr 123 #15B - 35",
    "email":"xxxx@xx.com",
    "telefono":"3001234567",
    "tipoRelacion":"CONTRATISTA",
    "relacionadoCon": "900788788"
}

Valor	Tipo	Descripción	Requerido
tipoContraparte	String	El tipo de relación con la contraparte a consultar	Obligatorio
pais	String	Pais de Residencia de la Contraparte	Obligatorio
ciudad	String	Ciudad de Residencia de la Contraparte	Opcional
direccion	String	Dirección de Residencia de la Contraparte	Opcional
email	String	Email de la Contraparte	Opcional
telefono	String	Telefono de la Contraparte	Opcional
tipoRelacion	String	Tipo de relación con la Contraparte	Opcional
relacionadoCon	String	Dato con la que la contraparte esta relacionada	Opcional

Importante: Para habilitar esta funcionalidad, debe solicitar a su analista comercial asignado que habilite la opción de agregar contrapartes vía Web Services para su empresa. Si la opción no está habilitada no se registrara la contraparte automáticamente en la consulta

Consulta en Modo Rápido

{
    "datoConsultar":"19123402",
    "tipoDocumento":"cc",
    "modoRapido":true
}

Valor	Tipo	Descripción
modoRapido	Boolean	Parametro para indicar que se extraiga la información de cache, lea el apartado siguiente

Existen escenarios donde el tiempo de respuesta es muy importante. Por lo tanto, se puede enviar el atributo modoRapido dentro de la petición para evitar la consulta de nombre en las fuentes y obtenerla del caché. En caso de que no exista el nombre en el caché, se responde con el nombre no encontrado.

Nota : Es importante resaltar que contamos con un caché de nombres de más de 40.000.000 de datos para Colombia.

Importante: En el caso de países diferentes a Colombia, se recomienda configurar el modo rápido en false, debido a que por el momento no se cuenta con una cantidad suficiente de nombres almacenados en caché.