Network

API reference for the Plaid Network

Endpoints
/network/status/getCheck the status of a user in the Plaid Network

Endpoints

=*=*=*=

/network/status/get

Check a user's Plaid Network status

The /network/status/get endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer.
Note: it is strongly recommended to check for Layer eligibility in the frontend. /network/status/get should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the Layer documentation.

network/status/get

Request fields

client_id
stringstring
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.
secret
stringstring
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.
user
requiredobjectrequired, object
An object specifying information about the end user for the network status check.
phone_number
requiredstringrequired, string
The user's phone number in E.164 format.
template_id
stringstring
The id of a template defined in Plaid Dashboard. This field is used if you have additional criteria that you want to check against (e.g. Layer eligibility).
1const request: NetworkStatusGetRequest = {
2  user: {
3    phone_number: '+14155550015',
4  },
5};
6try {
7  const response = await plaidClient.networkStatusGet(request);
8  const networkStatus = response.data.network_status;
9} catch (error) {
10  // handle error
11}
network/status/get

Response fields and example

network_status
stringstring
Enum representing the overall network status of the user.

Possible values: UNKNOWN, RETURNING_USER
layer
nullableobjectnullable, object
An object representing Layer-related metadata for the requested user.
eligible
booleanboolean
Indicates if the user is eligible for a Layer session.
request_id
stringstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "network_status": "RETURNING_USER",
3  "request_id": "m8MDnv9okwxFNBV"
4}