Onboarding Workflow

The service center APIs can be used to track and complete various onboarding tasks.

The following instructions will guide you through the onboarding of a new client/account.

Step 1 - Check LoginID availability.

When creating a user or multiple users, you should first check to confirm the login ID(s) you want to use are available.

Endpoint: GET /api/v2/users/loginId/{loginId}

This step should be completed when a loginId is selected by the Advisor/Advisee.

This may be done later in the workflow but prior to submitting the service task for completion.

Step 2 - Complete household details in Service Center

Create a household that will be used to group accounts by supplying a ‘houseHoldName’.

Endpoint(s): POST /api/v2/service-center/tasks PUT /api/v2/service-center/tasks/{serviceTaskId}

This step can also be completed after the initial onboarding is complete.

This request will create a ‘houseHoldId’ that is unique to that household.

Step 3 - Complete createUsersTasks object in Service Center

Submit user information for the member(s) that are being created as part of this service task.

Endpoint(s): POST /api/v2/service-center/tasks PUT /api/v2/service-center/tasks/{serviceTaskId}

If an account is being created for an existing user on the GSAS platform, you do not need to submit this object in your request.

For entity accounts, the user that will be created will serve as the authorized signatory on the account.

Customer Identification Program (CIP) collection:

• Required items such as source of wealth and expected activity must be provided in the initial call.
• Optional items such as number of dependents, marital status, or tax bracket can be included or set up later in the Update a User API workflow.

Step 4 - Complete createFirmTasks in Service Center

Create the group/corporate entity that will own the account.

Endpoint(s): POST /api/v2/service-center/tasks PUT /api/v2/service-center/tasks/{serviceTaskId}

For firmRep, you should provide the loginId for the user who will be the authorized signatory on the account. We will automatically clone the Authorized Signatory user and set them as a firmRep for that entity.

Step 5 - Get a list of branch and rep codes the advisor has access to

Advisors are given access to specific rep and branch codes on GSAS system. Use this end point to populate a list of branch and rep codes the authenticated advisor has access to.

Endpoint: GET /api/v2/users/branch-rep-codes

Branch and rep codes are required to be set when creating any GSAS account.

Step 6 - Complete createAccountTasks object in Service Center

Submit the required information for the account(s) you wish to create as part of this service task.

Endpoint(s): POST /api/v2/service-center/tasks PUT /api/v2/service-center/tasks/{serviceTaskId}

Each task object within a service task will get its own taskId.

For non-entity accounts, if a new member is being created as part of the service task, enter the taskId from the createUserTasks object as the primaryAccountOwner.

More than one natural person account can be set up under a single member without resending any of the member information.

For trust accounts required trust information and trust parties must be included in the createAccountTasks object.

For entity accounts:

• The primaryAccountOwner should be set as the taskId from the create firm task.
• The members loginId should be set in the signatoryMembers field in the relatedEntities object for that account.
• The system will automatically create a firmRep using the auth signatory information and set the relationship to the firm in the background.

Optional items (trusted contacts, beneficiaries, tax lot relief methods, etc.) can be included or set/updated later in the Update an Account API call.

Step 7 - Complete other Service Center Tasks

You can also include additional tasks as part of your onboarding request:

• Create a bank link createBankLinkTasks
• Initiate an Asset Transfer from an external brokerage account assetTransferTasks

Endpoint(s): POST /api/v2/service-center/tasks PUT /api/v2/service-center/tasks/{serviceTaskId}

These steps can also be completed after the account has been onboarded by using the Create a Bank Link and Create External Transfer end points.

For additional information around submitting an account transfer request post onboarding, see the Account Transfer API guide.

For additional information around creating up a bank link and funding your account post onboarding, see the Banking Services API guide.

Step 8 - Identify invitationId(s)

This request will be used to get the invitation ID(s) associated with the service task Id.

End Point: GET /api/v2/service-tasks/{serviceTaskId}/invitations

Any user that requires a signature will be assigned an invitationId.

The invitationId can be used to submit a single signature for all workflows within the associated service task that require a signature.

• Account Creation Task
• Bank Link Creation Task
• Asset Transfer Task

Step 9 - Sign and Submit the Service Task

Use this request to submit the signature and complete the service task.

There are two options to submit a signature for account opening:

1. Submit a Digital Signature
2. Upload a wet signed Account Certification PDF

Only one signature is required per Advisee to satisfy signature requirements for all workflows within the service task that require a signature.

Submit an e-Signature

Submit the service task and the Account Certification signature(s) to create the objects under the service task.

Endpoint: POST /api/v2/invitations/{invitationId}/sign-now

Upload a Wet Signature

Uload a signed account certification form for each user being onboarded.

1. Download Account Certification for Wet Signature

Download a prefilled account certification form to collect a wet signature.

Endpoint: GET invitations/{invitationId}/download-invitation-packet

2. Upload Signed Account Certification Form

Endpoint POST invitations/{invitationId}/wet-sign Notes

All required signatures must be submitted for a given workflow in order for the account to be created. i.e. Joint accounts require signatures from primary AND joint account owners to create the account.

Only one signature is required per Advisee to satisfy signature requirements

Step 10 - Check Account for Restrictions

Check the Account for any restrictions resulting from the account opening process, such as a CIP Failure.

Endpoint: GET /api/v2/accounts/{accountNumber}

Restrictions prevent further actions like initiating deposits and trading from taking place on an account.

Account restrictions are returned in the ‘accountRestrictions’ object in the GET Account API call.