> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/kyc/register-data.md). # Registrar dados ## Consulta na Receita Federal Retorna se o CPF consultado está regular, irregular, falecido e outras informações da Receita Federal. **Seção:** `CPF` **Parâmetros obrigatórios:** `cpf, birthDate` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------- | ------ | ----------------------------------------------- | | CPF | Objeto | Objeto com detalhes da consulta de CPF | | cpf.statusCode | String | Código de status | | cpf.name | String | Nome da pessoa na Receita Federal | | cpf.socialName | String | Nome social da pessoa | | cpf.birthDate | String | Data de nascimento na Receita Federal | | cpf.registrationStatusCode | String | Código da situação cadastral | | cpf.registrationStatusMessage | String | Mensagem da situação cadastral | | cpf.issueDate | String | Data de emissão do documento na Receita Federal | | cpf.deathYear | String | Ano de óbito (se houver) | | cpf.deathMessage | String | Mensagem de óbito | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "cpf": { "statusCode": "00", "registrationStatusCode": "00", "registrationStatusMessage": "REGULAR", "name": "JOHN DOE", "socialName": "JANE DOE", "birthDate": "08/05/1987", "issueDate": "14/02/2012", "deathYear": "", "deathMessage": "" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | consulta\_cpf | Verifica se foi possível consultar o CPF na Receita Federal. | | código\_erro\_cpf | Verifica se o CPF está em ordem. | | cpf\_nome\_igual | Verifica se o nome encontrado na execução (parâmetro/OCR) é o mesmo da base oficial. | | cpf\_não\_falecido | A regra será inválida se o CPF consultado estiver em situação de óbito, de acordo com os Dados Básicos PF ou Receita Federal (pfBasicData, cpf e pfData). | | over\_21 | Verifica se o titular do CPF tem mais de 21 anos. | | maior\_que\_18 | Verifica se o titular do CPF tem mais de 18 anos. | | maior\_que\_16 | Verifica se o titular do CPF tem mais de 16 anos. | | maior\_que\_14 | Verifica se o titular do CPF tem mais de 14 anos. | | similaridade\_entre\_primeiro\_e\_último\_nome | Verifica a semelhança entre a união do primeiro e do último nome enviado nos parâmetros comparada à união do primeiro nome e de cada sobrenome na origem. | | {% endtab %} | | | {% endtabs %} | | ## Consulta na Receita Federal - NOVO (PF2) Consulta o serviço da Receita Federal do Brasil ou fontes privadas (conforme disponibilidade) e retorna se o CPF consultado está em situação regular, irregular ou de óbito. A diferença em relação à fonte "cpf" é que ela pode ser consultada sem o parâmetro "birthDate", e regras individuais podem ser aplicadas para os status da Receita Federal: regular, suspenso, nulo, cancelado, falecido e pendente de regularização. **Seção:** `pfData` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.name | String | Nome | | data.socialName | String | Nome social | | data.birthDate | String | Data de nascimento | | data.taxIdStatus | String | Status do CPF em relação à Receita Federal | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "name": "JOHN DOE", "socialName": "JANE DOE", "taxIdStatus": "REGULAR", "birthDate": "08/05/1999" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | não\_existe\_na\_base\_da\_receita\_federal | A regra será inválida se o CPF não for encontrado na base da Receita Federal. | | não\_vivo | A regra será inválida se o CPF consultado estiver em situação de óbito, de acordo com os Dados Básicos PF ou Receita Federal (pfBasicData e pfData). | | não\_pendente\_de\_regularização | A regra será inválida se o CPF consultado tiver status de regularização pendente na Receita Federal. | | não\_cancelado | A regra será inválida se o CPF consultado tiver cadastro cancelado na Receita Federal. | | não\_suspenso | A regra será inválida se o CPF consultado tiver status cadastral suspenso na Receita Federal. | | não\_nulo | A regra será inválida se o CPF consultado tiver status cadastral nulo na Receita Federal. | | maior\_que\_18 | Verifica se o titular do CPF tem mais de 18 anos. | | maior\_que\_16 | Verifica se o titular do CPF tem mais de 16 anos. | | maior\_que\_14 | Verifica se o titular do CPF tem mais de 14 anos. | | consulta\_cpf | Verifica se foi possível consultar o CPF na Receita Federal. | | código\_erro\_cpf | Verifica se o CPF está em ordem. | | cpf\_nome\_igual | Verifica se o nome encontrado na execução (parâmetro/OCR) é o mesmo da base oficial. | | cpf\_não\_falecido | A regra será inválida se o CPF consultado estiver em situação de óbito, de acordo com os Dados Básicos PF ou Receita Federal (pfBasicData, cpf e pfData). | | cpf\_regular | A regra será inválida se o CPF tiver cadastro irregular na Receita Federal. | | intervalos\_de\_idade\_inválidos | Verifica se o titular do CPF está dentro da faixa etária configurada. | | {% endtab %} | | | {% endtabs %} | | ## Dados Básicos (PF1.1) Reúne informações básicas sobre um CPF. **Seção:** `pfBasicData` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.name | String | Nome | | data.socialName | String | Nome social | | data.gender | String | Gênero | | data.birthDate | String | Data de nascimento | | data.birthCountry | String | País de nascimento | | data.motherName | String | Nome da mãe | | data.fatherName | String | Nome do pai | | data.taxIdNumber | String | Número do CPF | | data.taxIdCountry | String | País do documento | | data.alternativeIdNumbers | Objeto | Números de documentos alternativos | | data.alternativeIdNumbers.SocialSecurityNumber | String | Número de Segurança Social | | data.taxIdStatus | String | Status do CPF em relação à Receita Federal | | data.taxIdOrigin | String | Origem do CPF | | data.hasObitIndication | Booleano | Indica se houve óbito para essa pessoa | | data.obitIndicationOrigin | String | A origem da informação de óbito | | data.obitIndicationYear | String | Ano da indicação de óbito | | data.taxIdStatusDate | String | Data da consulta de status | | data.creationDate | String | Data de criação | | data.lastUpdateDate | String | Última atualização | | data.message | String | Descrição do status da consulta | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "taxIdNumber": "03852939097", "taxIdCountry": "BRASIL", "name": "JOHN DOE", "socialName": "JANE DOE", "gender": "M", "birthDate": "1999-05-08T00:00:00Z", "birthCountry": "BRASILEIRA", "motherName": "MARIA DOE", "fatherName": "", "taxIdStatus": "REGULAR", "taxIdOrigin": "RECEITA FEDERAL", "alternativeIdNumbers": { "SocialSecurityNumber": "12961902314" }, "hasObitIndication": false, "obitIndicationOrigin": "", "obitIndicationYear": "", "taxIdStatusDate": "2016-02-01T00:00:00Z", "creationDate": "2016-02-01T00:00:00Z", "lastUpdateDate": "2016-02-01T00:00:00Z" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | -------------------------------- | --------------------------------------------------------------------- | | over\_21 | Verifica se o titular do CPF tem mais de 21 anos. | | maior\_que\_18 | Verifica se o titular do CPF tem mais de 18 anos. | | maior\_que\_16 | Verifica se o titular do CPF tem mais de 16 anos. | | maior\_que\_14 | Verifica se o titular do CPF tem mais de 14 anos. | | maior\_que\_14 | Verifica se o titular do CPF tem mais de 14 anos. | | cpf\_nulo | Verifica se a fonte de dados básicos está retornando valores. | | intervalos\_de\_idade\_inválidos | Verifica se o titular do CPF está dentro da faixa etária configurada. | | {% endtab %} | | | {% endtabs %} | | ## Consulta na Receita Federal - NOVO (PF1.2) Reúne informações básicas sobre um CPF. **Seção:** `pfCpfData` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.name | String | Nome | | data.socialName | String | Nome social | | data.birthDate | String | Data de nascimento | | data.taxIdStatus | String | Status do CPF em relação à Receita Federal | | data.taxIdNumber | String | Número de identificação do CPF | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "taxIdNumber": "03852939097", "name": "JOHN DOE", "socialName": "JANE DOE", "taxIdStatus": "REGULAR", "birthDate": "1999-05-08T00:00:00Z", "hasObitIndication": true, "obitIndicationYear": "2023" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ---------------------------------- | -------------------------------------------------------------------------------------------- | | fonte\_big\_data\_menor\_de\_idade | Verifica se a fonte retornou que o titular tem menos de 18 anos. | | cpf\_nome\_igual | Verifica se o nome encontrado durante a execução (parâmetro/OCR) corresponde à base oficial. | | não\_vivo | Verifica se o CPF pertence a um titular falecido. | | não\_pendente\_de\_regularização | Verifica se o CPF está com status de regularização pendente. | | não\_cancelado | Verifica se o CPF consta como cancelado na Receita Federal. | | não\_suspenso | Verifica se o CPF consta como suspenso na Receita Federal. | | não\_nulo | Verifica se o CPF consta como nulo na Receita Federal. | | consulta\_cpf | Verifica se foi possível realizar a consulta com a Receita Federal ou não. | | {% endtab %} | | | {% endtabs %} | | ## Dados pessoais enriquecidos - NOVO (PF1.3) Retorna dados pessoais enriquecidos de um CPF, incluindo endereços, pessoas associadas, documentos, contatos e muito mais. **Seção:** `pfPersonalEnhancedData` **Parâmetro obrigatório:** `CPF` > **Observação:** Somente os campos `taxIdNumber`, `nome`, `birthDate`e `motherName` são sempre retornados. Todos os outros campos podem não estar presentes na resposta, dependendo da disponibilidade dos dados. {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | message | String | Mensagem de status da solicitação | | data | Objeto | Dados retornados | | data.hasLawsuits | Booleano | Indica se há processos judiciais | | data.taxIdNumber | String | Número do CPF | | data.taxIdStatus | String | Status do CPF | | data.name | String | Nome | | data.motherName | String | Nome da mãe | | data.birthDate | String | Data de nascimento (formato ISO) | | data.gender | String | Gênero (masculino/feminino) | | data.socialName | String | Nome social | | data.addresses | Array | Lista de endereços | | data.addresses\[x].ibgeCode | Número | Código do município do IBGE | | data.addresses\[x].street | String | Nome da rua | | data.addresses\[x].number | String | Número | | data.addresses\[x].complement | String | Complemento | | data.addresses\[x].neighborhood | String | Bairro | | data.addresses\[x].city | String | Cidade | | data.addresses\[x].state | String | Estado | | data.addresses\[x].country | String | País | | data.addresses\[x].zipCode | String | CEP | | data.associatedPeople | Array | Lista de pessoas associadas | | data.associatedPeople\[x].name | String | Nome da pessoa associada | | data.associatedPeople\[x].taxIdNumber | String | CPF da pessoa associada | | data.documents | Array | Lista de documentos | | data.documents\[x].type | String | Tipo de documento (ex.: cpf) | | data.documents\[x].value | String | Valor do documento | | data.contacts | Array | Lista de contatos | | data.contacts\[x].type | String | Tipo de contato (e-mail, telefone etc.) | | data.contacts\[x].value | String | Valor do contato | | data.nationality | String | Nacionalidade | | data.createdAt | String | Data de criação (formato ISO) | | data.updatedAt | String | Data da última atualização (formato ISO) | | data.revenueServiceActive | Booleano | Indica se está ativo na Receita Federal | | data.isForeigner | Booleano | Indica se o titular está cadastrado como estrangeiro. Omitido quando a fonte não retorna essa informação. | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "message": "Consulta realizada com sucesso.", "data": { "hasLawsuits": false, "taxIdNumber": "32244186059", "taxIdStatus": "REGULAR", "name": "JOHN DOE", "motherName": "NOME DA MÃE", "birthDate": "1999-01-31T02:00:00.000Z", "gender": "masculino", "socialName": "NOME SOCIAL", "addresses": [ { "ibgeCode": 3538006, "street": "NOME DA RUA", "number": "123", "complement": "", "neighborhood": "ENDEREÇO RESIDENCIAL", "city": "SAO PAULO", "estado": "SP", "country": "Brasil", "zipCode": "12456789" } ], "associatedPeople": [ { "name": "NOME ASSOCIADO", "taxIdNumber": "12345678901" } ], "documents": [ { "type": "cpf", "value": "12345678900" } ], "contacts": [ { "type": "email", "value": "contato@mail.com" }, { "type": "phone", "value": "+5511999999999" } ], "nationality": "BRASILEIRA", "createdAt": "2025-12-17T14:20:37.101Z", "updatedAt": "2025-12-17T14:20:37.101Z", "revenueServiceActive": true, "isForeigner": false } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ---------------------------------- | -------------------------------------------------------------------------------------------- | | fonte\_big\_data\_menor\_de\_idade | Verifica se a fonte retornou que o titular tem menos de 18 anos. | | cpf\_nome\_igual | Verifica se o nome encontrado durante a execução (parâmetro/OCR) corresponde à base oficial. | | não\_vivo | Verifica se o CPF pertence a um titular falecido. | | não\_pendente\_de\_regularização | Verifica se o CPF está com status de regularização pendente. | | não\_cancelado | Verifica se o CPF consta como cancelado na Receita Federal. | | não\_suspenso | Verifica se o CPF consta como suspenso na Receita Federal. | | não\_nulo | Verifica se o CPF consta como nulo na Receita Federal. | | consulta\_cpf | Verifica se foi possível realizar a consulta com a Receita Federal ou não. | | {% endtab %} | | | {% endtabs %} | | ## E-mails (PF11) Retorna uma lista dos e-mails da pessoa. **Seção:** `pfEmails` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | items | Array | Dados dos e-mails | | items\[x].email | String | Endereço de e-mail | | items\[x].type | String | Tipo de e-mail | | items\[x].firstPassageDate | String | Data da primeira passagem | | items\[x].lastPassageDate | String | Data da última passagem | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "items": [ { "email": "johndoe@email.com", "type": "pessoal", "firstPassageDate": "2018-04-22T06:06:56.957Z", "lastPassageDate": "2020-08-04T09:17:15.041Z" } ] } } ``` {% endtab %} {% endtabs %} ## Endereços (PF12) Retorna uma lista com os endereços da pessoa. **Seção:** `pfAddresses` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | message | String | Descrição do status da consulta | | data | Array | Dados de retorno | | data\[x].typology | String | Tipo de via | | data\[x].title | String | Título/definição | | data\[x].addressMain | String | Nome | | data\[x].number | String | Número | | data\[x].complement | String | Complemento | | data\[x].neighborhood | String | Bairro | | data\[x].zipCode | String | CEP | | data\[x].city | String | Cidade | | data\[x].state | String | Estado | | data\[x].country | String | País | | data\[x].type | String | Lista de endereços | | data\[x].complementType | String | Tipo de endereço calculado a partir do complemento do endereço | | data\[x].householdCode | String | Código do domicílio do endereço | | data\[x].buildingCode | String | Código do prédio do endereço | | data\[x].householdTotalPassages | Número | Número de vezes que este código de domicílio foi visto para esta entidade | | data\[x].householdBadPassages | Número | Número de vezes que este código de domicílio foi visto para esta entidade em uma situação suspeita | | data\[x].householdCrawlingPassages | Número | Quantidade de passagens do domicílio com a entidade que tem como origem uma captura | | data\[x].householdValidationPassages | Número | Quantidade de passagens do domicílio com a entidade que tem como origem uma captura | | data\[x].householdQueryPassages | Número | Quantidade de passagens do domicílio com a entidade que tem como origem uma consulta | | data\[x].householdMonthAveragePassages | Número | Média mensal de vezes que o domicílio foi visto com a entidade | | data\[x].householdNumberOfEntities | Número | Número de entidades distintas associadas a este domicílio | | data\[x].buildingTotalPassages | Número | Número de vezes que este código de prédio foi visualizado para esta entidade | | data\[x].buildingBadPassages | Número | Número de vezes que este código de prédio foi visto para esta entidade em uma situação suspeita | | data\[x].buildingCrawlingPassages | Número | Quantidade de passagens do prédio com a entidade que tem como origem uma captura | | data\[x].buildingValidationPassages | Número | Quantidade de passagens do prédio com a entidade que tem como origem uma validação | | data\[x].buildingQueryPassages | Número | Quantidade de passagens do prédio com a entidade que tem como origem uma consulta | | data\[x].buildingMonthAveragePassages | Número | Média mensal de vezes que o prédio foi visto com a entidade | | data\[x].buildingNumberOfHouseholds | Número | Número de domicílios diferentes associados a este prédio | | data\[x].last3MonthsPassages | Número | Número de passagens da entidade nos últimos 3 meses | | data\[x].last6MonthsPassages | Número | Número de passagens da entidade nos últimos 6 meses | | data\[x].last12MonthsPassages | Número | Número de passagens da entidade nos últimos 12 meses | | data\[x].last18MonthsPassages | Número | Número de passagens da entidade nos últimos 18 meses | | data\[x].priority | Número | Indica a prioridade do endereço | | data\[x].isMain | Booleano | Indica se o endereço é o principal | | data\[x].isRecent | Booleano | Indica se esse endereço é recente | | data\[x].isActive | Booleano | Indica se esse endereço está ativo | | data\[x].isRatified | Booleano | Indica se o endereço foi ratificado com a base de referência dos Correios (DNE ou similar) | | data\[x].firstPassageDate | String | Data da primeira passagem deste domicílio com esta entidade | | data\[x].lastPassageDate | String | Data da última passagem deste domicílio com esta entidade | | data\[x].creationDate | String | Data do primeiro registro relacionado | | data\[x].lastUpdateDate | String | Última atualização do endereço | | data\[x].hasOptIn | Booleano | Indica se houve aceite de pedidos nesse endereço | | data\[x].ibgeCode | String | Código do município | | data\[x].latitude | Número | Latitude | | data\[x].longitude | Número | Longitude | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "items": [ { "typology": "RUA", "title": "", "addressMain": "XXXXXX XXXXXXX", "number": "17", "complement": "", "neighborhood": "CENTRO", "zipCode": "XXXXXXXX", "city": "XXXXXXXXXXX", "state": "XX", "country": "Brasil", "type": "TRABALHO", "complementType": "", "householdCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "buildingCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "householdTotalPassages": 1, "householdBadPassages": 1, "householdCrawlingPassages": 1, "householdValidationPassages": 1, "householdQueryPassages": -1, "householdMonthAveragePassages": 1, "householdNumberOfEntities": 1, "buildingTotalPassages": 1, "buildingBadPassages": 1, "buildingCrawlingPassages": 1, "buildingValidationPassages": 1, "buildingQueryPassages": -1, "buildingMonthAveragePassages": 1, "buildingNumberOfHouseholds": -1, "last3MonthsPassages": -1, "last6MonthsPassages": -1, "last12MonthsPassages": -1, "last18MonthsPassages": -1, "priority": 1, "isMain": true, "isRecent": false, "isActive": true, "isRatified": false, "firstPassageDate": "2016-02-01T00:00:00Z", "lastPassageDate": "2016-02-01T00:00:00Z", "creationDate": "2016-02-01T00:00:00Z", "lastUpdateDate": "2016-02-01T00:00:00Z", "hasOptIn": false, "ibgeCode": "XXXXXX", "latitude": -00.00, "longitude": -00.00 } ] } } ``` {% endtab %} {% endtabs %} ## Números de telefone (PF13) Retorna uma lista dos números de telefone da pessoa. **Seção:** `pfPhones` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | items | Array | Dados dos telefones | | items\[x].number | String | Número de telefone | | items\[x].areaCode | String | Código de área (DDD do estado) | | items\[x].countryCode | String | Código do país | | items\[x].type | String | Categoria do número | | items\[x].lastPassageDate | String | Data do último uso | | items\[x].portabilityHistory | Array | Histórico de portabilidade | | items\[x].hasOptIn | Booleano | Aceita ligações de marketing | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "items": [ { "number": "XXXXXXXXX", "areaCode": "11", "countryCode": "55", "type": "CELULAR", "lastPassageDate": "2020-05-12T22:46:23.812Z", "portabilityHistory": [], "hasOptIn": "false" } ] } } ``` {% endtab %} {% endtabs %} ## ANTT Consulte o site da ANTT para identificar se o transportador está habilitado para realizar atividades. **Seção:** `antt` **Parâmetro obrigatório**: `CPF`, `placa` **Formatos de placa:** *AAA9999* ou *AAA9A999* {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.hasRegister | Booleano | Status que informa se contém um registro | | data.transporter | String | Transportador | | data.rntrc | String | Número do RNTRC | | data.rntrcSituation | String | Situação | | data.memberSince | String | Data do primeiro relacionamento | | data.expirationDate | String | Data de expiração | | data.city | String | Cidade | | data.message | String | Mensagem presente no cadastro | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Não foram encontrados transportadores para o filtro informado." } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | não\_possui\_participante\_antt | A regra será inválida se o veículo e a pessoa/empresa consultados não estiverem autorizados a realizar atividades. | | {% endtab %} | | | {% endtabs %} | | ## Dados de sites (PF32) Retorna informações sobre os sites e domínios associados ao CPF consultado, seja por registro de domínio ou por informações contidas no próprio conteúdo do site. **Seção:** `pfDomains` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | --------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Array | Dados de retorno | | data\[x].hostName | String | Nome do host | | data\[x].domainName | String | Nome do domínio | | data\[x].domainClass | String | Classificação do site | | data\[x].registrationStatus | String | Status do registro | | data\[x].registrationDate | String | Data de criação do site | | data\[x].expirationDate | String | Data de expiração do site | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": [ { "hostName": "", "domainName": "", "domainClass": "", "registrationStatus": "", "registrationDate": "", "expirationDate": "" } ] } ``` {% endtab %} {% endtabs %} ## Endereços - NOVO (PF77) Retorna uma lista de endereços. **Seção:** `pfAddressesAlt` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.addresses | Array | A lista de endereços ordenada em ordem decrescente de acordo com o nível de confiabilidade | | data.addresses\[x].street | String | Endereço da rua | | data.addresses\[x].number | String | Número do endereço | | data.addresses\[x].complement | String | Complemento do endereço | | data.addresses\[x].neighborhood | String | Bairro do endereço | | data.addresses\[x].zipCode | String | CEP | | data.addresses\[x].city | String | Cidade | | data.addresses\[x].state | String | Estado | | data.addresses\[x].country | String | País | | data.addresses\[x].completeAddress | String | Endereço completo | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso", "addresses": [ { "street": "Rua Tiradentes", "number": "1077", "complement": "5º andar", "neighborhood": "Centro", "zipCode": "95800000", "city": "Venâncio Aires", "state": "RS", "country": "Brasil", "completeAddress": "Rua Tiradentes, 1077 - 5º andar - Centro, Venâncio Aires - RS, 95800000" }, { "street": "Avenida Marechal Floriano", "number": "45", "complement": "Sala 801", "neighborhood": "Centro", "zipCode": "20080901", "city": "Rio de Janeiro", "state": "RJ", "country": "Brasil", "completeAddress": "Avenida Marechal Floriano, 45 - Sala 801 - Centro, Rio de Janeiro - RJ, 20080901" } ] } } ``` {% endtab %} {% endtabs %} ## Números de telefone - NOVO (PF14) Retorna uma lista dos números de telefone da pessoa. \**Este recurso não valida menores de idade* **Seção:** `pfPhonesAlt` **Parâmetro obrigatório:** `CPF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | message | String | Descrição do status da consulta | | data | Objeto | Dados de retorno | | data.phones | Array | Dados dos telefones | | data.phones\[x].number | String | Número de telefone | | data.phones\[x].areaCode | String | Código de área (DDD do estado) | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "message": "Consulta realizada com sucesso", "data": { "phones": [ { "number": "999999999", "areaCode": "11" } ] } } ``` {% endtab %} {% endtabs %} ## Detalhes do CEP - NOVO (PF15) Retorna informações detalhadas relacionadas a um CEP, incluindo nome da rua, bairro, cidade, estado e outros dados relevantes. **Seção:** `zipCodeDetails` **Parâmetro obrigatório:** `cep` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.district | String | Bairro | | data.street | String | Nome da rua | | data.city | String | Cidade | | data.cityCodeIbge | String | Código IBGE da cidade | | data.ufName | String | Nome do estado | | data.uf | String | Sigla do estado | | data.ufCodeIbge | String | Código IBGE do estado | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso", "district": "Centro", "street": "Rua Tiradentes", "city": "Venâncio Aires", "cityCodeIbge": "4322608", "ufName": "Rio Grande do Sul", "uf": "RS", "ufCodeIbge": "43" } } ``` {% endtab %} {% endtabs %} ## Consulta de CURP (PF18) Coleta informações básicas sobre uma CURP (Clave Única de Registro de Población) no México. **Seção:** `mxCurpCheck` **Parâmetro obrigatório:** `curp` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](https://github.com/combateafraude/public-docs/blob/docs-api/core-api/transactions/background-check/data-structure.md#status-code)) | | data | Objeto | Dados de retorno | | data.name | String | Nome | | data.gender | String | Gênero | | data.age | Número | Idade | | data.birthDate | String | Data de nascimento | | data.birthCountry | String | País de nascimento | | data.motherName | String | Nome da mãe | | data.fatherName | String | Nome do pai | | data.taxIdNumber | String | Número da CURP | | data.taxIdStatus | String | Status da CURP em relação ao Serviço de Administração Tributária | | data.taxIdCountry | String | País do documento | | data.taxIdOrigin | String | Origem da CURP | | data.taxIdStatusDate | String | Data da consulta de status | | data.alternativeIdNumbers | Objeto | Números de documentos alternativos | | data.alternativeIdNumbers.socialSecurityNumber | String | Número de Segurança Social | | data.hasObitIndication | Booleano | Indica se houve óbito para essa pessoa | | data.obitIndicationYear | String | Ano da indicação de óbito | | data.creationDate | String | Data de criação | | data.lastUpdateDate | String | Última atualização | | data.message | String | Descrição do status da consulta | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "taxIdNumber": "FOEJ600704HVZXRW36", "taxIdStatus": "", "taxIdOrigin": "", "taxIdCountry": "MEXICO", "name": "JOHNNY DOE", "gender": "M", "age": 26, "birthDate": "1999-05-08T00:00:00Z", "birthCountry": "MEXICO", "motherName": "JANE DOE", "fatherName": "JOHN DOE", "alternativeIdNumbers": { "socialSecurityNumber": "" }, "hasObitIndication": false, "obitIndicationYear": "", "taxIdStatusDate": "2016-02-01T00:00:00Z", "creationDate": "2016-02-01T00:00:00Z", "lastUpdateDate": "2016-02-01T00:00:00Z" } } ``` {% endtab %} {% endtabs %} ## Link de cadastro - NOVO (PF91) Retorna os dados enviados pelo usuário. Nenhum parâmetro é necessário. **Seção:** `registryLinkSource` **Parâmetro opcional:** `personId, CPF, CNPJ, RG, CNH, nome, data de nascimento, e-mail, número de telefone, IP do usuário, país do documento` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | data.message | String | Descrição do status da consulta | | data | Objeto | Dados de retorno | | data.documentId | String | Identificador do documento principal | | data.documentType | String | Tipo do documento principal (ex.: PERSONID, CPF, CNPJ, RG, CNH) | | data.name | String | Nome | | data.birthDate | String | Data de nascimento | | data.email | String | Endereço de e-mail | | data.phoneNumber | String | Número de telefone | | data.userIp | String | Endereço IP do usuário | | data.documentCountry | String | País do documento | | data.additionalDocuments | Array | Lista de documentos adicionais | | data.additionalDocuments\[x].documentId | String | Identificador do documento | | data.additionalDocuments\[x].documentType | String | Tipo do documento (ex.: CPF, CNPJ, RG, CNH) | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "documentId": "abc123456789def0", "documentType": "PERSONID", "name": "JOHN DOE", "birthDate": "1999-05-08T00:00:00Z", "email": "johndoe@email.com", "phoneNumber": "11999999999", "userIp": "192.168.0.1", "documentCountry": "BR", "additionalDocuments": [ { "documentId": "03852939097", "documentType": "CPF" }, { "documentId": "11222333000181", "documentType": "CNPJ" }, { "documentId": "123456789", "documentType": "RG" }, { "documentId": "04567891011", "documentType": "CNH" } ] } } ``` {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/kyc/register-data.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.