TokenRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/banco-inter/main/json-schema/banco-inter-token-request-schema.json",
  "title": "TokenRequest",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/banco-inter-token-openapi.yml#/components/schemas/TokenRequest",
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Client Id obtido no detalhe da tela de aplicações no IB"
    },
    "client_secret": {
      "type": "string",
      "description": "Client Secret obtido no detalhe da tela de aplicações no IB"
    },
    "grant_type": {
      "type": "string",
      "description": "GrantType que utilizamos, o default é (client_credentials)",
      "default": "client_credentials"
    },
    "scope": {
      "description": "Escopos cadastrados na tela de aplicações.\n\n\n**Onde encontrar os escopos:**<br>\nVocê encontra os escopos necessários para acesso na documentação \nespecífica de cada endpoint.<br>\n**Exemplo:**<br>\nO endpoint para Consultar extrato requer o escopo `extrato.read`,\nconforme indicado na imagem abaixo, retirada da documentação:\n\n\n<img src=\"/media/exemplo_escopo.png\"><br>\n\n**Múltiplos escopos:**<br>\nÉ possível solicitar múltiplos escopos simultaneamente, enviando-os\nem sequência separados por espaço.<br>\n**Exemplo:**<br>\nPara gerar um token com permissões de consulta para extrato, cobrança\ne Pix, utilize:<br>\nextrato.read boleto-cobranca.read pix.read\n",
      "type": "string"
    }
  },
  "required": [
    "client_id",
    "client_secret",
    "grant_type",
    "scope"
  ]
}