1. API Key
Bestfy API
  • Sobre a Bestfy
    • Comece aqui
  • Webhooks
    • O que é um Webhook?
  • Status de transação
    • Status de Pagamento na Bestfy
  • Transações
    • Criar transações
      POST
    • Estornar transação
      POST
    • Buscar transação
      GET
    • Listar transações
      GET
  • Saldo
    • Buscar saldo
      GET
  • API Key
    • Validar API Key
      GET
  1. API Key

Validar API Key

GET
https://api.bestfy.io/company/validate-api-key
Use este endpoint para verificar se a API Key informada pelo produtor/seller é válida antes de realizar qualquer transação.
Ele permite confirmar se a chave está correta e vinculada a uma empresa ativa, evitando que erros de configuração sejam descobertos apenas no momento da compra.

Regras de uso#

O header x-api-key é obrigatório.
Utilize este endpoint para validações prévias (onboarding, configuração ou testes).
A resposta segue o mesmo modelo de dados da empresa utilizado nos demais endpoints.

Exemplo de requisição#

Request

Header Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.bestfy.io/company/validate-api-key' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>'
Response Response Example
{
  "company": {
    "id": "9c2e8f41-6a3d-4c2f-9f87-1e6d4b0a9d21",
    "cpf": "123.456.789-09",
    "legalName": "Loja Exemplo LTDA",
    "fantasyName": "Loja Exemplo",
    "invoiceName": "Loja Exemplo",
    "productsType": "PHYSICAL",
    "cep": "01001-000",
    "address": "Rua Exemplo",
    "number": "100",
    "city": "São Paulo",
    "state": "SP",
    "website": "https://loja-exemplo.com",
    "kycReportId": null,
    "averageOrderValueInCents": 25900,
    "averageMonthlyRevenue": "BETWEEN_10K_AND_50K",
    "operationType": "ECOMMERCE",
    "feesConfiguration": "BASE",
    "permissionsConfiguration": "BASE",
    "acquirerConfiguration": "BASE",
    "baasConfiguration": "BASE",
    "financialReserveBaseConfiguration": "BASE",
    "status": "ACTIVE",
    "kybCompanyStatus": "NOT_STARTED",
    "previousStatusBeforeBlocked": "ACTIVE",
    "registrationStatus": "EXTRA_DOCUMENTS_STEP",
    "type": "INDIVIDUAL",
    "createdAt": "2025-09-10T15:40:21.118Z",
    "updatedAt": "2026-02-01T11:12:44.903Z",
    "approvedAt": null
  }
}
Modified at 2026-04-02 20:03:25
Previous
Buscar saldo
Built with