Get onboardings

Queries the status of one or all onboardings for a client.

---

Get all onboardings

GET/v1/onboardings

Request

Headers

Field	Type	Required	Description
Authorization	string	Yes	Access token in Bearer ACCESS_TOKEN format

Not applicable: Path Parameters, Body.

Query Parameters

Field	Type	Required	Description
search_type	string	No	Search type. Possible value: SUBMITTED. Default: SUBMITTED.
page	integer	No	Page number (0-based). Default: 0.
size	integer	No	Results per page (minimum 1). Default: 20.
referrer	string	No	Filter by referrer

---

Code Example

cURL

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

JavaScript

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);

Python

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())

Node.js

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 Success

{
  "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
}

Get an onboarding by ID

GET/v1/onboardings/{onboarding_id}

Request

Headers

Field	Type	Required	Description
Authorization	string	Yes	Access token in Bearer ACCESS_TOKEN format

Path Parameters

Field	Type	Required	Description
onboarding_id	string (uuid)	Yes	Onboarding ID

Not applicable: Query Parameters, Body.

Response

Error Codes

Status	Description
401	Unauthorized — invalid or missing token
403	Forbidden — unauthorized client
404	Not Found — onboarding does not exist
422	Validation Error — submitted parameters are invalid
500	Internal Server Error — internal server error

---

Code Example

cURL

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

JavaScript

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);

Python

import requests

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

print(response.json())

Node.js

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 Success

{
  "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"
    }
  ]
}

Response fields

Field	Type	Description
externalCode	string (uuid)	Unique onboarding ID
state	string	Onboarding status. See Onboarding statuses
referrer	string | null	Associated referrer
accounts	array | null	Accounts generated upon onboarding completion. See Account fields
personBankAccounts	array	Active bank accounts linked to the onboarding's owner. Only returned by Get an onboarding by ID. See Bank account fields

Account fields

accounts is null while the onboarding has not produced any account yet.

Once it does, it carries one entry per account created, each with its own accountId, state and type. Which accounts appear depends on the company_type the onboarding was created with.

Field	Type	Description
accountId	string | null	Account identifier
state	string	Account status. See Account statuses
cvu	string | null	Account CVU. Only present on ALLARIAMAS accounts
type	string	Account type. See Account types

Bank account fields

personBankAccounts lists the bank accounts linked to the person (natural or legal) who owns the onboarding. Only active bank accounts are returned; inactive ones are left out.

It is always present on Get an onboarding by ID, and is an empty array when the person has no active bank account or the onboarding has not been processed yet. Get all onboardings does not return it.

Field	Type	Description
cxu	string	CXU of the bank account (its CBU or CVU)
createdAt	string (date-time)	Date and time the bank account was linked, in ISO 8601 format with microseconds and no timezone offset (e.g. 2026-10-15T14:32:10.727992)

Onboarding statuses

Status	Description
APPROVED	Onboarding approved
PENDING	Pending review
REJECTED	Onboarding rejected

Account statuses

Status	Description
PENDING	Pending processing
PENDING_MANUAL_INPUT	Requires manual intervention
COMPLETED	Account successfully created
FAILED	Error creating the account
INACTIVE	Inactive account
UNPROCESSED	Unprocessed
BLOCKED	Blocked account

Account types

Type	Description
ALLARIA	Brokerage account (comitente) used to trade with Allaria. See Account identifiers
ALLARIAMAS	Allaria+ wallet account, addressed by its cvu
ALLARIAMAS_INTERNAL	Allaria+ internal brokerage account (comitente), not operated directly by the client