API REST del IDP

Backend: auth-backend. URL base: BASE_URL_IDP/api/v1/.

Convenciones

• Autenticación: Authorization: Bearer <access_token> (ver Introducción).

• Aislamiento por cliente: en aprobación de documentos y notificaciones, cada cliente OAuth2 solo ve los recursos que él mismo registró; el cliente se asigna automáticamente al crear el recurso.

• Identificador: los recursos se consultan por su codigo.

• Paginación: por número de página.

  Parámetro	Default	Máximo
  page	1	—
  page_size	10	100

• Formato de error:

  {
    "error_code": "...",
    "error_message": "...",
    "detail": "..."
  }

Directorio de identidades

Método	Ruta	Descripción
GET	/api/v1/directory/users/	Lista identidades del directorio
GET	/api/v1/directory/users/{public_id}/	Obtiene una identidad por public_id

Scopes: directory:all:users:read, directory:external:users:read, directory:internal:users:read y directory:admin:users:read, según el tipo de usuarios a consultar.

La documentación detallada (parámetros, respuestas y ejemplos) está en API REST de Directorio de Identidades.

Aprobación de documentos

Prefijo: /api/v1/aprobacion-documentos/.

Método	Ruta	Descripción	Scope
GET	documentos-oficiales/	Listar documentos oficiales	approvaldocs:officialdocuments:read
POST	documentos-oficiales/	Registrar documento oficial	approvaldocs:officialdocuments:create
GET	documentos-oficiales/{codigo}/	Obtener documento oficial	approvaldocs:officialdocuments:read
GET	solicitudes-aprobacion/	Listar solicitudes de aprobación	approvaldocs:approvalrequests:read
POST	solicitudes-aprobacion/	Registrar solicitud de aprobación	approvaldocs:approvalrequests:create
GET	solicitudes-aprobacion/{codigo}/	Obtener solicitud de aprobación	approvaldocs:approvalrequests:read

El registro de documentos oficiales recibe el archivo como multipart/form-data.

Notificaciones

Prefijo: /api/v1/notificaciones/.

Método	Ruta	Descripción	Scope
GET	solicitudes-notificacion/	Listar solicitudes de notificación	notifications:requests:read
POST	solicitudes-notificacion/	Registrar solicitud de notificación	notifications:requests:create
GET	solicitudes-notificacion/{codigo}/	Obtener solicitud de notificación	notifications:requests:read
POST	solicitudes-notificacion/{codigo}/reemplazar-formulario/	Reemplazar el formulario de notificación	notifications:requests:create

Reemplazar formulario

Reemplaza la solicitud de aprobación del formulario de notificación sin crear una nueva solicitud de notificación:

• Se permite en cualquier estado (pendiente, en proceso, cancelada o fallida), salvo si la solicitud ya fue completada.
• Si no se adjunta un nuevo formulario_notificacion, se reutiliza el documento oficial anterior con una nueva solicitud de aprobación.
• Si la solicitud original no tenía formulario (no notificaba por Ciudadanía Digital), el endpoint agrega ese canal: formulario_notificacion pasa a ser obligatorio y se crea un envío en espera por cada destinatario ya registrado.

Referencia completa

Campos de cada request/response: BASE_URL_IDP/api/docs/.