Distribuidor
Canal do parceiro que cadastra clientes e certifica os fornecedores deles.
Listar os clientes do seu canal
Os clientes ligados à sua credencial, com o estado do vínculo de cada um.
Listar os clientes do seu canal › Responses
Os seus clientes.
successDo vínculo mais recente para o mais antigo.
totalCadastrar um cliente (depósito) no seu canal
Cria a conta do cliente com o documento dele e devolve o link de primeiro acesso. O cliente conclui o próprio acesso e autoriza o vínculo — até que ele faça isso, o cliente responde com status: "pending_first_access" e ainda não aceita convites de certificação. Aceita Idempotency-Key; reenviar o mesmo documento devolve o cliente já existente em vez de duplicá-lo.
Cadastrar um cliente (depósito) no seu canal › Request Body
documentCNPJ do cliente, com ou sem pontuação.
legal_nametrade_nameexternal_referenceO seu identificador; volta nas respostas de escrita.
Cadastrar um cliente (depósito) no seu canal › Responses
O cliente já existia no seu canal: repetição do cadastro, sem duplicar.
successclient_idexternal_referenceidempotentÉ ele que distingue a repetição do cadastro novo — nunca o status.
statusO estado real naquele instante.
Consultar um cliente do seu canal
Detalhe do cliente e quantos fornecedores dele estão certificados.
path Parameters
idO client_id devolvido no cadastro.
Consultar um cliente do seu canal › Responses
O cliente.
successclient_idnamelegal_namedocumentCNPJ, só dígitos.
statussincecertified_suppliersQuantos fornecedores do depósito têm selo válido agora. A lista sai de /suppliers.
Gerar o convite de certificação de um fornecedor
Gera, em nome do cliente, o link que o fornecedor abre para aderir. Devolve o link e o preço. Exige que o cliente já tenha concluído o primeiro acesso e autorizado o vínculo — caso contrário responde 409 CLIENT_CONSENT_PENDING. Responde status: "invited" (o mesmo nome do estado na lista e nos avisos), price_cents e payment_options — as formas de pagamento que o fornecedor verá na adesão. email diz o desfecho do nosso envio, inclusive undeliverable (o endereço informado não pode receber mensagens).
path Parameters
idO client_id devolvido no cadastro.
Gerar o convite de certificação de um fornecedor › Request Body
documentCPF ou CNPJ do fornecedor.
person_typeTermos da lei brasileira; não se traduzem.
nameexternal_referenceGerar o convite de certificação de um fornecedor › Responses
Convite gerado.
successinvite_idGuarde: é o que o reenvio do convite pede.
external_referencestatusO mesmo nome do primeiro dos estados do andamento e dos avisos.
urlO link que o fornecedor abre. Entregue-o como veio.
price_centsEm centavos de real. Depende do tipo de pessoa — não fixe no seu código.
As formas que o fornecedor verá na adesão, na ordem da página; a primeira é a de price_cents.
reusedtrue = já havia convite vivo para o documento neste depósito, e ele voltou. Chamar de novo não duplica.
emailO que aconteceu com o NOSSO envio — informativo, nunca impede o convite: sent (saiu), sem_destinatario (o convite não trazia contact.email), nao_pedido (send_invite_email: false), reenvio_recente (o mesmo convite já recebeu um e-mail nos últimos minutos), undeliverable (o endereço não pode receber mensagens) e failed (tentamos e não saiu; o link da resposta vale).
Listar os fornecedores de um cliente, com o ANDAMENTO de cada um
Todos os fornecedores daquele cliente e em que ponto está a certificação de cada um — uma linha por documento. O status é um dos nove: invited, invite_expired, awaiting_payment, in_verification, certified, expired, refused, verification_expired e revoked. ⚠️ refused (a verificação recusou) e verification_expired (a pessoa não concluiu) levam a ações opostas e por isso são estados distintos. revoked: o certificado foi revogado e deixou de valer — não é recusa nem vencimento. O andamento, e só ele: esta rota não devolve consulta, histórico, representante, decisão, etapa nem MOTIVO — nada que diga por que um desfecho foi o que foi. ⚠️ Este vocabulário NÃO é o de /distributor/seal, que responde a pergunta binária do selo com valid/expired.
path Parameters
idO client_id devolvido no cadastro.
Listar os fornecedores de um cliente, com o ANDAMENTO de cada um › Responses
Os fornecedores e o andamento de cada um.
successclient_idUma linha por documento.
total0 é resposta normal — também para um client_id fora do seu canal.
Reenviar o primeiro acesso de um cliente pendente
Gera um link de primeiro acesso NOVO (o anterior deixa de valer) e o envia por e-mail ao responsável cadastrado, para o cliente que ainda não concluiu o primeiro acesso. Devolve first_access.url e first_access.email_sent, como no cadastro. Cliente que já concluiu responde 409 CLIENT_ALREADY_ACTIVE. Reenviar não gera aviso.
path Parameters
idO client_id devolvido no cadastro.
Reenviar o primeiro acesso de um cliente pendente › Responses
Primeiro acesso reemitido.
successclient_idstatusReenviar o convite de certificação
Envia de novo, por e-mail, o convite emitido. contact.email, quando vem, passa a ser o contato do convite. Devolve url e email com os valores da emissão. Convite usado, cancelado ou vencido responde 409 INVITE_NOT_OPEN; convite inexistente ou de outro cliente, 404 INVITE_NOT_FOUND. Reenviar não gera aviso.
path Parameters
idO client_id devolvido no cadastro.
invite_idO invite_id devolvido na emissão do convite.
Reenviar o convite de certificação › Responses
Convite reenviado.
successinvite_idurlO mesmo link do convite — reenviar não cria convite novo.
emailO que aconteceu com o NOSSO envio — informativo, nunca impede o convite: sent (saiu), sem_destinatario (o convite não trazia contact.email), nao_pedido (send_invite_email: false), reenvio_recente (o mesmo convite já recebeu um e-mail nos últimos minutos), undeliverable (o endereço não pode receber mensagens) e failed (tentamos e não saiu; o link da resposta vale).
Reenviar o link de verificação ao fornecedor
Para o fornecedor em in_verification: envia de novo, por e-mail, o link da verificação a cada pessoa dele que ainda não concluiu. O documento vai no CORPO, nunca no caminho. Devolve sent e recipients. Fornecedor fora de in_verification responde 409 SUPPLIER_NOT_IN_VERIFICATION; sem link aberto, 409 NO_LINK_TO_RESEND. Reenviar não gera aviso.
path Parameters
idO client_id devolvido no cadastro.
Reenviar o link de verificação ao fornecedor › Request Body
documentCPF ou CNPJ do fornecedor.
Reenviar o link de verificação ao fornecedor › Responses
O desfecho do reenvio (veja sent).
successdocumentO documento normalizado, só dígitos.
senttrue quando ao menos uma pessoa recebeu.
recipientsQuantas pessoas do fornecedor receberam o link agora — sem identificá-las.
Consultar o selo de um fornecedor pelo documento
Diz se aquele documento está certificado no seu canal e até quando o selo vale. Sem custo. Responde certified: false para documento que não esteja certificado em nenhum cliente do seu canal.
query Parameters
documentCPF ou CNPJ, com ou sem pontuação.
Consultar o selo de um fornecedor pelo documento › Responses
O selo — ou certified: false, que também é 200.
successdocumentO documento normalizado, só dígitos.
certifiedtrue se o documento tem selo em pelo menos um depósito do seu canal.
null quando certified é false.