GET
/
v1-preview
/
models
/
brokerage-statement
/
{documentId}
Csharp (SDK)
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;

var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Models.BrokerageStatement.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");

// handle response
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "brokerage-statement",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "accountNumber": "ACC123456789",
    "broker": {
      "name": "Goldman Sachs & Co. LLC",
      "address": "200 West Street, New York, NY 10282",
      "phoneNumber": "+1 (212) 902-1000"
    },
    "advisor": [
      {
        "name": "John Smith",
        "phoneNumber": "+1 (212) 902-1234",
        "address": "200 West Street, New York, NY 10282"
      }
    ],
    "client": {
      "name": "Jane Doe",
      "address": "123 Main Street, New York, NY 10001",
      "phoneNumber": "+1 (212) 555-0123"
    },
    "statementStartDate": "2024-02-01",
    "statementEndDate": "2024-02-29",
    "statementPeriod": "February 2024",
    "totalPortfolioValue": 1500000,
    "baseCurrency": "USD",
    "holdingsLevel": [
      {
        "accountType": "Individual",
        "assetClass": "Equity",
        "description": "Apple Inc. Common Stock",
        "symbol": "AAPL",
        "cusip": "037833100",
        "quantity": 100,
        "price": 175.5,
        "priceAsOfDate": "2024-02-29",
        "currency": "USD",
        "marketValue": 17550,
        "priorMarketValue": 17000,
        "costBasis": 15000,
        "accruedValue": 2550,
        "estimatedIncome": 100,
        "estimatedYield": 0.57,
        "currentYield": 0.55
      }
    ],
    "transactions": [
      {
        "tradeDate": "2/15",
        "settlementDate": "2/17",
        "accountType": "Individual",
        "transactionTypeLevel1": "Buy",
        "transactionTypeLevel2": "Market Order",
        "transactionType": "Stock Purchase",
        "description": "Purchase of 50 shares of AAPL",
        "symbol": "AAPL",
        "quantity": 50,
        "price": 175.25,
        "currency": "USD",
        "amount": 8762.5,
        "taxableAmount": 0,
        "nonTaxableAmount": 0,
        "pendingStatus": "Completed"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

documentId
string
required

The id of the document

Response

Extracted Brokerage Statement Data Response

meta
object
required

Represents a document that has been submitted for processing.

Examples:
{
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "image-to-text",
"status": "Processed",
"pageCount": 10,
"errors": [{ "message": "Total is required" }]
}
fields
object

Fields extracted from a brokerage statement

Examples:
{
"accountNumber": "ACC123456789",
"broker": {
"name": "Goldman Sachs & Co. LLC",
"address": "200 West Street, New York, NY 10282",
"phoneNumber": "+1 (212) 902-1000"
},
"advisor": [
{
"name": "John Smith",
"phoneNumber": "+1 (212) 902-1234",
"address": "200 West Street, New York, NY 10282"
}
],
"client": {
"name": "Jane Doe",
"address": "123 Main Street, New York, NY 10001",
"phoneNumber": "+1 (212) 555-0123"
},
"statementStartDate": "2024-02-01",
"statementEndDate": "2024-02-29",
"statementPeriod": "February 2024",
"totalPortfolioValue": 1500000,
"baseCurrency": "USD",
"holdingsLevel": [
{
"accountType": "Individual",
"assetClass": "Equity",
"description": "Apple Inc. Common Stock",
"symbol": "AAPL",
"cusip": "037833100",
"quantity": 100,
"price": 175.5,
"priceAsOfDate": "2024-02-29",
"currency": "USD",
"marketValue": 17550,
"priorMarketValue": 17000,
"costBasis": 15000,
"accruedValue": 2550,
"estimatedIncome": 100,
"estimatedYield": 0.57,
"currentYield": 0.55
}
],
"transactions": [
{
"tradeDate": "2/15",
"settlementDate": "2/17",
"accountType": "Individual",
"transactionTypeLevel1": "Buy",
"transactionTypeLevel2": "Market Order",
"transactionType": "Stock Purchase",
"description": "Purchase of 50 shares of AAPL",
"symbol": "AAPL",
"quantity": 50,
"price": 175.25,
"currency": "USD",
"amount": 8762.5,
"taxableAmount": 0,
"nonTaxableAmount": 0,
"pendingStatus": "Completed"
}
]
}
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.