Advisee Documents

The GSCS APIs allow users to download monthly statements and tax documents for advisees.

The following steps describe the workflow to pull documents via API.

Step 1 - Identify Account Owners (optional)

Use this API to identify the loginId of the member to pull the document for.

Endpoint: Get accounts

Example Request: GET /api/v2/accounts/RL12345678

To pull an advisee document, you will need to know the 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 2 - Validate User Identity

This request returns details about the user, which you could use to validate the users identity such as email address, name and date of birth.

Endpoint: Get all users

Example Requests: GET /api/v2/users GET /api/v2/users?loginIds=[bobsmith, smith12345]

Step 3 - Get a List of Available Documents

This request returns a list of all documents available for that user.

Endpoint: List documents to download

Example Request: 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 household ID and household name.

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. As an example, a can receive one statement with the accounts in their household and another statement with their accounts not in the household.

Step 4 - 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: Download a user document

Example Request: GET /api/v2/downloads/{reportId}

Document Types Supported