Introduction
Documentación de la API para APIListasVRI.
This documentation aims to provide all the information you need to work with our API.
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
Para obtener un token de autenticación, por favor dirígete a la plataforma Starsol en la sección de configuración encontrarás el método para generarlo. Si tienes problemas, contacte al administrador.
Lists
APIs para consultar listas vinculantes, restrictivas e informativas.
Consultar listas
requires authentication
Devuelve las listas de respuesta inmediata (OFAC, PEP, GOOGLE y ONU) y retorna un ID de consulta (query_id) para consultar los resultados de las listas asincronas posteriormente.
Example request:
curl --request GET \
--get "https://api-listas.starsol.com.co/api/v1/lists" \
--header "Authorization: Bearer {token} Token de autenticación" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"apellido\": \"consequatur\",
\"nombre\": \"consequatur\",
\"nuip\": 17,
\"tipo_nuip\": \"consequatur\",
\"tipo_persona\": \"consequatur\"
}"
const url = new URL(
"https://api-listas.starsol.com.co/api/v1/lists"
);
const headers = {
"Authorization": "Bearer {token} Token de autenticación",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"apellido": "consequatur",
"nombre": "consequatur",
"nuip": 17,
"tipo_nuip": "consequatur",
"tipo_persona": "consequatur"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"message": "Se retornan los resultados de las listas sincronas consultadas. Las listas asincronas se procesarán y estarán disponibles posteriormente.",
"timestamp": "2026-01-01T00:00:00+00:00",
"data": {
"resultados": {
"OFAC": {
"respuesta": [
{
"name": "John Doe",
"type": "-0-",
"country": "USA",
"info1": "Additional info 1",
"info2": "Additional info 2",
"info3": "Additional info 3",
"info4": "Additional info 4",
"info5": "Additional info 5",
"info6": "Additional info 6",
"info7": "Additional info 7",
"info8": "Additional info 8",
"updated_at": "2025-01-01 12:00:00"
}
],
"respuesta_formateada": [
{
"name": "John Doe",
"type": "-0-",
"country": "USA",
"info1": "Additional info 1",
"info2": "Additional info 2",
"info3": "Additional info 3",
"info4": "Additional info 4",
"info5": "Additional info 5",
"info6": "Additional info 6",
"info7": "Additional info 7",
"info8": "Additional info 8",
"updated_at": "2025-01-01 12:00:00"
}
],
"mensaje": "Se encontraron 1 coincidencias",
"records": 1
},
"GOOGLE": {
"respuesta": [
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
},
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
}
],
"respuesta_formateada": [
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
},
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
}
],
"mensaje": "Se encontraron 2 coincidencias",
"records": 2
},
"ONU": {
"respuesta": [
{
"DATAID": "12345",
"FIRST_NAME": "Jane",
"SECOND_NAME": "A.",
"UN_LIST_TYPE": "DPRK",
"REFERENCE_NUMBER": "67890",
"LISTED_ON": "2020-01-01",
"COMMENTS1": "Some comments",
"GENDER": "Femenino",
"DESIGNATION": {
"VALUE": "Some designation"
},
"NATIONALITY": {
"VALUE": "Country Name"
},
"LIST_TYPE": {
"VALUE": "Type Value"
},
"LAST_DAY_UPDATED": {
"VALUE": "2024-12-31"
},
"INDIVIDUAL_ALIAS": {
"QUALITY": "Alias Quality",
"ALIAS_NAME": "Alias Name"
},
"INDIVIDUAL_ADDRESS": {
"CITY": "City Name",
"STATE_PROVINCE": "Province Name",
"COUNTRY": "Country Name",
"NOTE": "Address Note"
},
"INDIVIDUAL_DATE_OF_BIRTH": {
"TYPE_OF_DATE": "EXACT or APPROXIMATELY",
"DATE": "1990-01-01",
"YEAR": "1990"
},
"INDIVIDUAL_PLACE_OF_BIRTH": {
"CITY": "Birth City",
"STATE_PROVINCE": "Birth Province",
"COUNTRY": "Birth Country"
},
"INDIVIDUAL_DOCUMENT": {
"TYPE_OF_DOCUMENT": "Passport",
"NUMBER": "A12345678",
"COUNTRY_OF_ISSUE": "Country Name"
}
}
],
"respuesta_formateada": [
{
"DATAID": "12345",
"FIRST_NAME": "Jane",
"SECOND_NAME": "A.",
"UN_LIST_TYPE": "DPRK",
"REFERENCE_NUMBER": "67890",
"LISTED_ON": "2020-01-01",
"COMMENTS1": "Some comments",
"GENDER": "Femenino",
"DESIGNATION": {
"VALUE": "Some designation"
},
"NATIONALITY": {
"VALUE": "Country Name"
},
"LIST_TYPE": {
"VALUE": "Type Value"
},
"LAST_DAY_UPDATED": {
"VALUE": "2024-12-31"
},
"INDIVIDUAL_ALIAS": {
"QUALITY": "Alias Quality",
"ALIAS_NAME": "Alias Name"
},
"INDIVIDUAL_ADDRESS": {
"CITY": "City Name",
"STATE_PROVINCE": "Province Name",
"COUNTRY": "Country Name",
"NOTE": "Address Note"
},
"INDIVIDUAL_DATE_OF_BIRTH": {
"TYPE_OF_DATE": "EXACT or APPROXIMATELY",
"DATE": "1990-01-01",
"YEAR": "1990"
},
"INDIVIDUAL_PLACE_OF_BIRTH": {
"CITY": "Birth City",
"STATE_PROVINCE": "Birth Province",
"COUNTRY": "Birth Country"
},
"INDIVIDUAL_DOCUMENT": {
"TYPE_OF_DOCUMENT": "Passport",
"NUMBER": "A12345678",
"COUNTRY_OF_ISSUE": "Country Name"
}
}
],
"mensaje": "Se encontraron 1 coincidencias",
"records": 1
},
"PEP": {
"respuesta": [
{
"nuip": "123456789",
"organization": "Organization Name",
"position": "Position Title",
"name": "Full Name",
"init_date": "2024-01-01",
"end_date": "2025-01-01",
"resume": "Summary or resume information",
"updated_at": "2025-01-01 12:00:00"
}
],
"respuesta_formateada": [
{
"nuip": "123456789",
"organization": "Organization Name",
"position": "Position Title",
"name": "Full Name",
"init_date": "2024-01-01",
"end_date": "2025-01-01",
"resume": "Summary or resume information",
"updated_at": "2025-01-01 12:00:00"
}
],
"mensaje": "Se encontraron 1 coincidencias",
"records": 1
}
},
"query_id": "252c62fb-8303-4220-8547-12d039d9fe0b"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Consultar resultados de una consulta realizada
requires authentication
Example request:
curl --request GET \
--get "https://api-listas.starsol.com.co/api/v1/lists/consequatur" \
--header "Authorization: Bearer {token} Token de autenticación" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api-listas.starsol.com.co/api/v1/lists/consequatur"
);
const headers = {
"Authorization": "Bearer {token} Token de autenticación",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"message": "Resultados de la consulta.",
"timestamp": "2026-01-23T18:54:32+00:00",
"data": {
"query": {
"uuid": "d4f1c3e2-3b6a-4f5e-9c2a-123456789abc",
"nombre": "John",
"apellido": "Doe",
"nuip": "123456789",
"tipo_nuip": "CC",
"tipo_persona": "PN",
"estado": "COMPLETADO",
"consultas_async": 5,
"created_at": "2026-01-01T04:52:07.000000Z",
"updated_at": "2026-01-01T04:53:07.000000Z"
},
"resultados": {
"OFAC": {
"respuesta": [
{
"name": "John Doe",
"type": "-0-",
"country": "USA",
"info1": "Additional info 1",
"info2": "Additional info 2",
"info3": "Additional info 3",
"info4": "Additional info 4",
"info5": "Additional info 5",
"info6": "Additional info 6",
"info7": "Additional info 7",
"info8": "Additional info 8",
"updated_at": "2025-01-01 12:00:00"
}
],
"respuesta_formateada": [
{
"name": "John Doe",
"type": "-0-",
"country": "USA",
"info1": "Additional info 1",
"info2": "Additional info 2",
"info3": "Additional info 3",
"info4": "Additional info 4",
"info5": "Additional info 5",
"info6": "Additional info 6",
"info7": "Additional info 7",
"info8": "Additional info 8",
"updated_at": "2025-01-01 12:00:00"
}
],
"mensaje": "Se encontraron 1 coincidencias",
"created_at": "2026-01-01T04:52:07.000000Z"
},
"PEP": {
"respuesta": [
{
"nuip": "123456789",
"organization": "Organization Name",
"position": "Position Title",
"name": "Full Name",
"init_date": "2024-01-01",
"end_date": "2025-01-01",
"resume": "Summary or resume information",
"updated_at": "2025-01-01 12:00:00"
}
],
"respuesta_formateada": [
{
"nuip": "123456789",
"organization": "Organization Name",
"position": "Position Title",
"name": "Full Name",
"init_date": "2024-01-01",
"end_date": "2025-01-01",
"resume": "Summary or resume information",
"updated_at": "2025-01-01 12:00:00"
}
],
"mensaje": "Se encontraron 1 coincidencias",
"created_at": "2026-01-01T04:52:07.000000Z"
},
"GOOGLE": {
"respuesta": [
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
},
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
}
],
"respuesta_formateada": [
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
},
{
"title": "John Doe - Profile",
"link": "https://example.com/johndoe",
"displayLink": "example.com",
"snippet": "This is a snippet from the webpage about John Doe.",
"formattedUrl": "https://example.com/johndoe",
}
],
"mensaje": "Se encontraron 2 coincidencias",
"created_at": "2026-01-01T04:52:07.000000Z"
},
"ONU": {
"respuesta": [
{
"DATAID": "12345",
"FIRST_NAME": "Jane",
"SECOND_NAME": "A.",
"UN_LIST_TYPE": "DPRK",
"REFERENCE_NUMBER": "67890",
"LISTED_ON": "2020-01-01",
"COMMENTS1": "Some comments",
"GENDER": "Femenino",
"DESIGNATION": {
"VALUE": "Some designation"
},
"NATIONALITY": {
"VALUE": "Country Name"
},
"LIST_TYPE": {
"VALUE": "Type Value"
},
"LAST_DAY_UPDATED": {
"VALUE": "2024-12-31"
},
"INDIVIDUAL_ALIAS": {
"QUALITY": "Alias Quality",
"ALIAS_NAME": "Alias Name"
},
"INDIVIDUAL_ADDRESS": {
"CITY": "City Name",
"STATE_PROVINCE": "Province Name",
"COUNTRY": "Country Name",
"NOTE": "Address Note"
},
"INDIVIDUAL_DATE_OF_BIRTH": {
"TYPE_OF_DATE": "EXACT or APPROXIMATELY",
"DATE": "1990-01-01",
"YEAR": "1990"
},
"INDIVIDUAL_PLACE_OF_BIRTH": {
"CITY": "Birth City",
"STATE_PROVINCE": "Birth Province",
"COUNTRY": "Birth Country"
},
"INDIVIDUAL_DOCUMENT": {
"TYPE_OF_DOCUMENT": "Passport",
"NUMBER": "A12345678",
"COUNTRY_OF_ISSUE": "Country Name"
}
}
],
"respuesta_formateada": [
{
"DATAID": "12345",
"FIRST_NAME": "Jane",
"SECOND_NAME": "A.",
"UN_LIST_TYPE": "DPRK",
"REFERENCE_NUMBER": "67890",
"LISTED_ON": "2020-01-01",
"COMMENTS1": "Some comments",
"GENDER": "Femenino",
"DESIGNATION": {
"VALUE": "Some designation"
},
"NATIONALITY": {
"VALUE": "Country Name"
},
"LIST_TYPE": {
"VALUE": "Type Value"
},
"LAST_DAY_UPDATED": {
"VALUE": "2024-12-31"
},
"INDIVIDUAL_ALIAS": {
"QUALITY": "Alias Quality",
"ALIAS_NAME": "Alias Name"
},
"INDIVIDUAL_ADDRESS": {
"CITY": "City Name",
"STATE_PROVINCE": "Province Name",
"COUNTRY": "Country Name",
"NOTE": "Address Note"
},
"INDIVIDUAL_DATE_OF_BIRTH": {
"TYPE_OF_DATE": "EXACT or APPROXIMATELY",
"DATE": "1990-01-01",
"YEAR": "1990"
},
"INDIVIDUAL_PLACE_OF_BIRTH": {
"CITY": "Birth City",
"STATE_PROVINCE": "Birth Province",
"COUNTRY": "Birth Country"
},
"INDIVIDUAL_DOCUMENT": {
"TYPE_OF_DOCUMENT": "Passport",
"NUMBER": "A12345678",
"COUNTRY_OF_ISSUE": "Country Name"
}
}
],
"mensaje": "Se encontraron 1 coincidencias",
"created_at": "2026-01-09T04:52:08.000000Z"
},
"PROCURADURIA": {
"respuesta": {
"html": "<!--?xml version=\"1.0\" encoding=\"utf-16\"?--><h2 class=\"titulo0\">Datos del ciudadano</h2><div class=\"datosConsultado\">\n Señor(a)\n <span>JOHN</span><span></span><span>DOE</span><span></span> identificado(a) con\n Cédula de ciudadanía Número\n 123456789.\n <br><br></div><h2>El ciudadano no presenta antecedentes</h2>",
"mensaje": "Consulta exitosa"
},
"respuesta_formateada": {
"texto": "Datos del ciudadano\nSeñor(a) JOHNDOE identificado(a) con Cédula de ciudadanía Número 123456789.\n\n\nEl ciudadano no presenta antecedentes"
},
"mensaje": "Consulta exitosa",
"created_at": "2026-01-01T04:52:08.000000Z"
},
"JUDICIAL": {
"respuesta": {
"html": "[CONTENIDO HTML DE LA RESPUESTA]",
"mensaje": "Se encontraron 2 registros."
},
"respuesta_formateada": {
"tabla": [
{
"Despacho y Departamento": "JUZGADO 001 ADMINISTRATIVO DE PEREIRA (RISARALDA)",
"Fecha de Radicación y última actuación": "2009-11-04\n2009-11-04",
"Número de Radicación": "11001333100120090053999",
"Sujetos Procesales": "Demandante: John Doe\nDemandado: MUNICIPIO DE SANTA ROSA DE CABAL"
},
{
"Despacho y Departamento": "JUZGADO 006 CIVIL MUNICIPAL DE PEREIRA (RISARALDA)",
"Fecha de Radicación y última actuación": "2006-01-16\n2010-08-04",
"Número de Radicación": "11001400300620060001100",
"Sujetos Procesales": "Demandante: BANCO DAVIVIENDA S.A.\nDemandado: JOHN Doe"
}
]
},
"mensaje": "Se encontraron 2 registros.",
"created_at": "2026-01-01T04:52:16.000000Z"
},
"ADRES": {
"respuesta": {
"html": "[CONTENIDO HTML DE LA RESPUESTA]",
"mensaje": "Consulta en plataforma Adres exitosa"
},
"respuesta_formateada": {
"tabla": {
"APELLIDOS": "DOE ",
"DEPARTAMENTO": "VALLE",
"ENTIDAD": "EPS",
"ESTADO": "ACTIVO",
"FECHA DE AFILIACIÓN EFECTIVA": "01/05/2012",
"FECHA DE FINALIZACIÓN DE AFILIACIÓN": "31/12/2999",
"FECHA DE NACIMIENTO": "**/**/**",
"MUNICIPIO": "SANTIAGO DE CALI",
"NOMBRES": "JOHN",
"NÚMERO DE IDENTIFICACION": "123456789",
"REGIMEN": "CONTRIBUTIVO",
"TIPO DE AFILIADO": "BENEFICIARIO",
"TIPO DE IDENTIFICACIÓN": "CC"
}
},
"mensaje": "Consulta en plataforma Adres exitosa",
"created_at": "2026-01-01T04:52:27.000000Z"
},
"REGISTRADURIA": {
"respuesta": {
"html": "[CONTENIDO HTML DE LA RESPUESTA]",
"mensaje": "Consulta exitosa"
},
"respuesta_formateada": {
"texto": "Fecha Consulta: 08/01/2026\nEl número de documento 123456789 se encuentra en el archivo nacional de identificación con estado Vigente (Vivo)"
},
"mensaje": "Consulta exitosa",
"created_at": "2026-01-09T04:53:00.000000Z"
},
"JEPMS": {
"respuesta": {
"html": "[CONTENIDO HTML DE LA RESPUESTA]",
"mensaje": "No se encontraron registros en JEPMS."
},
"respuesta_formateada": {
"tabla": [
{
"IDENTIFICACION": "123456789 ",
"JUZGADO": "0027",
"NOMBRE SUJETO": "JOHN - DOE",
"NUMERO RADICACION": "12345678901234567890",
"REPRESENTANTE": "JANE SMITH"
}
]
},
"mensaje": "Se encontraron 1 registros en JEPMS.",
"created_at": "2026-01-01T04:53:05.000000Z"
}
},
"observaciones": []
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.