Firmar documento

Registra la firma de una declaración jurada (compra o venta), de un documento de fondos comunes de inversión, o de los términos y condiciones para una cuenta.

POST/v1/broker/document/sign

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

Campos condicionales: description, privacy_policy, version

El significado y la obligatoriedad de description, privacy_policy y version dependen de document_type:

• AFFIDAVIT: description es requerido y debe ser BUY o SELL. privacy_policy y version no deben enviarse.
• MUTUAL_FUNDS: description es requerido y debe contener el código bloomberg del fondo (por ejemplo, ALDOAHOBMep). privacy_policy y version no deben enviarse.
• TERMS_AND_CONDITIONS: version y privacy_policy son requeridos. description no debe enviarse.

Campo	Tipo	Requerido	Descripción
account_id	string	Sí	Identificador de la cuenta que firma el documento.
document_type	string	Sí	Tipo de documento a firmar. Valores permitidos: AFFIDAVIT, MUTUAL_FUNDS, TERMS_AND_CONDITIONS.
description	string	Condicional	BUY/SELL para una declaración jurada, o el código bloomberg del fondo para fondos comunes de inversión. No debe enviarse para TERMS_AND_CONDITIONS.
privacy_policy	string	Condicional	Versión de la política de privacidad. Requerido solo cuando document_type es TERMS_AND_CONDITIONS.
version	string	Condicional	Versión de los términos y condiciones. Requerido solo cuando document_type es TERMS_AND_CONDITIONS.

Response

2XX Éxito

Campo	Tipo	Descripción
msg	string	Mensaje de resultado. Si el documento ya estaba firmado, msg describe la firma existente en lugar de registrar una nueva.

Códigos de error

Status	Descripción
400	Bad Request — parámetros inválidos o faltantes
401	Unauthorized — token de acceso inválido o faltante
403	Forbidden — el token no tiene permiso para acceder a este recurso
500	Internal Server Error

Estructura del error:

{
  "code": "invalid_request",
  "description": "description must be BUY or SELL when document type is AFFIDAVIT"
}

Ejemplo de código

cURL

curl -X POST https://b2b.allaria.cloud/v1/broker/document/sign \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "1234",
    "document_type": "AFFIDAVIT",
    "description": "BUY"
  }'

JavaScript

const response = await fetch('https://b2b.allaria.cloud/v1/broker/document/sign', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    account_id: '1234',
    document_type: 'AFFIDAVIT',
    description: 'BUY',
  }),
});

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

Python

import requests

response = requests.post(
  'https://b2b.allaria.cloud/v1/broker/document/sign',
  headers={
    'Authorization': 'Bearer ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  json={
    'account_id': '1234',
    'document_type': 'AFFIDAVIT',
    'description': 'BUY',
  }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://b2b.allaria.cloud/v1/broker/document/sign',
  {
    account_id: '1234',
    document_type: 'AFFIDAVIT',
    description: 'BUY',
  },
  {
    headers: {
      Authorization: 'Bearer ACCESS_TOKEN',
      'Content-Type': 'application/json',
    },
  }
);

console.log(response.data);

Declaración jurada (BUY o SELL)

{
  "account_id": "1234",
  "document_type": "AFFIDAVIT",
  "description": "BUY"
}

Documento de fondos comunes de inversión

{
  "account_id": "1234",
  "document_type": "MUTUAL_FUNDS",
  "description": "ALDOAHOBMep"
}

Términos y condiciones

{
  "account_id": "1234",
  "document_type": "TERMS_AND_CONDITIONS",
  "version": "1.0",
  "privacy_policy": "1.0"
}

2XX Éxito

{
  "msg": "Document signing registered successfully"
}