Kuenta Docs

Appearance

Endpoints principales de la aplicación ​

Nota: Todos los endpoints requieren sesión/autenticación, excepto aquellos marcados explícitamente como [PÚBLICO]. [AUTH] indica que el endpoint requiere autenticación para ser consumido.

🔧 Sistema y Estado ​

  • GET /health [PÚBLICO]

🔑 OAuth2 - Autenticación de API ​

Endpoints para autenticación de aplicaciones y servicios que consumen la API:

  • POST /oauth/token [PÚBLICO]
  • POST /oauth/revoke [PÚBLICO]
  • GET /oauth/keys [PÚBLICO]
  • GET /oauth/client [AUTH]

🔐 Autenticación de Usuario ​

Endpoints para autenticación de usuarios finales:

  • POST /auth/login [PÚBLICO]
  • POST /auth/logout [AUTH]
  • POST /auth/refresh [AUTH]
  • POST /auth/register [PÚBLICO]

Gestión de Contraseñas ​

  • POST /auth/password/request [PÚBLICO]
  • POST /auth/password/verify [PÚBLICO]
  • POST /auth/password/reset [PÚBLICO]

Verificación TOTP ​

  • POST /auth/totp/request [PÚBLICO]
  • POST /auth/totp/verify [PÚBLICO]

Autenticación Multi-Factor (MFA) ​

  • POST /auth/mfa/challenge [PÚBLICO]
  • POST /auth/mfa/session [PÚBLICO]
  • POST /auth/mfa/login/totp [PÚBLICO]

🏢 Configuración de Cuenta y Organización ​

  • GET /configs?hostname=:hostname [PÚBLICO] (cambiado de /config/:hostname a query parameter para evitar conflictos)
  • POST /organization [AUTH]
  • GET /organizations [AUTH]
  • POST /organization/:entityid/config [AUTH]
  • GET /organization/:entityid/configs [AUTH]
  • GET /organization/:entityid/config/:configid [AUTH]
  • PUT /organization/:entityid/config/:configid [AUTH]
  • DELETE /organization/:entityid/config/:configid [AUTH]

👥 Gestión de Usuarios y Miembros ​

  • POST /members [AUTH]
  • GET /members [AUTH]
  • GET /members/:memberid [AUTH]
  • PUT /members/:memberid [AUTH]
  • DELETE /members/:memberid [AUTH]
  • PUT /organization/:entityid/members/:memberid/role [AUTH]

👤 Gestión de Terceros (Deudores y Partners) ​

  • POST /debtor [AUTH]
  • GET /debtors [AUTH]
  • GET /debtor/:debtorid [AUTH]
  • DELETE /debtor/:debtorid [AUTH]
  • POST /debtor/:debtorid/assistance/request [AUTH]
  • POST /debtor/:debtorid/assistance [AUTH]
  • GET /assistance/twilio [PÚBLICO]
  • GET /debtor-status/:id_number [AUTH]
  • POST /partners [AUTH]
  • GET /partners [AUTH]
  • DELETE /partners/:entityid [AUTH]

📄 Gestión de Perfiles ​

  • GET /profiles [AUTH]
  • GET /profiles/:profileid [AUTH]
  • GET /profiles/:profileid/debtor [AUTH]
  • GET /profile [AUTH]
  • PUT /profile [AUTH]
  • PUT /profile/:field [AUTH]
  • POST /profile/:field [AUTH]
  • GET /profile/:field [AUTH]
  • GET /profile/:field/:id [AUTH]
  • DELETE /profile/:field/:id [AUTH]
  • DELETE /profile/:field [AUTH]

Perfiles de Deudores ​

  • GET /debtor/:debtorid/profile [AUTH]
  • PUT /debtor/:debtorid/profile [AUTH]
  • GET /debtor/:debtorid/profiles/:profileid [AUTH]
  • GET /debtor/:debtorid/profiles/:profileid/:field [AUTH]
  • GET /debtor/:debtorid/profiles/:profileid/:field/:id [AUTH]
  • POST /debtor/:debtorid/profiles/:profileid/:field [AUTH]
  • PUT /debtor/:debtorid/profiles/:profileid/field [AUTH]
  • GET /debtor/:debtorid/profile/:field [AUTH]
  • POST /debtor/:debtorid/profile/:field [AUTH]
  • GET /debtor/:debtorid/profile/:field/:id [AUTH]
  • DELETE /debtor/:debtorid/profile/:field [AUTH]
  • DELETE /debtor/:debtorid/profile/:field/:id [AUTH]

Perfiles Legales ​

  • POST /organization/:organizationid/profile [AUTH]
  • GET /organization/:entityid/profiles [AUTH]
  • GET /organization/:entityid/profile/:profileid [AUTH]
  • PUT /organization/:entityid/profile/:profileid [AUTH]
  • PUT /organization/:entityid/profile/:profileid/field [AUTH]
  • POST /legal/:field [AUTH]
  • GET /legal/:field [AUTH]
  • GET /legal/:field/:id [AUTH]
  • DELETE /legal/:field [AUTH]
  • DELETE /legal/:field/:id [AUTH]

💳 Productos de Crédito ​

  • GET /products [PÚBLICO]
  • GET /custom-products [AUTH]
  • GET /products/:product-id [PÚBLICO]
  • GET /marketplace/:nickname/products [PÚBLICO]

💰 Cuentas por Cobrar (Receivables) ​

  • POST /receivable [AUTH]
  • GET /receivables [AUTH]
  • GET /receivables/installments [AUTH]
  • GET /receivable/:creditid [AUTH]
  • PUT /receivable/:creditid [AUTH]
  • DELETE /receivable/:creditid [AUTH]
  • GET /receivable/:creditid/full-balance [AUTH]
  • GET /receivable/:creditid/version/:version [AUTH]
  • GET /receivable/:creditid/envelope [AUTH]
  • PATCH /receivable/:creditid/approval [AUTH]
  • PUT /receivable/:creditid/profile [AUTH]
  • GET /receivables/:creditid/forms?type=legal|natural [AUTH] - Get forms for receivable credit (all fields)
  • GET /payables/:creditid/forms?type=legal|natural [AUTH] - Get forms for payable credit (filtered fields)
  • PATCH /receivable/:creditid/analysis [AUTH]
  • PATCH /receivable/:creditid/analysis-setting [AUTH]
  • POST /receivable/:creditid/comment [AUTH]
  • GET /receivable/:creditid/logs [AUTH]
  • GET /receivable/:creditid/logs/:logid/webhook-log [AUTH]
  • GET /receivable/:creditid/installment/:installmentnumber [AUTH]
  • POST /receivable/:creditid/update-payment [AUTH]
  • POST /receivable/:creditid/update-start [AUTH]
  • POST /receivable/:creditid/update-rates [AUTH]
  • POST /receivable/:creditid/full-paid [AUTH]
  • PUT /receivable/:creditid/restart-proccess [AUTH]
  • PUT /receivable/:creditid/validate-signature [AUTH]
  • PUT /receivable/:creditid/complete-coOwners [AUTH]
  • PATCH /receivable/:creditid/desist [AUTH]
  • PATCH /receivable/:creditid/npl [AUTH]
  • PATCH /receivable/:creditid/preferred-disbursement-method [AUTH]
  • POST /receivable/:creditid/notification [AUTH]

💸 Cuentas por Pagar (Payables) ​

  • POST /payable [AUTH]
  • GET /payables [AUTH]
  • GET /payable/:creditid [AUTH]
  • GET /payable/:creditid/documents [AUTH]
  • GET /payable/:creditid/envelope [AUTH]
  • GET /payable/:creditid/version/:version [AUTH]
  • GET /payable/:creditid/dryrun [AUTH]
  • GET /payable/:creditid/orders [AUTH]
  • GET /payables/:creditid/credit-line/currency [AUTH]
  • PATCH /payable/:creditid/desist [AUTH]
  • PATCH /payable/:creditid/confirm [AUTH]
  • POST /payable/:creditid/notification [AUTH]
  • DELETE /payable/:creditid [AUTH]
  • PUT /payable/:creditid/ask-update/:ask [AUTH]
  • PUT /payable/:creditid/ask-temporary/:ask [AUTH]
  • PUT /payable/:creditid/ask-update-admin/:ask [AUTH]
  • PUT /payable/:creditid/order/change-payment [AUTH]

📊 Evaluación y Scoring ​

  • POST /debtor/:debtorid/credit-analysis [AUTH]
  • GET /credit-analyses [AUTH]
  • GET /credit-analysis/:creditstudyid [AUTH]
  • GET /credit-analysis/:creditstudyid/status [AUTH]
  • GET /credit-analysis/:creditstudyid/outputfile/:filename [AUTH]
  • DELETE /debtor/:debtorid/credit-analysis/:creditstudyid [AUTH]
  • GET /debtor/:debtorid/credit-analyses [AUTH]
  • POST /analysis [AUTH]
  • POST /analysis-request [AUTH]

Modelos de Scoring ​

  • POST /organization/:entityid/config/:configid/scoring-model [AUTH]
  • GET /organization/:entityid/config/:configid/scoring-models [AUTH]
  • PUT /organization/:entityid/config/:configid/scoring-model/:id [AUTH]
  • POST /organization/:entityid/config/:configid/scoring-model-rule [AUTH]
  • GET /organization/:entityid/config/:configid/scoring-model-rules [AUTH]
  • GET /scoring-model-rule/:rule-id [AUTH]
  • PUT /scoring-model-rule/:rule-id [AUTH]
  • DELETE /scoring-model-rule/:rule-id [AUTH]

💳 Pagos y Enlaces de Pago ​

  • GET /payment-links [AUTH]
  • POST /payment-links [AUTH]
  • GET /payment-links/:ref [PÚBLICO]
  • PUT /payment-links/:ref [AUTH]
  • DELETE /payment-links/:ref [AUTH]
  • GET /payment-links/:ref/requests [AUTH]
  • GET /payment-links/:ref/requests/:cref [AUTH]

Órdenes de Pago ​

  • POST /approved [AUTH]
  • POST /orders/:orderid [AUTH]
  • GET /list/:orderid [AUTH]
  • GET /simulation [AUTH]
  • POST /orders/payvalida/notification [PÚBLICO]
  • POST /orders/paymentsway/notification [PÚBLICO]

Desembolsos ​

  • POST /check [AUTH]
  • POST /disbursements/payvalida/notification [PÚBLICO]

📋 Documentos y Archivos ​

  • GET /documents [AUTH]
  • GET /document/:document-id [AUTH]
  • GET /document/:document-id/pdf/:download_name [AUTH]
  • GET /debtors/documents [AUTH]
  • GET /debtors/document/:document-id [AUTH]
  • GET /debtors/document/:document-id/pdf/:download_name [AUTH]
  • GET /registration-document [PÚBLICO]
  • POST /registration-document [AUTH]
  • GET /miss-registration-document [AUTH]
  • GET /template/:templateid/preview [AUTH]
  • PATCH /template/:templateid/preview [AUTH]
  • GET /template/:templateid/public-preview [PÚBLICO]

✍️ Firmas Digitales ​

Firmas TOTP ​

  • POST /document/:document-id/signature-totp [AUTH]
  • PUT /document/:document-id/signature-totp/:signature-id [AUTH]
  • GET /document/:document-id/signature-totp/:signature-id/:field [AUTH]
  • GET /twilio/configuration-org/:configuration-org-id/entity/:entity-id/user/:user-id/document/:document-id/signature/:signature-id/code [AUTH]

Firmas SMS/Email ​

  • POST /document/:document-id/signature-sms-email [AUTH]
  • PUT /document/:document-id/signature-sms-email/:signature-id [AUTH]
  • GET /document/:document-id/signature-sms-email/:signature-id/:field [AUTH]

Firmas Scan ​

  • POST /document/:document-id/signature-scan [AUTH]
  • POST /document/:document-id/signature-scan/:signature-id/accept [AUTH]
  • GET /document/:document-id/signature-scan/:signature-id [AUTH]
  • GET /document/:document-id/signature-scan/:signature-id/:field [AUTH]
  • DELETE /document/:document-id/signature-scan/:signature-id/signature-file/:signature-file-id/:field [AUTH]

Solicitudes de Firma ​

  • POST /validate-id [AUTH]
  • GET /greet [AUTH]
  • GET /request-id [AUTH]
  • POST /signature-requests/:signature-request-id/email [AUTH]
  • POST /signature-requests/:signature-request-id/sign/attachment [AUTH]
  • POST /signature-requests/:signature-request-id/sign/voice [AUTH]
  • GET /ask-confirmation [AUTH]
  • POST /confirmation [AUTH]

📦 Envelopes ​

  • GET /envelopes [AUTH]
  • GET /envelope/:envelope-id [AUTH]
  • GET /envelope/:envelope-id/documents [AUTH]
  • GET /debtors/envelopes [AUTH]
  • POST /envelope [AUTH]
  • POST /envelope/:envelopeid/signature [AUTH]
  • PUT /envelope/:envelopeid/entity/:entityid/signature [AUTH]
  • POST /envelope-from-document [AUTH]
  • POST /envelope-from-link [AUTH]
  • PUT /envelopes/:envelopeid [AUTH]
  • PUT /envelopes/:envelopeid/methods/:method [AUTH]
  • PUT /envelopes/:envelopeid/entities/:entityid/:field [AUTH]
  • PUT /envelopes/:envelopeid/asked-temporary-field/:ask [AUTH]

✉️ Invitaciones y Colaboración ​

  • GET /invitations [AUTH]
  • GET /invitations/:invitation-id [AUTH]
  • PATCH /invitations/:invitation-id [AUTH]
  • DELETE /invitations/:invitation-id [AUTH]
  • PUT /invitations/:invitation-id/method/:method [AUTH]
  • GET /payable/:creditid/invitations [AUTH]
  • POST /payable/:creditid/invitations [AUTH]

🔄 Operaciones Masivas ​

  • POST /batch/file [AUTH]
  • POST /:batch-payment-id/order [AUTH]
  • GET /:batch-payment-id [AUTH]

🔌 Integraciones Externas ​

  • POST /xtsources [AUTH]
  • POST /xtsources/file [AUTH]
  • GET /third-party-config/:name [AUTH]
  • POST /third-party-config [AUTH]
  • PUT /third-party-config/:tpConfigID [AUTH]

Webhooks de Payvalida ​

  • GET /payvalida/webhook/orders/:reference [PÚBLICO]
  • POST /payvalida/webhook/orders/:reference [PÚBLICO]

📊 Reportes y Exportaciones ​

  • GET /export/receivables [AUTH]
  • GET /export/debtors [AUTH]
  • GET /export/debtors/credit-active [AUTH]
  • GET /export/debtors/credit-active/facturatech [AUTH]
  • GET /export/installments [AUTH]
  • GET /export/logs [AUTH]
  • GET /export/daily [AUTH]
  • GET /export/monthly [AUTH]
  • GET /export/orders [AUTH]
  • GET /export/orders/receivables [AUTH]
  • GET /export/orders/receivables/sse [AUTH]
  • GET /export/orders/file/:fileid [AUTH]
  • GET /export/disbursements [AUTH]
  • GET /export/datacredito [AUTH]
  • GET /export/procreditcsv [AUTH]
  • GET /export/payments [AUTH]
  • GET /export/safix [AUTH]
  • GET /export/safix-individual [AUTH]
  • GET /export/safix-clients [AUTH]
  • GET /export/quantitative-scoring [AUTH]
  • GET /export/transunion [AUTH]

Service Meter - Análisis de Uso y Métricas ​

📊 Paginación Eficiente: Todos los endpoints de Service Meter soportan el parámetro includeCount=true para obtener el total de elementos junto con los datos paginados, evitando múltiples consultas.

Parámetros de Paginación Comunes:

  • limit (int): Número máximo de elementos por página (por defecto: 100)
  • offset (int): Número de elementos a omitir (por defecto: 0)
  • includeCount (bool): Si es true, incluye el total de elementos en la respuesta
  • startDate (string): Fecha de inicio en formato YYYY-MM-DD
  • endDate (string): Fecha de fin en formato YYYY-MM-DD
  • feature (string): Filtrar por feature específico
  • tag (string): Clave del tag para filtrar
  • tagValue (string): Valor del tag para filtrar

Estructura de Respuesta con Paginación:

json
{
  "success": true,
  "data": {
    "logs": [...],        // o "dailyLogs" o "monthlyLogs" según el endpoint
    "total": 1500        // Solo cuando includeCount=true
  }
}

Logs Detallados ​

  • GET /organization/:entityid/service-meter/logs [AUTH]
    • Descripción: Obtiene registros detallados de uso del servicio
    • Paginación: Soporta includeCount para obtener total de elementos
    • Filtros: feature, tag, tagValue, startDate, endDate

Logs Agregados Diarios ​

  • GET /organization/:entityid/service-meter/daily-logs [AUTH]
    • Descripción: Obtiene métricas de uso agregadas por día
    • Paginación: Soporta includeCount para obtener total de elementos
    • Filtros: feature, startDate, endDate

Logs Agregados Mensuales ​

  • GET /organization/:entityid/service-meter/monthly-logs [AUTH]
    • Descripción: Obtiene métricas de uso agregadas por mes
    • Paginación: Soporta includeCount para obtener total de elementos
    • Filtros: feature, startDate, endDate

Logs Globales (Solo Administradores) ​

  • GET /service-meter/global/daily-logs [AUTH]

    • Descripción: Obtiene métricas globales agregadas por día (todos los clientes)
    • Paginación: Soporta includeCount para obtener total de elementos
    • Filtros: feature, after, before

  • GET /service-meter/global/monthly-logs [AUTH]

    • Descripción: Obtiene métricas globales agregadas por mes (todos los clientes)
    • Paginación: Soporta includeCount para obtener total de elementos
    • Filtros: feature, after, before

Resúmenes y Exportaciones ​

  • GET /organization/:entityid/service-meter/summary-logs [AUTH]
  • GET /organization/:entityid/service-meter/export/credit-analysis [AUTH]
  • GET /organization/:entityid/service-meter/export/credit-verification [AUTH]
  • GET /organization/:entityid/service-meter/export/credit-administration [AUTH]
  • GET /organization/:entityid/service-meter/export/consent-documents [AUTH]
  • GET /organization/:entityid/service-meter/export/sms-email-documents [AUTH]
  • GET /organization/:entityid/service-meter/export/voice-documents [AUTH]

📈 Estadísticas y Analytics ​

  • GET /stats/credits/completed [AUTH]
  • GET /stats/credits/by-debtor-id/completed/:debtorid [AUTH]

📚 Catálogos y Consultas ​

  • GET /cities [PÚBLICO]
  • GET /countries [PÚBLICO]
  • GET /countries/:countryCode/cities [PÚBLICO]
  • GET /currencies [PÚBLICO]
  • GET /health_providers [PÚBLICO]
  • GET /bank_entities [PÚBLICO]
  • GET /usury-rates [PÚBLICO]
  • GET /familycompensationfund [PÚBLICO]

🔔 Webhooks y Notificaciones ​

  • POST /webhook [AUTH]
  • GET /webhooks [AUTH]
  • GET /webhook/:webhookid [AUTH]
  • PUT /webhook/:webhookid [AUTH]
  • DELETE /webhook/:webhookid [AUTH]
  • POST /webhook-test [AUTH]
  • POST /webhook/:webhookid/request [AUTH]

⚙️ Reglas de Negocio y Configuración ​

Flujos de Decisión ​

  • POST /decision-flow [AUTH]
  • GET /decision-flows [AUTH]
  • GET /decision-flow/:decisionflowid [AUTH]
  • PUT /decision-flow/:decisionflowid [AUTH]
  • DELETE /decision-flow/:decisionflowid [AUTH]
  • GET /default-check-flow [AUTH]

Grupos de Reglas de Decisión ​

  • GET /:group_id [AUTH]
  • PUT /:group_id [AUTH]
  • DELETE /:group_id [AUTH]

Formularios y Campos ​

Campos Maestros y de Configuración ​

  • GET /profile-fields [AUTH] - List all master fields (public data)
  • GET /fields [AUTH] - Get all master fields (Field[]) for current session's configuration (replaces /organization/:entityid/config/:configid/profile-fields)
  • GET /config/form/fields [AUTH] - Get unique fields (FieldWithMetadata[]) from merged forms (all configured forms) with onlyAdmin metadata

Formularios - Administración (Propios) ​

  • GET /config/forms?type=legal|natural [AUTH] - Listar todos los formularios configurados mergeados (básico + personalizados)
  • GET /config/forms/:formid [AUTH] - Obtener un formulario específico por ID
  • GET /config/form/fields [AUTH] - Obtener campos únicos (FieldWithMetadata[]) de formularios mergeados con onlyAdmin
  • GET /config/forms/:formid/fields [AUTH] - Listar todos los campos de un formulario específico
  • GET /config/forms/:formid/fields/:fieldid [AUTH] - Obtener un campo específico de un formulario
  • GET /config/forms/:formid/fields/:fieldid/nested?profileID=:profileid [AUTH] - Obtener campos anidados para un campo específico

Formularios - Perfiles (Marca Blanca) ​

  • GET /entities/:entityid/config/forms?type=legal|natural [AUTH] - Listar todos los formularios configurados mergeados (básico + personalizados)
  • GET /entities/:entityid/config/forms?name=base&type=legal|natural|legal,natural [AUTH] - Obtener SOLO el formulario básico (no todos los formularios configurados)
  • GET /entities/:entityid/config/forms/:formid [AUTH] - Obtener un formulario específico de una entidad
  • GET /entities/:entityid/config/form/fields [AUTH] - Obtener campos únicos (FieldWithMetadata[]) de una entidad
  • GET /entities/:entityid/config/forms/:formid/fields [AUTH] - Listar campos de un formulario de una entidad
  • GET /entities/:entityid/config/forms/:formid/fields/:fieldid [AUTH] - Obtener un campo específico de un formulario de una entidad
  • GET /entities/:entityid/config/forms/:formid/fields/:fieldid/nested?profileID=:profileid [AUTH] - Obtener campos anidados de un formulario de una entidad

Nota importante:

  • Sin name=base: Retorna todos los formularios configurados mergeados (básico + personalizados)
  • Con name=base: Retorna SOLO el formulario básico (sin formularios personalizados)

Formularios de Créditos ​

  • GET /receivables/:creditid/forms?type=legal|natural [AUTH] - Get forms for receivable credit (all fields)
  • GET /payables/:creditid/forms?type=legal|natural [AUTH] - Get forms for payable credit (filtered fields)

Endpoints Legacy (DEPRECATED) ​

  • GET /organization/:entityid/config/:configid/profile-fields [AUTH] - DEPRECATED: Use GET /fields instead
  • GET /form/:type [AUTH] - DEPRECATED: Use GET /entities/:id/config/forms?name=base&type=... instead
  • GET /forms/:formid [AUTH] - DEPRECATED: Use GET /config/forms/:formid (admin) or GET /entities/:id/config/forms/:formid (profiles) instead
  • GET /forms?type=legal|natural [AUTH] - DEPRECATED: Use GET /config/forms?type=... (admin) or GET /entities/:id/config/forms?type=... (profiles) instead
  • GET /entities/:entityid/forms?type=legal|natural [AUTH] - DEPRECATED: Use GET /entities/:entityid/config/forms?type=... instead
  • GET /forms/:formid/fields [AUTH] - DEPRECATED: Use GET /config/forms/:formid/fields (admin) or GET /entities/:id/config/forms/:formid/fields (profiles) instead
  • GET /forms/:formid/fields/:fieldid [AUTH] - DEPRECATED: Use GET /config/forms/:formid/fields/:fieldid (admin) or GET /entities/:id/config/forms/:formid/fields/:fieldid (profiles) instead
  • GET /forms/:formid/fields/:fieldid/nested [AUTH] - DEPRECATED: Use GET /config/forms/:formid/fields/:fieldid/nested (admin) or GET /entities/:id/config/forms/:formid/fields/:fieldid/nested (profiles) instead
  • GET /forms/fields [AUTH] - DEPRECATED: Use GET /config/form/fields instead
  • POST /organization/:entityid/config/:configid/profile-field [AUTH]
  • PUT /organization/:entityid/config/:configid/profile-field [AUTH]
  • PUT /organization/:entityid/config/:configid/profile-field/:profilefieldid [AUTH]
  • DELETE /organization/:entityid/config/:configid/profile-field/:profilefieldid [AUTH]
  • POST /organization/:entityid/config/:configid/profile-group [AUTH]
  • PUT /organization/:entityid/config/:configid/profile-group/:id [AUTH]
  • GET /organization/:entityid/config/:configid/profile-groups [AUTH]

🛡️ Roles y Permisos ​

  • POST /debtor-organization/:debtororganizationid/role [AUTH]
  • GET /debtor-organization/:debtororganizationid/roles [AUTH]
  • GET /organization/:debtororganizationid/roles/:roleid [AUTH]
  • PUT /organization/:debtororganizationid/role [AUTH]
  • DELETE /organization/:debtororganizationid/role [AUTH]
  • DELETE /organization/:entityid/role [AUTH]
  • GET /roles/:role-id/entity/profile/:type/:field [AUTH]
  • POST /role-template [AUTH]
  • GET /role-template [AUTH]
  • GET /role-template/:roletemplateid [AUTH]
  • PUT /role-template/:roletemplateid [AUTH]
  • DELETE /role-template/:roletemplateid [AUTH]

🔗 Compartir y Solicitudes ​

  • POST /debtor/:debtorid/share-request [AUTH]
  • GET /debtor/:debtorid/share-requests [AUTH]
  • GET /debtor/:debtorid/share-request/:token [AUTH]
  • PUT /debtor/:debtorid/share-request/:token/:status [AUTH]
  • DELETE /debtor/:debtorid/share-request/:token [AUTH]
  • GET /share-requests [AUTH]
  • POST /debtor-organization/:debtororganizationid/share-request [AUTH]
  • GET /debtor-organization/:debtororganizationid/share-requests [AUTH]
  • GET /debtor-organization/:debtororganizationid/share-request/:token [AUTH]
  • PUT /debtor-organization/:debtororganizationid/share-request/:token/:status [AUTH]
  • DELETE /debtor-organization/:debtororganizationid/share-request/:token [AUTH]
  • GET /share-requests/organization/:organizationid [AUTH]
  • POST /organization/:organizationid/user/:userid/share-request [AUTH]
  • GET /organization/:organizationid/user/:userid/share-requests [AUTH]
  • PUT /organization/:organizationid/user/:userid/share-request [AUTH]

💼 Planes y Facturación ​

  • GET /plans [AUTH]
  • POST /plan [AUTH]
  • GET /plan/:plan-id [AUTH]
  • PUT /plan/:plan-id [AUTH]
  • GET /suscriptions [AUTH]
  • POST /suscription [AUTH]
  • GET /suscription/:suscription-id [AUTH]
  • PUT /suscription/:suscription-id [AUTH]
  • GET /bills [AUTH]
  • GET /bills/:suscription-id [AUTH]
  • GET /bill/:bill-id [AUTH]
  • GET /bill/:bill-id/abstract [AUTH]
  • GET /bill/:bill-id/export/abstract [AUTH]
  • GET /bill/:bill-id/export/summary [AUTH]
  • GET /bill/:bill-id/export/detail [AUTH]

📄 Certificados ​

  • GET /certificate/:documentid [PÚBLICO]

🔧 Herramientas Adicionales ​

Assets ​

  • GET /assets/favicon.png [PÚBLICO]
  • GET /assets/manifest.json [PÚBLICO]
  • GET /assets/external [PÚBLICO]

Verificaciones y Cheques ​

  • GET /:checkid [AUTH]
  • PATCH /:checkid/status [AUTH]
  • GET /checks/:checkid/logs [AUTH]
  • GET /:flowid [AUTH]
  • PUT /:flowid [AUTH]
  • PATCH /attach [AUTH]
  • PATCH /complete [AUTH]
  • PATCH /detach [AUTH]
  • GET /download [AUTH]
  • POST /validate [AUTH]
  • PUT /update [AUTH]
  • GET /entity/:entityid/sse/checks/:checkid [AUTH]

Entidades ​

  • POST /entity/:entityid/clients [AUTH]
  • GET /entity/:entityid/clients [AUTH]
  • GET /entity/:entityid/client/:clientid [AUTH]
  • PUT /entity/:entityid/client/:clientid [AUTH]
  • GET /entity/:entityid/client/:clientid/settings [AUTH]
  • PUT /entity/:entityid/client/:clientid/settings [AUTH]
  • GET /entity/:entityid/nickname/suggestion [AUTH]
  • PUT /entity/:entityid/nickname [AUTH]
  • POST /entity/:entityid/nickname/available [AUTH]

Límites de Crédito ​

  • GET /credit-limits [AUTH]
  • GET /credit-limits/:credit-limit-id [AUTH]
  • GET /creditor/credit-limits [AUTH]
  • GET /creditor/credit-limits/:credit-limit-id [AUTH]

Créditos de Pago ​

  • GET /credit/pay [AUTH]

--- Fin de endpoints --- ​

Total de endpoints documentados: 300+

Última actualización: $(date +"%Y-%m-%d")

Esta documentación se genera automáticamente a partir del código fuente y la especificación OpenAPI del proyecto. Los endpoints referencian el archivo error.yaml compartido para definiciones de errores consistentes.