Check document signed

Check if a document is signed.

GET/v1/broker/document/signed

Request

Headers

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

Not applicable: Path Parameters, Body.

Query Parameters

Conditional meaning of description

description must be BUY or SELL when document_type is AFFIDAVIT, or the fund's bloomberg code when document_type is MUTUAL_FUNDS.

Field	Type	Required	Description
account_id	string	Yes	Account identifier to check.
document_type	string	Yes	Type of document to check. Allowed values: AFFIDAVIT, MUTUAL_FUNDS.
description	string	Yes	BUY/SELL for an affidavit, or the bloomberg code for mutual funds.

Response

2XX Success

The response body is a bare JSON boolean: true if the document is signed, false otherwise.

Error Codes

Status	Description
400	Bad Request — invalid or missing parameters
401	Unauthorized — invalid or missing access token
403	Forbidden — the token does not have permission to access this resource
500	Internal Server Error

Error structure:

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

Code Example

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 Success

true