Atributos Adicionais

É possível enviar atributos adicionais no JSON ao consumir o serviço.

usuarioAppPropietaria

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

Valor	Tipo	Descrição
usuarioAppPropietaria	String	Identifica o usuário que fez a solicitação do sistema que consome o web service. No e-mail de alerta, aparecerá como “Usuário Aplicação Empresa”

fechaExpedicion

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

Valor	Tipo	Descrição
fechaExpedicion	String	Se você deseja consultar fontes que exigem a data de emissão do documento, este atributo deve ser adicionado e a data deve estar no seguinte formato: dd/MM/yyyy

Adicionado automaticamente 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	Descrição	Requerido
tipoContraparte	String	Tipo de relação com a contraparte a ser consultada	Obrigatório
pais	String	País de residência da contraparte	Obrigatório
ciudad	String	Cidade de residência da contraparte	Opcional
direccion	String	Endereço de residência da contraparte	Opcional
email	String	E-mail da contraparte	Opcional
telefono	String	Telefone da contraparte	Opcional
tipoRelacion	String	Tipo de relação com a contraparte	Opcional
relacionadoCon	String	Dado com o qual a contraparte está relacionada	Opcional

Importante: Para habilitar esta funcionalidade, você deve solicitar ao seu analista comercial designado que habilite a opção de adicionar contrapartes via Web Services ara sua empresa. Se a opção não estiver habilitada, a contraparte não será registrada automaticamente na consulta.

Consulta em Modo Rápido

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

Valor	Tipo	Descrição
modoRapido	Boolean	Parâmetro para indicar que a informação deve ser extraída do cache. Consulte a seção seguinte.

Existem cenários onde o tempo de resposta é muito importante. Portanto, você pode enviar o atributo modoRapido dentro da solicitação para evitar consultar o nome nas fontes e obter do cache. Caso o nome não esteja no cache, a resposta será que o nome não foi encontrado.

Note: É importante ressaltar que contamos com um cache de nomes com mais de 40.000.000 de registros para a Colômbia.

Importante: No caso de países diferentes da Colômbia, recomenda-se configurar o modo rápido como false, pois, no momento, não há uma quantidade suficiente de nomes armazenados em cache.