Account Provisioning (In a single-account setup)
This flow is applicable if you are using the "One SharedSavings account per End User" account setup, and do not have Performance Dreams enabled. See Account Setups for more information and options.
Note that the account provisioning flow is asynchronous and flexible in terms of when in the user journey it is done. It's for example also possible to decide to provision the account before the End User even starts using the Impact Finance Web App.
To avoid creating multiple accounts, make sure to populate the externalId
field with the POST
request to the Impact Finance API /accounts
endpoint.
If you don’t want to provide actual externalId
and don't care about its value, then just set it to some constant string for example "dreams". It’s unique on user-level so it can be shared with other users, while guaranteeing that each user can only have a single account with this value.
If you don’t want to provide actual externalId
, but still want to separate different accounts, then put the userId
in the field. That will prevent a user from getting more than one account, while still separating different user accounts.
When nothing is provided in externalId
then multiple POST
requests to the Impact Finance API /accounts
endpoint will create multiple accounts, even if the "One SharedSavings account per End User" feature is enabled.