---
updatedAt: 2025-06-12T01:01:55.000Z
agentTools:
  projectIndex: https://api-documentation.versium.com/llms.txt
---

# Try the API

Try out the consumerinfo API. * Returned results use your monthly matches.  *

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "demographic-append",
    "version": "6.8"
  },
  "servers": [
    {
      "url": "https://api.versium.com/v2/demographic"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-versium-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Try the API",
        "description": "Try out the consumerinfo API. * Returned results use your monthly matches.  *",
        "operationId": "consumerinfo",
        "parameters": [
          {
            "name": "output[]",
            "in": "query",
            "description": "Output Type: full_demographic OR one or more of demographic, financial, lifestyle, political.",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "first",
            "in": "query",
            "description": "A person's first name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "last",
            "in": "query",
            "description": "A person's last name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "address",
            "in": "query",
            "description": "A house/building number and street",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "address_2",
            "in": "query",
            "description": "The unit number of an address",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "city",
            "in": "query",
            "description": "A city name",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "description": "A US state two letter abbreviation",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "zip",
            "in": "query",
            "description": "A 5 digit US ZIP code",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "country",
            "in": "query",
            "description": "A 2 letter country code (only US is currently supported)",
            "schema": {
              "type": "string",
              "default": "US"
            }
          },
          {
            "name": "email",
            "in": "query",
            "description": "A valid email address (consumer or business)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "phone",
            "in": "query",
            "description": "A valid 10 digit North American phone number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cfg_maxrecs",
            "in": "query",
            "description": "The number of returned records",
            "schema": {
              "type": "string",
              "default": "1"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "text",
              "code": "aaaa"
            }
          ],
          "samples-languages": [
            "text"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```