find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/btg-pactual:btg-pactual-leads-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: KGIRO - de Crédito Leads API
  version: 1.0.0
  description: Api Developers Leads de Crédito
servers:
- url: https://api.empresas.btgpactual.com/kgiro
  description: ''
tags:
- name: Leads
paths:
  /form/kgiro/start:
    post:
      tags:
      - Leads
      description: Envio das informações para solicitação de crédito
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              required:
              - workflowLeadCanonical
              type: object
              properties:
                workflowLeadCanonical:
                  description: propriedade base
                  required:
                  - operatorIdentification
                  - customerIdentification
                  - externalIdentification
                  - revenue
                  - hasOptin
                  - desiredCreditLines
                  type: object
                  properties:
                    operatorIdentification:
                      description: CPF do operador
                      type: string
                    customerIdentification:
                      description: CNPJ do cliente
                      type: string
                    externalIdentification:
                      description: Identificador único fornecido pelo parceiro. Será utilizado para identificar o cliente
                      type: string
                    revenue:
                      description: Faturamento médio mensal
                      type: number
                    hasOptin:
                      description: Possui aceite SCR Optin?
                      type: boolean
                    desiredCreditLines:
                      description: Linhas de créditos solicitadas no envio da análise
                      type: array
                      items:
                        description: Linha de crédito desejada
                        required:
                        - desiredAmount
                        - creditLine
                        type: object
                        properties:
                          desiredAmount:
                            format: double
                            description: Valor desejado
                            type: number
                          creditLine:
                            description: Nome da linha de crédito
                            enum:
                            - KGIRO
                            - LIMITE_MAIS
                            - CARTAO_DE_CREDITO
                            - ANTECIPACAO_DE_RECEBIVEIS_CARTAO
                            - ANTECIPACAO_DE_RECEBIVEIS_BOLETOS
                            type: string
                          gracePeriod:
                            description: Período de carência (em meses)
                            type: integer
                          term:
                            description: Quantidade de parcelas
                            type: integer
                        example:
                          creditLine: KGIRO
                          desiredAmount: 10000
                          term: 6
                          gracePeriod: 0
                        title: desiredCreditLine
                  example:
                    operatorIdentification: '11111111111'
                    customerIdentification: '11111111111'
                    externalIdentification: GUID
                    revenue: 40000
                    hasOptin: true
                    desiredCreditLines:
                    - creditLine: KGIRO
                      desiredAmount: 10000
                      term: 6
                      gracePeriod: 0
                  title: workflowLeadCanonical
              example:
                workflowLeadCanonical:
                  operatorIdentification: '11111111111'
                  customerIdentification: '11111111111'
                  externalIdentification: GUID
                  revenue: 40000
                  hasOptin: true
                  desiredCreditLines:
                  - creditLine: KGIRO
                    desiredAmount: 10000
                    term: 6
                    gracePeriod: 0
              title: startWorkflowLead
            examples:
              Exemplo:
                value:
                  workflowLeadCanonical:
                    operatorIdentification: '11111111111'
                    customerIdentification: '11111111111'
                    externalIdentification: GUID
                    revenue: 40000
                    hasOptin: true
                    desiredCreditLines:
                    - creditLine: KGIRO
                      desiredAmount: 10000
                      term: 6
                      gracePeriod: 0
        required: true
      responses:
        '200':
          description: Requisição recebida
        '500':
          content:
            application/json:
              schema:
                title: Root Type for internalServerErrorResponse
                description: ''
                type: object
                properties:
                  brn:
                    type: string
                  name:
                    type: string
                  invalidParams:
                    type: array
                    items: {}
                example:
                  brn: brn:empresas:credit-manager:errors:internal-server-error
                  name: ServerInternalError
                  invalidParams: []
              examples:
                ' ':
                  value:
                    brn: brn:empresas:credit-manager:errors:internal-server-error
                    name: ServerInternalError
                    invalidParams: []
          description: Erro interno
      security:
      - oauth2:
        - brn:btg:empresas:kgiro:workflow
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/KGIRO%20-%20Leads%20de%20Cr%5Cxe9dito/envio-das-informacoes-para-solicitacao-de-credito
      summary: Create form kgiro start
      x-summary-source: derived
      operationId: postFormKgiroStart
      x-operation-id-source: derived
components:
  securitySchemes:
    oauth2:
      flows:
        clientCredentials:
          tokenUrl: https://id.btgpactual.com/oauth2/token
          scopes:
            brn:btg:empresas:kgiro:workflow: Scope kgiro wf
      type: oauth2
x-reassembled-from:
  source: https://developers.empresas.btgpactual.com/docs/api-specs-target/
  method: Operation objects decoded verbatim from the "api" payload that the provider's Docusaurus OpenAPI docs embed in each reference page chunk (/assets/js/*.js); grouped by info.title; jsonRequestBodyExample and postman keys dropped.
  chunks:
  - https://developers.empresas.btgpactual.com/assets/js/d9eca5a4.82230bf4.js