Dashboard End-User Review API
API reference for reviewing Dashboard end users with Monitor, Identity Verification, and Beacon
Endpoints | |
---|---|
/dashboard_user/get | Retrieve information about a dashboard end user |
/dashboard_user/list | List dashboard end users |
/dashboard_user/get
Retrieve a dashboard user
Retrieve information about a dashboard user.
dashboard_user/getRequest fields
dashboard_user_id
requiredstring
ID of the associated user.
secret
string
Your Plaid API
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
string
Your Plaid API
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.1const request: DashboardUserGetRequest = {2 dashboard_user_id: 'usr_1SUuwqBdK75GKi',3};45try {6 const response = await client.dashboardUserGet(request);7} catch (error) {8 // handle error9}
dashboard_user/get
Response fields and example
id
string
ID of the associated user.
created_at
string
An ISO8601 formatted timestamp.
Format:
date-time
email_address
string
A valid email address. Must not have leading or trailing spaces.
Format:
email
status
string
The current status of the user.
Possible values:
invited
, active
, deactivated
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "id": "54350110fedcbaf01234ffee",3 "created_at": "2020-07-24T03:26:02Z",4 "email_address": "user@example.com",5 "status": "active",6 "request_id": "saKrIBuEB9qJZng"7}
Was this helpful?
/dashboard_user/list
List dashboard users
List all dashboard users associated with your account.
dashboard_user/listRequest fields
secret
string
Your Plaid API
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
string
Your Plaid API
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.cursor
string
An identifier that determines which page of results you receive.
1try {2 const response = await client.dashboardUserList({});3} catch (error) {4 // handle error5}
dashboard_user/list
Response fields and example
dashboard_users
[object]
List of dashboard users
id
string
ID of the associated user.
created_at
string
An ISO8601 formatted timestamp.
Format:
date-time
email_address
string
A valid email address. Must not have leading or trailing spaces.
Format:
email
status
string
The current status of the user.
Possible values:
invited
, active
, deactivated
next_cursor
nullablestring
An identifier that determines which page of results you receive.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "dashboard_users": [3 {4 "id": "54350110fedcbaf01234ffee",5 "created_at": "2020-07-24T03:26:02Z",6 "email_address": "user@example.com",7 "status": "active"8 }9 ],10 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",11 "request_id": "saKrIBuEB9qJZng"12}
Was this helpful?
Webhooks
SCREENING: STATUS_UPDATED
Fired when an individual screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
webhook_type
string
SCREENING
webhook_code
string
STATUS_UPDATED
screening_id
string
The ID of the associated screening.
environment
string
The Plaid environment the webhook was sent from
Possible values:
sandbox
, production
1{2 "webhook_type": "SCREENING",3 "webhook_code": "STATUS_UPDATED",4 "screening_id": "scr_52xR9LKo77r1Np",5 "environment": "production"6}
Was this helpful?
ENTITY_SCREENING: STATUS_UPDATED
Fired when an entity screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
webhook_type
string
ENTITY_SCREENING
webhook_code
string
STATUS_UPDATED
entity_screening_id
string
The ID of the associated entity screening.
environment
string
The Plaid environment the webhook was sent from
Possible values:
sandbox
, production
1{2 "webhook_type": "ENTITY_SCREENING",3 "webhook_code": "STATUS_UPDATED",4 "screening_id": "entscr_52xR9LKo77r1Np",5 "environment": "production"6}