Get daily affidavit status

Returns whether the buy and/or sell affidavit has already been signed today for an account.

GET/v1/broker/document/affidavit/account/{accountId}/today

Request

Headers

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

Path Parameters

Field	Type	Required	Description
accountId	string	Yes	Account identifier to check.

Not applicable: Query Parameters, Body.

Response

2XX Success

Field	Type	Description
buy	boolean	Whether the BUY affidavit has already been signed today for this account.
sell	boolean	Whether the SELL affidavit has already been signed today for this account.

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": "Account ID must not be blank"
}

Code Example

cURL

curl -X GET https://b2b.allaria.cloud/v1/broker/document/affidavit/account/1234/today \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const accountId = '1234';

const response = await fetch(
  `https://b2b.allaria.cloud/v1/broker/document/affidavit/account/${accountId}/today`,
  {
    method: 'GET',
    headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
  }
);

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

Python

import requests

account_id = '1234'

response = requests.get(
  f'https://b2b.allaria.cloud/v1/broker/document/affidavit/account/{account_id}/today',
  headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const accountId = '1234';

const response = await axios.get(
  `https://b2b.allaria.cloud/v1/broker/document/affidavit/account/${accountId}/today`,
  { headers: { Authorization: 'Bearer ACCESS_TOKEN' } }
);

console.log(response.data);

2XX Success

{
  "buy": true,
  "sell": false
}