---
updatedAt: 2025-09-29T21:37:17.000Z
agentTools:
  projectIndex: https://docs.gratifypay.com/llms.txt
---

# Retrieve all inputs for a merchant

Fetches all input data associated with a specific merchant, identified by the provided merchantId.  
The inputs represent the data submitted for processing under the merchant's account.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Gratify KYB API",
    "description": "# Overview\n",
    "version": "1.1.0"
  },
  "tags": [
    {
      "name": "Inputs",
      "description": "Merchant input data"
    }
  ],
  "servers": [
    {
      "url": "https://kyc.gratifypay.com/2024-09-01/",
      "description": "Gratify KYB API"
    }
  ],
  "security": [
    {
      "GratifyKybAuth": []
    }
  ],
  "paths": {
    "/merchants/{merchantId}/inputs": {
      "get": {
        "summary": "Retrieve all inputs for a merchant",
        "description": "Fetches all input data associated with a specific merchant, identified by the provided merchantId.  \nThe inputs represent the data submitted for processing under the merchant's account.\n",
        "tags": [
          "Inputs"
        ],
        "parameters": [
          {
            "name": "merchantId",
            "in": "path",
            "description": "Unique string identifier for the merchant.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "merchant_71a944eb-bc3a-4e30-b3e1-47b11a47dcc1"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved all inputs for the merchant.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InputCollection"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "5XX": {
            "$ref": "#/components/responses/ServerError"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Input": {
        "type": "object",
        "description": "Represents an input data for a merchant. Each input entry includes a key to identify the data and the associated data value. \nProvided data are submitted for KYB processing based on the configuration.\n",
        "properties": {
          "tenantId": {
            "type": "string",
            "description": "Unique identifier for the tenant associated with this input.",
            "example": "tenant_9795a15c-c2a1-427e-b08b-b62fda44a00a"
          },
          "merchantId": {
            "type": "string",
            "description": "Unique identifier for the merchant associated with this input.",
            "example": "merchant_71a944eb-bc3a-4e30-b3e1-47b11a47dcc1"
          },
          "key": {
            "type": "string",
            "description": "Unique key for identifying the input entry. This key is used to reference the input data in \"source\" field in configurations.",
            "example": "$.address.country"
          },
          "data": {
            "description": "Data payload associated with the input. This can be of any valid data type, most commonly a string. It can also represent numbers, booleans and arbitrary objects or arrays depending on the input.",
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "array"
              },
              {
                "type": "object",
                "additionalProperties": true
              }
            ],
            "example": "Canada"
          }
        }
      },
      "InputCollection": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Input"
        }
      },
      "APIError": {
        "description": "An API error message structure",
        "required": [
          "errorCode",
          "errorMessage"
        ],
        "type": "object",
        "properties": {
          "errorCode": {
            "description": "Short name for the error",
            "type": "string"
          },
          "errorMessage": {
            "description": "Detailed error message",
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The request is malformed or input is not valid. Double check your request message body is to specification and try again.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/APIError"
            },
            "example": {
              "errorCode": 400,
              "errorMessage": "Bad Request Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unuahtorized access to the API. Double check your API credentials and try again.",
        "headers": {
          "WWW_Authenticate": {
            "schema": {
              "type": "string"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/APIError"
            },
            "example": {
              "errorCode": 401,
              "errorMessage": "Unauthorized Access Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "The specified resource was not found. Double check your URL and version strings try again.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/APIError"
            },
            "example": {
              "errorCode": 404,
              "errorMessage": "Object now found"
            }
          }
        }
      },
      "ServerError": {
        "description": "An unexpected error occurred at the Gratify Server",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/APIError"
            },
            "example": {
              "errorCode": 500,
              "errorMessage": "An unknown error has occurred. Please try again later"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "GratifyKybAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "The Gratify KYB API uses standardized Basic Auth over HTTPS for authentication of all API calls. Provide your API Key as the username and your API Secret as the password."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```