VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Autenticação avançada

Adoção de conta importada por CNPJ

Envia um código ao e-mail antigo de uma conta B2B importada, para o cliente assumir o cadastro ao se registrar.

Quando a loja vem de outra plataforma, os clientes empresariais são importados sem senha. Se um deles se cadastra de novo com o mesmo CNPJ, a loja não pode simplesmente entregar a conta importada: qualquer pessoa que souber o CNPJ assumiria o cadastro. A adoção resolve isso: antes do registro, a plataforma manda um código de verificação ao e-mail que já está na conta importada, e o cliente só consegue assumir a conta se informar esse código.

Esta rota é só o passo de envio. O código volta no campo adoption_otp de POST /api/v1/auth/register, junto com o CNPJ.

Pontos principais
  • A resposta é sempre 200 {"success": true}, para CNPJ inexistente, conta ativa, conta importada ou limite de envios atingido. Não dá para usar a rota para descobrir cadastros.
  • Você não escolhe o destino: o código vai só para o e-mail que consta na conta importada.
  • Só funciona em lojas que ligaram a adoção e o envio do código (módulo cnpj-login). Fora disso, 503.
  • Se a loja usa reCAPTCHA, envie X-Recaptcha-Token.
POST/api/v1/auth/cnpj-adoption/otp/requestPública

Pedir o código de adoção

Corpo da requisição

cnpjstringobrigatório
CNPJ da empresa, com ou sem pontuação.

Cabeçalhos

X-Recaptcha-Tokenstring
Token reCAPTCHA v3, exigido só se a loja configurou reCAPTCHA.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/auth/cnpj-adoption/otp/request" \
  -H "Content-Type: application/json" \
  -d '{
  "cnpj": "12.345.678/0001-95"
}'

Resposta

200Pedido aceito
json
{
  "success": true
}

Campos da resposta

successboolean
Sempre true. Não indica que um e-mail foi enviado.

Erros

StatusQuandoExemplo de corpo
400CNPJ ausente ou corpo inválido.{"error":"invalid_request","detail":"CNPJ is required"}
403reCAPTCHA exigido e ausente ou reprovado.{"error":"captcha_required","detail":"reCAPTCHA token is required"}
429Limite de requisições da família /auth/.{"error":"rate limit exceeded","detail":"too many requests, please try again later"}
503A loja não habilitou a adoção ou o envio do código.{"error":"cnpj_adoption_unavailable","detail":"contact the store to verify the imported account"}
Como montar a tela

Mostre "Se o CNPJ tiver cadastro anterior, enviamos um código para o e-mail dele" e abra o campo do código. Se o cliente não receber, a saída é falar com a loja: a API não confirma nem nega a existência da conta.

Veja também

  • Autenticação
  • Consulta de CNPJ no cadastro
  • Autenticação avançada
Anterior
Aceitar convite de contador
Próxima
Sessão do cliente
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também