Verificar si un documento está firmado

Verifica si un documento se encuentra firmado.

GET/v1/broker/document/signed

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

Significado condicional de description

description debe ser BUY o SELL cuando document_type es AFFIDAVIT, o el código bloomberg del fondo cuando document_type es MUTUAL_FUNDS.

Campo	Tipo	Requerido	Descripción
account_id	string	Sí	Identificador de la cuenta a verificar.
document_type	string	Sí	Tipo de documento a verificar. Valores permitidos: AFFIDAVIT, MUTUAL_FUNDS.
description	string	Sí	BUY/SELL para una declaración jurada, o el código bloomberg para fondos comunes de inversión.

Response

2XX Éxito

El cuerpo de la respuesta es un booleano JSON simple: true si el documento está firmado, false en caso contrario.

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 GET "https://b2b.allaria.dev/v1/broker/document/signed?account_id=1234&document_type=AFFIDAVIT&description=BUY" \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const params = new URLSearchParams({
  account_id: '1234',
  document_type: 'AFFIDAVIT',
  description: 'BUY',
});

const response = await fetch(
  `https://b2b.allaria.dev/v1/broker/document/signed?${params}`,
  {
    method: 'GET',
    headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
  }
);

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

Python

import requests

response = requests.get(
  'https://b2b.allaria.dev/v1/broker/document/signed',
  params={
    'account_id': '1234',
    'document_type': 'AFFIDAVIT',
    'description': 'BUY',
  },
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://b2b.allaria.dev/v1/broker/document/signed',
  {
    params: {
      account_id: '1234',
      document_type: 'AFFIDAVIT',
      description: 'BUY',
    },
    headers: { Authorization: 'Bearer ACCESS_TOKEN' }
  }
);

console.log(response.data);

2XX Éxito

true