Brazil CPF Fetch - Advance

Overview

The Brazil CPF Fetch API is designed to retrieve detailed information associated with a given CPF (Cadastro de Pessoas Físicas) number. This API is tailored for use within Brazil to help verify the identity and registration status of individuals, supporting compliance with local KYC regulations.

Use Case

This API is crucial for a variety of business processes that require reliable identity verification in Brazil, such as:

Financial Services: Verifying customer identity during account opening, loan applications, and other banking services.

E-commerce: Confirming the identity of customers during checkout to prevent fraudulent transactions.

Healthcare: Ensuring patient identity before providing medical services or access to medical records.

Insurance: Verifying policyholder information during claims processing and new policy issuance.

Employment Background Checks: Confirming the identity of potential hires to ensure they meet hiring criteria.

API Details

Request Body

curl --location 'https://api.signzy.app/api/v3/global-kyc-fetch/br/cpf-adv' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cpf": "45272720806",
    "relatives": "false",
    "getRfInformationWhenContactNotFound": "true"
}'

Request Body Parameters

Parameter	Type	Description	Required
cpf	String	A Brazilian individual taxpayer identifier (“Cadastro de Pessoas Físicas”). Used to look up or validate a specific person.	Yes
relatives	Boolean (as string)	Indicates whether the search should include the individual's relatives. "false" means relatives are not included.	No
getRfInformationWhenContactNotFound	Boolean (as string)	If set to "true", the system should retrieve RF (Registro Federal or similar fallback data) when no contact information is found.	No

Response Body

{
  "result": {
    "uniqueIdentifier": "{uniqueIdentifier}",
    "person": {
      "cpf": "{cpf}",
      "externalId": "{externalId}",
      "mainCpf": "{mainCpf}",
      "alternateCpfs": "{alternateCpfs}",
      "name": "{name}",
      "socialName": "{socialName}",
      "homonyms": "{homonyms}",
      "birthDateTime": "{birthDateTime}",
      "birthDate": "{birthDate}",
      "age": "{age}",
      "zodiacSign": "{zodiacSign}",
      "gender": "{gender}",
      "motherName": "{motherName}",
      "motherCpf": "{motherCpf}",
      "fatherName": "{fatherName}",
      "fatherCpf": "{fatherCpf}",
      "deceased": "{deceased}",
      "deathYear": "{deathYear}",
      "deathDate": "{deathDate}",
      "nis": "{nis}",
      "nisList": "{nisList}",
      "cns": "{cns}",
      "rgNumber": "{rgNumber}",
      "rgState": "{rgState}",
      "rgIssueDate": "{rgIssueDate}",
      "rgIssuingAuthorityCode": "{rgIssuingAuthorityCode}",
      "voterIdNumber": "{voterIdNumber}",
      "voterZone": "{voterZone}",
      "voterSection": "{voterSection}",
      "birthCity": "{birthCity}",
      "estimatedMonthlyIncome": "{estimatedMonthlyIncome}",
      "registrationDateInRevenueService": "{registrationDateInRevenueService}",
      "lastRevenueCheckDate": "{lastRevenueCheckDate}",
      "registrationStatusInRevenueService": "{registrationStatusInRevenueService}",
      "pepRole": "{pepRole}",
      "pepTermEnd": "{pepTermEnd}",
      "estimatedIncomeConfidenceIndex": "{estimatedIncomeConfidenceIndex}"
    },
    "addresses": [
      {
        "order": "{order}",
        "addressTypeId": "{addressTypeId}",
        "cityId": "{cityId}",
        "state": "{state}",
        "city": "{city}",
        "neighborhood": "{neighborhood}",
        "streetType": "{streetType}",
        "streetName": "{streetName}",
        "number": "{number}",
        "complement": "{complement}",
        "postalCode": "{postalCode}"
      }
    ],
    "phones": [],
    "mobiles": [
      {
        "order": "{order}",
        "areaCode": "{areaCode}",
        "number": "{number}",
        "phoneTypeId": "{phoneTypeId}"
      },
      {
        "order": "{order}",
        "areaCode": "{areaCode}",
        "number": "{number}",
        "phoneTypeId": "{phoneTypeId}"
      }
    ],
    "emails": [],
    "relatives": [
      {
        "cpf": "{cpf}",
        "name": "{name}",
        "birthDateTime": "{birthDateTime}",
        "deceased": "{deceased}",
        "deathYear": "{deathYear}",
        "deathDate": "{deathDate}",
        "estimatedMonthlyIncome": "{estimatedMonthlyIncome}",
        "pepRole": "{pepRole}",
        "pepTermEnd": "{pepTermEnd}",
        "relationshipType": "{relationshipType}",
        "registrationStatusInRevenueService": "{registrationStatusInRevenueService}",
        "lastRevenueCheckDate": "{lastRevenueCheckDate}"
      }
    ],
    "peopleAtSameAddress": [],
    "companiesAtSameAddress": [],
    "partnerships": [],
    "employers": [
      {
        "relatedCompany": {
          "cnpj": "{cnpj}",
          "companyName": "{companyName}"
        }
      }
    ],
    "partners": []
  },
  "reason": "{reason}",
  "code": "{code}"
}

Response Body Parameters

Parameter	Type	Description
result	Object	Main container for all returned information.
result.uniqueIdentifier	String	Internal unique identifier for this result.
result.person	Object	Personal data of the individual.
result.person.cpf	String	Person’s CPF.
result.person.externalId	String	External system identifier.
result.person.mainCpf	String	Main CPF if multiple CPFs exist.
result.person.alternateCpfs	String	Additional CPFs linked to the person.
result.person.name	String	Full legal name.
result.person.socialName	String	Social name (if different).
result.person.homonyms	String	Number of people with the same name.
result.person.birthDateTime	String	Birth date including time (ISO datetime).
result.person.birthDate	String	Birth date only.
result.person.age	String	Age of the person.
result.person.zodiacSign	String	Zodiac sign.
result.person.gender	String	Gender of the person.
result.person.motherName	String	Mother's full name.
result.person.motherCpf	String	Mother's CPF.
result.person.fatherName	String	Father's full name.
result.person.fatherCpf	String	Father's CPF.
result.person.deceased	String	Indicates if the person is deceased.
result.person.deathYear	String	Year of death.
result.person.deathDate	String	Exact date of death.
result.person.nis	String	NIS number (social identification).
result.person.nisList	String	List of NIS numbers.
result.person.cns	String	SUS national health card number.
result.person.rgNumber	String	RG (ID card) number.
result.person.rgState	String	State where RG was issued.
result.person.rgIssueDate	String	Date RG was issued (ISO datetime).
result.person.rgIssuingAuthorityCode	String	RG issuing authority code.
result.person.voterIdNumber	String	Voter registration number.
result.person.voterZone	String	Voter zone.
result.person.voterSection	String	Voter section.
result.person.birthCity	String	Birth city.
result.person.estimatedMonthlyIncome	String	Estimated monthly income.
result.person.registrationDateInRevenueService	String	Registration date in tax authority.
result.person.lastRevenueCheckDate	String	Last CPF validation check.
result.person.registrationStatusInRevenueService	String	CPF registration status.
result.person.pepRole	String	PEP (Politically Exposed Person) role.
result.person.pepTermEnd	String	End date of PEP role.
result.person.estimatedIncomeConfidenceIndex	String	Confidence index of estimated income.
result.addresses	Array	List of addresses.
result.addresses[].order	String	Address order.
result.addresses[].addressTypeId	String	Address type identifier.
result.addresses[].cityId	String	City identifier.
result.addresses[].state	String	State abbreviation.
result.addresses[].city	String	City name.
result.addresses[].neighborhood	String	Neighborhood.
result.addresses[].streetType	String	Street type.
result.addresses[].streetName	String	Street name.
result.addresses[].number	String	Building number.
result.addresses[].complement	String	Address complement.
result.addresses[].postalCode	String	Postal code (CEP).
result.phones	Array	List of phone numbers (empty).
result.mobiles	Array	List of mobile numbers.
result.mobiles[].order	String	Mobile number order.
result.mobiles[].areaCode	String	Area code (DDD).
result.mobiles[].number	String	Mobile number.
result.mobiles[].phoneTypeId	String	Mobile type identifier.
result.emails	Array	List of emails (empty).
result.relatives	Array	List of relatives.
result.relatives[].cpf	String	Relative’s CPF.
result.relatives[].name	String	Relative’s name.
result.relatives[].birthDateTime	String	Relative’s birth date/time.
result.relatives[].deceased	String	Whether the relative is deceased.
result.relatives[].deathYear	String	Year of death.
result.relatives[].deathDate	String	Exact date of death.
result.relatives[].estimatedMonthlyIncome	String	Estimated income of the relative.
result.relatives[].pepRole	String	PEP role for relative.
result.relatives[].pepTermEnd	String	PEP role end date.
result.relatives[].relationshipType	String	Relationship type (e.g., MOTHER, COUSIN).
result.relatives[].registrationStatusInRevenueService	String	Relative’s CPF status.
result.relatives[].lastRevenueCheckDate	String	Last revenue check for relative.
result.peopleAtSameAddress	Array	People living at the same address (empty).
result.companiesAtSameAddress	Array	Companies at the same address (empty).
result.partnerships	Array	Partnerships (empty).
result.employers	Array	List of employers.
result.employers[].relatedCompany	Object	Employer company information.
result.employers[].relatedCompany.cnpj	String	Company CNPJ.
result.employers[].relatedCompany.companyName	String	Company legal name.
result.partners	Array	Companies the person is a partner in (empty).
reason	String	Explanation of result status.
code	String	Result code.

Error Code and Response Mapping

{
    "result": {},
    "reason": "/cpf/ is required",
    "code": "E003"
}

Error Response Parameters

Parameter	Description
result	Empty result object
reason	Reason for error
code	Error code from Signzy

Error Codes

HTTP Status Code	Error Code	Description
400	E001	Bad Request
401	E1001	Unauthorized Access
403	E201	Forbidden
404	E301	Data Not Found
409	E401	Upstream error
429	E501	Rate Limit Exceeded
500	E601	Internal Server Error
503	E701	Service Unavailable
504	E801	Timeout

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!