Consulta de CPF (naturalPersonLookup)
$nfe->naturalPersonLookup consulta a situação cadastral de uma pessoa
física na Receita Federal. Recurso global, servido por
naturalperson.api.nfe.io.
dataApiKeyCom fallback para apiKey. Veja Configuração.
Métodos
| Método | Descrição | Retorno |
|---|---|---|
getStatus($cpf, $birthDate) | Situação cadastral do CPF. | NaturalPersonStatus |
A consulta de CPF exige duas credenciais do titular: o CPF e a data de nascimento.
Consultar a situação cadastral
$status = $nfe->naturalPersonLookup->getStatus('311.192.980-00', '1990-05-20');
$birthDate aceita uma string ISO (YYYY-MM-DD) ou um \DateTimeImmutable:
$status = $nfe->naturalPersonLookup->getStatus(
'31119298000',
new \DateTimeImmutable('1990-05-20'),
);
Datas malformadas ou fora de faixa lançam
Nfe\Exception\InvalidRequestException antes de qualquer requisição. O CPF
também é validado quanto ao formato.
CPF e data de nascimento são dados pessoais — trate o resultado conforme a LGPD: não logue o payload bruto e restrinja o acesso ao propósito da consulta.
Veja também
- Consulta de CNPJ — o equivalente PJ.
- Pessoas físicas — cadastro de tomadores PF.
- Configuração — modelo de duas chaves.