action plaid_application_get {
  label: "Retrieve information about a Plaid application"
  description: "Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences"
  provider: plaid
  method: POST
  path: "/application/get"
  encoding: json
  input: {
    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: {
    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."
      }
    }
  }
}