Crear onboarding

Inicia un nuevo proceso de onboarding para un cliente. Retorna el onboarding_id que se usará en los pasos siguientes.

POST/v1/onboardings

Request

Headers

Campo	Tipo	Requerido	Descripción
Authorization	string	Sí	Token de acceso en formato Bearer ACCESS_TOKEN
Content-Type	string	Sí	Debe ser application/json

No aplica: Path Parameters, Query Parameters.

Body

Campo	Tipo	Requerido	Descripción
company_type	string	Sí	Empresa para la cual se realiza el onboarding. Valores permitidos: ALLARIA, ALLARIAMAS
onboarding_type	string	Sí	Tipo de onboarding. Valores permitidos: INDIVIDUAL, BUSINESS

Response

2XX Éxito

Campo	Tipo	Descripción
onboarding_id	string (uuid)	ID del onboarding. Se usa en carga de documentos, carga de datos y consulta de estado
ttl	integer	Timestamp Unix, en segundos, en el que vence el onboarding — 60 días después de creado. Es un instante absoluto, no una duración

Códigos de error

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

Ejemplo de código

cURL

curl -X POST "https://b2b.allaria.cloud/v1/onboardings" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_type": "ALLARIA",
    "onboarding_type": "INDIVIDUAL"
  }'

JavaScript

const response = await fetch('https://b2b.allaria.cloud/v1/onboardings', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    company_type: 'ALLARIA',
    onboarding_type: 'INDIVIDUAL'
  })
});

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

Python

import requests

response = requests.post(
  'https://b2b.allaria.cloud/v1/onboardings',
  headers={
    'Authorization': 'Bearer ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  json={
    'company_type': 'ALLARIA',
    'onboarding_type': 'INDIVIDUAL'
  }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://b2b.allaria.cloud/v1/onboardings',
  {
    company_type: 'ALLARIA',
    onboarding_type: 'INDIVIDUAL'
  },
  {
    headers: {
      Authorization: 'Bearer ACCESS_TOKEN',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

2XX Éxito

{
  "onboarding_id": "550e8400-e29b-41d4-a716-446655440000",
  "ttl": 1773668700
}