/
v3.0.11Get access

getLegitimuzMaskedCpfInfo

Retrieves masked CPF identity information from Legitimuz for a given CPF number.

Request parameters:

NameDescriptionTypeValuesDefault
cpf
CPF numbernumber--

Parameters marked with must be included in the request

This method is usually used with these methods:
getLegitimuzVerificationUrlsgetLegitimuzActionConfirmationUrlgetLegitimuzActionConfirmationUrlByEmail

Call example:

getLegitimuzMaskedCpfInfo({
  cpf: 47778334704
})

Response examples:

{
  code: 0,
  rid: 1411903112,
  data: {
    result: 0,
    result_text: null,
    details: {
      Cpf: '47778334704',
      Name: 'Be***************************es',
      FirstName: 'Be****ce',
      LastName: 'Ma******************es',
      BirthDate: -1254528000,
      Gender: 2,
      MothersName: 'Ma**************uz',
      Situation: 'Regular',
      Age: 95,
      Nationality: 'Brasileira',
      ZodiacSign: '',
      BlackList: false,
      Pep: false,
      LegitimuzInfoKey: '47778334704_cpf',
      LegitimuzInfoKeyExpire: 1771246258,
      Address: {
        ZipCode: '26****40',
        Address: 'JU***RA',
        City: 'QUEIMADOS',
        State: 'RJ',
        Town: 'VL JUREMA',
        AdditionalAddress: ''
      }
    }
  }
}

Response parameters:

NameDescriptionTypeValues
Cpf
CPF numbernumber-
Name
Masked full name of the CPF holder.string-
FirstName
Masked first name.string-
LastName
Masked last name.string-
BirthDate
Date of birth represented as a Unix timestamp (in seconds).number-
Gender
Numeric gender identifiernumber-
MothersName
Masked mother’s full name.string-
Situation
Current CPF status (e.g. Regular).string-
Age
Age calculated based on the birth date.number-
Nationality
Nationality of the CPF holder.string-
ZodiacSign
Zodiac sign derived from the birth date (may be empty).string-
BlackList
Indicates whether the CPF is flagged on any blacklist.booleantrue / false
Pep
Politically Exposed Person indicator. booleantrue / false
LegitimuzInfoKey
Unique cache key identifying this CPF lookup in Legitimuz.string-
LegitimuzInfoKeyExpire
Unix timestamp (in seconds) indicating when the cached CPF data expires.string-
Address
Address informationobject
└─ ZipCode
Masked postal (ZIP) code.string-
└─ Address
Masked street or address name.string-
└─ City
City associated with the address.string-
└─ State
Brazilian state abbreviation.string-
└─ Town
District or neighborhood name.string-
└─ AdditionalAddress
Optional complementary address information (e.g. apartment, block).string-