kycR7LookupCustomer

Cpf validation for identifying user

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

personalId	User’s national ID number used to identify the person.	string	-	-

This method is usually used with these methods:

kycR7LookupCep kycR7GenerateLivenessUrl

Call example:
JavaScriptReact HookFlutter

kycR7LookupCustomer({
  personalId: '39110826333'
})

Response examples:
SuccessError

{
  code: 0,
  data: {
    details: {
      address: {
        city: 'FORTALEZA',
        neighborhood: 'VILA VELHA',
        postal_code: '60347235',
        state: 'CE',
        street: {
          complement: '',
          name: 'R R GEORGE CAVALCANTE',
          number: '635'
        }
      },
      birth_date: -49680000,
      gender: 'Female',
      is_pep: false,
      linked: false,
      name: 'FRANCISCA ANGELA SILVA ALMEIDA',
      verified: false
    },
    result: 200
  }
}

Response parameters:

Name	Description	Type	Values

address	Address related info	object
└─ city	city	string	-
└─ neighborhood	neighborhood	string	-
└─ postal_code	postal code	string	-
└─ state	state	string	-
└─ street	Street related info	object
└─ complement	complement	string	-
└─ name	name	string	-
└─ number	number	number	-
birth_date	User's birth date	number	-
gender	User's gender	string	-
name	User name	string	-
verified	Is user verified	boolean	true / false

kycR7LookupCustomer

Request parameters:

This method is usually used with these methods:

Call example:JavaScriptReact HookFlutter

Response examples:SuccessError

Response parameters:

Call example:
JavaScriptReact HookFlutter

Response examples:
SuccessError