Onboarding y KYB

Koywe expone una superficie pública de onboarding para flujos de registro y una superficie pública de KYB para verificación de merchants. Son flujos distintos pero relacionados.

Dos Flujos Públicos

Pre-Onboarding de Usuario

Usa estos endpoints para crear y enviar borradores de registro:

POST /api/v1/pre-onboarding/registration-draft
PUT /api/v1/pre-onboarding/registration-draft/{draftId}
GET /api/v1/pre-onboarding/registration-draft/{draftId}
POST /api/v1/pre-onboarding/registration-form/{draftId}
GET /api/v1/pre-onboarding/registrations
GET /api/v1/pre-onboarding/registrations/{registrationId}/status

KYB de Merchant

Usa estos endpoints cuando el merchant ya existe y está listo para verificación:

POST /api/v1/organizations/{organizationId}/merchants/{merchantId}/onboarding/kyb
GET /api/v1/organizations/{organizationId}/merchants/{merchantId}/onboarding/kyb
GET /api/v1/organizations/{organizationId}/merchants/{merchantId}/onboarding/kyb/{kybId}

Flujo Recomendado

Consultar Estado Actual de Onboarding

El usuario autenticado puede consultar sus evaluaciones con:

GET /api/v1/onboarding/me

Disparar KYB de Merchant


curl -X POST 'https://api-sandbox.koywe.com/api/v1/organizations/TU_ORG_ID/merchants/TU_MERCHANT_ID/onboarding/kyb' \
  -H 'Authorization: Bearer TU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "forceRetrigger": false
  }'

Después de dispararlo, consulta el endpoint de estado hasta que exista la URL del proveedor o un estado final.

Buenas Prácticas

Guarda los IDs de borrador para que el usuario pueda reanudar.
Trata KYB como un proceso asíncrono.
Separa en tu modelo interno “registro completado” de “merchant KYB aprobado”.