What is a user in the configuration block?
user is a TPAStream concept which consolidates all of the information of a given set of participant credentials. Underneath a user:
there are members which have credentials, unique-keys defined by an implementor to identify the user in the system, a unique email which acts as the default identifier of the participant, and a name.
An example of a TPAStream user is an implementor’s Admin Credentials for TPAStream. However, these users are configured as policy holders.
Notes for users in the configuration block:
- A user cannot be an Admin within the TPAStream system.
- A user cannot be associated with 2 different SDK Tokens.
- A user must have a first and last name provided.
- A user must have a unique email.
For more information on configuration objects see our Client Usage Docs.
How do I make test users for the SDK (A Useful Gmail Trick)?
When implementing the StreamConnect SDK it can be useful to use a test user object if you do not have access to provided user credentials.
We suggest that you use an email which does not currently have an account in TPAStream, however, if you have a gmail configured to the TPAStream Admin portal you can follow this pattern to create a new unique user in TPAStream that still will receive the same emails.
firstname.lastname@example.org -> email@example.com
I’d like to use React Native
See our React Native Docs
I’d like to create a more customized flow for how a user enters credentials and validation.
The default recommendation for customizing the SDK flow is to use the various sdk Callbacks.
The SDK renders various steps with default templates which should be editted post render using JS and CSS. However, if you would like
to create more customized widgets it is possible to turn off the default rendering using the various
renderXStep values within the
If you are to turn of the default template rendering, the callbacks associated with each of those steps will provide functions and objects in their parameters which will allow an implementor to mirror all of the functionality previously defined in the default template.
Each of the provided information is present in the Callbacks docs.
How do I use the data from the SDK?
The StreamConnect SDK is designed to take in carrier credentials, save them to the TPAStream sytem, and then validate the credentials. If you are implementing the whole Stream Connect flow, including interfacing with the TPAStream API and using TPAStream webhooks, you will find the doneEasyEnroll callback to hold the main pieces of information you need.
There we define specifically a
policyHolder which can be thought of as the carrier credentials that were just submitted.
policyHolder will have:
policy_holder_idwhich is its unique identifier in TPAStream
login_problemwhich will define the state of the credentials. See doneEasyEnroll
- And a
payer_idall of which can be useful when implementing the TPAStream Webhooks.
For implementing the TPAStream webhooks to get information on when a new claim is added to TPAStream or when the first crawl of the credentials is completed see our Webhook Docs
What is the tenant configuration block?
Within the TPAStream configuration examples as well as the Client Usage Docs you might sometimes see
tenant block defined within it. This specific configuraiton option is determined when your
sdkToken is created.
This can almost always be left blank, unless you are an entity which is managing multiple different tenants within TPAStream. If the latter is the case you will have been informed when your token was created.
What is “vendor” within the various configuration blocks?
When configuring the SDK a user will see ”
vendor” within the configuration block of the
employer object. This
will almost always be set to the value
A Vendor in TPA Stream indicates which System of Record an identifier belongs to. If the identifier is the unique database ID from your own in-house system, simply refer to it as “internal”
I have a unique key for my participants, how can I associate those in TPAStream?
user configuration object you can define
memberSystemKey. This system key will be defined under the same vendor as the
employer block, since a member can only exist under 1 employer.
See our Client Usage Docs for more information on the
user object block.