Metadata about an event that occured while the user was going through Link
Name | Type | Description | Notes |
---|---|---|---|
request_id | str | The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events. | |
error_code | str | The error code that the user encountered. Emitted by `ERROR`, `EXIT`. | [optional] |
error_message | str | The error message that the user encountered. Emitted by: `ERROR`, `EXIT`. | [optional] |
error_type | str | The error type that the user encountered. Emitted by: `ERROR`, `EXIT`. | [optional] |
exit_status | str | The status key indicates the point at which the user exited the Link flow. Emitted by: `EXIT`. | [optional] |
institution_id | str | The ID of the selected institution. Emitted by: all events. | [optional] |
institution_name | str | The name of the selected institution. Emitted by: all events. | [optional] |
institution_search_query | str | The query used to search for institutions. Emitted by: `SEARCH_INSTITUTION`. | [optional] |
mfa_type | str | If set, the user has encountered one of the following MFA types: code, device, questions, selections. Emitted by: `SUBMIT_MFA` and `TRANSITION_VIEW` when view_name is `MFA`. | [optional] |
view_name | str | The name of the view that is being transitioned to. Emitted by: `TRANSITION_VIEW`. | [optional] |
selection | str | Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are `phoneotp` or `password`; if selection is used to describe the selected Auth Type Select flow, then possible values are `flow_type_manual` or `flow_type_instant`. Emitted by: `MATCHED_SELECT_VERIFY_METHOD` and `SELECT_AUTH_TYPE`. | [optional] |
brand_name | str | The name of the selected brand. | [optional] |
match_reason | str | The reason this institution was matched, which will be either `returning_user` or `routing_number`. Emitted by: `MATCHED_SELECT_INSTITUTION`. | [optional] |
routing_number | str | The routing number submitted by user at the micro-deposits routing number pane. Emitted by `SUBMIT_ROUTING_NUMBER`. | [optional] |
account_number_mask | str | The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, `account_number_mask` is empty. Emitted by `SUBMIT_ACCOUNT_NUMBER`. | [optional] |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |