Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Brokerage Statement

A brokerage/portfolio statement is issued by an asset manager, brokerage, or bank to an individual to detail information about and composition of assets or investments. The brokerage statement is a common form type found in mortgage, specifically for for verification of assets.

The form_type parameter BROKERAGE_STATEMENT for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

πŸ“˜

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

brokerage_statement-Part1-General:bankOrBrokerageInstitutionName

Text

Bank or Brokerage Institution Name

brokerage_statement-Part1-General:accountNumber

Text

Account Number

brokerage_statement-Part1-General:accountHolderName1

Text

Name of the primary account holder on the statement

brokerage_statement-Part1-General:accountHolderName2

Text

Name of the secondary account holder on the statement

brokerage_statement-Part1-General:accountHolderAddress:addressLine1

Text

Address Line 1 of the account holder(s)

brokerage_statement-Part1-General:accountHolderAddress:addressLine2

Text

Address Line 2 of the account holder(s)

brokerage_statement-Part1-General:accountHolderAddress:city

Text

City in which the account holders who owns the portfolio resides

brokerage_statement-Part1-General:accountHolderAddress:state

Text

Formatted 2 character state code. State in which the account holders who owns the portfolio resides

brokerage_statement-Part1-General:accountHolderAddress:zip

Text

Formatted 5 digit ZIP code. Zip in which the account holders who owns the portfolio resides

brokerage_statement-Part2-StatementDetails:statementPeriodBeginningDate

Date

Statement Period Beginning Date

brokerage_statement-Part2-StatementDetails:statementPeriodEndingDate

Date

Statement Period Ending Date

brokerage_statement-Part2-StatementDetails:statementIssueDate

Date

Statement Issue Date

brokerage_statement-Part2-StatementDetails:statementPeriodBeginningBalance

Money

Statement Period Beginning Balance

brokerage_statement-Part2-StatementDetails:statementPeriodEndingBalance

Money

Statement Period Ending Balance

brokerage_statement-Part3-AssetComposition:cash-MarketValue

Money

Cash - Market Value

brokerage_statement-Part3-AssetComposition:moneyMarket-MarketValue

Money

Money Market - Market Value

brokerage_statement-Part3-AssetComposition:fixedIncome-MarketValue

Money

Fixed Income - Market Value

brokerage_statement-Part3-AssetComposition:equity-MarketValue

Money

Equity - Market Value

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Sample JSON Result

{
    "status": 200,
    "response": {
        "pk": 29885040,
        "uuid": "5d13c8bb-afec-488b-bdf8-712ea597806e",
        "forms": [
            {
                "pk": 29631922,
                "uuid": "4dd59c4c-6a44-4f13-8e6d-ed8583925452",
                "form_type": "BROKERAGE_STATEMENT",
                "form_config_pk": 17528,
                "tables": [],
                "raw_fields": {
                    "brokerage_statement-Part1-General:accountNumber": {
                        "value": "6521-415290",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderName1": {
                        "value": "ASHER GABRIEL",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderName2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderAddress:zip": {
                        "value": "14420",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderAddress:city": {
                        "value": "BROCKPORT",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part3-AssetComposition:cash-MarketValue": {
                        "value": "10459095.81",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderAddress:state": {
                        "value": "NY",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part2-StatementDetails:statementIssueDate": {
                        "value": "05/02/2016",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part3-AssetComposition:equity-MarketValue": {
                        "value": "14925012.37",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:bankOrBrokerageInstitutionName": {
                        "value": "MORGAN STANLEY",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part3-AssetComposition:fixedIncome-MarketValue": {
                        "value": "18355012.59",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part3-AssetComposition:moneyMarket-MarketValue": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderAddress:addressLine1": {
                        "value": "6265 BROCKPORT SPENCERPORT RD",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part1-General:accountHolderAddress:addressLine2": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part2-StatementDetails:statementPeriodEndingDate": {
                        "value": "04/30/2016",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part2-StatementDetails:statementPeriodBeginningDate": {
                        "value": "04/01/2016",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part2-StatementDetails:statementPeriodEndingBalance": {
                        "value": "55464593.13",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    },
                    "brokerage_statement-Part2-StatementDetails:statementPeriodBeginningBalance": {
                        "value": "48887823.07",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "Sample Brokerage Statement.pdf"
                    }
                }
            }
        ]
    },
    "message": "OK"
}

Updated about a month ago


Brokerage Statement


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.