Retrieve Contracts Keys

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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Listá los nombres de los documentos previamente cargados para una persona usando su person_id.

Antes de empezar

  1. Tené a mano el person_id de la persona cuyos documentos querés consultar.
  2. Usá este endpoint antes de recuperar un archivo puntual con GET /api/accounts/persons/contracts/{person_id}/{legal_person_document}.
  3. Ajustá page y size si 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=10

Parámetros

Path parameters

ParámetroTipoRequeridoDescripción
person_idstringSíIdentificador de la persona asociada a los documentos.

Query parameters

ParámetroTipoRequeridoDefaultDescripción
pageintegerNo1Número de página que querés consultar.
sizeintegerNo10Cantidad de documentos por página.

Qué devuelve este endpoint

La respuesta devuelve un objeto paginado con estos campos:

  • items: lista de documentos registrados
  • total: cantidad total de documentos disponibles
  • page: página actual
  • size: cantidad de elementos por página

Cada elemento dentro de items incluye:

CampoTipoDescripción
namestringNombre 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: el person_id, page o size tienen un formato inválido.
  • Error de negocio por person_id inexistente: 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.

Path Params
string
required
Query Params
integer
Defaults to 1
integer
Defaults to 10
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json