Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
643 matches
46 actions
Plaid
46 actions
- Create a deposit switchPOSTv1.0.0
- Create a deposit switch without using Plaid ExchangePOSTv1.0.0
- Create a new identity verificationPOSTv1.0.0
- Create an Asset ReportPOSTv1.0.0
- Create Asset Report Audit CopyPOSTv1.0.0
- Create Link Delivery sessionPOSTv1.0.0
- Create payment consentPOSTv1.0.0
- Create payment profilePOSTv1.0.0
- Create payment recipientPOSTv1.0.0
- Creates a new end customer for a Plaid reseller.POSTv1.0.0
- Get balance of your Bank Transfer accountPOSTv1.0.0
- Get CategoriesPOSTv1.0.0
- Get details of all supported institutionsPOSTv1.0.0
- Get details of an institutionPOSTv1.0.0
- Get Link Delivery sessionPOSTv1.0.0
- Get payment consentPOSTv1.0.0
- Get payment detailsPOSTv1.0.0
- Get payment profilePOSTv1.0.0
- Get payment recipientPOSTv1.0.0
- List a historical log of user consent eventsPOSTv1.0.0
- List a user’s connected applicationsPOSTv1.0.0
- List dashboard usersPOSTv1.0.0
- List Identity VerificationsPOSTv1.0.0
- List payment recipientsPOSTv1.0.0
- List sweepsPOSTv1.0.0
- Retrieve a dashboard userPOSTv1.0.0
- Retrieve a PDF Asset ReportPOSTv1.0.0
- Retrieve a summary of an individual's employment informationPOSTv1.0.0
- Retrieve a sweepPOSTv1.0.0
- Retrieve a user's payroll informationPOSTv1.0.0
- Retrieve an Asset ReportPOSTv1.0.0
- Retrieve an Asset Report Audit CopyPOSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an ItemPOSTv1.0.0
- Retrieve identity dataPOSTv1.0.0
- Retrieve identity match scorePOSTv1.0.0
- Retrieve Identity VerificationPOSTv1.0.0
- Retrieve information about a Plaid applicationPOSTv1.0.0
- Retrieve information from the bank accounts used for employment verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verification in PDF formatPOSTv1.0.0
- Retrieve Link sessions for your userPOSTv1.0.0
- Search employer databasePOSTv1.0.0
- Search institutionsPOSTv1.0.0
- Update the scopes of access for a particular applicationPOSTv1.0.0
Finance/Plaid
Retrieve information about a Plaid application
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
{
"type": "object",
"description": "ApplicationGetRequest defines the schema for `/application/get`",
"required": [
"application_id",
"client_id",
"secret"
],
"properties": {
"application_id": {
"type": "string",
"description": "This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect."
},
"client_id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
{
"type": "object",
"description": "ApplicationGetResponse defines the response schema for `/application/get`",
"required": [
"application",
"request_id"
],
"properties": {
"application": {
"type": "object",
"description": "Metadata about the application",
"required": [
"application_id",
"application_url",
"city",
"company_legal_name",
"country_code",
"display_name",
"join_date",
"logo_url",
"name",
"postal_code",
"reason_for_access",
"region",
"use_case"
],
"properties": {
"application_id": {
"type": "string",
"description": "This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect."
},
"application_url": {
"type": "string",
"description": "The URL for the application's website"
},
"city": {
"type": "string",
"description": "A string representing the city of the client’s headquarters."
},
"company_legal_name": {
"type": "string",
"description": "A string representing the name of client’s legal entity."
},
"country_code": {
"type": "string",
"description": "A string representing the country code of the client’s headquarters."
},
"display_name": {
"type": "string",
"description": "A human-readable name of the application for display purposes"
},
"join_date": {
"type": "string",
"format": "date",
"description": "The date this application was granted production access at Plaid in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC."
},
"logo_url": {
"type": "string",
"description": "A URL that links to the application logo image."
},
"name": {
"type": "string",
"description": "The name of the application"
},
"postal_code": {
"type": "string",
"description": "A string representing the postal code of the client’s headquarters."
},
"reason_for_access": {
"type": "string",
"description": "A string provided by the connected app stating why they use their respective enabled products."
},
"region": {
"type": "string",
"description": "A string representing the region of the client’s headquarters."
},
"use_case": {
"type": "string",
"description": "A string representing client’s broad use case as assessed by Plaid."
}
}
},
"request_id": {
"type": "string",
"description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
}
}
}