Entrada de leads

Endereços

Base: https://www.bancadahq.com.br

Método e caminho	Senha da fonte	Para
POST /webhook/leads/{senha}	Dentro do endereço	Fonte que só aceita colar uma URL
POST /webhook/leads	Cabeçalho X-Token: {senha}	Fonte que manda cabeçalho
POST /api/leads	Cabeçalho Authorization: Bearer {senha}	Fonte do tipo API

A senha de uma fonte de webhook não vale em /api/leads, e a de uma fonte de API não vale nos endereços de webhook.

Corpo

• JSON em UTF-8 com Content-Type: application/json.
• Um lead (objeto), uma lista de leads, ou { "leads": [ ... ] }.
• De 1 a 1.000 leads por envio, até 5 MB.

Campos

Os nomes ignoram maiúsculas e separadores: valorMargem, valor_margem e VALOR-MARGEM são o mesmo campo.

Campo	Nomes aceitos	Formato
CPF (obrigatório)	cpf, documento, nr_cpf, cpf_cliente, numero_cpf	Texto ou número; só os dígitos contam; até 11, completa zeros à esquerda
Nome	nome, name, nome_completo, nome_cliente, nomeTrabalhador	Texto; sem nome, a mensagem usa “Cliente”
Margem	margem, margem_disponivel, valorMargem, valor_margem, margem_livre	Número, 1234.56, 1.234,56, R$ 1.234,56 ou 1.500 (milhar)
Admissão	admissao, data_admissao, dataAdmissao, admitido_em, dt_admissao	dd/mm/aaaa ou aaaa-mm-dd
Nascimento	nascimento, data_nascimento, dataNascimento, nascido_em, dt_nascimento	dd/mm/aaaa ou aaaa-mm-dd
Validade da oferta	validade, valido_ate, dataValidade, oferta_valida_ate, valida_ate, dt_validade, dataHoraValidadeSolicitacao	dd/mm/aaaa hh:mm, dd/mm/aaaa ou ISO 8601; sem fuso, vale a hora de Brasília
Telefone	telefone, celular, whatsapp, fone, telefone_celular	Qualquer formato; só os dígitos contam

Campos fora da tabela ficam guardados com o lead. Dois deles o corte sabe ler, se você ligar as regras:

Campo	Nomes aceitos	Regra
Empregador	numeroInscricaoEmpregador, cnpj_empregador, documento_empregador, inscricao_empregador	Com 11 dígitos é CPF: descartado se Descartar empregador sem CNPJ estiver ligado
Pessoa exposta politicamente	pessoaExpostaPoliticamente, pep, pessoa_exposta	{"Codigo": 1, ...}, true, S ou sim é exposta

Um campo conhecido que não dá para ler fica vazio, e o valor original é guardado.

Resposta

200 com a contagem do envio:

{
  "recebidos": 3,
  "aceitos": 2,
  "recusados": [{ "indice": 1, "motivo": "cpf_invalido", "detalhe": "sem CPF" }]
}

Um lead ruim é recusado sozinho; o lote nunca é recusado inteiro por causa dele. CPF com dígito verificador errado é aceito e descartado depois como CPF inválido.

Erros

Formato: { "error": { "code": "...", "message": "...", "details": {} } }

Status	Código	Quando
400	JSON_INVALIDO	O corpo não é JSON
400	CORPO_VAZIO	O corpo veio vazio
400	CORPO_INVALIDO	Não é um lead, uma lista nem { "leads": [...] }
400	SEM_LEADS	A lista veio vazia
401	NAO_AUTORIZADO	Senha errada, trocada, de outro tipo de fonte, ou fonte desligada
413	MUITOS_LEADS	Mais de 1.000 leads
413	CORPO_GRANDE_DEMAIS	Mais de 5 MB
503	RECEPCAO_PAUSADA	Recebimento pausado; o cabeçalho Retry-After: 300 pede reenvio em 5 minutos

Reenvio

Pode reenviar à vontade. O mesmo CPF entra de novo como registro de chegada, mas é consultado uma vez e recebe uma mensagem só.