API de Consulta de Saldo

A API de Consulta de Saldo é usada para consultar em tempo real o saldo atual da sua conta eKYCPro e a quota disponível de detecção.

Endpoint da API

GET https://api.ekycpro.com/v1/balance

Método de Requisição

Headers de Requisição

Parâmetro	Obrigatório	Descrição
X-API-Key	Sim	Sua chave de API

Exemplos de Resposta

Resposta com Sucesso

{
  "status": "OK",
  "balance": 1000.50,
  "credit": 5000,
  "used_today": 250.50,
  "daily_limit": 10000,
  "reset_time": "2026-03-20T00:00:00Z"
}

Descrição dos Campos

Campo	Tipo	Descrição
status	string	Status da resposta, OK significa sucesso
balance	number	Saldo atual da conta (USD)
credit	number	Crédito disponível
used_today	number	Quota usada hoje
daily_limit	number	Limite diário
reset_time	string	Horário de reset da quota

Códigos de Status

Código	Descrição
200	Requisição bem-sucedida
401	Falha na autenticação, chave de API inválida
429	Requisições muito frequentes
500	Erro do servidor, tente novamente mais tarde

Exemplos de Código

cURL

curl --location 'https://api.ekycpro.com/v1/balance' \
--header 'X-API-Key: YOUR_API_KEY'

Python

import requests

api_key = 'YOUR_API_KEY'
response = requests.get(
    'https://api.ekycpro.com/v1/balance',
    headers={'X-API-Key': api_key}
)

print(response.json())

JavaScript

const apiKey = 'YOUR_API_KEY';

fetch('https://api.ekycpro.com/v1/balance', {
  headers: {
    'X-API-Key': apiKey
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));