Skip to main content
A KYC template is the blueprint for every automated compliance check kycert runs on your behalf. It tells the bureau engine which sources to query, in which phase to run them, and how to respond when a source returns a finding — block the customer immediately, send them to your manual review queue, or simply enrich their profile. Getting your templates right is the most important configuration step in kycert.

Template structure

Every template organises its sources into three phases. The phase you assign to a source determines both when it runs and what power it has over the final decision. Critical phase — sequential, hard blockers Sources in the critical phase run one at a time, in order. If any source returns INVALID and you have configured its on_hit rule as block, the run stops immediately and the customer is rejected without proceeding further. Use this phase for absolute disqualifiers: an active federal arrest warrant (cnj_mandados_prisao), international sanctions matches (uk_sanctions, eu_sanctions), or an irregular CPF (receita_federal_cpf). Because sources run sequentially, a block early in the phase saves the credits that would have been spent on subsequent sources. Important phase — parallel, manual review triggers Sources in the important phase run concurrently after the critical phase passes. An INVALID result here does not automatically reject the customer — it places them in your manual review queue with the finding highlighted. Use this phase for PEP exposure (pep_coaf), CGU sanctions lists (cgu_cnc), and the slave labour registry (sit_trabalho_escravo). Your compliance analyst reviews the queue and makes the final call. Additional phase — parallel, informational only Sources in the additional phase also run concurrently, but their results never block or flag a customer. They enrich the compliance profile with context that supports your analyst’s decision or satisfies enhanced due diligence requirements. Use this phase for TSE campaign donor lookups, ICIJ offshore leak screening, or financial profile data.

Creating a template

1

Open the template builder

Go to Bureau → Templates → New Template in your dashboard sidebar.
2

Name your template and add a description

Choose a clear, unambiguous name — for example, “Standard PF KYC — Retail FX” or “Enhanced PJ Due Diligence — High Value”. The description is displayed to analysts when they select a template for a manual lookup, so make it informative.
3

Add sources to each phase

Select sources from the source catalog on the right panel and drag them into the critical, important, or additional phase lane. The catalog shows the source description, estimated run time, and credit cost so you can judge the trade-off before committing.
4

Configure on_hit rules for critical and important sources

Click any source in the critical or important phase to open its settings panel. Set the on_hit rule:
  • block — rejects the customer immediately when this source returns INVALID. Only available in the critical phase.
  • pending — sends the customer to manual review when this source returns INVALID. Recommended for important-phase sources.
5

Review and publish

The builder shows an estimated credit cost per run and flags any configuration issues (e.g., a source with no on_hit rule in the critical phase). When you’re satisfied, click Publish. The template becomes available immediately for new runs.
Templates are immutable once published. Every bureau run stores a snapshot of the template used, which is required for audit traceability under BCB 3.978/2020. If you need to change your verification logic — add a source, adjust a phase, or change an on_hit rule — create a new template version. Existing runs will always reference the template version that was active when they executed. Always consult your compliance officer before modifying a published template, as regulatory requirements may mandate specific sources or configurations.
The following configuration covers the most common retail FX onboarding scenario and satisfies the minimum requirements of BCB Circular 3.978 for individual customers.
PhaseSourceon_hit ruleRationale
Criticalreceita_federal_cpfblockValidates CPF status, death record, and name match — entry gate for all PF checks
Criticalcnj_mandados_prisaoblockActive federal arrest warrant is an absolute disqualifier
Criticaluk_sanctionsblockUK FCDO financial sanctions — mandatory for FX operations
Criticaleu_sanctionsblockEU Financial Sanctions Files — mandatory for FX operations
Importantpep_coafpendingPEP status requires analyst review and enhanced due diligence
Importantcgu_cncpendingCGU CEIS/CNEP/CEPIM sanctions — significant compliance signal
Importantsit_trabalho_escravopendingSlave labour registry — reputational and legal risk
Additionaltse_doadores_2024Electoral donor exposure — informational context
Additionalantecedentes_pfCriminal antecedents — enrichment for high-risk profiles
Additionalicij_offshore_leaksICIJ offshore database — flags for enhanced due diligence

Template presets

kycert ships with built-in presets to accelerate setup. Load a preset in the template builder and customise it from there — presets are a starting point, not a final configuration.
Preset IDSubjectIncluded sourcesUse case
kyc_minimo_pfPFreceita_federal_cpf, cnj_mandados_prisao, cgu_cnc, pep_coafMinimum BCB 3.978-compliant set for individual customers
kyc_padrao_pfPFMinimum + cnj_improbidade, ofac_sdn, un_sanctions, cvm_processo_admRecommended for medium-risk retail FX profiles
compliance_pfPFStandard + antecedentes_pf, cnis_inscricao, trf_processos, cnj_seeu_processos, cvm_participanteEnhanced due diligence for high-risk or high-net-worth individuals
kyc_minimo_pjPJreceita_federal_cnpj, cgu_cnc, ofac_sdn, un_sanctionsMinimum BCB 3.978-compliant set for companies
kyc_padrao_pjPJMinimum + cnj_improbidade, cvm_processo_admRecommended for standard corporate onboarding
compliance_pjPJStandard + trf_processos, cnj_seeu_processos, cenprot_protestosEnhanced due diligence for high-risk companies
If you are onboarding individuals for the first time and want to comply with BCB 3.978 immediately, load the kyc_minimo_pf preset, review it with your compliance officer, and publish. You can always create a stricter version later.
  • Bureau Overview — how the engine executes a template
  • Runs — viewing results and downloading compliance reports
  • Data Sources — full catalog of available sources