# Repass

> Documentação da API do Repass — plataforma de gestão de afiliados.

## Docs

- [Altera o tier do afiliado](https://userepass.com/docs/api-reference/affiliates/altera-o-tier-do-afiliado.md): Altera o tier do afiliado, afetando a regra de comissão aplicável. `tier: null` retorna o afiliado ao tier base do programa. Dispara o webhook `affiliate.tier_changed`.
- [Anonimiza um afiliado (solicitação do titular, LGPD art. 18)](https://userepass.com/docs/api-reference/affiliates/anonimiza-um-afiliado-solicitação-do-titular-lgpd-art-18.md): Atende a um pedido de eliminação de dados (LGPD art. 18): remove o nome, e-mail e chave PIX do afiliado (substituídos por valores anonimizados), zera IP/user-agent dos cliques associados e expurga PII do histórico de eventos, revogando também a sessão do afiliado no portal. Exige status `rejected`,…
- [Apaga um afiliado de demonstração (hard delete)](https://userepass.com/docs/api-reference/affiliates/apaga-um-afiliado-de-demonstração-hard-delete.md): Remove definitivamente um afiliado técnico `@activation.repass.test` e o subgraph operacional ligado a ele (links, cupons, cliques, conversões, comissões, etc.). Recusa afiliados reais (403). Não escreve no event store.
- [Aprova um afiliado pendente](https://userepass.com/docs/api-reference/affiliates/aprova-um-afiliado-pendente.md): Aprova um afiliado pendente, mudando o status para `approved`. Dispara o webhook `affiliate.approved`.
- [Atualiza um afiliado](https://userepass.com/docs/api-reference/affiliates/atualiza-um-afiliado.md): Atualiza dados do afiliado: nome, regra de comissão customizada e perfil de pagamento/fiscal (método, chave PIX, CNPJ). `pixKey` e `pixKeyType` devem ser definidos ou limpos juntos. Dispara o webhook `affiliate.updated`.
- [Bane um afiliado](https://userepass.com/docs/api-reference/affiliates/bane-um-afiliado.md): Bane permanentemente um afiliado, mudando o status para `banned`. Exige um motivo, que fica registrado no histórico. Dispara o webhook `affiliate.banned`.
- [Consulta o status de uma importação de afiliados](https://userepass.com/docs/api-reference/affiliates/consulta-o-status-de-uma-importação-de-afiliados.md): Retorna o status e o progresso de um import de afiliados: totais, importados, falhados e os erros por linha (linhas inválidas/duplicadas).
- [Consulta um afiliado](https://userepass.com/docs/api-reference/affiliates/consulta-um-afiliado.md): Retorna um afiliado da organização pelo seu ID.
- [Convida um afiliado para o portal](https://userepass.com/docs/api-reference/affiliates/convida-um-afiliado-para-o-portal.md): Emite um convite de acesso ao portal para um afiliado existente e envia a URL de claim por e-mail (em dev, logada no console). O afiliado conclui o cadastro/login e tem a conta vinculada. Falha se o afiliado já tem acesso ao portal.
- [Cria ou retoma um afiliado de demonstração](https://userepass.com/docs/api-reference/affiliates/cria-ou-retoma-um-afiliado-de-demonstração.md): Cria (ou reconcilia) um afiliado técnico de ativação com e-mail determinístico `@activation.repass.test`, status `approved` e link padrão ativo. Não escreve no event store nem dispara webhooks.
- [Cria um afiliado em um programa](https://userepass.com/docs/api-reference/affiliates/cria-um-afiliado-em-um-programa.md): Cria um afiliado no programa. Em `mode: direct` o cadastro é imediato; em `mode: invite` envia um convite para o afiliado concluir o cadastro. Dispara o webhook `affiliate.created`.
- [Importa afiliados de um CSV (assíncrono)](https://userepass.com/docs/api-reference/affiliates/importa-afiliados-de-um-csv-assíncrono.md): Importa afiliados em massa a partir de um CSV (multipart, até 10MB) com as colunas `email`, `name` e os opcionais `total_earned_cents` e `since` (histórico pré-migração). O processamento é assíncrono: o registro nasce `pending` e o progresso pode ser consultado em GET /affiliate-imports/{importId}.…
- [Lista as importações de afiliados](https://userepass.com/docs/api-reference/affiliates/lista-as-importações-de-afiliados.md): Lista os imports de afiliados da organização, com paginação por cursor.
- [Lista o histórico de eventos do afiliado](https://userepass.com/docs/api-reference/affiliates/lista-o-histórico-de-eventos-do-afiliado.md): Lista o histórico de eventos do afiliado (criação, mudanças de status, tier e atualizações), em ordem de ocorrência. Útil para auditoria.
- [Lista os afiliados](https://userepass.com/docs/api-reference/affiliates/lista-os-afiliados.md): Lista os afiliados da organização, com filtros opcionais por programa, status, tier e busca textual (nome/e-mail). Resultados paginados por cursor.
- [Pausa um afiliado aprovado](https://userepass.com/docs/api-reference/affiliates/pausa-um-afiliado-aprovado.md): Suspende temporariamente um afiliado aprovado, mudando o status para `paused`. Dispara o webhook `affiliate.paused`.
- [Reativa um afiliado pausado](https://userepass.com/docs/api-reference/affiliates/reativa-um-afiliado-pausado.md): Reativa um afiliado pausado, mudando o status de volta para `approved`. Dispara o webhook `affiliate.resumed`.
- [Rejeita um afiliado pendente](https://userepass.com/docs/api-reference/affiliates/rejeita-um-afiliado-pendente.md): Rejeita um afiliado pendente, mudando o status para `rejected`. Exige um motivo, que fica registrado no histórico. Dispara o webhook `affiliate.rejected`.
- [Cria uma chave de API da organização](https://userepass.com/docs/api-reference/api-keys/cria-uma-chave-de-api-da-organização.md): Cria uma chave de API da organização (prefixo `rsto_`). A chave pertence à organização, não ao usuário, e opera com escopo de admin. Requer papel owner/admin. A chave em texto puro só é retornada nesta resposta.
- [Lista as chaves de API da organização](https://userepass.com/docs/api-reference/api-keys/lista-as-chaves-de-api-da-organização.md): Lista as chaves de API da organização (config `org-keys`). Requer papel owner/admin. Não retorna o valor da chave.
- [Revoga uma chave de API da organização](https://userepass.com/docs/api-reference/api-keys/revoga-uma-chave-de-api-da-organização.md): Revoga (apaga) uma chave de API da organização. Qualquer integração usando a chave deixa de funcionar imediatamente. Requer papel owner/admin.
- [Contadores de uso da organização](https://userepass.com/docs/api-reference/billing/contadores-de-uso-da-organização.md): Retorna os contadores de uso da sua conta (afiliados aprovados e programas ativos) para a tela de plano e cobrança. Apenas leitura, sem enforcement de limites.
- [Consulta um clique](https://userepass.com/docs/api-reference/clicks/consulta-um-clique.md): Retorna um clique específico da organização pelo seu identificador. Responde 404 se o clique não pertencer à sua organização ou não existir.
- [Estatísticas de cliques de um link (bots excluídos)](https://userepass.com/docs/api-reference/clicks/estatísticas-de-cliques-de-um-link-bots-excluídos.md): Retorna as estatísticas de cliques de um link (total e únicos por visitante), com bots excluídos da contagem. Aceita uma janela opcional de data (from/to) para limitar o período agregado.
- [Lista os cliques](https://userepass.com/docs/api-reference/clicks/lista-os-cliques.md): Lista os cliques da organização com paginação por cursor. Aceita filtros por programa, afiliado, link, classificação de bot, status de conversão e janela de data de ocorrência.
- [Consulta a versão corrente da regra de comissão](https://userepass.com/docs/api-reference/commission-rules/consulta-a-versão-corrente-da-regra-de-comissão.md): Retorna a versão corrente (mais recente) da regra de comissão do programa — aquela aplicada ao calcular novas comissões.
- [Consulta a versão corrente da regra de comissão do tier](https://userepass.com/docs/api-reference/commission-rules/consulta-a-versão-corrente-da-regra-de-comissão-do-tier.md): Retorna a versão corrente (mais recente) da regra de comissão própria do tier — aquela aplicada ao calcular comissões dos afiliados do tier. Retorna 404 quando o tier ainda não tem regra própria (nesse caso vale a regra padrão do programa).
- [Consulta uma versão específica da regra de comissão](https://userepass.com/docs/api-reference/commission-rules/consulta-uma-versão-específica-da-regra-de-comissão.md): Retorna uma versão específica da regra de comissão do programa pelo seu identificador, útil para auditar qual regra foi aplicada a comissões antigas.
- [Cria uma nova versão da regra de comissão](https://userepass.com/docs/api-reference/commission-rules/cria-uma-nova-versão-da-regra-de-comissão.md): Cria uma nova versão da regra de comissão do programa. As regras são imutáveis e versionadas: este endpoint não altera versões anteriores, apenas publica uma nova versão corrente.
- [Cria uma nova versão da regra de comissão de um tier](https://userepass.com/docs/api-reference/commission-rules/cria-uma-nova-versão-da-regra-de-comissão-de-um-tier.md): Publica uma nova versão da regra de comissão própria do tier. As regras são imutáveis e versionadas por dono: este endpoint não altera versões anteriores nem a regra padrão do programa, apenas publica a nova versão corrente do tier.
- [Lista as versões da regra de comissão de um tier (histórico imutável)](https://userepass.com/docs/api-reference/commission-rules/lista-as-versões-da-regra-de-comissão-de-um-tier-histórico-imutável.md): Lista todas as versões da regra de comissão própria do tier, formando o histórico imutável (da mais recente à mais antiga).
- [Lista todas as versões da regra de comissão (histórico imutável)](https://userepass.com/docs/api-reference/commission-rules/lista-todas-as-versões-da-regra-de-comissão-histórico-imutável.md): Lista todas as versões da regra de comissão de um programa, formando o histórico imutável (da mais antiga à mais recente).
- [Anula uma comissão](https://userepass.com/docs/api-reference/commissions/anula-uma-comissão.md): Anula uma comissão, registrando o motivo. Muda o status para `voided` e remove-a de payouts futuros. Idempotente via header `Idempotency-Key`.
- [Aprova uma comissão antecipadamente (antes do fim do hold) ou libera sua revisão de ban](https://userepass.com/docs/api-reference/commissions/aprova-uma-comissão-antecipadamente-antes-do-fim-do-hold-ou-libera-sua-revisão-de-ban.md): Aprova manualmente uma comissão antes do fim do período de hold, ou libera-a de uma revisão (ex.: suspeita de ban). Muda o status para `approved` e preenche `approvedAt`.
- [Consulta uma comissão com o detalhamento do cálculo](https://userepass.com/docs/api-reference/commissions/consulta-uma-comissão-com-o-detalhamento-do-cálculo.md): Retorna uma comissão pelo seu identificador, incluindo a memória de cálculo aberta (regra e versão aplicadas, base, percentuais e detalhes do tipo).
- [Cria uma comissão de bônus avulsa](https://userepass.com/docs/api-reference/commissions/cria-uma-comissão-de-bônus-avulsa.md): Cria uma comissão de bônus avulsa para um afiliado, sem vínculo com conversão (`type=bonus`). Idempotente via header `Idempotency-Key`.
- [Lista as comissões (estornos via type=clawback)](https://userepass.com/docs/api-reference/commissions/lista-as-comissões-estornos-via-type=clawback.md): Lista as comissões da organização, com paginação por cursor. Filtre por afiliado, conversão, payout, status, revisão, tipo, ciclo de cobrança ou janela de `occurredAt`. Estornos aparecem com `type=clawback`.
- [Saldo do afiliado: pendente, aprovado não pago, estornos e projeção do próximo payout](https://userepass.com/docs/api-reference/commissions/saldo-do-afiliado:-pendente-aprovado-não-pago-estornos-e-projeção-do-próximo-payout.md): Retorna o saldo financeiro do afiliado: comissões pendentes, aprovadas não pagas, estornos (clawbacks) e a projeção do próximo payout. Valores em centavos.
- [Anula uma conversão](https://userepass.com/docs/api-reference/conversions/anula-uma-conversão.md): Anula uma conversão com motivo obrigatório, tornando-a inelegível a comissão. Registra um evento de anulação na trilha de auditoria.
- [Consulta uma conversão com seus snapshots de decisão](https://userepass.com/docs/api-reference/conversions/consulta-uma-conversão-com-seus-snapshots-de-decisão.md): Retorna uma conversão com seus snapshots de atribuição, regra de comissão e antifraude. Use `expand[]` para incluir o clique e/ou o afiliado relacionados.
- [Jornada do cliente por trás da atribuição](https://userepass.com/docs/api-reference/conversions/jornada-do-cliente-por-trás-da-atribuição.md): Reconstrói a jornada do cliente: a sequência de toques (cliques em links de afiliados e cupom) e a distribuição de crédito entre os afiliados que levou à atribuição da conversão.
- [Lista as conversões](https://userepass.com/docs/api-reference/conversions/lista-as-conversões.md): Lista paginada das conversões da organização, com filtros por programa, afiliado, status, tipo, método de atribuição e janela de ocorrência.
- [Registra uma conversão manualmente (operador)](https://userepass.com/docs/api-reference/conversions/registra-uma-conversão-manualmente-operador.md): Attributes a conversion to an explicit affiliate. A justification is required and is recorded in the emitted `conversion.created` event.
- [Registra uma conversão (server-to-server)](https://userepass.com/docs/api-reference/conversions/registra-uma-conversão-server-to-server.md): Resolves attribution, applies the commission rule and runs fraud scoring, returning the result in the same response. Repeated requests with the same `sourceEventId` return 200 with the header `Idempotent-Replay: true`. If the customer already has an active conversion in the program, the new one is d…
- [Simula uma conversão sem persistir](https://userepass.com/docs/api-reference/conversions/simula-uma-conversão-sem-persistir.md): Aplica atribuição, regra de comissão e antifraude ao afiliado informado sem criar conversão, comissão, clique ou evento.
- [Trilha de auditoria completa de uma conversão](https://userepass.com/docs/api-reference/conversions/trilha-de-auditoria-completa-de-uma-conversão.md): Retorna a trilha de auditoria completa da conversão: todos os eventos associados a ela, em ordem cronológica.
- [Consulta um cupom com o status de sincronização no provedor](https://userepass.com/docs/api-reference/coupons/consulta-um-cupom-com-o-status-de-sincronização-no-provedor.md): Retorna um cupom da organização pelo seu identificador, incluindo o status atual de sincronização com o provedor de pagamento (`providerSync`).
- [Cria um cupom para um afiliado (sincronizado com o provedor de pagamento)](https://userepass.com/docs/api-reference/coupons/cria-um-cupom-para-um-afiliado-sincronizado-com-o-provedor-de-pagamento.md): Cria um cupom de desconto para o afiliado e dispara a sincronização com o provedor de pagamento. O cupom nasce com status `pending` e passa a `active` (ou `sync_failed`) conforme o resultado da sincronização.
- [Desativa um cupom (propaga para o provedor de pagamento)](https://userepass.com/docs/api-reference/coupons/desativa-um-cupom-propaga-para-o-provedor-de-pagamento.md): Desativa o cupom e propaga a desativação para o provedor de pagamento. O cupom passa a `inactive`, deixa de gerar descontos e tem `deactivatedAt` preenchido.
- [Lista os cupons](https://userepass.com/docs/api-reference/coupons/lista-os-cupons.md): Lista os cupons da organização, com paginação por cursor. Permite filtrar por programa, afiliado e status.
- [Retenta a sincronização com o provedor de pagamento](https://userepass.com/docs/api-reference/coupons/retenta-a-sincronização-com-o-provedor-de-pagamento.md): Reexecuta a sincronização do cupom com o provedor de pagamento, tipicamente após um `sync_failed`. Em caso de sucesso o cupom passa a `active`; em caso de falha permanece `sync_failed`.
- [Comparação do período atual vs anterior](https://userepass.com/docs/api-reference/dashboard/comparação-do-período-atual-vs-anterior.md): Compara o período atual com a janela anterior espelhada `[from−(to−from), from)`. `revenue` soma conversões não-voided (distinto da receita atribuída do herói, que soma comissões). `series` traz a receita (conversões) em 5 fatias alinhadas por índice.
- [Contagem de afiliados e receita atribuída por programa](https://userepass.com/docs/api-reference/dashboard/contagem-de-afiliados-e-receita-atribuída-por-programa.md): Stats agregados por programa: total de afiliados e receita atribuída no período.
- [Contagem de conversões e último clique por afiliado](https://userepass.com/docs/api-reference/dashboard/contagem-de-conversões-e-último-clique-por-afiliado.md): Métricas de linha por afiliado: conversões não anuladas no período e data do último clique (all-time).
- [Conversões ao longo do tempo (não anuladas)](https://userepass.com/docs/api-reference/dashboard/conversões-ao-longo-do-tempo-não-anuladas.md): Conversões não anuladas por bucket de calendário (dia/semana/mês conforme o período).
- [Coortes mensais de afiliados: LTV, clientes e retenção](https://userepass.com/docs/api-reference/dashboard/coortes-mensais-de-afiliados:-ltv-clientes-e-retenção.md): Coortes mensais (mês UTC de criação do afiliado): clientes distintos e LTV médio por afiliado (conversões não-voided, all-time) e retenção nos últimos 30 dias (clique não-bot ou conversão). Meses sem afiliados vêm zerados.
- [Funil de conversão do período](https://userepass.com/docs/api-reference/dashboard/funil-de-conversão-do-período.md): Funil do relatório: cliques não-bot → conversões (todas) → aprovadas (≥1 comissão standard approved/paid) → pagas (≥1 comissão standard paid). Taxas em bps; divisor 0 devolve 0.
- [Novos afiliados ao longo do tempo](https://userepass.com/docs/api-reference/dashboard/novos-afiliados-ao-longo-do-tempo.md): Novos afiliados (por data de criação) por bucket de calendário, conforme o período.
- [Receita atribuída: 30 dias atuais vs anteriores](https://userepass.com/docs/api-reference/dashboard/receita-atribuída:-30-dias-atuais-vs-anteriores.md): Série de receita atribuída (comissões `standard` aprovadas/pagas) dos últimos 30 dias versus os 30 dias anteriores, em 5 buckets alinhados — gráfico-herói da home.
- [Top afiliados por ganhos atribuídos no período](https://userepass.com/docs/api-reference/dashboard/top-afiliados-por-ganhos-atribuídos-no-período.md): Ranking dos afiliados por ganhos atribuídos no período. Usado no módulo compacto da home.
- [Totais de comissão por status no período](https://userepass.com/docs/api-reference/dashboard/totais-de-comissão-por-status-no-período.md): Soma e contagem de comissões por status (pendente/aprovada/paga/anulada) no período.
- [Envelope completo do evento (payload + metadados)](https://userepass.com/docs/api-reference/events/envelope-completo-do-evento-payload-+-metadados.md): Retorna o envelope completo de um único evento de domínio da organização (payload, metadados de ator/origem e timestamps de ocorrência e gravação). Retorna 404 se o evento não existir ou pertencer a outra organização.
- [Lista os eventos de domínio (o log de auditoria como recurso de API)](https://userepass.com/docs/api-reference/events/lista-os-eventos-de-domínio-o-log-de-auditoria-como-recurso-de-api.md): Lista os eventos de domínio da organização — o log de auditoria de tudo que aconteceu na sua conta. Os eventos são imutáveis: uma vez registrados, não podem ser alterados ou removidos. Suporta filtros por tipo, tipo/ID de agregado, tipo de ator e janela temporal de ocorrência, com paginação por curs…
- [Taxonomia de eventos com a versão atual do schema de payload](https://userepass.com/docs/api-reference/events/taxonomia-de-eventos-com-a-versão-atual-do-schema-de-payload.md): Retorna a taxonomia de tipos de evento de domínio reconhecidos pela API, cada um com seu tipo de agregado, a versão atual do schema do payload e uma descrição. Útil para descobrir quais eventos você pode assinar via webhooks.
- [Aprova a NF manualmente (override da validação automática)](https://userepass.com/docs/api-reference/fiscal/aprova-a-nf-manualmente-override-da-validação-automática.md): Aprovação manual pelo operador: válvula de escape quando a extração automática falha ou rejeita indevidamente (PDF ilegível, tomador com grafia diferente) e resgate de NF travada em `processing`. Exige o arquivo enviado. Transiciona para `validated` e libera o pagamento. Emite `invoice.validated` co…
- [Cobra novamente a NF pendente do afiliado](https://userepass.com/docs/api-reference/fiscal/cobra-novamente-a-nf-pendente-do-afiliado.md): Envia um lembrete ao afiliado para que envie a NF pendente do pagamento. Só se aplica a NFs com status `pending`. Registra o evento de cobrança (`invoice.reminder_sent`). Requer um usuário com permissão de administrador (owner ou admin).
- [Consulta uma NF com os dados extraídos e o estado de validação](https://userepass.com/docs/api-reference/fiscal/consulta-uma-nf-com-os-dados-extraídos-e-o-estado-de-validação.md): Retorna uma nota fiscal pelo ID, com os dados extraídos do arquivo (número, série, CNPJ, valor, chave de acesso), a proveniência da extração e o estado de validação (status, erros, motivo de rejeição). Use para acompanhar a extração após o envio (status `processing` → `validated`/`rejected`).
- [Envia o arquivo da NF de um pagamento (extração automática)](https://userepass.com/docs/api-reference/fiscal/envia-o-arquivo-da-nf-de-um-pagamento-extração-automática.md): Envia o arquivo da NF (multipart PDF/XML até 5MB). O arquivo é a única fonte de dados: número, CNPJ do emissor, valor e tomador são extraídos automaticamente (parser de XML NF-e/NFS-e ou IA para PDF) e validados contra o pagamento. A NF fica `processing` durante a extração (assíncrona) e transiciona…
- [Lista as notas fiscais (obrigações de NF)](https://userepass.com/docs/api-reference/fiscal/lista-as-notas-fiscais-obrigações-de-nf.md): Lista as notas fiscais (obrigações de NF) da organização, com paginação por cursor. Permite filtrar por afiliado, payout e status.
- [Rejeita uma NF com um motivo (reabre a pendência do pagamento)](https://userepass.com/docs/api-reference/fiscal/rejeita-uma-nf-com-um-motivo-reabre-a-pendência-do-pagamento.md): Rejeita manualmente uma NF com um motivo. Marca a NF como `rejected`, reabre a pendência de NF do pagamento e permite ao afiliado reenviar o documento. Emite evento de rejeição da NF. Requer um usuário com permissão de administrador (owner ou admin).
- [Revalida a NF com os dados atuais](https://userepass.com/docs/api-reference/fiscal/revalida-a-nf-com-os-dados-atuais.md): Reexecuta a validação determinística sobre os dados JÁ EXTRAÍDOS do arquivo, com o cadastro atual do afiliado e do pagamento; usado após corrigir o CNPJ do afiliado. Não re-extrai o arquivo (para isso, reenvie a NF). Retorna 409 com a extração em andamento (`processing`) ou sem extração concluída. E…
- [URL temporária para download do documento da NF](https://userepass.com/docs/api-reference/fiscal/url-temporária-para-download-do-documento-da-nf.md): Gera uma URL temporária (pré-assinada) para download do arquivo da NF armazenado. A URL expira em poucos minutos (campo `expiresAt`). Requer um usuário com permissão de administrador (owner ou admin).
- [Atualiza a política de fraude](https://userepass.com/docs/api-reference/fraud/atualiza-a-política-de-fraude.md): Atualiza as bandas de decisão antifraude da organização (`approveBelow` <= `reviewAbove`). Aplica-se às próximas conversões avaliadas.
- [Confirma fraude (anula a conversão)](https://userepass.com/docs/api-reference/fraud/confirma-fraude-anula-a-conversão.md): Confirma a fraude da conversão (decisão `confirmed`), anulando-a e tornando-a inelegível a comissão. Registra um evento na trilha de auditoria.
- [Confirma um falso positivo (libera a conversão)](https://userepass.com/docs/api-reference/fraud/confirma-um-falso-positivo-libera-a-conversão.md): Marca a checagem como falso positivo, liberando a conversão da fila de revisão e tornando-a elegível a comissão (decisão `cleared`). Registra um evento na trilha de auditoria.
- [Conversões travadas para revisão manual](https://userepass.com/docs/api-reference/fraud/conversões-travadas-para-revisão-manual.md): Lista paginada das conversões travadas para revisão manual por terem score antifraude acima da banda de revisão configurada.
- [Faixas de decisão de fraude](https://userepass.com/docs/api-reference/fraud/faixas-de-decisão-de-fraude.md): Retorna as bandas de decisão antifraude vigentes da organização: o score abaixo do qual a conversão é aprovada automaticamente e acima do qual é enviada para revisão manual.
- [Score de fraude, decisão e sinais detalhados](https://userepass.com/docs/api-reference/fraud/score-de-fraude-decisão-e-sinais-detalhados.md): Retorna a checagem antifraude de uma conversão: score, decisão e sinais detalhados que compuseram a avaliação.
- [Aplica um patch parcial ao estado do guia](https://userepass.com/docs/api-reference/guide/aplica-um-patch-parcial-ao-estado-do-guia.md): Faz o merge de um patch parcial no estado do guia do usuário na organização ativa e retorna o estado resultante. Semântica de merge: cada entrada de `tours` enviada SUBSTITUI integralmente a armazenada daquele tour, exceto quando a armazenada tem `contentVersion` maior (escritor desatualizado: manté…
- [Consulta o estado do guia do usuário na organização ativa](https://userepass.com/docs/api-reference/guide/consulta-o-estado-do-guia-do-usuário-na-organização-ativa.md): Retorna o estado do guia de onboarding do painel (tours, telas visitadas e preferências) do usuário autenticado na organização ativa. Quando o usuário ainda não interagiu com o guia, retorna o estado inicial vazio com `updatedAt: null`.
- [Verificação de saúde](https://userepass.com/docs/api-reference/health/verificação-de-saúde.md): Endpoint público de liveness usado por load balancers e monitoramento para verificar se a API está no ar. Não exige autenticação e não emite eventos.
- [Aprovação síncrona de saque do Asaas (público, por token)](https://userepass.com/docs/api-reference/ingest/aprovação-síncrona-de-saque-do-asaas-público-por-token.md): Recebe a transferência recém-criada e responde APPROVED/REFUSED. Aprova somente quando casa um payout real do Repass (id, valor, chave PIX e lote fundeado). Autenticação pelo token no header `asaas-access-token`.
- [Connect webhook da plataforma Stripe (público, autenticado por assinatura)](https://userepass.com/docs/api-reference/ingest/connect-webhook-da-plataforma-stripe-público-autenticado-por-assinatura.md): Recebe eventos de contas conectadas via o Connect webhook da plataforma. Autenticação é a assinatura com `STRIPE_CONNECT_WEBHOOK_SECRET`. Roteia pela conta em `event.account`. Retorna 200 quando a assinatura é válida; 401 para assinatura inválida, conta desconhecida ou org sem config.
- [Envio de eventos via API (chave de API)](https://userepass.com/docs/api-reference/ingest/envio-de-eventos-via-api-chave-de-api.md): Envio direto de eventos de cobrança para integrações que não usam um gateway com suporte nativo: conversão, cobrança recorrente (ciclos 2 em diante), estorno/chargeback e cancelamento de assinatura. Reenviar o mesmo `sourceEventId` é tratado como reprocessamento e não duplica o efeito. Autentique co…
- [Webhook do Asaas (público, autenticado por token)](https://userepass.com/docs/api-reference/ingest/webhook-do-asaas-público-autenticado-por-token.md): Recebe eventos do Asaas para a organização: status da conta, conclusão de transferências (repasse) e pagamento do aporte. Autenticação pelo token no header `asaas-access-token`. Retorna 200 mesmo para eventos sem efeito (para o Asaas parar de reentregar); 401 para organização/token inválidos.
- [Webhook do Stripe (público, autenticado por assinatura)](https://userepass.com/docs/api-reference/ingest/webhook-do-stripe-público-autenticado-por-assinatura.md): Recebe eventos do Stripe para a organização indicada no path (config manual). Autenticação é a assinatura do provedor (header `stripe-signature`), não API key. Retorna 200 sempre que a assinatura é válida — inclusive para eventos não tratados, sem match ou rejeitados por regra de negócio — para o St…
- [Atualiza um link (o token é imutável)](https://userepass.com/docs/api-reference/links/atualiza-um-link-o-token-é-imutável.md): Atualiza o subId e/ou a URL de destino do link. O token é imutável e não pode ser alterado. A nova URL de destino, quando informada, deve pertencer a um domínio na whitelist da organização. Emite o evento `link.updated`.
- [Cria um link de afiliado](https://userepass.com/docs/api-reference/links/cria-um-link-de-afiliado.md): Cria um novo link de rastreamento para o afiliado. Se o token for omitido, é gerado um identificador aleatório de 8 caracteres; o token é único globalmente. A URL de destino, quando informada, deve pertencer a um domínio na whitelist da organização. Emite o evento `link.created`.
- [Desativa um link (o token fica reservado por 12 meses)](https://userepass.com/docs/api-reference/links/desativa-um-link-o-token-fica-reservado-por-12-meses.md): Desativa o link: ele deixa de redirecionar e de aceitar cliques. O token permanece reservado por 12 meses, impedindo reaproveitamento. Emite o evento `link.deactivated`.
- [Garante o link padrão de um afiliado](https://userepass.com/docs/api-reference/links/garante-o-link-padrão-de-um-afiliado.md): Retorna o link padrão existente ou cria um novo de forma idempotente. Útil para reparar uma criação de afiliado que foi concluída sem o link automático.
- [Lista os links de um afiliado](https://userepass.com/docs/api-reference/links/lista-os-links-de-um-afiliado.md): Lista todos os links do afiliado (ativos e inativos), incluindo o link padrão gerado automaticamente.
- [Reativa um link inativo](https://userepass.com/docs/api-reference/links/reativa-um-link-inativo.md): Reativa um link inativo, voltando a redirecionar e aceitar cliques. Emite o evento `link.reactivated`.
- [Atualiza um material (nome, formato ou status)](https://userepass.com/docs/api-reference/materials/atualiza-um-material-nome-formato-ou-status.md): Atualiza o `name`, o `format` ou o `status` (`active`/`archived`) de um material. Emite `material.updated`.
- [Consulta um material](https://userepass.com/docs/api-reference/materials/consulta-um-material.md): Retorna um material específico do programa.
- [Exclui um material permanentemente](https://userepass.com/docs/api-reference/materials/exclui-um-material-permanentemente.md): Remove o material e o arquivo do storage de forma permanente (hard-delete). Emite `material.deleted`.
- [Lista os materiais do programa](https://userepass.com/docs/api-reference/materials/lista-os-materiais-do-programa.md): Lista os criativos do programa, com paginação por cursor. Filtre por status (`active`/`archived`).
- [Sobe um material (criativo) do programa](https://userepass.com/docs/api-reference/materials/sobe-um-material-criativo-do-programa.md): Envia um arquivo (multipart: imagem, PDF ou ZIP até 10MB) com os campos `name` e `format?`. O criativo fica disponível para os afiliados baixarem. Emite `material.created`.
- [Envia um documento do onboarding](https://userepass.com/docs/api-reference/pagamentos-por-pix/envia-um-documento-do-onboarding.md): Envia o arquivo de um documento do onboarding (multipart, até 10MB). Só se aplica aos documentos que aceitam upload no painel; documentos de verificação de identidade devem ser enviados pelo link indicado. Requer um usuário com permissão de administrador (owner ou admin).
- [Estado da habilitação de pagamentos por PIX](https://userepass.com/docs/api-reference/pagamentos-por-pix/estado-da-habilitação-de-pagamentos-por-pix.md): Retorna o estado do onboarding de pagamentos por PIX (status, documentos, prontidão e fila de liberação) ou `null` quando ainda não foi habilitado. Alimenta o banner da dashboard.
- [Habilita pagamentos por PIX (inicia o onboarding)](https://userepass.com/docs/api-reference/pagamentos-por-pix/habilita-pagamentos-por-pix-inicia-o-onboarding.md): Inicia a habilitação de pagamentos por PIX para a organização com os dados de KYC. Se houver vaga sob o teto de liberação, o onboarding começa imediatamente (`documents_pending`); caso contrário a organização entra na fila de liberação gradual (`requested`). Requer um usuário com permissão de admini…
- [Sincroniza a lista de documentos requeridos](https://userepass.com/docs/api-reference/pagamentos-por-pix/sincroniza-a-lista-de-documentos-requeridos.md): Atualiza a lista de documentos requeridos a partir do provedor. Requer um usuário com permissão de administrador (owner ou admin).
- [Anexa comprovante de pagamento manual](https://userepass.com/docs/api-reference/payouts/anexa-comprovante-de-pagamento-manual.md): Envia o arquivo do comprovante (PDF/imagem até 5MB) para um payout em liquidação manual. Exige owner/admin.
- [Autoriza o repasse de um lote e gera a cobrança PIX (aporte)](https://userepass.com/docs/api-reference/payouts/autoriza-o-repasse-de-um-lote-e-gera-a-cobrança-pix-aporte.md): Autoriza o repasse do lote (ação do gestor): calcula o total dos repasses pagáveis (NF validada quando exigida e chave PIX definida), soma a folga de taxas e gera uma cobrança PIX (QR Code) na conta da organização nesse valor. Ao pagar o QR, o saldo é confirmado e a distribuição por PIX é liberada.…
- [Cancela o aporte pendente e libera as reservas do lote](https://userepass.com/docs/api-reference/payouts/cancela-o-aporte-pendente-e-libera-as-reservas-do-lote.md): Confirma no provedor que a cobrança ainda está não paga, exclui a cobrança e então cancela os payouts agendados, libera suas comissões e cancela as NFs em uma transação. Requer papel owner/admin. Bloqueado quando a flag PostHog `asaas-payouts` está off.
- [Cancela um payout agendado (as comissões voltam a aprovado não pago)](https://userepass.com/docs/api-reference/payouts/cancela-um-payout-agendado-as-comissões-voltam-a-aprovado-não-pago.md): Cancela um payout agendado: as comissões agregadas voltam ao estado aprovado não pago e o evento de cancelamento é emitido. Exige perfil owner ou admin.
- [Capacidades de liquidação (feature flags)](https://userepass.com/docs/api-reference/payouts/capacidades-de-liquidação-feature-flags.md): Indica se a liquidação via Asaas está habilitada (PostHog `asaas-payouts`). Quando desabilitada, o painel usa liquidação manual.
- [Comprovante de um payout concluído](https://userepass.com/docs/api-reference/payouts/comprovante-de-um-payout-concluído.md): Retorna a URL do comprovante (provedor ou URL assinada do comprovante manual anexado).
- [Consulta um lote de payout com seus payouts e notas fiscais](https://userepass.com/docs/api-reference/payouts/consulta-um-lote-de-payout-com-seus-payouts-e-notas-fiscais.md): Retorna um lote de fechamento. Use `expand=payouts` e/ou `expand=invoices` para incluir os payouts agregados e as notas fiscais vinculadas, e `expand=payable` para o resumo de repasses pagáveis vs. retidos (a mesma regra da autorização do aporte).
- [Consulta um payout com seu snapshot de destino](https://userepass.com/docs/api-reference/payouts/consulta-um-payout-com-seu-snapshot-de-destino.md): Retorna um payout com seu snapshot de destino (fixado na criação). Use `expand=commissions` para incluir as comissões agregadas.
- [Fecha o ciclo de payouts (dryRun padrão true; execução real agenda os payouts)](https://userepass.com/docs/api-reference/payouts/fecha-o-ciclo-de-payouts-dryrun-padrão-true;-execução-real-agenda-os-payouts.md): Fecha o ciclo de payouts. Com `dryRun: true` (padrão) apenas simula; com `dryRun: false` agenda os payouts dos afiliados elegíveis e emite os eventos correspondentes. Exige perfil owner ou admin.
- [Lista os lotes de payout (fechamentos de ciclo)](https://userepass.com/docs/api-reference/payouts/lista-os-lotes-de-payout-fechamentos-de-ciclo.md): Lista os lotes de fechamento de ciclo da organização, com paginação por cursor. Cada lote agrega os payouts de um fechamento, com status derivado (`processing`, `completed`, `partial`) e os totais do ciclo.
- [Lista os payouts](https://userepass.com/docs/api-reference/payouts/lista-os-payouts.md): Lista os payouts da organização, com paginação por cursor. Permite filtrar por afiliado, status e método de pagamento.
- [Marca payouts como pagos (liquidação manual)](https://userepass.com/docs/api-reference/payouts/marca-payouts-como-pagos-liquidação-manual.md): Liquida payouts `scheduled` sem passar pelo Asaas: marca `completed`, paga as comissões e registra `settlementSource=manual`. Sucesso parcial por id. Exige owner/admin.
- [Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos](https://userepass.com/docs/api-reference/payouts/prévia-do-ciclo-de-payouts:-quem-recebe-quanto-e-bloqueios-ativos.md): Simula o fechamento do ciclo de payouts sem agendar nada: lista afiliados elegíveis, valores, afiliados bloqueados (com motivo) e totais consolidados. Por ser apenas uma simulação, não altera nada nem emite eventos.
- [Reconcilia manualmente a cobrança de aporte do lote](https://userepass.com/docs/api-reference/payouts/reconcilia-manualmente-a-cobrança-de-aporte-do-lote.md): Consulta a cobrança vigente no provedor para recuperar uma confirmação cujo webhook não chegou. A operação é idempotente e só libera a distribuição quando o valor líquido cobre integralmente os payouts do aporte. Requer papel owner/admin. Bloqueado quando a flag PostHog `asaas-payouts` está off.
- [Reenfileira um payout que falhou para reprocessamento](https://userepass.com/docs/api-reference/payouts/reenfileira-um-payout-que-falhou-para-reprocessamento.md): Reenfileira um payout com status `failed` para reprocessamento, emite o evento correspondente e dispara a execução em seguida (best-effort; o cron diário é a rede de segurança). Exige perfil owner ou admin.
- [Visão contábil dos payouts liquidados no período (exportação)](https://userepass.com/docs/api-reference/payouts/visão-contábil-dos-payouts-liquidados-no-período-exportação.md): Visão contábil dos payouts concluídos num período (por data de pagamento): uma linha por payout com afiliado, valor, comprovante e situação da NF vinculada. Base para a exportação contábil (CSV) no painel.
- [Atualiza o perfil do usuário autenticado](https://userepass.com/docs/api-reference/profile/atualiza-o-perfil-do-usuário-autenticado.md): Atualiza o perfil do usuário autenticado. Permite alterar o nome e a foto/avatar (enviar `image: null` remove a imagem). Campos omitidos permanecem inalterados; retorna o perfil já atualizado.
- [Consulta o papel do usuário autenticado na organização ativa](https://userepass.com/docs/api-reference/profile/consulta-o-papel-do-usuário-autenticado-na-organização-ativa.md): Retorna a organização sob a qual a sessão opera (tenant resolvido) e o papel do usuário nela. Útil para o cliente decidir o que exibir (ex.: ações de owner/admin). Resolve a org pela mesma regra do `requireAuth` (organização ativa ou única).
- [Consulta o perfil do usuário autenticado](https://userepass.com/docs/api-reference/profile/consulta-o-perfil-do-usuário-autenticado.md): Retorna o perfil do usuário autenticado (nome, e-mail, avatar e papel global).
- [Envia o avatar do usuário autenticado](https://userepass.com/docs/api-reference/profile/envia-o-avatar-do-usuário-autenticado.md): Envia uma imagem (JPEG, PNG, WebP ou GIF, até 2MB), grava no storage e atualiza user.image com a URL pública estável do avatar.
- [Arquiva um programa](https://userepass.com/docs/api-reference/programs/arquiva-um-programa.md): Encerra permanentemente o programa (status `archived`).
- [Arquiva um tier](https://userepass.com/docs/api-reference/programs/arquiva-um-tier.md): Arquiva um tier: ele some da lista ativa e os afiliados desse tier voltam a usar a regra padrão do programa. O histórico da regra própria do tier é preservado. Idempotente. Requer um usuário com função owner ou admin.
- [Ativa um programa](https://userepass.com/docs/api-reference/programs/ativa-um-programa.md): Reativa o programa (status `active`), retomando a atribuição de cliques e conversões.
- [Atualiza um programa](https://userepass.com/docs/api-reference/programs/atualiza-um-programa.md): Atualiza parcialmente a configuração de um programa: apenas os campos enviados são alterados (os omitidos permanecem inalterados).
- [Atualiza um tier (renomear e/ou reposicionar)](https://userepass.com/docs/api-reference/programs/atualiza-um-tier-renomear-eou-reposicionar.md): Renomeia e/ou reposiciona um tier ativo. Informe `name` e/ou `position`. Requer um usuário com função owner ou admin.
- [Consulta um programa](https://userepass.com/docs/api-reference/programs/consulta-um-programa.md): Retorna um programa específico da sua conta pelo seu identificador.
- [Cria um programa](https://userepass.com/docs/api-reference/programs/cria-um-programa.md): Cria um novo programa de afiliados na sua conta, aplicando os valores padrão de configuração (moeda BRL, aprovação manual, janela de atribuição etc.). O programa nasce com status `active`.
- [Cria um tier](https://userepass.com/docs/api-reference/programs/cria-um-tier.md): Cria um tier (faixa) no programa. O nome deve ser único entre os tiers ativos. Se a posição for omitida, o tier vai para o fim da lista. Requer um usuário com função owner ou admin.
- [Lista os programas](https://userepass.com/docs/api-reference/programs/lista-os-programas.md): Lista os programas da sua conta, com paginação por cursor e filtro opcional por status.
- [Lista os tiers ativos do programa](https://userepass.com/docs/api-reference/programs/lista-os-tiers-ativos-do-programa.md): Lista os tiers ativos do programa em ordem de posição. Cada tier tem seu próprio histórico de regra de comissão; tiers sem regra própria usam a regra padrão do programa.
- [Pausa um programa](https://userepass.com/docs/api-reference/programs/pausa-um-programa.md): Suspende temporariamente o programa (status `paused`): novos cliques e conversões deixam de ser atribuídos.
- [Reordena os tiers ativos do programa](https://userepass.com/docs/api-reference/programs/reordena-os-tiers-ativos-do-programa.md): Reescreve as posições dos tiers ativos na ordem informada, numa única operação. Requer um usuário com função owner ou admin.
- [Cancela um job ainda não executado](https://userepass.com/docs/api-reference/reprocessing/cancela-um-job-ainda-não-executado.md): Cancela um job que ainda não foi executado, marcando-o como `canceled` e invalidando seu `confirmationToken`. Requer um usuário com função owner ou admin. Jobs já executados não podem ser cancelados.
- [Cria um job de reprocessamento (sempre uma simulação com o relatório de impacto)](https://userepass.com/docs/api-reference/reprocessing/cria-um-job-de-reprocessamento-sempre-uma-simulação-com-o-relatório-de-impacto.md): Cria um job de reprocessamento de comissões para um programa numa janela de datas, aplicando uma nova regra. Sempre nasce como simulação (`dry_run`): nenhum valor é alterado, apenas é gerado o relatório de impacto (comissões recalculadas, ajustes planejados, delta total e maiores variações por afili…
- [Detalhe item a item: cada comissão com antes/depois](https://userepass.com/docs/api-reference/reprocessing/detalhe-item-a-item:-cada-comissão-com-antesdepois.md): Lista os itens do job de reprocessamento, comissão a comissão, com o estado antes/depois, a variação em centavos e o tipo de tratamento (`recalculate`, `adjustment` ou `blocked`). Resultados paginados.
- [Executa uma simulação aprovada (owner/admin; confirmationToken exigido acima do limite configurado)](https://userepass.com/docs/api-reference/reprocessing/executa-uma-simulação-aprovada-owneradmin;-confirmationtoken-exigido-acima-do-limite-configurado.md): Aplica em definitivo um job que está em `dry_run`: recalcula as comissões elegíveis e cria comissões de ajuste para as já pagas/travadas (e notifica os afiliados conforme suas preferências de reprocessamento). Requer um usuário com função owner ou admin. Quando o impacto excede o limite configurado,…
- [Lista os jobs de reprocessamento (histórico por programa)](https://userepass.com/docs/api-reference/reprocessing/lista-os-jobs-de-reprocessamento-histórico-por-programa.md): Lista os jobs de reprocessamento da organização (histórico), com paginação por cursor. Permite filtrar por programa (`program_id`) e por status (`dry_run`, `executed`, `canceled`).
- [Status do job + resumo de impacto](https://userepass.com/docs/api-reference/reprocessing/status-do-job-+-resumo-de-impacto.md): Retorna um job de reprocessamento pelo ID, com seu status e o resumo de impacto. O `confirmationToken` só é exposto enquanto o job está em `dry_run`.
- [Adiciona um domínio personalizado](https://userepass.com/docs/api-reference/settings/adiciona-um-domínio-personalizado.md): Adiciona um domínio próprio (em `pending`) e gera o token de verificação para o registro TXT. Requer papel owner/admin. Emite `custom_domain.added`.
- [Atualiza a configuração do tracker client-side](https://userepass.com/docs/api-reference/settings/atualiza-a-configuração-do-tracker-client-side.md): Ajusta a política `trustClientSide` e/ou rotaciona a publishable key. Rotacionar invalida a key anterior — o script instalado precisa ser atualizado.
- [Atualiza a política de payouts (vale para os próximos ciclos)](https://userepass.com/docs/api-reference/settings/atualiza-a-política-de-payouts-vale-para-os-próximos-ciclos.md): Atualiza a política de payouts da organização (ciclo, dia de fechamento, valor mínimo e método padrão). Vale para os próximos ciclos. Exige perfil owner ou admin.
- [Atualiza a política de reprocessamento](https://userepass.com/docs/api-reference/settings/atualiza-a-política-de-reprocessamento.md): Atualiza as preferências de reprocessamento da organização (limite de confirmação e modo de notificação dos afiliados). Requer um usuário com função owner ou admin.
- [Atualiza a política fiscal (atualmente apenas o modo affiliate_uploads é aceito)](https://userepass.com/docs/api-reference/settings/atualiza-a-política-fiscal-atualmente-apenas-o-modo-affiliate_uploads-é-aceito.md): Atualiza a política fiscal da organização. Atualmente apenas o modo `affiliate_uploads` é aceito. Requer um usuário com permissão de administrador (owner ou admin).
- [Atualiza o branding whitelabel do portal](https://userepass.com/docs/api-reference/settings/atualiza-o-branding-whitelabel-do-portal.md): Atualiza cores e flag de marca Repass (merge parcial: campo omitido preserva, `null` limpa). A logo é gerenciada via POST/DELETE `/settings/portal-branding/logo`. Requer papel owner/admin. Emite `settings.updated`.
- [Conclui a conexão OAuth de uma conta Stripe](https://userepass.com/docs/api-reference/settings/conclui-a-conexão-oauth-de-uma-conta-stripe.md)
- [Consulta a configuração do tracker client-side](https://userepass.com/docs/api-reference/settings/consulta-a-configuração-do-tracker-client-side.md): Retorna a publishable key (`pk_*`) do script client-side e a política de confiança (`trustClientSide`). Provisiona a key na primeira chamada (idempotente).
- [Consulta o branding whitelabel do portal](https://userepass.com/docs/api-reference/settings/consulta-o-branding-whitelabel-do-portal.md): Retorna o branding do portal da organização (logo, cores, flag de marca Repass) aplicado quando o portal é servido no domínio do cliente. Sem configuração, retorna os defaults (marca Repass).
- [Define o segredo de assinatura do webhook do Stripe](https://userepass.com/docs/api-reference/settings/define-o-segredo-de-assinatura-do-webhook-do-stripe.md): Define (ou substitui) o signing secret do webhook do Stripe da organização, usado para verificar a assinatura HMAC dos eventos recebidos. Retorna a configuração mascarada.
- [Define um domínio personalizado como principal](https://userepass.com/docs/api-reference/settings/define-um-domínio-personalizado-como-principal.md): Marca um domínio verificado como o primário da organização (usado por padrão em novos links). Zera o primário anterior. Requer papel owner/admin. Emite `custom_domain.primary_changed`.
- [Desconecta a integração Stripe com recuperação segura](https://userepass.com/docs/api-reference/settings/desconecta-a-integração-stripe-com-recuperação-segura.md)
- [Envia a logo do portal whitelabel](https://userepass.com/docs/api-reference/settings/envia-a-logo-do-portal-whitelabel.md): Envia uma imagem (PNG, JPEG ou SVG, até 2MB), grava no storage e atualiza `portal_branding.logoUrl` com a URL pública estável. Requer owner/admin e feature de branding.
- [Exibe a configuração do webhook do Stripe (mascarada)](https://userepass.com/docs/api-reference/settings/exibe-a-configuração-do-webhook-do-stripe-mascarada.md): Retorna a configuração do webhook do Stripe da organização de forma mascarada: indica se está configurada e exibe apenas os 4 últimos dígitos do signing secret, nunca o segredo completo.
- [Inicia a conexão OAuth de uma conta Stripe](https://userepass.com/docs/api-reference/settings/inicia-a-conexão-oauth-de-uma-conta-stripe.md)
- [Lista os domínios de destino permitidos](https://userepass.com/docs/api-reference/settings/lista-os-domínios-de-destino-permitidos.md): Retorna a whitelist de domínios de destino permitidos para URLs de links da organização.
- [Lista os domínios personalizados da organização](https://userepass.com/docs/api-reference/settings/lista-os-domínios-personalizados-da-organização.md): Lista os domínios próprios da organização, com o estado de verificação de DNS e de TLS. Filtra por tipo com `?kind=link|portal`.
- [Política de payouts vigente (ciclo, dia de fechamento, mínimo, método)](https://userepass.com/docs/api-reference/settings/política-de-payouts-vigente-ciclo-dia-de-fechamento-mínimo-método.md): Retorna a política de payouts vigente da organização (ciclo de fechamento, dia de fechamento, valor mínimo e método padrão).
- [Política de reprocessamento: limite de confirmação e modo de notificação ao afiliado](https://userepass.com/docs/api-reference/settings/política-de-reprocessamento:-limite-de-confirmação-e-modo-de-notificação-ao-afiliado.md): Retorna as preferências de reprocessamento da organização: o limite de impacto (em centavos) que dispara a dupla confirmação e o modo de notificação dos afiliados.
- [Política fiscal vigente (modo de NF)](https://userepass.com/docs/api-reference/settings/política-fiscal-vigente-modo-de-nf.md): Retorna a política fiscal atual da organização: o modo de emissão da NF (`nfMode`).
- [Remove a logo do portal whitelabel](https://userepass.com/docs/api-reference/settings/remove-a-logo-do-portal-whitelabel.md): Apaga o arquivo no storage e limpa `portal_branding.logoUrl`. Requer owner/admin e feature de branding.
- [Remove um domínio personalizado](https://userepass.com/docs/api-reference/settings/remove-um-domínio-personalizado.md): Remove o domínio (hard-delete). Links que o usavam voltam ao domínio padrão. Requer papel owner/admin. Emite `custom_domain.removed`.
- [Substitui a lista de domínios de destino permitidos](https://userepass.com/docs/api-reference/settings/substitui-a-lista-de-domínios-de-destino-permitidos.md): Substitui por completo a whitelist de domínios de destino permitidos para URLs de links da organização. Domínios fora desta lista são rejeitados na criação/atualização de links. Após salvar, revalida os links existentes: os que apontam para um domínio que saiu da whitelist têm o destino removido — `…
- [Verifica a saúde atual da conexão Stripe](https://userepass.com/docs/api-reference/settings/verifica-a-saúde-atual-da-conexão-stripe.md)
- [Verifica o DNS de um domínio personalizado](https://userepass.com/docs/api-reference/settings/verifica-o-dns-de-um-domínio-personalizado.md): Verifica a posse (TXT `_repass.<hostname>`) e o roteamento (CNAME) do domínio. Sucesso marca `verified` e emite `custom_domain.verified`; falha não altera o estado. Requer papel owner/admin.
- [Lista as versões dos termos de um programa (da mais recente)](https://userepass.com/docs/api-reference/terms/lista-as-versões-dos-termos-de-um-programa-da-mais-recente.md): Lista todas as versões de termos publicadas para um programa, da mais recente para a mais antiga. Cada versão é imutável e tem um formato (`markdown`, `pdf` ou `link`).
- [Lista os templates de termos](https://userepass.com/docs/api-reference/terms/lista-os-templates-de-termos.md): Retorna o catálogo completo de templates de termos em Markdown curados pelo Repass. O gestor pode preencher as variáveis e editar livremente o conteúdo antes de publicar uma nova versão.
- [Publica uma nova versão dos termos a partir de um PDF (multipart)](https://userepass.com/docs/api-reference/terms/publica-uma-nova-versão-dos-termos-a-partir-de-um-pdf-multipart.md): Publica uma nova versão imutável dos termos a partir de um arquivo PDF (multipart, até 10MB) com o campo opcional `requireReacceptance`. O arquivo é guardado no storage e baixado depois via `GET /programs/:programId/terms/:version/file`. Só administradores. Emite o evento `terms.published`.
- [Publica uma nova versão dos termos (markdown ou link externo)](https://userepass.com/docs/api-reference/terms/publica-uma-nova-versão-dos-termos-markdown-ou-link-externo.md): Publica uma nova versão imutável dos termos do programa no formato `markdown` (texto) ou `link` (URL externa), incrementando o número de versão. Para enviar um PDF use `POST /programs/:programId/terms/file`. Por ser uma mudança jurídica sensível, só pode ser realizada por administradores (ou proprie…
- [URL temporária para visualizar/baixar uma versão em PDF dos termos](https://userepass.com/docs/api-reference/terms/url-temporária-para-visualizarbaixar-uma-versão-em-pdf-dos-termos.md): Gera uma URL temporária (pré-assinada) para visualizar/baixar o PDF de uma versão de termos cujo formato é `pdf`. A URL expira em poucos minutos (`expiresAt`). Disponível para qualquer membro autenticado.
- [Associa um visitante a um e-mail com hash (público)](https://userepass.com/docs/api-reference/tracking/associa-um-visitante-a-um-e-mail-com-hash-público.md): Rota pública (sem autenticação). Associa um visitante a um e-mail hasheado (SHA-256) para casamento de identidade entre dispositivos. Idempotente por (visitorId, emailHash); a organização é derivada do clique mais recente do visitante. Responde 201 quando cria a identidade e 200 quando já existia.
- [Redirecionamento de link de afiliado (público)](https://userepass.com/docs/api-reference/tracking/redirecionamento-de-link-de-afiliado-público.md): Rota pública (não requer autenticação). Registra o clique, define o cookie first-party do visitante e responde 302 para o destino com o id do clique anexado no parâmetro repass_cid. Respeita o status do programa e do afiliado: programas arquivados redirecionam para a landing page sem rastrear, afili…
- [Registra um clique via snippet JS (público)](https://userepass.com/docs/api-reference/tracking/registra-um-clique-via-snippet-js-público.md): Rota pública (não requer autenticação). Registra um clique enviado pelo snippet JS a partir do token do link. Responde 201 com o clique rastreado ou 200 quando o rastreamento é pulado (afiliado pendente ou programa arquivado). Links removidos respondem 410. Emite o evento de webhook `click.recorded`…
- [Registra uma conversão via tracker client-side (público)](https://userepass.com/docs/api-reference/tracking/registra-uma-conversão-via-tracker-client-side-público.md): Rota pública autenticada pela publishable key (`pk_*`) no header `X-Repass-Key` — nunca pela chave secreta. Registra uma conversão disparada pelo tracker no browser (`source: script`). A organização é derivada da publishable key. Idempotente por `sourceEventId`. Se a organização não confia no client…
- [Atualiza URL, eventos assinados ou status](https://userepass.com/docs/api-reference/webhooks/atualiza-url-eventos-assinados-ou-status.md): Atualiza parcialmente um endpoint de webhook: URL de destino, descrição, eventos assinados e/ou status. Reativar (status `active`) um endpoint desabilitado por alta taxa de falhas limpa o motivo de desativação.
- [Consulta um endpoint de webhook](https://userepass.com/docs/api-reference/webhooks/consulta-um-endpoint-de-webhook.md): Retorna um endpoint de webhook da sua conta pelo seu ID. O segredo de assinatura é retornado mascarado.
- [Cria um endpoint de webhook (o segredo é retornado SÓ aqui)](https://userepass.com/docs/api-reference/webhooks/cria-um-endpoint-de-webhook-o-segredo-é-retornado-só-aqui.md): Cria um endpoint de webhook de saída para a sua conta e gera seu segredo de assinatura HMAC. O segredo em claro é retornado apenas nesta resposta — guarde-o, pois depois só aparece mascarado.
- [Entregas esgotadas aguardando reenvio manual](https://userepass.com/docs/api-reference/webhooks/entregas-esgotadas-aguardando-reenvio-manual.md): Lista as entregas em dead-letter do endpoint — aquelas cujas tentativas automáticas se esgotaram e aguardam reenvio manual. Paginação por cursor.
- [Envia uma entrega webhook.test assinada para validar a integração](https://userepass.com/docs/api-reference/webhooks/envia-uma-entrega-webhooktest-assinada-para-validar-a-integração.md): Envia uma entrega de teste `webhook.test` assinada por HMAC ao endpoint para validar a integração. O evento de teste não fica registrado no histórico de eventos; retorna o resultado da entrega (status, resposta e latência).
- [Exclui um endpoint de webhook (o log de entregas vai junto)](https://userepass.com/docs/api-reference/webhooks/exclui-um-endpoint-de-webhook-o-log-de-entregas-vai-junto.md): Remove permanentemente um endpoint de webhook da sua conta. Todo o histórico de entregas associado (incluindo entregas em dead-letter) é apagado junto.
- [Lista os endpoints de webhook (segredos sempre mascarados)](https://userepass.com/docs/api-reference/webhooks/lista-os-endpoints-de-webhook-segredos-sempre-mascarados.md): Lista os endpoints de webhook da sua conta com paginação por cursor. Os segredos de assinatura são sempre retornados mascarados.
- [Log de entregas dos últimos 30 dias](https://userepass.com/docs/api-reference/webhooks/log-de-entregas-dos-últimos-30-dias.md): Lista o histórico de entregas do endpoint nos últimos 30 dias, com paginação por cursor e filtro opcional por status. Inclui detalhes de requisição, resposta e latência de cada tentativa.
- [Reenvia uma entrega: enfileira uma nova tentativa referenciando a original](https://userepass.com/docs/api-reference/webhooks/reenvia-uma-entrega:-enfileira-uma-nova-tentativa-referenciando-a-original.md): Agenda uma nova tentativa de entrega para uma entrega existente (tipicamente em dead-letter), criando uma entrega de reenvio que referencia a original via `replayOfId`. Responde 202 com a entrega recém-agendada.
- [Rotaciona o segredo de assinatura (janela de carência de 24h assina com os dois)](https://userepass.com/docs/api-reference/webhooks/rotaciona-o-segredo-de-assinatura-janela-de-carência-de-24h-assina-com-os-dois.md): Gera um novo segredo de assinatura HMAC para o endpoint e retorna o valor em claro (única vez que ele aparece). Durante uma janela de carência de 24h as entregas são assinadas com o segredo novo e o anterior, evitando perda de mensagens enquanto você atualiza a verificação no seu lado.
- [Autenticação](https://userepass.com/docs/autenticacao.md): Autentique requisições com chaves de API e entenda organizações e papéis.
- [Uso com agentes](https://userepass.com/docs/cli/agentes.md): A skill repass-cli: boas práticas embarcadas para Claude e outros agentes de terminal.
- [Autenticação](https://userepass.com/docs/cli/autenticacao.md): Login por device flow ou chave de API, organização ativa, logout e whoami.
- [Automação e CI](https://userepass.com/docs/cli/automacao-ci.md): Uso não interativo da CLI: chave de API, --yes, --json e exit codes em pipelines.
- [Configuração](https://userepass.com/docs/cli/configuracao.md): Onde a CLI guarda estado local, perfis nomeados, variáveis de ambiente e precedência.
- [Convenções](https://userepass.com/docs/cli/convencoes.md): Anatomia de um comando, saída, corpo de requisição, modelo de risco, exit codes e erros.
- [Instalação](https://userepass.com/docs/cli/instalacao.md): Instale o binário repass globalmente com npm, pnpm ou yarn.
- [Paginação](https://userepass.com/docs/cli/paginacao.md): --limit, cursores e --all nos comandos de listagem da CLI.
- [Afiliados (CLI)](https://userepass.com/docs/cli/recursos/affiliates.md): Comandos de cadastro, ciclo de vida, tier, saldo, timeline e import em massa de afiliados.
- [Cliques (CLI)](https://userepass.com/docs/cli/recursos/clicks.md): Comandos de consulta ao histórico de cliques de rastreamento.
- [Comissões (CLI)](https://userepass.com/docs/cli/recursos/commissions.md): Comandos do ledger de comissões: listagem, aprovação, estorno e bônus avulsos.
- [Conversões (CLI)](https://userepass.com/docs/cli/recursos/conversions.md): Comandos de ingestão, atribuição, criação manual, anulação, auditoria e jornada de conversões.
- [Cupons (CLI)](https://userepass.com/docs/cli/recursos/coupons.md): Comandos de cupons de afiliado: emissão, listagem, sincronização e desativação.
- [Dashboard (CLI)](https://userepass.com/docs/cli/recursos/dashboard.md): Métricas agregadas da organização (receita, ranking de afiliados, séries temporais) e notificações.
- [Events (CLI)](https://userepass.com/docs/cli/recursos/events.md): Event store: log de auditoria append-only da organização, com a taxonomia de tipos.
- [Fraud (CLI)](https://userepass.com/docs/cli/recursos/fraud.md): Fila de revisão antifraude e decisões sobre conversões suspeitas.
- [Invoices (CLI)](https://userepass.com/docs/cli/recursos/invoices.md): Comandos de envio, validação, rejeição, cobrança e download de notas fiscais.
- [Links (CLI)](https://userepass.com/docs/cli/recursos/links.md): Comandos de links de rastreamento: criação, atualização, ciclo de vida e estatísticas.
- [Payout batches (CLI)](https://userepass.com/docs/cli/recursos/payout-batches.md): Comandos de consulta aos lotes de fechamento de ciclo (histórico de pagamentos agrupados por rodada).
- [Payouts (CLI)](https://userepass.com/docs/cli/recursos/payouts.md): Comandos de ciclos de pagamento: prévia, execução, retentativa, cancelamento, recibos e relatório contábil.
- [Profile (CLI)](https://userepass.com/docs/cli/recursos/profile.md): Perfil do usuário autenticado, organização ativa (membership) e avatar.
- [Programas (CLI)](https://userepass.com/docs/cli/recursos/programs.md): Comandos de programas, tiers, regras de comissão, termos e materiais.
- [Reprocess (CLI)](https://userepass.com/docs/cli/recursos/reprocess.md): Jobs de reprocessamento de comissões: dry-run, inspeção do impacto e execução.
- [Settings (CLI)](https://userepass.com/docs/cli/recursos/settings.md): Políticas da organização por área, domínios próprios e chaves de API.
- [Webhooks (CLI)](https://userepass.com/docs/cli/recursos/webhooks.md): Endpoints de webhook, segredo de assinatura, entregas, dead-letter e reenvio.
- [CLI](https://userepass.com/docs/cli/visao-geral.md): Camada de terminal oficial da Repass: o binário repass, sobre a mesma API do SDK.
- [Afiliados](https://userepass.com/docs/conceitos/afiliados.md): Ciclo de vida do afiliado: cadastro, aprovação, tiers e termos.
- [Modelos de atribuição](https://userepass.com/docs/conceitos/atribuicao.md): Os cinco modelos de atribuição e como dividem a comissão.
- [Comissões](https://userepass.com/docs/conceitos/comissoes.md): Cálculo, holds, aprovação, void e clawback de comissões.
- [Conversões e fraude](https://userepass.com/docs/conceitos/conversoes-e-fraude.md): Ingestão, matching, atribuição e scoring de fraude de conversões.
- [Event store e auditoria](https://userepass.com/docs/conceitos/event-store.md): Trilha de auditoria imutável e reconstrução de decisões.
- [Fiscal (Brasil)](https://userepass.com/docs/conceitos/fiscal.md): Notas fiscais e política fiscal no Brasil.
- [Ingestão de eventos](https://userepass.com/docs/conceitos/ingestao.md): Receba eventos de cobrança via webhook de gateway ou S2S.
- [Links e cupons](https://userepass.com/docs/conceitos/links-e-cupons.md): Links rastreáveis, tokens e cupons de afiliado.
- [Payouts](https://userepass.com/docs/conceitos/payouts.md): Ciclos de pagamento, prévia, execução e comprovantes.
- [Programas e regras de comissão](https://userepass.com/docs/conceitos/programas-e-regras.md): Configure programas de afiliados e regras de comissão versionadas.
- [Reprocessamento](https://userepass.com/docs/conceitos/reprocessamento.md): Recalcule comissões com dry-run obrigatório e relatório de impacto.
- [Termos do programa](https://userepass.com/docs/conceitos/termos.md): Versionamento e aceite de termos por programa.
- [Tracking de cliques](https://userepass.com/docs/conceitos/tracking.md): Como cliques são registrados, atribuídos e protegidos (LGPD).
- [Ambientes e limites](https://userepass.com/docs/convencoes/ambientes.md): URLs base, versionamento e limites de uso da API.
- [Erros](https://userepass.com/docs/convencoes/erros.md): Formato padronizado de erros e códigos de status.
- [Expand](https://userepass.com/docs/convencoes/expand.md): Carregue recursos relacionados com o parâmetro expand.
- [Idempotência](https://userepass.com/docs/convencoes/idempotencia.md): Reenvie requisições POST com segurança usando Idempotency-Key.
- [IDs e recursos](https://userepass.com/docs/convencoes/ids-e-recursos.md): Formato dos identificadores e convenções de recursos da API.
- [Paginação](https://userepass.com/docs/convencoes/paginacao.md): Paginação por cursor em todos os endpoints de listagem.
- [Conversões server-to-server](https://userepass.com/docs/guias/conversoes-server-to-server.md): Envie conversões com confiabilidade via S2S e idempotência.
- [Integração básica](https://userepass.com/docs/guias/integracao-basica.md): Do zero à primeira comissão: integração ponta a ponta.
- [Integrar Stripe](https://userepass.com/docs/guias/integrar-stripe.md): Conecte o Stripe e propague repass_cid na metadata para atribuir cada venda ao afiliado certo.
- [Atribuição multi-touch](https://userepass.com/docs/guias/multi-touch-atribuicao.md): Exemplo prático de divisão de comissão entre múltiplos cliques.
- [Refund e clawback](https://userepass.com/docs/guias/refund-e-clawback.md): Como reembolsos geram clawback de comissão.
- [Reprocessar mudança de regra](https://userepass.com/docs/guias/reprocessar-mudanca-de-regra.md): Recalcule comissões após alterar uma regra, com segurança.
- [Tracker client-side (script)](https://userepass.com/docs/guias/script-tracker-client-side.md): Instale a tag da Repass, identifique visitantes e registre conversões direto do navegador.
- [Introdução](https://userepass.com/docs/introducao.md): O que é o Repass e as superfícies da plataforma: painel, portal white-label, API, SDK, CLI e servidor MCP.
- [Início rápido](https://userepass.com/docs/quickstart.md): Integre com a API do Repass em poucos passos: crie um Programa, aprove um Afiliado, gere um Link, registre uma Conversão e consulte a Comissão.
- [Configuração](https://userepass.com/docs/sdk/configuracao.md): Inicialização do client, base URL, timeout, retries, fetch customizado, idempotência e opções por requisição.
- [Tratamento de erros](https://userepass.com/docs/sdk/erros.md): A hierarquia RepassError, propriedades e como estreitar cada caso no catch.
- [Início rápido (SDK)](https://userepass.com/docs/sdk/inicio-rapido.md): Do zero a uma comissão calculada usando o @repass/sdk em TypeScript.
- [Paginação](https://userepass.com/docs/sdk/paginacao.md): Listagens por cursor: aguarde uma página ou percorra todas automaticamente.
- [Recursos e métodos](https://userepass.com/docs/sdk/recursos.md): O client expõe um namespace por recurso. Veja a página de cada um para os métodos e exemplos.
- [Affiliates](https://userepass.com/docs/sdk/recursos/affiliates.md): Ciclo de vida, tier, saldo e timeline dos afiliados.
- [Clicks](https://userepass.com/docs/sdk/recursos/clicks.md): Histórico de cliques de rastreamento, com filtro de bots.
- [Commissions](https://userepass.com/docs/sdk/recursos/commissions.md): Ledger de comissões: listagem, aprovação, estorno e bônus avulsos.
- [Conversions](https://userepass.com/docs/sdk/recursos/conversions.md): Ingestão, atribuição, anulação e auditoria de conversões.
- [Coupons](https://userepass.com/docs/sdk/recursos/coupons.md): Cupons de afiliado e sincronização com o gateway de pagamento.
- [Events](https://userepass.com/docs/sdk/recursos/events.md): Event store: log de auditoria append-only com a taxonomia de tipos.
- [Fraud](https://userepass.com/docs/sdk/recursos/fraud.md): Fila de revisão antifraude e decisões sobre conversões suspeitas.
- [Invoices](https://userepass.com/docs/sdk/recursos/invoices.md): Notas fiscais: envio multipart, validação, rejeição e download.
- [Links](https://userepass.com/docs/sdk/recursos/links.md): Links de rastreamento dos afiliados, com ciclo de vida e estatísticas.
- [Payout batches](https://userepass.com/docs/sdk/recursos/payout-batches.md): Lotes de fechamento de ciclo: histórico dos payouts agrupados por rodada.
- [Payouts](https://userepass.com/docs/sdk/recursos/payouts.md): Ciclos de pagamento: prévia, execução, retentativa, cancelamento e recibos.
- [Profile](https://userepass.com/docs/sdk/recursos/profile.md): Perfil do usuário ou credencial autenticada (/me).
- [Programs](https://userepass.com/docs/sdk/recursos/programs.md): Programas de afiliados e seus sub-recursos: tiers, regras de comissão e termos.
- [Reprocess](https://userepass.com/docs/sdk/recursos/reprocess.md): Jobs de reprocessamento de comissões: dry-run, inspeção do impacto e execução.
- [Settings](https://userepass.com/docs/sdk/recursos/settings.md): Políticas e configurações da organização: payout, fiscal, fraude, reprocessamento, Stripe e domínios de link.
- [Webhooks](https://userepass.com/docs/sdk/recursos/webhooks.md): Endpoints de webhook, segredo de assinatura, entregas e dead-letter.
- [SDK TypeScript](https://userepass.com/docs/sdk/visao-geral.md): Cliente oficial @repass/sdk: altamente tipado, sem dependências de runtime, para Node, browser e edge.
- [Verificação de assinatura](https://userepass.com/docs/webhooks/assinatura.md): Valide a autenticidade dos webhooks com HMAC.
- [Catálogo de eventos](https://userepass.com/docs/webhooks/catalogo-de-eventos.md): Todos os tipos de evento emitidos pelo Repass.
- [Retries e dead-letter](https://userepass.com/docs/webhooks/retries-e-dead-letter.md): Política de reentrega, dead-letter e replay de webhooks.
- [Webhooks](https://userepass.com/docs/webhooks/visao-geral.md): Receba eventos do Repass em tempo real via webhooks.

## OpenAPI Specs

- [openapi](https://userepass.com/docs/openapi.json)