Skip to main content

Descripción general

La query getBusiness devuelve el estado KYB actual de una cuenta de negocio, junto con una instantánea de la lista de propietarios y en qué etapa está cada dueño en la verificación de identidad. Así es como respondes dos preguntas distintas después de registrar un negocio:
  • ¿Ya fue aprobado el negocio? Lee kybStatus.
  • ¿Qué lo está demorando? Lee owners — un dueño aún en PENDING_CIP o PENDING_INVITE suele ser la respuesta.
También puedes recibir cambios de estado suscribiéndote al webhook KYB_STATUS_UPDATE, lo que evita lecturas programadas. El webhook solo lleva el estado del negocio, así que llama esta query cuando necesites la lista de dueños. Ver Seguimiento de una solicitud.

Alcances requeridos

La query no recibe argumentos — siempre resuelve el negocio vinculado al accountId del token que llama. Usa un token emitido para la cuenta de negocio que devolvió registerBusiness; el token de consumidor con el que te registraste no funcionará.
Cuando Fluz crea el otorgamiento OAuth del negocio durante el registro, REGISTER_BUSINESS se incluye forzosamente en los scopes de ese otorgamiento, por lo que un token emitido para la nueva cuenta de negocio siempre puede llamar esta query.

Estructura básica de la query

Detalles de la respuesta

BusinessOwnerStatus

ExternalKybStatus (enum)

registerBusiness devuelve SUBMITTED, que no es un valor de este enum — ese mismo momento aquí se lee como PENDING.
PENDING agrupa varios estados internos en un solo valor. Eso importa en un caso: requestOwnerDocumentVerificationLink solo funciona mientras el caso está en un estado interno específico, y kybStatus no puede decirte en cuál estás.

BusinessOwnerVerificationType (enum)

ExternalBusinessOwnerStatus (enum)

Ejemplo cURL

Respuesta de ejemplo

Jane necesita un enlace de verificación. Carol fue invitada y Fluz le enviará un email. El negocio no puede ser aprobado hasta que ambas lleguen a READY.

Códigos de error

Esta query devuelve todos los fallos en el arreglo superior errors — no hay un payload success: false.

Mejores prácticas

  • Prefiere el webhook y lee para conciliación. Suscríbete a KYB_STATUS_UPDATE para menor latencia, y lee esta query cuando el usuario regrese a tu pantalla de onboarding o en una programación en segundo plano de baja frecuencia — por hora, no por carga de página.
  • Espera ambas señales antes de salir a producción. kybStatus: APPROVED y cada dueño en READY.
  • No trates una solicitud de enlace como progreso. El status de un dueño cambia cuando realmente completa la verificación, no cuando generas su enlace.

Páginas relacionadas

Resumen de KYB

El ciclo de vida del estado y cómo rastrear un caso hasta la decisión.

Enlace de verificación del dueño

Genera un enlace para dueños reportados como DOCUMENTS y PENDING_CIP.

Registrar un negocio

La mutación que crea la cuenta que lee esta query.