Zelify Open API
Referencia de las APIs de Zelify para integrar productos y servicios financieros. Consulta los requisitos de cada operación, sus parámetros y las respuestas disponibles.
Punto de acceso de la API.
Autenticación (Collapsed)
Gestiona el acceso, la recuperación de credenciales y la verificación de usuarios y organizaciones en la plataforma.
- post/api/auth/organization/register
- post/api/auth/dashboard/login
- post/api/auth/dashboard/login/verify-otp
- post/api/auth/logout
- post/api/auth/refresh
- post/api/auth/service-token
- post/api/auth/service-token/refresh
- post/api/auth/password/forgot
- post/api/auth/password/reset
- post/api/auth/organizations/{id}/members/password/reset
- post/api/auth/password/change
- get/api/auth/users
- post/api/v2/auth/send-otp
- post/api/v2/auth/verify-otp
- post/api/v2/auth/signup
- post/api/v2/auth/login
- post/api/v2/auth/refresh
- post/api/v2/auth/logout
- get/api/v2/auth/me
- post/api/v2/auth/block-user
- post/api/v2/auth/unblock-user
- post/api/v2/auth/forgot-password
- post/api/v2/auth/verify-reset-otp
- post/api/v2/auth/reset-password
- post/api/v2/auth/signup/attributes
- get/api/v2/auth/signup/attributes
- get/api/v2/auth/signup/onboarding-schema
- put/api/v2/auth/signup/onboarding-extra
Registro de aplicación (Collapsed)
Acompaña el registro inicial de usuarios de la aplicación, incluyendo la verificación de correo, teléfono y credenciales.
- post/api/auth/app-register/start
- post/api/auth/app-register/verify-email
- post/api/auth/app-register/phone/send-otp
- post/api/auth/app-register/verify-phone
- post/api/auth/app-register/complete
- post/api/auth/app-register/app-login
- post/api/auth/app-register/forgot-password
- post/api/auth/app-register/verify-reset-otp
- post/api/auth/app-register/reset-password
Perfil y sesiones (Collapsed)
Permite consultar y actualizar el perfil autenticado, administrar sesiones activas y verificar cambios de correo o teléfono.
- get/api/me
- patch/api/me
- get/api/me/config
- get/api/me/sessions
- delete/api/me/sessions/{sessionId}
- patch/api/me/email/change
- patch/api/me/email/verify
- patch/api/me/phone/change
- patch/api/me/phone/verify
- post/api/me/photo
- get/api/v2/me
- patch/api/v2/me
- get/api/v2/me/config
- get/api/v2/me/sessions
- delete/api/v2/me/sessions/{sessionId}
- patch/api/v2/me/email/change
- patch/api/v2/me/email/verify
- patch/api/v2/me/phone/change
- patch/api/v2/me/phone/verify
- post/api/v2/me/photo
Correos y OTP (Collapsed)
Envía correos transaccionales y códigos de un solo uso utilizados en procesos de autenticación y verificación.
Extracción documental (Collapsed)
Incorpora y revisa documentos de identidad para obtener los datos requeridos durante la verificación del usuario.
Verificación biométrica (Collapsed)
Valida la coincidencia entre la fotografía del documento y la evidencia facial del usuario.
Prueba de vida (Collapsed)
Confirma que la evidencia facial corresponde a una persona presente durante el proceso de verificación.
Usuarios y analítica de identidad (Collapsed)
Consulta expedientes de identidad, verificaciones realizadas y métricas operativas asociadas a los usuarios.
Procesos de identidad (Collapsed)
Crea y administra flujos reutilizables de verificación documental, biométrica y de identidad.
Configuración de verificaciones (Collapsed)
Configura y activa los procesos de identidad disponibles para cada organización.
- post/api/organizations/{id}/identity-workflows
- get/api/organizations/{id}/identity-workflows
- get/api/organizations/{id}/identity-workflows/active
- get/api/organizations/{id}/identity-workflows/{workflowId}
- patch/api/organizations/{id}/identity-workflows/{workflowId}
- delete/api/organizations/{id}/identity-workflows/{workflowId}
Screening global (Collapsed)
Evalúa personas o entidades frente a las fuentes de cumplimiento disponibles y conserva el resultado de cada consulta.
- get/api/aml/screening/batches
- get/api/aml/screening/batch/{batch_screening_id}/result/{batch_result_id}
- get/api/aml/screening/batch/{batch_screening_id}
- post/api/aml/screening/batch
- get/api/aml/screenings
- get/api/aml/screenings/{screening_id}
- post/api/aml/screening
- get/api/v2/aml/screening/batches
- get/api/v2/aml/screening/batch/{batch_screening_id}/result/{batch_result_id}
- get/api/v2/aml/screening/batch/{batch_screening_id}
- post/api/v2/aml/screening/batch
- get/api/v2/aml/screenings
- get/api/v2/aml/screenings/{screening_id}
- post/api/v2/aml/screening
Monitoreo de operaciones (Collapsed)
Mantiene sujetos bajo revisión continua y permite consultar los cambios relevantes para el cumplimiento.
Listas globales (Collapsed)
Consulta el catálogo de fuentes de cumplimiento disponibles para las evaluaciones.
Listas internas (Collapsed)
Administra listas privadas de cada organización y permite identificar coincidencias con sus propios criterios de cumplimiento.
- post/api/aml/internal-lists
- get/api/aml/internal-lists
- post/api/aml/internal-lists/{list_short_name}/records/import
- get/api/aml/internal-lists/{list_short_name}/records/csv-template
- post/api/aml/internal-lists/{list_short_name}/records
- get/api/aml/internal-lists/{list_short_name}/records
- get/api/aml/internal-lists/{list_short_name}/records/{record_id}
- delete/api/aml/internal-lists/{list_short_name}/records/{record_id}
- post/api/aml/internal-lists/{list_short_name}/match
- post/api/v2/aml/internal-lists
- get/api/v2/aml/internal-lists
- post/api/v2/aml/internal-lists/{list_short_name}/records/import
- get/api/v2/aml/internal-lists/{list_short_name}/records/csv-template
- post/api/v2/aml/internal-lists/{list_short_name}/records
- get/api/v2/aml/internal-lists/{list_short_name}/records
- get/api/v2/aml/internal-lists/{list_short_name}/records/{record_id}
- delete/api/v2/aml/internal-lists/{list_short_name}/records/{record_id}
- post/api/v2/aml/internal-lists/{list_short_name}/match
Grupos de validación AML (Collapsed)
Configura conjuntos de fuentes y criterios de validación para los procesos de cumplimiento de la organización.
Riesgo de clientes (Collapsed)
Consolida indicadores de riesgo y cumplimiento asociados a cada cliente.
Transferencias (Collapsed)
Crea y consulta transferencias internas, interbancarias e internacionales, incluidos datos de beneficiario, estado y trazabilidad.
- post/api/organizations/{id}/transfers/internal
- get/api/organizations/{id}/transfers/internal
- get/api/organizations/{id}/transfers/account-lookup
- post/api/organizations/{id}/transfers/interbank
- get/api/organizations/{id}/transfers/interbank
- post/api/organizations/{id}/transfers/user-key
- post/api/organizations/{id}/transfers/international
- get/api/organizations/{id}/transfers/international
Claves personales (Collapsed)
Administra identificadores personales utilizados para localizar beneficiarios y simplificar el envío de fondos.
- post/api/organizations/{id}/users/{userId}/personal-keys
- get/api/organizations/{id}/users/{userId}/personal-keys
- get/api/organizations/{id}/users/{userId}/personal-keys/{keyId}
- patch/api/organizations/{id}/users/{userId}/personal-keys/{keyId}
- delete/api/organizations/{id}/users/{userId}/personal-keys/{keyId}
- get/api/organizations/{id}/personal-keys/lookup
Saldos y movimientos (Collapsed)
Consulta el saldo disponible y el historial de movimientos financieros asociados a un usuario.
Contactos (Collapsed)
Administra beneficiarios internos, interbancarios e internacionales y sincroniza contactos disponibles para transferencias.
- post/api/organizations/{id}/contacts
- get/api/organizations/{id}/contacts
- post/api/organizations/{id}/contacts/sync
- get/api/organizations/{id}/contacts/{contactId}
- delete/api/organizations/{id}/contacts/{contactId}
- get/api/organizations/{id}/users/{userId}/contacts
- post/api/organizations/{id}/users/{userId}/contacts
- get/api/organizations/{id}/users/{userId}/contacts/{contactId}
- patch/api/organizations/{id}/users/{userId}/contacts/{contactId}
- delete/api/organizations/{id}/users/{userId}/contacts/{contactId}
Contactos ZChat (Collapsed)
Gestiona los contactos utilizados por ZChat para iniciar conversaciones y solicitudes de pago.
Conversaciones y solicitudes de pago (Collapsed)
Gestiona conversaciones, mensajes y solicitudes de pago entre participantes de la plataforma.
Chat ZChat (Collapsed)
Crea conversaciones de ZChat, publica mensajes y permite aceptar o rechazar solicitudes de pago.
Gestión de tarjetas (Collapsed)
Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
- post/api/organizations/{id}/users/{userId}/cards
- get/api/organizations/{id}/users/{userId}/cards
- get/api/organizations/{id}/users/{userId}/cards/{cardId}/consumptions
- post/api/organizations/{id}/users/{userId}/cards/{cardId}/consumptions
- get/api/organizations/{id}/users/{userId}/cards/{cardId}/reveal
- patch/api/organizations/{id}/users/{userId}/cards/{cardId}/block
- patch/api/organizations/{id}/users/{userId}/cards/{cardId}/cancel
- patch/api/organizations/{id}/users/{userId}/cards/{cardId}/freeze
- patch/api/organizations/{id}/users/{userId}/cards/{cardId}/activate
- patch/api/organizations/{id}/users/{userId}/cards/{cardId}/limits
- post/api/organizations/{id}/users/{userId}/cards/{cardId}/fund
- post/api/organizations/{id}/users/{userId}/cards/{cardId}/report
- get/api/organizations/{id}/users/{userId}/cards/{cardId}/statement
Solicitar tarjeta
Permite solicitar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta. La solicitud considera account id y card type según corresponda.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required
Body·
- Type: stringaccount
_id requiredID de la cuenta a asociar con la tarjeta
- Type: "DEBITO_VIRTUAL_CUENTA" or "DEBITO_VIRTUAL_PREPAGO"enumcard
_type required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"account_id": "00000000-0000-0000-0000-000000000000",
"card_type": "DEBITO_VIRTUAL_CUENTA"
}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"bin": "string",
"last_four": "string",
"card_holder_name": "string",
"expiry_month": "string",
"expiry_year": "string",
"card_type": "DEBITO_VIRTUAL",
"status": "ACTIVE",
"balance": "string",
"currency": null,
"daily_limit": null,
"monthly_limit": null,
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"account_number": null,
"created_at": "2026-10-07T21:12:51.978Z",
"card_number": "string",
"cvv": "string",
"card_type_display": "string"
}Recurso creado correctamente.
Listar tarjetas del usuario
Permite listar tarjetas del usuario. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"bin": "string",
"last_four": "string",
"card_holder_name": "string",
"expiry_month": "string",
"expiry_year": "string",
"card_type": "DEBITO_VIRTUAL",
"status": "ACTIVE",
"balance": "string",
"currency": null,
"daily_limit": null,
"monthly_limit": null,
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"account_number": null,
"created_at": "2026-10-07T21:12:51.978Z"
}
]Operación realizada correctamente.
Obtener consumos
Permite obtener consumos. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/consumptions' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"card_id": "123e4567-e89b-12d3-a456-426614174000",
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"card_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": "string",
"currency": "string",
"description": null,
"reference_type": null,
"reference_id": null,
"account_number": null,
"created_at": "2026-10-07T21:12:51.978Z"
}
]
}Operación realizada correctamente.
Crear consumo
Permite crear consumo. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta. La solicitud considera amount, currency, description y reference type según corresponda.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Body·
- Type: numberamountrequired
Monto del consumo
- Type: stringcurrencyrequired
Moneda (3 caracteres)
- Type: stringdescription
Descripción del consumo
- Type: stringreference
_id ID de referencia externa
- Type: stringreference
_type Tipo de referencia (ej. compra_online)
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/consumptions' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 50.99,
"currency": "USD",
"description": "",
"reference_type": "",
"reference_id": ""
}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"card_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": "string",
"currency": "string",
"description": null,
"reference_type": null,
"reference_id": null,
"account_number": null,
"created_at": "2026-10-07T21:12:51.978Z"
}Recurso creado correctamente.
Revelar tarjeta
Permite revelar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/reveal' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"bin": "string",
"last_four": "string",
"card_holder_name": "string",
"expiry_month": "string",
"expiry_year": "string",
"card_type": "DEBITO_VIRTUAL",
"status": "ACTIVE",
"balance": "string",
"currency": null,
"daily_limit": null,
"monthly_limit": null,
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"account_number": null,
"created_at": "2026-10-07T21:12:51.978Z",
"card_number": "string",
"cvv": "string",
"card_type_display": "string"
}Operación realizada correctamente.
Bloquear tarjeta
Permite bloquear tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/block' \
--request PATCH \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "ACTIVE",
"message": "string"
}Operación realizada correctamente.
Cancelar tarjeta
Permite cancelar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/cancel' \
--request PATCH \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "ACTIVE",
"message": "string"
}Operación realizada correctamente.
Congelar tarjeta
Permite congelar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/freeze' \
--request PATCH \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "ACTIVE",
"message": "string"
}Operación realizada correctamente.
Activar tarjeta
Permite activar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/activate' \
--request PATCH \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "ACTIVE",
"message": "string"
}Operación realizada correctamente.
Ajustar límites
Permite ajustar límites. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta. La solicitud considera daily limit y monthly limit según corresponda.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Body·
- Type: numberdaily
_limit Límite diario en la moneda de la tarjeta
- Type: numbermonthly
_limit Límite mensual en la moneda de la tarjeta
Responses
- 200
Operación realizada correctamente.
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/limits' \
--request PATCH \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"daily_limit": 500,
"monthly_limit": 5000
}'
Operación realizada correctamente.
Recargar tarjeta
Permite recargar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta. La solicitud considera amount y currency según corresponda.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Body·
- Type: numberamountrequired
Monto a recargar en la tarjeta
- Type: stringcurrencyrequired
Moneda de la recarga
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/fund' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"amount": 500,
"currency": "MXN"
}'
{
"success": true,
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"card_id": "123e4567-e89b-12d3-a456-426614174000",
"new_card_balance": "string",
"new_account_balance": "string",
"message": "Recarga exitosa"
}Recurso creado correctamente.
Reportar tarjeta
Permite reportar tarjeta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta. La solicitud considera motivo y report type según corresponda.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Body·
- Type: stringmotivorequired
Motivo del reporte
- Type: stringenumreport
_type Tipo de reporte: ROBO, PERDIDA, FRAUDE, DANIO, OTRO
valuesROBOPERDIDAFRAUDEDANIOOTRO
Responses
- 201
Recurso creado correctamente.
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/report' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"motivo": "Tarjeta extraviada en transporte público",
"report_type": "OTRO"
}'
Recurso creado correctamente.
Estado de cuenta
Permite estado de cuenta. Solicita, consulta y administra tarjetas, consumos, límites, fondeos, bloqueos, activaciones, reportes y estados de cuenta.
Path Parameters
- Type: stringidrequired
- Type: stringuser
Id required - Type: stringcard
Id required
Query Parameters
- Type: stringdate
_from required - Type: stringdate
_to required
Responses
- 200
Operación realizada correctamente.
- application/json
- application/json
- application/json
- application/json
curl '/api/organizations/{id}/users/{userId}/cards/{cardId}/statement?date_from=&date_to=' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
Operación realizada correctamente.
Catálogo y recargas (Collapsed)
Consulta y administra servicios disponibles, además de ejecutar recargas para usuarios de una organización.
- get/api/organizations/{id}/basic-services
- post/api/organizations/{id}/basic-services
- get/api/organizations/{id}/basic-services/{serviceId}
- patch/api/organizations/{id}/basic-services/{serviceId}
- delete/api/organizations/{id}/basic-services/{serviceId}
- post/api/organizations/{id}/basic-services/users/{userId}/{serviceId}/recharge
Favoritos de servicios (Collapsed)
Guarda y administra cuentas o referencias frecuentes utilizadas para pagar servicios.
- get/api/organizations/{id}/users/{userId}/basic-service-favorites
- post/api/organizations/{id}/users/{userId}/basic-service-favorites
- get/api/organizations/{id}/users/{userId}/basic-service-favorites/{favoriteId}
- patch/api/organizations/{id}/users/{userId}/basic-service-favorites/{favoriteId}
- delete/api/organizations/{id}/users/{userId}/basic-service-favorites/{favoriteId}
Pagos de servicios (Collapsed)
Ejecuta pagos de servicios para un usuario y registra la operación asociada.
Deudas de proveedores (Collapsed)
Consulta obligaciones pendientes con proveedores y procesa pagos de deudas internas o externas.
Onboarding KYC (Collapsed)
Gestiona sesiones de onboarding para recopilar, verificar y completar la información de identidad de una persona.
- post/api/v2/kyc-onboarding/sessions
- get/api/v2/kyc-onboarding/sessions
- get/api/v2/kyc-onboarding/sessions/{sessionId}
- post/api/v2/kyc-onboarding/sessions/{sessionId}/otp/email/send
- post/api/v2/kyc-onboarding/sessions/{sessionId}/otp/email/verify
- post/api/v2/kyc-onboarding/sessions/{sessionId}/otp/phone/send
- post/api/v2/kyc-onboarding/sessions/{sessionId}/otp/phone/verify
- post/api/v2/kyc-onboarding/sessions/{sessionId}/register
- post/api/v2/kyc-onboarding/sessions/{sessionId}/resume
- post/api/v2/kyc-onboarding/sessions/{sessionId}/refresh
- post/api/v2/kyc-onboarding/sessions/{sessionId}/complete
- get/api/v2/kyc-onboarding/identity/workflow
- post/api/v2/kyc-onboarding/identity/extract
- post/api/v2/kyc-onboarding/identity/liveness/session
- get/api/v2/kyc-onboarding/identity/liveness/session/{livenessSessionId}/result
- post/api/v2/kyc-onboarding/identity/facematch
Casos KYC asistidos (Collapsed)
Permite a asesores crear, revisar y completar expedientes KYC con acompañamiento operativo.
- post/api/advisor-kyc/cases
- get/api/advisor-kyc/cases
- get/api/advisor-kyc/cases/{caseId}
- patch/api/advisor-kyc/cases/{caseId}
- post/api/advisor-kyc/cases/{caseId}/otp/email/send
- post/api/advisor-kyc/cases/{caseId}/otp/email/verify
- post/api/advisor-kyc/cases/{caseId}/otp/phone/send
- post/api/advisor-kyc/cases/{caseId}/otp/phone/verify
- post/api/advisor-kyc/cases/{caseId}/documents/id
- post/api/advisor-kyc/cases/{caseId}/liveness/link
- get/api/advisor-kyc/cases/{caseId}/liveness
- post/api/advisor-kyc/cases/{caseId}/facematch
- post/api/advisor-kyc/cases/{caseId}/commit-user
Onboarding de organizaciones (Collapsed)
Recopila información legal, técnica y documental necesaria para habilitar una organización.
- get/api/organizations/{organizationId}/onboarding/status
- post/api/organizations/{organizationId}/onboarding/kyb-files
- post/api/organizations/{organizationId}/onboarding/aml-files
- post/api/organizations/{organizationId}/onboarding/business-plan
- post/api/organizations/{organizationId}/onboarding/additional-info
- get/api/organizations/onboarding/visibility
- patch/api/organizations/onboarding/visibility
Organizaciones y configuración (Collapsed)
Administra organizaciones, configuración, servicios habilitados, identidad visual y parámetros operativos.
- get/api/organizations/available-scopes
- get/api/organizations/{id}/scopes
- post/api/organizations/{id}/scopes
- delete/api/organizations/{id}/scopes/{scope}
- get/api/organizations
- post/api/organizations
- get/api/organizations/{id}/branding
- patch/api/organizations/{id}/branding
- get/api/organizations/{id}
- patch/api/organizations/{id}
- post/api/organizations/{id}/branding/logo
- get/api/organizations/{id}/config
- patch/api/organizations/{id}/config
- get/api/organizations/{id}/config/identity
- patch/api/organizations/{id}/config/identity
- get/api/organizations/{id}/config/auth
- get/api/organizations/{id}/config/aml
- get/api/v2/organization
Credenciales API (Collapsed)
Crea, consulta, rota y revoca credenciales de integración pertenecientes a una organización.
Clientes de organización (Collapsed)
Consulta y administra clientes vinculados a una organización y su información básica.
Solicitudes a producción (Collapsed)
Gestiona solicitudes de habilitación productiva, revisión de requisitos y seguimiento de su estado.
Usuarios (Collapsed)
Administra perfiles de usuario, membresías, estados, fotografías y datos de onboarding.
- get/api/organizations/{id}/users
- post/api/organizations/{id}/users
- get/api/organizations/{id}/users/search
- patch/api/organizations/{id}/users/batch/status
- post/api/organizations/{id}/users/batch/roles
- delete/api/organizations/{id}/users/batch/roles
- post/api/organizations/{id}/users/batch/reset-password
- post/api/organizations/{id}/users/batch/set-password
- get/api/organizations/{id}/users/{userId}
- patch/api/organizations/{id}/users/{userId}
- post/api/organizations/{id}/users/{userId}/reset-password
- post/api/organizations/{id}/users/{userId}/set-password
- patch/api/organizations/{id}/users/{userId}/dashboard-otp
- post/api/organizations/{id}/users/{userId}/roles
- delete/api/organizations/{id}/users/{userId}/roles/{roleId}
- post/api/organizations/{id}/users/{userId}/photo
- post/api/organizations/{id}/users/lookup
- get/api/users/registered
- get/api/users/registered/{userId}
Dashboard (Collapsed)
Expone resúmenes operativos y funciones administrativas utilizadas por el dashboard de cada organización.
Miembros del dashboard (Collapsed)
Crea, consulta y administra miembros con acceso administrativo al dashboard.
Roles (Collapsed)
Consulta y administra los roles disponibles para asignar permisos a miembros de una organización.
Menú de aplicación (Collapsed)
Devuelve la estructura de navegación y opciones habilitadas para el usuario autenticado.
Cuentas (Collapsed)
Crea y consulta cuentas financieras vinculadas a usuarios, monedas y productos disponibles.
Cuentas conjuntas (Collapsed)
Administra cuentas compartidas y la participación de sus titulares.
Vinculación y verificación bancaria (Collapsed)
Vincula cuentas bancarias, valida credenciales y consulta la información recuperada de las instituciones conectadas.
Conexión bancaria (Collapsed)
Gestiona conexiones bancarias y consulta cuentas, titulares y movimientos obtenidos mediante integraciones financieras.
Bancos externos (Collapsed)
Consulta información bancaria externa asociada a usuarios y organizaciones.
Descuentos, comercios y cupones (Collapsed)
Administra comercios, promociones, descuentos, cupones, disponibilidad y redenciones.
- get/api/discounts/merchants/me/resolve-merchant
- post/api/discounts/merchants/onboarding
- post/api/discounts/merchants
- get/api/discounts/merchants
- get/api/discounts/merchants/nearby
- get/api/discounts/merchants/{merchantId}
- patch/api/discounts/merchants/{merchantId}
- get/api/discounts/merchants/{merchantId}/organizations
- post/api/discounts/merchants/{merchantId}/logo
- patch/api/discounts/merchants/{merchantId}/deactivate
- post/api/discounts/merchants/{merchantId}/branches
- get/api/discounts/merchants/{merchantId}/branches
- get/api/discounts/merchants/{merchantId}/branches/{branchId}
- patch/api/discounts/merchants/{merchantId}/branches/{branchId}
- patch/api/discounts/merchants/{merchantId}/branches/{branchId}/geolocation
- patch/api/discounts/merchants/{merchantId}/branches/{branchId}/deactivate
- post/api/discounts/merchants/{merchantId}/categories
- get/api/discounts/merchants/{merchantId}/categories
- patch/api/discounts/merchants/{merchantId}/categories/{categoryId}
- post/api/discounts/merchants/{merchantId}/products
- get/api/discounts/merchants/{merchantId}/products
- get/api/discounts/merchants/{merchantId}/products/{productId}
- patch/api/discounts/merchants/{merchantId}/products/{productId}
- delete/api/discounts/merchants/{merchantId}/products/{productId}
- patch/api/discounts/merchants/{merchantId}/products/{productId}/activate
- patch/api/discounts/merchants/{merchantId}/products/{productId}/deactivate
- post/api/discounts/merchants/{merchantId}/discounts
- get/api/discounts/merchants/{merchantId}/discounts
- get/api/discounts/merchants/{merchantId}/reports/redemptions
- get/api/discounts/merchants/{merchantId}/reports/summary
- get/api/discounts/merchants/{merchantId}/analytics
- get/api/discounts/discounts
- get/api/discounts/discounts/{discountId}
- patch/api/discounts/discounts/{discountId}
- get/api/discounts/discounts/{discountId}/organizations
- get/api/discounts/discounts/{discountId}/analytics
- patch/api/discounts/discounts/{discountId}/activate
- patch/api/discounts/discounts/{discountId}/deactivate
- get/api/discounts/discounts/{discountId}/coupons
- post/api/discounts/discounts/{discountId}/coupons
- get/api/discounts/coupons/by-code/{code}
- get/api/discounts/coupons/share-token/{token}
- post/api/discounts/coupons/share
- post/api/discounts/coupons/redeem
- post/api/discounts/coupons/confirm-use
- patch/api/discounts/coupons/{id}/deactivate
- get/api/organizations/{id}/discounts/merchants
- get/api/organizations/{id}/discounts/merchants/nearby
- get/api/organizations/{id}/discounts/discounts
- post/api/organizations/{id}/discounts/merchants/{merchantId}
- patch/api/organizations/{id}/discounts/merchants/{merchantId}
- delete/api/organizations/{id}/discounts/merchants/{merchantId}
- post/api/organizations/{id}/discounts/discounts/{discountId}
- patch/api/organizations/{id}/discounts/discounts/{discountId}
- delete/api/organizations/{id}/discounts/discounts/{discountId}
- get/api/organizations/{id}/discounts/claims
- patch/api/organizations/{id}/discounts/claims/{claimId}/cancel
- get/api/organizations/{id}/discounts/reports/redemptions
- get/api/organizations/{id}/discounts/reports/summary
- post/api/organizations/{id}/discounts/coupons/redeem
- post/api/v2/discounts/merchants
- get/api/v2/discounts/merchants
- get/api/v2/discounts/merchants/nearby
- get/api/v2/discounts/merchants/{merchantId}
- patch/api/v2/discounts/merchants/{merchantId}
- patch/api/v2/discounts/merchants/{merchantId}/deactivate
- post/api/v2/discounts/merchants/{merchantId}/branches
- get/api/v2/discounts/merchants/{merchantId}/branches
- get/api/v2/discounts/merchants/{merchantId}/branches/{branchId}
- patch/api/v2/discounts/merchants/{merchantId}/branches/{branchId}
- patch/api/v2/discounts/merchants/{merchantId}/branches/{branchId}/geolocation
- patch/api/v2/discounts/merchants/{merchantId}/branches/{branchId}/deactivate
- post/api/v2/discounts/merchants/{merchantId}/categories
- get/api/v2/discounts/merchants/{merchantId}/categories
- patch/api/v2/discounts/merchants/{merchantId}/categories/{categoryId}
- post/api/v2/discounts/merchants/{merchantId}/products
- get/api/v2/discounts/merchants/{merchantId}/products
- get/api/v2/discounts/merchants/{merchantId}/products/{productId}
- patch/api/v2/discounts/merchants/{merchantId}/products/{productId}
- delete/api/v2/discounts/merchants/{merchantId}/products/{productId}
- patch/api/v2/discounts/merchants/{merchantId}/products/{productId}/activate
- patch/api/v2/discounts/merchants/{merchantId}/products/{productId}/deactivate
- post/api/v2/discounts/merchants/{merchantId}/discounts
- get/api/v2/discounts/merchants/{merchantId}/discounts
- get/api/v2/discounts/merchants/{merchantId}/reports/redemptions
- get/api/v2/discounts/merchants/{merchantId}/reports/summary
- get/api/v2/discounts/merchants/{merchantId}/analytics
- get/api/v2/discounts/discounts
- get/api/v2/discounts/discounts/{discountId}
- patch/api/v2/discounts/discounts/{discountId}
- patch/api/v2/discounts/discounts/{discountId}/activate
- patch/api/v2/discounts/discounts/{discountId}/deactivate
- get/api/v2/discounts/discounts/{discountId}/coupons
- post/api/v2/discounts/discounts/{discountId}/coupons
- get/api/v2/discounts/discounts/{discountId}/analytics
- get/api/v2/discounts/coupons/by-code/{code}
- get/api/v2/discounts/coupons/share-token/{token}
- post/api/v2/discounts/coupons/share
- post/api/v2/discounts/coupons/redeem
- post/api/v2/discounts/coupons/confirm-use
- patch/api/v2/discounts/coupons/{id}/deactivate
- get/api/v2/discounts/claims
- patch/api/v2/discounts/claims/{claimId}/cancel
- get/api/v2/discounts/reports/redemptions
- get/api/v2/discounts/reports/summary
Administración de descuentos (Collapsed)
Expone configuración, visibilidad y analítica administrativa de campañas de descuentos.
- get/api/discounts/admin/analytics/overview
- get/api/discounts/admin/analytics/top-merchants
- get/api/discounts/admin/analytics/top-organizations
- get/api/discounts/admin/analytics/top-discounts
- get/api/discounts/admin/analytics/funnel
- get/api/discounts/admin/analytics/by-country
- get/api/discounts/admin/analytics/by-merchant-type
- get/api/discounts/admin/analytics/executive-comparisons
- get/api/discounts/admin/analytics/timeseries
- get/api/discounts/admin/analytics/recent-activity
- get/api/discounts/admin/analytics/dashboard
- get/api/discounts/admin/visibility-relations
Catálogo de productos (Collapsed)
Consulta y administra productos, subproductos, servicios y precios disponibles para las organizaciones.
- get/api/catalog/products
- post/api/catalog/products
- patch/api/catalog/products/{productId}
- get/api/catalog/products/{productId}/sub-products
- post/api/catalog/sub-products
- patch/api/catalog/sub-products/{subProductId}
- get/api/catalog/sub-products/{subProductId}/services
- post/api/catalog/services
- patch/api/catalog/services/{serviceId}
Permisos de productos (Collapsed)
Controla qué productos y capacidades están habilitados para cada organización.
- get/api/organizations/{id}/entitlements/products
- put/api/organizations/{id}/entitlements/products/{productId}
- get/api/organizations/{id}/entitlements/sub-products
- put/api/organizations/{id}/entitlements/sub-products/{subProductId}
- get/api/organizations/{id}/entitlements/services
- put/api/organizations/{id}/entitlements/services/{serviceId}
Checkout BNPL (Collapsed)
Crea y procesa sesiones de compra financiada, incluyendo validación del cliente y plan de pago.
Clientes BNPL (Collapsed)
Consulta y administra clientes elegibles para productos de compra ahora y paga después.
Mensajería SMS (Collapsed)
Envía mensajes SMS mediante proveedores regionales y consulta los registros de entrega.
OTP por WhatsApp (Collapsed)
Envía códigos de verificación de un solo uso a través de WhatsApp.
Notificaciones por email (Collapsed)
Envía notificaciones por correo y administra la configuración necesaria para su entrega.
Notificaciones por correo (Collapsed)
Ejecuta envíos de correo utilizados por la integración y demostraciones de Pegala.
Plantillas (Collapsed)
Administra plantillas reutilizables de comunicación y contenido por organización.
Referidos (Collapsed)
Gestiona códigos, invitaciones y métricas del programa de referidos de usuarios.
Asistente Alaiza (Collapsed)
Procesa consultas del asistente financiero y genera respuestas basadas en el contexto autorizado de la organización.
Análisis de consumo (Collapsed)
Clasifica consumos y entrega análisis de comportamiento financiero a partir de transacciones registradas.
Educación financiera (Collapsed)
Ofrece contenido y recomendaciones educativas basadas en la actividad financiera del usuario.
Encuestas (Collapsed)
Publica encuestas y registra las respuestas proporcionadas por los usuarios.
Información de dispositivos (Collapsed)
Registra señales técnicas del dispositivo y dirección IP utilizadas para seguridad y trazabilidad.
Inteligencia de dispositivos (Collapsed)
Evalúa señales de dispositivo para identificar riesgo, anomalías y contexto de acceso.
Geolocalización (Collapsed)
Resuelve y normaliza ubicaciones utilizadas por servicios, comercios y controles de seguridad.
Webhooks (Collapsed)
Configura suscripciones, eventos y entregas de webhooks, incluido el seguimiento de reintentos.
Automatizaciones (Collapsed)
Recibe y procesa eventos relacionados con los flujos de evaluación administrados por plataforma.
Integraciones comerciales (Collapsed)
Consulta y sincroniza datos utilizados por la integración comercial de Big Bola Edibles.
Actualización de datos de microfinanzas (Collapsed)
Sincroniza catálogos y datos operativos con la plataforma de microfinanzas.
Prospectos de microfinanzas (Collapsed)
Registra y administra prospectos antes de convertirlos en clientes de microfinanzas.
Clientes de microfinanzas (Collapsed)
Consulta y administra clientes registrados en la plataforma de microfinanzas.
Ofertas de crédito (Collapsed)
Consulta y gestiona ofertas crediticias disponibles para clientes elegibles.
Productos de microfinanzas (Collapsed)
Consulta los productos financieros habilitados por la plataforma de microfinanzas.
Movimientos de microfinanzas (Collapsed)
Consulta transacciones y movimientos registrados para productos de microfinanzas.
Solicitudes de crédito (Collapsed)
Crea y consulta solicitudes de crédito y su proceso de evaluación.
Créditos (Collapsed)
Consulta y administra créditos originados, sus estados y condiciones.
Pagos de crédito (Collapsed)
Registra y consulta pagos, prepagos y procesamiento de cuotas de créditos.
Comercios asociados (Collapsed)
Procesa operaciones originadas por comercios asociados e identifica el agregador responsable de cada petición.
Notificaciones de microfinanzas (Collapsed)
Recibe notificaciones de cambios y eventos emitidos por la plataforma de microfinanzas.
Herramientas (Collapsed)
Agrupa operaciones auxiliares de diagnóstico y compatibilidad de la plataforma.
Hello (prueba de API keys)
Permite hello (prueba de API keys). Agrupa operaciones auxiliares de diagnóstico y compatibilidad de la plataforma. La solicitud considera api key y api secret según corresponda.
Headers
- Type: stringx
-api -secret API Secret (sk_...). Opcional si envías api_secret en el body.
- Type: stringx
-api -key API Key (zk_...). Opcional si envías api_key en el body.
Body·
Opcional: envía api_key y api_secret aquí si no usas headers. Si usas headers, el body puede ir vacío {}.
- Type: stringapi
_key API Key de la organización (zk_...). Opcional si envías x-api-key en el header.
- Type: stringapi
_secret API Secret de la organización (sk_...). Opcional si envías x-api-secret en el header.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
curl /api/v2/hello \
--request POST \
--header 'Content-Type: application/json' \
--data '{
"api_key": "zk_xxxxxxxxxxxx",
"api_secret": "sk_xxxxxxxxxxxx"
}'
{
"message": "Hello",
"organization_id": "123e4567-e89b-12d3-a456-426614174000"
}Operación realizada correctamente.
