Contribuyentes
Consultar Taxpayers
Lista, obtiene detalle y credenciales de contribuyentes registrados.
Listar Taxpayers
GET /taxpayers
Lista los taxpayers de la organización (paginado).
Query params
| Parámetro | Tipo | Default | Descripción |
|---|---|---|---|
page | number | 1 | Página |
limit | number | 10 | Elementos por página |
q | string | - | Buscar por identification o fullName |
sortBy | string | - | Campo de ordenamiento |
sortOrder | string | - | ASC | DESC |
Respuesta 200
{
"items": [
{
"id": "uuid",
"fullName": "NOMBRE",
"identification": "AOBE910907K45",
"status": "ACTIVE",
"priority": 0,
"createdAt": "2026-03-09T18:15:46.000Z",
"contacts": [],
"legalRepresentative": null,
"registrationType": "CIEC"
}
],
"meta": {
"totalItems": 10,
"itemCount": 5,
"itemsPerPage": 10,
"currentPage": 1
}
}
Ejemplo curl:
curl --location 'https://api.taxo.ws/taxpayers?page=1&limit=10' \
--header 'x-api-key: TU_API_KEY'
Detalle por ID
GET /taxpayers/:id
Obtiene el detalle de un taxpayer por ID (UUID). Incluye registrationType (CIEC, FIEL, BOTH) para saber qué tipo de credenciales tiene y cuál endpoint de asociación usar.
Respuesta 200
{
"id": "40b86d76-6758-45d8-ab02-db8f5e0d8687",
"fullName": "SUAREZ CORO BRYAN BOLIVAR",
"identification": "AOBE910907K45",
"status": "ACTIVE",
"priority": 0,
"createdAt": "2026-03-09T18:15:46.000Z",
"contacts": [{"kind": "EMAIL", "value": "[email protected]"}],
"legalRepresentative": null,
"registrationType": "BOTH"
}
Ejemplo curl:
curl --location 'https://api.taxo.ws/taxpayers/40b86d76-6758-45d8-ab02-db8f5e0d8687' \
--header 'x-api-key: TU_API_KEY'
Credenciales encriptadas
GET /taxpayers/:id/credentials
Obtiene las credenciales CIEC encriptadas con AES-256-GCM. Requiere x-api-key para que el cliente pueda desencriptar.
Respuesta 200
{
"encryptedCredential": "...",
"iv": "...",
"salt": "...",
"authTag": "..."
}
Ejemplo curl:
curl --location 'https://api.taxo.ws/taxpayers/40b86d76-6758-45d8-ab02-db8f5e0d8687/credentials' \
--header 'x-api-key: TU_API_KEY'