BTG Pactual Enriquecimento API

The Enriquecimento API from BTG Pactual — 5 operation(s) for enriquecimento.

Documentation GitHub OpenAPI

Operations 5

GET /apps/{clientId}/.well-known/customers/{taxId} Get apps by client id well known customers by tax id #

GET /apps/{clientId}/.well-known/customers/{taxId}/addresses Get apps by client id well known customers by tax id addresses #

GET /apps/{clientId}/.well-known/customers/{taxId}/documents/{pathSuffix} Get apps by client id well known customers by tax id documents by path suffix #

GET /apps/{clientId}/.well-known/customers/{taxId}/legal-representatives Get apps by client id well known customers by tax id legal representatives #

GET /apps/{clientId}/.well-known/customers/{taxId}/documents Get apps by client id well known customers by tax id documents #

Documentation

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Acquirers%20-%20PaymentLink/acquirers-paymentlink

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Acquirers%20-%20Salesprovider/acquirers-salesprovider

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/ANTECRED-Subcredenciadores/antecred-subcredenciadores

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Accounts/banking-accounts

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Cards/banking-cards

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20CCReceivables/banking-ccreceivables

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Collections/banking-collections

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20DDA/banking-dda

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20PaymentLink/banking-paymentlink

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20PaymentLinkRec/banking-paymentlinkrec

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Payments/banking-payments

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Payroll/banking-payroll

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Pix%20Autom%5Cxe1tico/banking-pix-automatico

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20PixCashin/banking-pixcashin

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Protest/banking-protest

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Banking%20-%20Split/banking-split

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/BankingHub%20-%20Open%20Finance%20Balance%20Refresh/bankinghub-open-finance-balance-refresh

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/CrediFlow%20-%20Ativos%20e%20Cess%5Cxf5es/crediflow-ativos-e-cessoes

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Consignado%20Privado/fidc-consignado-privado

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Credit%20Conciliation/fidc-credit-conciliation

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Document/fidc-document

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Eligibility/fidc-eligibility

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Motor%20de%20Credito/fidc-motor-de-credito

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Operation/fidc-operation

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Payment/fidc-payment

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Portability/fidc-portability

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Prepayment/fidc-prepayment

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Renegotiation/fidc-renegotiation

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Simulation/fidc-simulation

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Wallet/fidc-wallet

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/FIDC%20-%20Warranty/fidc-warranty

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Files/files

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/HUBFX%20-%20Cambio/hubfx-cambio

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/KGIRO%20-%20Leads%20de%20Cr%5Cxe9dito/kgiro-leads-de-credito

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/onboarding

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/SCF%20-%20Colombia/scf-colombia

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/SCF%20-%20Risco%20Sacado/scf-risco-sacado

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/SCF-Financiers-Supplier/scf-financiers-supplier

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Solar-CreditAnalysis/solar-creditanalysis

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Solar-Workflow/solar-workflow

📖

Documentation

https://developers.empresas.btgpactual.com/docs/api-specs-target/Webhooks/webhooks

Specifications

⚙

OpenAPI

https://artifacts.apis.io/btg-pactual/openapi/btg-pactual-enriquecimento-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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-enriquecimento-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:
  description: API implementada pelo parceiro que utilizaremos para buscar informações de nossos clientes em comum dentro da jornada de Onboarding.
  version: 1.0.0
  title: Onboarding Enriquecimento API
servers:
- url: https://api.sandbox.empresas.btgpactual.com
  description: Sandbox
- url: https://api.uat.empresas.btgpactual.com
  description: UAT
- url: https://api.empresas.btgpactual.com
  description: Production
tags:
- name: Enriquecimento
paths:
  /apps/{clientId}/.well-known/customers/{taxId}:
    get:
      tags:
      - Enriquecimento
      description: Obter informações básicas da empresa cliente no parceiro
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          example: '00000000000125'
          title: ClientId
      - name: taxId
        in: path
        required: true
        schema:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11}|[0-9]{14}$
          example: '00000000000125'
          title: TaxId
      - name: x-correlation-id
        in: header
        description: Cabeçalho para correlação de logs
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json-CustomerInfo:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    example: EMPRESA SANDBOX
                  legalNature:
                    type: string
                    example: EI
                  email:
                    type: string
                    example: sandbox@btgpactual.com
                  phoneNumber:
                    type: string
                    example: '5511000000002'
                  patrimonyAmount:
                    type: number
                    example: 0.01
                    title: Money
                  yearlyIncomeAmount:
                    type: number
                    example: 0.01
                    title: Money
                  monthlyAvgRevenueAmount:
                    type: number
                    example: 0.01
                    title: Money
                title: Customer
            application/json-NaturalPersonInfo:
              schema:
                type: object
                properties:
                  generalData:
                    type: object
                    properties:
                      taxId:
                        type: string
                      name:
                        type: string
                      email:
                        type: string
                      phone:
                        type: string
                    title: GeneralData
                  address:
                    type: object
                    properties:
                      type:
                        type: string
                        example: COMERCIAL
                        enum:
                        - RESIDENCIAL
                        - COMERCIAL
                        - OUTROS
                        - NATURALIDADE
                      zipCode:
                        type: string
                        example: '00000001'
                      country:
                        type: string
                        example: BR
                      state:
                        type: string
                        example: SP
                      city:
                        type: string
                        example: SAO PAULO
                      street:
                        type: string
                        example: RUA SANDBOX
                      number:
                        type: string
                        example: '369'
                      complement:
                        type: string
                        example: null
                      neighborhood:
                        type: string
                        example: BAIRRO SANDBOX
                    title: Address
                  additionalData:
                    type: object
                    properties:
                      birthState:
                        type: string
                      birthCity:
                        type: string
                      maritalStatus:
                        type: string
                        enum:
                        - CONTRATO_SOCIAL
                        - PROCURACAO
                        - ESTATUTO_SOCIAL
                        - REQUERIMENTO_EMPRESARIO
                        - BALANCO_DRE
                        - ATA_ELEICAO_DIRETORIA
                        - QUADRO_SOCIETARIO
                        - DOCUMENTO_FINANCEIRO
                        - CCMEI
                        - CARTA_APROVACAO_CONCURSO
                      spouse:
                        type: object
                        properties:
                          name:
                            type: string
                          taxId:
                            type: string
                    title: AdditionalData
                  complementaryData:
                    type: object
                    properties:
                      profession:
                        type: number
                      annualIncome:
                        type: number
                      totalAssets:
                        type: number
                    title: ComplementaryData
                title: NaturalPerson
      security:
      - BearerAuth: []
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/obter-informacoes-basicas-da-empresa-cliente-no-parceiro
      summary: Get apps by client id well known customers by tax id
      x-summary-source: derived
      operationId: getAppsByClientIdWellKnownCustomersByTaxId
      x-operation-id-source: derived
  /apps/{clientId}/.well-known/customers/{taxId}/addresses:
    get:
      tags:
      - Enriquecimento
      description: Obter o endereço informações da empresa cliente no parceiro
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          example: '00000000000125'
          title: ClientId
      - name: taxId
        in: path
        required: true
        schema:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11}|[0-9]{14}$
          example: '00000000000125'
          title: TaxId
      - name: x-correlation-id
        in: header
        description: Cabeçalho para correlação de logs
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Endereços da empresa cliente recuperada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          example: COMERCIAL
                          enum:
                          - RESIDENCIAL
                          - COMERCIAL
                          - OUTROS
                          - NATURALIDADE
                        zipCode:
                          type: string
                          example: '00000001'
                        country:
                          type: string
                          example: BR
                        state:
                          type: string
                          example: SP
                        city:
                          type: string
                          example: SAO PAULO
                        street:
                          type: string
                          example: RUA SANDBOX
                        number:
                          type: string
                          example: '369'
                        complement:
                          type: string
                          example: null
                        neighborhood:
                          type: string
                          example: BAIRRO SANDBOX
                      title: Address
      security:
      - BearerAuth: []
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/obter-o-endereco-informacoes-da-empresa-cliente-no-parceiro
      summary: Get apps by client id well known customers by tax id addresses
      x-summary-source: derived
      operationId: getAppsByClientIdWellKnownCustomersByTaxIdAddresses
      x-operation-id-source: derived
  /apps/{clientId}/.well-known/customers/{taxId}/documents/{pathSuffix}:
    get:
      tags:
      - Enriquecimento
      description: Obter os a lista de documentos existentes da empresa cliente para download no parceiro
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          example: '00000000000125'
          title: ClientId
      - name: taxId
        in: path
        required: true
        schema:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11}|[0-9]{14}$
          example: '00000000000125'
          title: TaxId
      - name: pathSuffix
        in: path
        required: true
        schema:
          type: string
          title: DocumentPathSuffix
      - name: x-correlation-id
        in: header
        description: Cabeçalho para correlação de logs
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Documento da empresa cliente baixado com sucesso
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            image/jpeg:
              schema:
                type: string
                format: binary
            image/jpg:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.wordprocessingml.document:
              schema:
                type: string
                format: binary
            application/msword:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            image/jfif:
              schema:
                type: string
                format: binary
            application/postscript:
              schema:
                type: string
                format: binary
      security:
      - BearerAuth: []
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/obter-os-a-lista-de-documentos-existentes-da-empresa-cliente-para-download-no-parceiro
      summary: Get apps by client id well known customers by tax id documents by path suffix
      x-summary-source: derived
      operationId: getAppsByClientIdWellKnownCustomersByTaxIdDocumentsByPathSuffix
      x-operation-id-source: derived
  /apps/{clientId}/.well-known/customers/{taxId}/legal-representatives:
    get:
      tags:
      - Enriquecimento
      description: Obter os representantes legais da empresa cliente no parceiro
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          example: '00000000000125'
          title: ClientId
      - name: taxId
        in: path
        required: true
        schema:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11}|[0-9]{14}$
          example: '00000000000125'
          title: TaxId
      - name: x-correlation-id
        in: header
        description: Cabeçalho para correlação de logs
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Endereço da empresa cliente recuperada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        cpf:
                          type: string
                          example: '00000000050'
                        name:
                          type: string
                          example: EMPRESA SANDBOX
                        email:
                          type: string
                          example: sandbox@btgpactual.com
                        phoneNumber:
                          type: string
                          example: '5511000000002'
                      title: LegalRepresentative
      security:
      - BearerAuth: []
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/obter-os-representantes-legais-da-empresa-cliente-no-parceiro
      summary: Get apps by client id well known customers by tax id legal representatives
      x-summary-source: derived
      operationId: getAppsByClientIdWellKnownCustomersByTaxIdLegalRepresentatives
      x-operation-id-source: derived
  /apps/{clientId}/.well-known/customers/{taxId}/documents:
    get:
      tags:
      - Enriquecimento
      description: Obter um documento da empresa cliente no parceiro
      parameters:
      - name: clientId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          example: '00000000000125'
          title: ClientId
      - name: taxId
        in: path
        required: true
        schema:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11}|[0-9]{14}$
          example: '00000000000125'
          title: TaxId
      - name: x-correlation-id
        in: header
        description: Cabeçalho para correlação de logs
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Documento da empresa cliente baixado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - CONTRATO_SOCIAL
                          - PROCURACAO
                          - ESTATUTO_SOCIAL
                          - REQUERIMENTO_EMPRESARIO
                          - BALANCO_DRE
                          - ATA_ELEICAO_DIRETORIA
                          - QUADRO_SOCIETARIO
                          - DOCUMENTO_FINANCEIRO
                          - CCMEI
                          - CARTA_APROVACAO_CONCURSO
                          example: REQUERIMENTO_EMPRESARIO
                          title: DocumentType
                        _links:
                          type: object
                          properties:
                            downloadFiles:
                              type: array
                              items:
                                type: object
                                properties:
                                  href:
                                    type: string
                                    format: uri
                                    description: URL do arquivo
                                    example: https://api.uat.empresas.btgpactual.com/apps/94b02c4d-f2ed-4f7b-b743-7280004e79a0/customers/37297902000141/documents/c76e5d20-eb58-4f8b-b851-526da5f89369
                                  method:
                                    type: string
                                    enum:
                                    - GET
                                    description: Método HTTP
                                  accept:
                                    type: string
                                    description: tipo MIME do arquivo
                                title: FileLink
                          title: DocumentLinks
                      title: DocumentItem
                title: Documents
      security:
      - BearerAuth: []
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/Onboarding/obter-um-documento-da-empresa-cliente-no-parceiro
      summary: Get apps by client id well known customers by tax id documents
      x-summary-source: derived
      operationId: getAppsByClientIdWellKnownCustomersByTaxIdDocuments
      x-operation-id-source: derived
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
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/d3628115.8ba34f46.js
  - https://developers.empresas.btgpactual.com/assets/js/10912880.f85f5bcf.js
  - https://developers.empresas.btgpactual.com/assets/js/f5ab7c6f.cc7b961e.js
  - https://developers.empresas.btgpactual.com/assets/js/d5d2dc68.74d9be5e.js
  - https://developers.empresas.btgpactual.com/assets/js/3d452c9d.65073d6b.js
  - https://developers.empresas.btgpactual.com/assets/js/e54615f3.580ec14b.js
  - https://developers.empresas.btgpactual.com/assets/js/6b059a19.95d5357c.js