connectedAccounts

Crear una cuenta conectada

Changed on

Crea una cuenta administrada por tu plataforma, la conecta a tu cuenta y marca el onboarding como completado. Si ya tienes una cuenta conectada para el mismo email, Recurrente la reutiliza y actualiza sus datos (idempotencia por email del administrador).

Para reenviar documentos, usa este mismo POST con la llave de la plataforma en X-SECRET-KEY, el mismo email y los archivos que quieres reemplazar en verification. No necesitas X-ACCOUNT-ID: este endpoint administra las cuentas conectadas desde la plataforma. La respuesta es 200 y conserva el mismo ID de cuenta; crear una cuenta nueva devuelve 201. Los documentos omitidos se conservan. Si no envías documentos, reutilizar la cuenta no vuelve a ejecutar su verificación.

Recurrente extrae automáticamente el tax_id (NIT) y el tax_name (razón social) del documento tax_registration_document (RTU) que envías en verification — no necesitas enviarlos en el request.

Debes enviar la documentación requerida para el tipo de cuenta en verification. Si faltan documentos requeridos, Recurrente responde 400 y no completa el onboarding de la cuenta.

Una respuesta 200 o 201 no significa que los documentos estén aprobados. Si se rechaza un documento durante su procesamiento, se emite verification.rejected con document_errors, también para los reenvíos. Cuando la verificación es aceptada se emite verification.completed. No se emite ese evento por cada carga: tiene que ocurrir un rechazo. Un reemplazo rechazado conserva el documento previamente aceptado y no revierte por sí solo una verificación ya completada.

Usa los nombres del esquema: para el DPI del representante legal de una empresa, verification[company_representative_id] y verification[company_representative_id_back]. Los campos legal_representative_id y legal_representative_selfie no están admitidos.

Puedes enviar bank_account para configurar de una vez la cuenta bancaria externa que recibirá retiros. Si tu cuenta tiene pricing especial para referidos, ese pricing se aplica a las cuentas conectadas nuevas.

Al crear o reutilizar la conexión, Recurrente emite el webhook account_connection.create con los campos parent_account y child_account.

post/connected_accounts

Request

Request body multipart/form-data

emailstring email required

Email del usuario administrador de la cuenta hija. Sirve como llave de idempotencia: si vuelves a llamar este endpoint con el mismo email, Recurrente reutiliza la cuenta conectada existente.

full_namestring required

Nombre completo del usuario administrador

phone_numberstring

Número de teléfono del usuario administrador

namestring required

Nombre comercial de la cuenta hija

account_type'business' | 'individual' | 'non_profit' required

Tipo de cuenta de negocio

withdrawals_schedule'daily' | 'manual' | 'instant'

Frecuencia para retiros de la cuenta hija

Response

Cuenta conectada existente reutilizada; los documentos enviados se procesan de nuevo

idstring

ID único de la cuenta conectada

statusstring

Estado de la cuenta

namestring

Nombre comercial de la cuenta

account_type'business' | 'individual' | 'non_profit'

Tipo de cuenta de negocio

created_atstring date-time

Fecha de creación

creator_namestring

Nombre del usuario creador

creator_emailstring email

Email del usuario creador

tax_idstring nullable

NIT extraído del RTU; si no está disponible, se conserva el ID fiscal previamente guardado en la cuenta.

tax_namestring nullable

Razón social extraída del RTU; si no está disponible, se conserva el nombre fiscal previamente guardado en la cuenta.

withdrawals_schedule'daily' | 'manual' | 'instant'

Frecuencia configurada para retiros

onboarding_completedboolean

Indica si la cuenta completó onboarding

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API