Additional Attributes

You can send additional attributes in the JSON of the service consumption.

usuarioAppPropietaria

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

Field	Type	Description
usuarioAppPropietaria	String	Identifies the user who made the request from the system consuming the web service. In the alert email, it will appear as “User Application Company”.

fechaExpedicion

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

Field	Type	Description
fechaExpedicion	String	To consult sources that require document issue date, this attribute must be added in dd/MM/yyyy format.

Automatically Added as Counterparty

{
    "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"
}

Field	Type	Description	Required
tipoContraparte	String	Type of relationship with the counterparty	Mandatory
pais	String	Country of residence of the counterparty	Mandatory
ciudad	String	City of residence of the counterparty	Optional
direccion	String	Address of the counterparty	Optional
email	String	Email of the counterparty	Optional
telefono	String	Phone number of the counterparty	Optional
tipoRelacion	String	Type of relationship with the counterparty	Optional
relacionadoCon	String	Data the counterparty is related to	Optional

Important: To enable this feature, you must request your assigned commercial analyst to activate the option to add counterparties via Web Services for your company. If the option is not enabled, the counterparty will not be automatically registered in the query.

Quick Mode Query

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

Field	Type	Description
modoRapido	Boolean	Parameter to indicate that data should be retrieved from cache.

In some scenarios, response time is very important. You can include the modoRapido attribute in the request to skip name lookup in sources and retrieve it from the cache.

If the name is not found in the cache, the response will indicate the name was not found.

Note: It is important to highlight that we have a name cache containing more than 40,000,000 records for Colombia.

Important: In the case of countries other than Colombia, it is recommended to set the fast mode to false, since there are currently not enough names stored in the cache.