Pular para conteúdo

Negativado

Endpoints:

  • /negatives/: lista os negativados cadastrados.
  • /negatives/pk:uuid/: detalha, apaga ou atualiza um registro específico, depende do verbo HTTP que esteja sendo utilizado.
  • /negatives/pk:uuid/down/: efetua a baixa do negativado e de todas as suas dívidas, assim como os coobrigados vinculados ao mesmo.

O negativado é o responsável pela dívida, a entidade que contraiu a dívida, podendo ser uma empresa (pessoa jurídica) ou uma pessoa física


Regras básica de validação

  • Precisa ter mais de 18 anos para ser negativado (essa validação não ocorre na API, mais sim, na hora da inclusão da dívida ao Bureau).
  • O registro do negativado é único, portanto, uma vez cadastrado, o mesmo não pode ser cadastrado novamente. Ao tentar realizar um novo cadastro de um negativado, sempre é validado o seu CPF/CNPJ e caso o mesmo já esteja cadastrado, um erro de validação será gerado

Campos do negativado

Campo Tipo Obrigatório Somente leitura Tamanho máximo Observacao
pk String/UUID Não Sim Identifica de forma única o registro.
document String Sim Não 14 Número do CPF se for pessoa física ou CNPJ se for jurídica. Caso seja 11 dígitos, considera-se uma pessoa física, se tiver 14 dígitos, se considera uma pessoa jurídica. Este campo não pode ser modificado após a inclusão do registro.
name String Sim Não 70 Nome ou razão social.
address String Sim Não 45 Endereço do negativado (rua, avenida, número...).
neighborhood String Sim Não 20 Bairro/vizinhança ou setor onde reside o negativado.
city String Sim Não 25 Nome da cidade onde reside o negativado
state String Sim Não 2 UF do estado brasileiro onde reside o negativado.
postalCode String Sim Não 8 Os 8 dígitos númericos de identificação do CEP.
rg String Não Não 15 Número do RG, disponível apenas para pessoas físicas.
rgUf String Não Não 2 UF onde foi emitido o RG. OBS: se for informado o RG, é obrigatório informar o rgUf.
birthday Date Não Não - Data de nascimento, utilizado apenas para PF (formato ano-mês-dia).
father String Não Não 70 Nome do pai (disponível apenas para PF)
mother String Não Não 70 Nome da mãe (disponível apenas para PF)
isActive Boolean Não Sim - Caso seja true, o negativado tem dívidas ativas, se for falase, todas as dívidas foram dado baixa.
createdAt Datetime Não Sim - Campo apenas de leitura e para controle do momento que foi feito o cadastro do registro no sistema. Retorna um datetime com o timezone

Cadastrando um novo registro

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/

Cadastro de pessoa física (PF)
curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
        \"document\": \"85261173000\",
        \"name\": \"Roberto Elias Cauã Moura\",
        \"address\": \"Avenida Carlos Gomes\",
        \"neighborhood\": \"Princesa Isabel\",
        \"city\": \"Cacoal\",
        \"state\": \"RO\",
        \"postalCode\": \"76964108\",
        \"rg\": \"130606479\",
        \"rgUf\": \"RO\",
        \"birthday\": \"1957-05-14\",
        \"father\": \"Edson André Breno Moura\",
        \"mother\": \"Isabel Emanuelly Kamilly\"
        }"
Cadastro de uma pessoa jurídica (PJ)
curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
        \"document\": \"38932369000105\",
        \"name\": \"Laura e Juan Locações de Automóveis ME\",
        \"address\": \"Rua Antônio Palmieri\",
        \"neighborhood\": \"Jardim Amoreiras\",
        \"city\": \"Campinas\",
        \"state\": \"SP\",
        \"postalCode\": \"13050653\"
        }"

Retorno

Retorno da inclusão PF
{
"pk": "01a4056c-fba6-4024-80ce-cf83da9e4e26",
"document": "85261173000",
"name": "Roberto Elias Cauã Moura",
"address": "Avenida Carlos Gomes",
"neighborhood": "Princesa Isabel",
"city": "Cacoal",
"state": "RO",
"postalCode": "76964108",
"rg": "130606479",
"rgUf": "RO",
"birthday": "1957-05-14",
"father": "Edson André Breno Moura",
"mother": "Isabel Emanuelly Kamilly",
"isActive": false,
"createdAt": "2022-06-24T15:28:22.120885-03:00"
}
Retorno da inclusão PJ
{
"pk": "930cb954-be50-4fc5-899c-4acccf029e9e",
"document": "38932369000105",
"name": "Laura e Juan Locações de Automóveis ME",
"address": "Rua Antônio Palmieri",
"neighborhood": "Jardim Amoreiras",
"city": "Campinas",
"state": "SP",
"postalCode": "13050653",
"rg": null,
"rgUf": null,
"birthday": null,
"father": null,
"mother": null,
"isActive": false,
"createdAt": "2022-06-24T15:47:59.568875-03:00"
}

Listando os registros cadastrados

Listando os negativados cadastrados
curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/?limit=2" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno


Retorno listando os negativados cadastrados
{
  "count": 2,
  "next": "https://homolog-pefin.targetinformacoes.com/negatives/",
  "previous": null,
  "results": [
    {
      "pk": "930cb954-be50-4fc5-899c-4acccf029e9e",
      "document": "38932369000105",
      "name": "Laura e Juan Locações de Automóveis ME",
      "address": "Rua Antônio Palmieri",
      "neighborhood": "Jardim Amoreiras",
      "city": "Campinas",
      "state": "SP",
      "postalCode": "13050653",
      "rg": null,
      "rgUf": null,
      "birthday": null,
      "father": null,
      "mother": null,
      "isActive": false,
      "createdAt": "2022-06-24T15:47:59.568875-03:00"
    },
    {
      "pk": "01a4056c-fba6-4024-80ce-cf83da9e4e26",
      "document": "85261173000",
      "name": "Roberto Elias Cauã Moura",
      "address": "Avenida Carlos Gomes",
      "neighborhood": "Princesa Isabel",
      "city": "Cacoal",
      "state": "RO",
      "postalCode": "76964108",
      "rg": "130606479",
      "rgUf": "RO",
      "birthday": "1957-05-14",
      "father": "Edson André Breno Moura",
      "mother": "Isabel Emanuelly Kamilly",
      "isActive": false,
      "createdAt": "2022-06-24T15:28:22.120885-03:00"
    }
  ]
}

Detalhando um registro

Detalhe do registro PJ cadastrado anteriormente
curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/930cb954-be50-4fc5-899c-4acccf029e9e/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno


Retorno do cadastro do PJ
{
  "pk": "930cb954-be50-4fc5-899c-4acccf029e9e",
  "document": "38932369000105",
  "name": "Laura e Juan Locações de Automóveis ME",
  "address": "Rua Antônio Palmieri",
  "neighborhood": "Jardim Amoreiras",
  "city": "Campinas",
  "state": "SP",
  "postalCode": "13050653",
  "rg": null,
  "rgUf": null,
  "birthday": null,
  "father": null,
  "mother": null,
  "isActive": false,
  "createdAt": "2022-06-24T15:47:59.568875-03:00"
}

Para apagar ou atualizar o registro, faça uma requisição igual a descrita em Detalhando um registro alterando apenas o verbo do HTTP para a respectiva necessidade (DELETE para apagar, PUT para atualizar o registro).

OBS: Após inserir o registro e ele ser sincronizado com a Serasa, mesmo atualizando as informações do negativo, o mesmo não será refletido na Serasa, a atualização das suas informações só será refletida nas novas inclusões. Caso precise que as informações que estão na Serasa seja atualizada, é necessário efetuar uma baixa e uma nova inclusão do registro.


Dando baixa no negativado

Ao efetuar a baixa do negativado, todos as dívidas e coobrigados vinculados ao mesmos será feito baixa de forma automática. Caso precise dar baixa em uma dívida específica, consulte a documentação em dívida que o mesmo será descrita como ser efetuado.

Para efetuar a baixa, é feito uma requisição usando o POST passando no corpo da requisição o motivo da baixa (reason_low).

Para ver os códigos disponível de motivo de baixa, veja o dícionário de dados

Caso seja efetuado a baixa com sucesso, o código 200 é retornado, em caso de erro de validação o 400 é retornado.

Regras básicas de validação:

  • É obrigatório informar o reason_low.
  • É obrigatório que o negativado tenha dívidas ativas
Dando baixa no negativado
# Está sendo considerado o pk/uuid do negativado o valor: 930cb954-be50-4fc5-899c-4acccf029e9e

curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/930cb954-be50-4fc5-899c-4acccf029e9e/down/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
          \"reason_low\": 1
        }"

Retorno


Retorno bem sucedido de uma baixa
{
  "detail": "Todos os débitos ativos foram dado baixa"
}