Navegar pela documentação

API BM CHECK BRASIL

Integração clara, do primeiro acesso à resposta.

Consulte BMs em lote com uma API direta, respostas previsíveis e autenticação segura.

Solicitar minha chave Acesso protegido

4endpoints disponíveis

200itens por chamada

Bearerautenticação por chave

PRIMEIRO PASSO

Autenticação

Envie sua chave em todas as chamadas pelo cabeçalho HTTP abaixo. Não coloque a chave em URLs nem a compartilhe em código público.

Authorization: Bearer bmc_CHAVE_DO_USUARIO

REFERÊNCIA

Endpoints

Todos os endpoints recebem JSON por POST e retornam uma estrutura consistente para facilitar sua integração.

Status da BM

Consulta o estado operacional de cada Business Manager informada.

POST/api/v1/bms/status

Um ID numérico de BM por item.Máximo de 200 itens por chamada

Ver exemplos e resposta

curl -X POST "https://seudominio.com/api/v1/bms/status" \
  -H "Authorization: Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"itens":["116217031391791","123456789012345"]}'

const resposta = await fetch("https://seudominio.com/api/v1/bms/status", {
  method: "POST",
  headers: {
    "Authorization": "Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "itens": [
    "116217031391791",
    "123456789012345"
  ]
})
});

const resultado = await resposta.json();

{
  "sucesso": true,
  "dados": [
    {
      "id": "116217031391791",
      "status": "VERIFIED"
    }
  ],
  "meta": {
    "total": 1,
    "processados": 1
  }
}

Informações da BM

Retorna as informações empresariais disponíveis para cada BM.

POST/api/v1/bms/informacoes

Um ID numérico de BM por item.Máximo de 200 itens por chamada

Ver exemplos e resposta

curl -X POST "https://seudominio.com/api/v1/bms/informacoes" \
  -H "Authorization: Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"itens":["116217031391791"]}'

const resposta = await fetch("https://seudominio.com/api/v1/bms/informacoes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "itens": [
    "116217031391791"
  ]
})
});

const resultado = await resposta.json();

{
  "sucesso": true,
  "dados": [
    {
      "id": "116217031391791",
      "status": "VERIFIED"
    }
  ],
  "meta": {
    "total": 1,
    "processados": 1
  }
}

Verificação da BM

Consulta a situação de verificação e os estados de análise da BM.

POST/api/v1/bms/verificacao

Um ID numérico de BM por item.Máximo de 200 itens por chamada

Ver exemplos e resposta

curl -X POST "https://seudominio.com/api/v1/bms/verificacao" \
  -H "Authorization: Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"itens":["116217031391791"]}'

const resposta = await fetch("https://seudominio.com/api/v1/bms/verificacao", {
  method: "POST",
  headers: {
    "Authorization": "Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "itens": [
    "116217031391791"
  ]
})
});

const resultado = await resposta.json();

{
  "sucesso": true,
  "dados": [
    {
      "id": "116217031391791",
      "status": "VERIFIED"
    }
  ],
  "meta": {
    "total": 1,
    "processados": 1
  }
}

Consultar convites

Consulta convites existentes e não gera links. Envie o ID da BM junto do link que já existe.

POST/api/v1/convites/consultar

BMID|Link, por exemplo: 116217031391791|https://business.facebook.com/invite/exemploMáximo de 200 itens por chamada

Ver exemplos e resposta

curl -X POST "https://seudominio.com/api/v1/convites/consultar" \
  -H "Authorization: Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"itens":["116217031391791|https://business.facebook.com/invite/exemplo"]}'

const resposta = await fetch("https://seudominio.com/api/v1/convites/consultar", {
  method: "POST",
  headers: {
    "Authorization": "Bearer bmc_EXEMPLO_SUBSTITUA_PELA_SUA_CHAVE",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "itens": [
    "116217031391791|https://business.facebook.com/invite/exemplo"
  ]
})
});

const resultado = await resposta.json();

{
  "sucesso": true,
  "dados": [
    {
      "id": "116217031391791|https://business.facebook.com/invite/exemplo",
      "status": "VERIFIED"
    }
  ],
  "meta": {
    "total": 1,
    "processados": 1
  }
}

RESPOSTAS

Erros

CHAVE_AUSENTEInforme a chave de API no cabeçalho Authorization.

CHAVE_INVALIDAA chave de API informada é inválida.

CHAVE_REVOGADAEsta chave de API foi revogada.

CHAVE_EXPIRADAEsta chave de API expirou.

CONTA_BLOQUEADAA conta associada a esta chave está bloqueada.

CREDITOS_INSUFICIENTESVocê não possui créditos suficientes.

LIMITE_EXCEDIDOO limite de requisições foi excedido. Tente novamente em instantes.

REQUISICAO_INVALIDARevise os itens enviados e tente novamente.

SERVICO_INDISPONIVELO serviço de consulta está temporariamente indisponível.

ERRO_INTERNONão foi possível concluir a solicitação.

Sem créditos disponíveis, a API responde com HTTP 402 e o código CREDITOS_INSUFICIENTES.

USO RESPONSÁVEL

Limites

200itens por chamada

30chamadas por minuto

1 crédito por requisiçãode 1 a 200 itens

Ao exceder a taxa, a API responde com HTTP 429 e informa quando a próxima tentativa poderá ser realizada.