getCpfValidation

Creates a validation request structure for CPF (Cadastro de Pessoas Físicas - Brazilian individual taxpayer ID) validation. It formats the parameters for a Swarm API call that validates CPF numbers and retrieves associated user information.

This command requires the logged in session

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

cpfValue	The CPF number to validate	string	-	-

Call example:
JavaScriptReact HookFlutter

getCpfValidation({
  cpfValue: '12345678901'
})

Response examples:
SuccessError

{
  code: 0,
  rid: 'command264969783521038',
  data: {
    result: 0,
    result_text: null,
    details: {
      Name: 'RAHYANE NANTES BENITES',
      FirstName: 'RAHYANE',
      LastName: 'NANTES BENITES',
      BirthDate: 689990400,
      CPFStatus: 'regular'
    }
  }
}

Response parameters:

Name	Description	Type	Values

FirstName	Users's first name.	array	-
LastName	User's last name.	string	-
BirthDate	Birth date represented as a Unix timestamp (seconds).	number	-
CPFStatus	Status of the CPF.	string	-
Name	User's full name	string	-