Advisee Documents for New Partners
The following steps describe the workflow for pulling a document via API for integration partners who do not have an established data file integration with GSAS.
This process will require an admin user to be setup in GSAS under each advisory firm that will use the integration. The admin user will have access to all accounts under that advisory firm with at least detailed level viewer access.
Step 1 - Pull a List of Accounts
Partners not integrated with our data feed will not have a list of account numbers available for a given advisor.
Use this API to identify all account numbers the advisor has access to.
Endpoint: GET /api/v2/accounts
This API call will be used to build a list of all account numbers that belong to the firm.
This API call will return all accounts under the firm and include primaryAccountOwner
, jointOwners
, signatoryMembers
, and any other user that can see the document (see full list in viewStatements
field in the response).
Step 2 - Identify Account Owners
Use this API so you can identify the loginids of the GSAS members who get documents for a given account.
Endpoint: GET /api/v2/accounts/{accountNumber}
To pull a document, you will need to know the GSAS loginid of the member whose document you want to pull.
This API call will return primary account owner (primaryAccountOwner
), joint owners (jointOwners
), authorized signatories (signatoryMembers
), and any other user that can see the document (see full list in viewStatements
field in the response).
Step 3 - Validate User Identity
This request returns details about the user, which you could use to validate the users identity.
- i.e. first name, last name and date of birth
Endpoint: GET /api/v2/users
GET /api/v2/users?loginIds=[bobsmith, smith12345]
This request will return details about the user which you could use to map to your system.
This includes first name, last name, date of birth, etc.
Step 4 - Get a List of Available Documents
This request returns a list of all documents available for that user.
Endpoint(s): GET /api/v2/downloads?loginId=[loginId]?reportType=[reportType]
GET /api/v2/downloads?loginId=[loginId]
You will need the reportId
returned in the API response URL to pull a specific document.
For household level statements, you will see household indicators returned including householdID
and householdName
.
If a member is part of a household and is receiving statements for the household, you will see multiple statements for a given month for that member.
- i.e. A member can receive one statement with the accounts in their household and another statement with their accounts not in the household.
Step 5 - Download the Document
This request returns the document in PDF or XML format. The format of the document depends on the document type.
Pass the reportId
for the report you are downloading in the request URL.
Endpoint: GET /api/v2/downloads/{reportId}
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.