Check a user's Plaid Network status

POST /network/status/get

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.

Request Body

Required

NetworkStatusGetRequest defines the request schema for /network/status/get

Parameters

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.
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.
user
required, object
An object specifying information about the end user for the network status check.
phone_number
required, string
The user’s phone number in E.164 format.
template_id
string
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).

Response

NetworkStatusGetResponse defines the response schema for /network/status/get

Response Properties

network_status
required, string
Enum representing the overall network status of the user.
layer
object
An object representing Layer-related metadata for the requested user.
eligible
required, boolean
Indicates if the user is eligible for a Layer session.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.