Skip to main content

Getting Started

This guide will help you get started with the Glassboard API.

These examples are suggested ways to run a deal through the API. Object Schemas are flexible in application. Certain fields are only required under specific conditions, usually those related to generating documents, creating accounts, etc. In the case where a data object is not complete enough to complete an operation, the API will return a 422 response with details about the missing required fields.

Additionally, some schemas work together to complete a larger task. For example, in order to complete an investment, a Profile and a Subscription is required. Elements from both schemas are used to populate tax forms and subscription agreements on-demand. Again, 422 responses will provide guidance if additional data is required to complete a request.