---
title: "Consult bank values"
method: POST
path: "/v2.1/consult_bank_values"
tags: ["Financial Process"]
---

# Consult bank values

`POST /v2.1/consult_bank_values`

## Request

- Base URL: `https://sandboxapi.fitbank.com.br/main/execute`
- URL: `https://sandboxapi.fitbank.com.br/main/execute/v2.1/consult_bank_values`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.easycredito.com.br/client/auth`
- TypeScript: <https://skmtc.dev/fitbank/apis/onboarding/docs/v2.1/consult_bank_values/post.ts> (a function with typed inputs; its response is checked against the schema)

# Consult bank values
>* Consult bank values
>>* Consulta de saldo

## Request body

- ConsultBankValues
  - `document` string: Documento
  - `bankAccount` string: Número da conta
  - `bankAccountDigit` string: Dígito da conta
  - `bankBranch` string: TIpo de conta
  - `bank` string: > Bancos >> Clique no link a seguir para visualizar os bancos <a href="https://developers.easycredito.com.br/enum/bank.json" target="_blank">https://developers.easycredito.com.br/enum/bank.json</a>
  - `startDate` string, date: Data inicial
  - `endDate` string, date: Data final
  - `type` string: Tipo

## Response `200`

Success

- ResponseConsultBankValues
  - `document` string: Documento
  - `bankAccount` string: Número da conta
  - `bankAccountDigit` string: Dígito da conta
  - `bankBranch` string: TIpo de conta
  - `bank` string: > Bancos >> Clique no link a seguir para visualizar os bancos <a href="https://developers.easycredito.com.br/enum/bank.json" target="_blank">https://developers.easycredito.com.br/enum/bank.json</a>
  - `startDate` string, date: Data inicial
  - `endDate` string, date: Data final
  - `type` string: Tipo

## Other responses

- `400`: Data validation error
- `403`: Forbidden
- `404`: The specified resource was not found

---

[API](https://skmtc.dev/fitbank/apis/onboarding.md) - [All operations](https://skmtc.dev/fitbank/apis/onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/fitbank/apis/onboarding/revisions/f94d262a8f58?raw)