get
https://example.com/api/accounts/persons/contracts-names/
Lista los nombres de los documentos previamente cargados para una persona y permite paginar el resultado.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Listá los nombres de los documentos previamente cargados para una persona usando su person_id.
Antes de empezar
- Tené a mano el
person_idde la persona cuyos documentos querés consultar. - Usá este endpoint antes de recuperar un archivo puntual con
GET /api/accounts/persons/contracts/{person_id}/{legal_person_document}. - Ajustá
pageysizesi necesitás paginar el resultado.
Cómo listar documentos disponibles
La ruta requiere el path parameter person_id.
GET /api/accounts/persons/contracts-names/{person_id}Podés agregar paginación con page y size.
GET /api/accounts/persons/contracts-names/{person_id}?page=1&size=10Parámetros
Path parameters
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
person_id | string | Sí | Identificador de la persona asociada a los documentos. |
Query parameters
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
page | integer | No | 1 | Número de página que querés consultar. |
size | integer | No | 10 | Cantidad de documentos por página. |
Qué devuelve este endpoint
La respuesta devuelve un objeto paginado con estos campos:
items: lista de documentos registradostotal: cantidad total de documentos disponiblespage: página actualsize: cantidad de elementos por página
Cada elemento dentro de items incluye:
| Campo | Tipo | Descripción |
|---|---|---|
name | string | Nombre exacto del documento registrado. |
Respuesta esperada
{
"items": [
{
"name": "estatuto.pdf"
},
{
"name": "autoridades.pdf"
}
],
"total": 2,
"page": 1,
"size": 10
}Cuándo usar este endpoint
Este endpoint es útil cuando necesitás:
- obtener el nombre exacto de un archivo ya cargado
- listar la documentación disponible de una persona jurídica
- listar documentación PEP asociada a una persona humana
- paginar resultados si una persona tiene muchos documentos registrados
Errores frecuentes
422 Validation Error: elperson_id,pageosizetienen un formato inválido.- Error de negocio por
person_idinexistente: verificá que la persona exista antes de listar sus documentos.
Siguiente paso
Usá el valor de name devuelto por este endpoint como legal_person_document en GET /api/accounts/persons/contracts/{person_id}/{legal_person_document} para recuperar un archivo puntual.
