Follow a dossier

Returns the dossier state (pending, completed or failed) and, once completed, the full result. Only the account that created the dossier can read it.

Parameters

idstringrequired

In the path. The dossie_id returned by POST /v1/dossie/cpf.

Free. The 100-credit charge happens once, when the dossier completes.

• While the status is pending, the response only shows progress. Once completed, the result is kept in your account and can be read at any time, at no extra cost.
• A dossier that does not exist or belongs to another account returns 404 with the code DOSSIER_NOT_FOUND.
• risk_level values: HIGH (sanctioned in CEIS, CNEP or an international list, expelled from the federal administration, a TCU unfit bidder or in the slave labor registry), MEDIUM (PEP, active debt of R$ 50,000 or more, barred from public office, or with irregular or electoral accounts at the TCU) and LOW (everything else).

Result fields

data.statusstring

pending, completed or failed.

data.completed_atstring

When the dossier finished. Absent while pending.

data.basic_infoobject

Holder cadastral data.

data.basic_info.full_namestring

Holder name.

data.basic_info.cadastral_statusstring | null

Cadastral status at the Brazilian Federal Revenue (e.g. REGULAR).

data.basic_info.birth_datestring

Birth date, YYYY-MM-DD.

data.compliance_summary.has_sanctionsboolean

true if there is a record in CEIS, CNEP, CEAF, an international sanctions list, or as a TCU unfit bidder.

data.compliance_summary.is_pepboolean

true if the person is politically exposed.

data.compliance_summary.has_active_debtsboolean

true if there is federal active debt (PGFN).

data.compliance_summary.has_possible_matchesboolean

true if any source returned POSSIBLE_MATCH (name-only search, may be a namesake). It needs checking and raises the risk to at least MEDIUM.

data.compliance_summary.risk_levelstring

LOW, MEDIUM or HIGH.

data.details.*.statusstring

Result of each source: CLEAR (nothing found), MATCH (listed, found by CPF), POSSIBLE_MATCH (the search was by name only and may be a namesake, check before deciding), NOT_APPLICABLE (a required piece of data was missing, such as the name) and UNAVAILABLE (the source failed after retries; the dossier then fails and is not charged). Only MATCH raises the risk to HIGH; POSSIBLE_MATCH raises it to MEDIUM at most.

data.details.pepobject

is_pep and the source (CGU).

data.details.ceisobject

found: there is a CEIS record.

data.details.slave_laborobject

found: listed in the MTE Employers Registry (slave-like labor). matches has, per entry, match (cpf: the employer CPF equals the one queried; name: an individual entrepreneur with the same name, an indication), state, fiscal_action_year, workers_involved, decision_date and inclusion_date. data_base is the publication date of the list (twice a year).

data.details.pgfn_active_debtobject

found, total_amount (BRL), records_count and data_base (date of the PGFN base) of the active debt. Matched by 6 digits of the CPF plus name: it is an indication.

data.details.international_sanctionsobject

OFAC (US), UN and EU sanctions lists. found, data_base and matches (source, matched_name, program, citizenship). The lists carry no CPF: matching is by exact full name and is an indication, so check before concluding.

data.details.cnepobject

found: there is a CNEP record (National Registry of Punished Companies), by full CPF.

data.details.ceafobject

found: listed in the CEAF (Federal Administration Expulsions Registry). The Transparency Portal publishes the CPF partially hidden, so matching uses the visible digits and the full name and is an indication. matches has punishment, published_at and agency.

data.details.tcuobject

Federal Court of Accounts lists, all by CPF: unfit_bidder, disqualified (barred from public office), irregular_accounts and electoral (irregular accounts with possible electoral implication). Each has found and, when listed, matches with process, decision, final_judgment_date, end_date and uf.

data.errorobject

Only when failed: code (SOURCE_UNAVAILABLE or CPF_NOT_FOUND) and message. Nothing is charged.