Network
API reference for the Plaid Network
| Endpoints | |
|---|---|
/network/status/get | Check 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.
Request fields
client_idstring
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.secretstring
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.userrequiredobject
An object specifying information about the end user for the network status check.
phone_numberrequiredstring
The user's phone number in E.164 format.
template_idstring
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).
/network/status/get
const request: NetworkStatusGetRequest = {
user: {
phone_number: '+14155550015',
},
};
try {
const response = await plaidClient.networkStatusGet(request);
const networkStatus = response.data.network_status;
} catch (error) {
// handle error
}
Response fields
network_statusstring
Enum representing the overall network status of the user.
Possible values:
UNKNOWN, RETURNING_USERrequest_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
Response Object
{
"network_status": "RETURNING_USER",
"request_id": "m8MDnv9okwxFNBV"
}