Record

The Brick API is an antifraud solution designed to help our customers create detailed records of their clients and perform comprehensive analyses on those records. This guide explains the relationship between a Record and a RecordAnalysis, the types of analyses supported, and which bundle triggers each type of analysis.

The Record Entity

A Record in the Brick API represents an entity (either an individual or a company) for whom antifraud analysis is conducted. Each Record can have multiple associated RecordAnalysis instances, representing different types of analyses performed on the record.

class  Record {
  id: string;
  name: string;
  document: string;
  created_by: string;
  created_at: Date;
  updated_at: Date;
  updated_by: string;

  entity_type: EntityType;
  public_key: string;
  status: RecordStatusEnum;
  origin: RecordOriginEnum;

  rental_price?: number;
  pdf?: string;

  bundles: {
    type: string;
    status: string;
  }[];
  
  loading: boolean;

  is_suspect: boolean;

  analyses: RecordAnalysis[];
  
  form_responses: RecordFormResponse[];

  evaluation_results: RecordEvaluationResult[];

  photo: string;

}

Record Analysis Schema

class  AnalysisDto  {
  id: string;
  type: string;
  record_id: string;

  properties: string;
  content: string;

  valid: boolean;
  loading: boolean;
  message: string;
  elapsed_time: number;
  contact_support: boolean;
  should_retry: boolean;

  created_at: Date;
  updated_at: Date;
  created_by: string;
  updated_by: string;
  facial_biometry_photo?: string;
};

Types of Analyses Supported

The Brick API supports various types of analyses, categorized by whether they are related to individuals (PF) or companies (PJ).

Individual Analyses (PF)

• PF_ARREST_WARRANTS: Checks for arrest warrants.
• PF_LAW_SUITS: Searches for any lawsuits.
• PF_ADDRESSES: Verifies address information.
• PF_ADMINISTRATIVE_PROCEDURES: Investigates administrative procedures.
• PF_COMPANIES: Checks for company associations.
• PF_CREDIT_ANALYSIS_BOAVISTA: Credit analysis via Boa Vista.
• PF_CREDIT_ANALYSIS_SPC: Credit analysis via SPC.
• PF_CREDIT_ANALYSIS_SPC_BASIC: Basic credit analysis via SPC.
• PF_CREDIT_ANALYSIS_SERASA: Credit analysis via Serasa.
• PF_CRIMINAL_RECORDS: Searches for criminal records.
• PF_EMPLOYMENT_BONDS: Verifies employment bonds.
• PF_FACEBOOK: Analyzes Facebook profile.
• PF_GOOGLE: Conducts a Google search.
• PF_PROTESTS: Checks for protests.
• PF_REVENUE_SERVICES: Verifies revenue services.
• PF_BASIC_DATA: Collects basic data.
• PF_FACIAL_BIOMETRY: Performs facial biometrics analysis.
• PF_LIVENESS: Conducts liveness detection.
• PF_SOCIAL_ASSISTANCE: Checks for social assistance information.
• PF_PUBLIC_JOBS: Investigates public job records.
• PF_CLASS_ENTITIES: Searches class entities.
• PF_RELATIONS: Analyzes relationships.

Company Analyses (PJ)

• PJ_ACTIVITY: Verifies company activities.
• PJ_ADDRESSES: Checks company addresses.
• PJ_BASIC_DATA: Collects basic company data.
• PJ_CREDIT_SPC: Credit analysis via SPC.
• PJ_CREDIT_BOAVISTA: Credit analysis via Boa Vista.
• PJ_LAW_SUITS: Searches for lawsuits.
• PJ_PARTNERS_LAW_SUITS: Checks lawsuits involving partners.
• PJ_PROTESTS: Investigates protests.
• PJ_RELATIONS: Analyzes company relations.

Bundles and Analysis Triggers

Bundles in the Brick API are predefined sets of analyses triggered together based on the type of entity (individual or company) and the specific bundle selected.

Bundles for Individuals (PF)

• ESSENTIAL: Triggers essential analyses such as basic data and key checks.
• BOA_VISTA: Triggers Boa Vista credit analysis.
• SERASA: Triggers Serasa credit analysis.
• SPC: Triggers SPC credit analysis.
• FACIAL_BIOMETRY: Triggers facial biometrics analysis.
• LIVENESS: Triggers liveness detection.
• PUBLIC_JOBS: Triggers public job records analysis.
• SOCIAL_ASSISTANCE: Triggers social assistance checks.
• CLASS_ENTITIES: Triggers class entities search.
• KYC: Compliance Checks
• CNH: Data from driver`s license

Bundles for Companies (PJ)

• ESSENTIAL: Triggers essential analyses for companies.
• BOA_VISTA: Triggers Boa Vista credit analysis.
• SERASA: Triggers Serasa credit analysis.
• SPC: Triggers SPC credit analysis.

Bundles x Analysis Types