Obtener onboardings

Consulta el estado de uno o todos los onboardings de un cliente.

Obtener todos los onboardings

GET/v1/onboardings

Request

Headers

Campo	Tipo	Requerido	Descripción
`Authorization`	string	Sí	Token de acceso en formato `Bearer ACCESS_TOKEN`

No aplica: Path Parameters, Body.

Query Parameters

Campo	Tipo	Requerido	Descripción
`search_type`	string	No	Tipo de búsqueda. Valor posible: `SUBMITTED`. Valor por defecto: `SUBMITTED`.
`page`	integer	No	Número de página (base 0). Valor por defecto: `0`.
`size`	integer	No	Resultados por página (mínimo 1). Valor por defecto: `20`.
`referrer`	string	No	Filtra por referido

Ejemplo de código

cURL
JavaScript
Python
Node.js

curl -X GET "https://b2b.allaria.cloud/v1/onboardings?search_type=SUBMITTED&page=0&size=20" \
  -H "Authorization: Bearer ACCESS_TOKEN"

const params = new URLSearchParams({ search_type: 'SUBMITTED', page: 0, size: 20 });

const response = await fetch(`https://b2b.allaria.cloud/v1/onboardings?${params}`, {
  headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://b2b.allaria.cloud/v1/onboardings',
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' },
  params={ 'search_type': 'SUBMITTED', 'page': 0, 'size': 20 }
)

print(response.json())

const axios = require('axios');

const { data } = await axios.get(
  'https://b2b.allaria.cloud/v1/onboardings',
  {
    headers: { Authorization: 'Bearer ACCESS_TOKEN' },
    params: { search_type: 'SUBMITTED', page: 0, size: 20 }
  }
);

console.log(data);

Response

2XX Éxito

{
  "content": [
    {
      "externalCode": "550e8400-e29b-41d4-a716-446655440000",
      "state": "PENDING",
      "referrer": "referrer-id",
      "accounts": null
    },
    {
      "externalCode": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "state": "APPROVED",
      "referrer": "referrer-id",
      "accounts": [
        {
          "accountId": "100012345",
          "state": "COMPLETED",
          "type": "ALLARIAMAS_INTERNAL"
        },
        {
          "accountId": "12345",
          "state": "COMPLETED",
          "type": "ALLARIAMAS",
          "cvu": "0000099900000000012345"
        },
        {
          "accountId": "20000001",
          "state": "COMPLETED",
          "type": "ALLARIA"
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 2,
  "first": true,
  "last": true,
  "size": 20,
  "number": 0,
  "numberOfElements": 2,
  "empty": false
}

Obtener un onboarding por ID

GET/v1/onboardings/{onboarding_id}

Request

Headers

Campo	Tipo	Requerido	Descripción
`Authorization`	string	Sí	Token de acceso en formato `Bearer ACCESS_TOKEN`

Path Parameters

Campo	Tipo	Requerido	Descripción
`onboarding_id`	string (uuid)	Sí	ID del onboarding

No aplica: Query Parameters, Body.

Response

Códigos de error

Status	Descripción
`401`	Unauthorized — token inválido o ausente
`403`	Forbidden — cliente no autorizado
`404`	Not Found — el onboarding no existe
`422`	Validation Error — los parámetros enviados son inválidos
`500`	Internal Server Error — error interno del servidor

Ejemplo de código

cURL
JavaScript
Python
Node.js

curl -X GET "https://b2b.allaria.cloud/v1/onboardings/ONBOARDING_ID" \
  -H "Authorization: Bearer ACCESS_TOKEN"

const response = await fetch('https://b2b.allaria.cloud/v1/onboardings/ONBOARDING_ID', {
  headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://b2b.allaria.cloud/v1/onboardings/ONBOARDING_ID',
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)

print(response.json())

const axios = require('axios');

const { data } = await axios.get(
  'https://b2b.allaria.cloud/v1/onboardings/ONBOARDING_ID',
  { headers: { Authorization: 'Bearer ACCESS_TOKEN' } }
);

console.log(data);

2XX Éxito

{
  "externalCode": "550e8400-e29b-41d4-a716-446655440000",
  "state": "APPROVED",
  "referrer": "referrer-id",
  "accounts": [
    {
      "accountId": "100012345",
      "state": "COMPLETED",
      "type": "ALLARIAMAS_INTERNAL"
    },
    {
      "accountId": "12345",
      "state": "COMPLETED",
      "type": "ALLARIAMAS",
      "cvu": "0000099900000000012345"
    },
    {
      "accountId": "20000001",
      "state": "COMPLETED",
      "type": "ALLARIA"
    }
  ],
  "personBankAccounts": [
    {
      "cxu": "0170099220000067797370",
      "createdAt": "2026-10-15T14:32:10.727992"
    }
  ]
}

Campos de la respuesta

Campo	Tipo	Descripción
`externalCode`	string (uuid)	ID único del onboarding
`state`	string	Estado del onboarding. Ver Estados del onboarding
`referrer`	string \| null	Referrer asociado
`accounts`	array \| null	Cuentas generadas al completarse el onboarding. Ver Campos de cuentas
`personBankAccounts`	array	Cuentas bancarias activas vinculadas al titular del onboarding. Solo la devuelve Obtener un onboarding por ID. Ver Campos de cuentas bancarias

Campos de cuentas

accounts es null mientras el onboarding todavía no generó ninguna cuenta.

Una vez que lo hace, trae una entrada por cada cuenta creada, cada una con su propio accountId, state y type. Qué cuentas aparecen depende del company_type con el que se creó el onboarding.

Campo	Tipo	Descripción
`accountId`	string \| null	Identificador de la cuenta
`state`	string	Estado de la cuenta. Ver Estados de cuenta
`cvu`	string \| null	CVU de la cuenta. Solo está presente en las cuentas `ALLARIAMAS`
`type`	string	Tipo de cuenta. Ver Tipos de cuenta

Campos de cuentas bancarias

personBankAccounts lista las cuentas bancarias vinculadas a la persona (humana o jurídica) titular del onboarding. Solo se devuelven las cuentas bancarias activas; las inactivas quedan afuera.

Siempre está presente en Obtener un onboarding por ID, y es un array vacío cuando la persona no tiene ninguna cuenta bancaria activa o el onboarding todavía no fue procesado. Obtener todos los onboardings no la devuelve.

Campo	Tipo	Descripción
`cxu`	string	CXU de la cuenta bancaria (su CBU o CVU)
`createdAt`	string (date-time)	Fecha y hora en que se vinculó la cuenta bancaria, en formato ISO 8601 con microsegundos y sin offset de zona horaria (por ejemplo, `2026-10-15T14:32:10.727992`)

Estados del onboarding

Estado	Descripción
`APPROVED`	Onboarding aprobado
`PENDING`	Pendiente de revisión
`REJECTED`	Onboarding rechazado

Estados de cuenta

Estado	Descripción
`PENDING`	Pendiente de procesamiento
`PENDING_MANUAL_INPUT`	Requiere intervención manual
`COMPLETED`	Cuenta creada correctamente
`FAILED`	Error al crear la cuenta
`INACTIVE`	Cuenta inactiva
`UNPROCESSED`	Sin procesar
`BLOCKED`	Cuenta bloqueada

Tipos de cuenta

Tipo	Descripción
`ALLARIA`	Cuenta comitente para operar en Allaria. Ver Identificadores de cuenta
`ALLARIAMAS`	Cuenta CVU de Allaria+ (billetera)
`ALLARIAMAS_INTERNAL`	Cuenta comitente interna de Allaria+, que el cliente no opera directamente

Obtener todos los onboardings​

Request​

Headers​

Query Parameters​

Ejemplo de código​

Response​

2XX Éxito​

Obtener un onboarding por ID​

Request​

Headers​

Path Parameters​

Response​

Códigos de error​

Ejemplo de código​

2XX Éxito​

Campos de la respuesta​

Campos de cuentas​

Campos de cuentas bancarias​

Estados del onboarding​

Estados de cuenta​

Tipos de cuenta​

Obtener todos los onboardings

Request

Headers

Query Parameters

Ejemplo de código

Response

2XX Éxito

Obtener un onboarding por ID

Request

Headers

Path Parameters

Response

Códigos de error

Ejemplo de código

2XX Éxito

Campos de la respuesta

Campos de cuentas

Campos de cuentas bancarias

Estados del onboarding

Estados de cuenta

Tipos de cuenta