Coobrigado/fiador

Para manusear as informações do coobrigado, precisa ter em mãos o PK da dívida

Endpoints:

• /negatives/:negative_pk/guarantors/: lista os coobrigados vinculados a determinada dívida.
• /negatives/:negative_pk/guarantors/pk:uuid/ : detalha, apaga ou atualiza um registro específico, depende do verbo HTTP que esteja sendo utilizado.
• /negatives/:negative_pk/guarantors/pk:uuid/down/ : efetua a baixa de um coobrigado.

Os coobrigados são as pessoas solidária na dívida que entraram como garantidores da dívida, mais popularmente chamados de fiadores, pode ser pessoas físicas ou jurídicas.

---

Regras básica de validação

• Não se pode adicionar um coobrigado a uma dívida já baixada.
• O coobrigado não pode ter 2 registros vinculados a mesma dívida.
• Não se pode cadastrar um novo registro com o campo motivo da baixa preenchido.
• Não se pode alterar as informações de um coobrigado após a sincronização com a Serasa.
• Após a sincronização com a Serasa, o único campo que pode ser alterado é o motivo da baixa.
• Os coobrigados estão vinculados a dívida e consequentemente ao negativado; uma mesma dívida, pode ter vários coobrigados.
• Um negativado pode ter o mesmo coobrigado cadastrado varias vezes, mais precisa estar vinculado a uma dívida diferente.

---

Campos do Coobrigado

Campo	Tipo	Obrigatório	Somente leitura	Tamanho máximo	Observacao
pk	String/UUID	Não	Sim		Identifica de forma única o registro.
debt	String/UUID	Não	Sim		Identifica o pk da dívida no qual esse coobrigado está relacionada.
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 coobrigado (rua, avenida, número...).
neighborhood	String	Sim	Não	20	Bairro/vizinhança ou setor onde reside o coobrigado.
city	String	Sim	Não	25	Nome da cidade onde reside o coobrigado
state	String	Sim	Não	2	UF do estado brasileiro onde reside o coobrigado.
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.
reasonLow	Inteiro	Não	Não		Motivo da baixa. Preenchido apenas através de uma operação de atualização quando se quer dar baixa na dívida, as opções disponiveis estão em dícionário de dados
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
isInclusionGenerate	Boolean	Não	Sim		Sincronização da inclusão foi efetuada/iniciada
isRemoveGenerate	Boolean	Não	Sim		Sincronização da baixa foi efetuada/iniciada. OBS: apenas quando foi dado baixa no coobrigado

---

Cadastro de um coobrigado

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

Pessoa Física (PF)Pessoa jurídica (PJ)

Cadastro do coobrigado pessoa física (PF)

curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/9fab1219-54b8-4a62-96b6-fe49278b0de7/guarantors" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
        \"debt\": \"a6561c6c-fdea-41f0-bb8b-fa266edc7202\",
        \"document\": \"85261173000\",
        \"name\": \"Roberto Elias Cauã Moura\",
        \"address\": \"Avenida Carlos Gomes\",
        \"neighborhood\": \"Princesa Isabel\",
        \"city\": \"Cacoal\",
        \"state\": \"RO\",
        \"postalCode\": \"76964108\",
        \"rg\": \"130606479\",
        \"rgUf\": \"RO\"
      }"

Cadastro de um coobrigado pessoa jurídica (PJ)

curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/9fab1219-54b8-4a62-96b6-fe49278b0de7/guarantors/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
      \"debt\": \"a6561c6c-fdea-41f0-bb8b-fa266edc7202\",
      \"document\": \"72213046000108\",
      \"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

---

Pessoa Física (PF)Pessoa jurídica (PJ)

Retorno da inclusão PF

  {
    "pk": "5b9f8ba4-aec4-4bde-af98-9a01386f4864",
    "debt": "a6561c6c-fdea-41f0-bb8b-fa266edc7202",
    "document": "85261173000",
    "name": "Roberto Elias Cauã Moura",
    "address": "Avenida Carlos Gomes",
    "neighborhood": "Princesa Isabel",
    "city": "Cacoal",
    "state": "RO",
    "postalCode": "76964108",
    "rg": "130606479",
    "rgUf": "RO",
    "reasonLow": null,
    "createdAt": "2022-07-06T13:20:15.072900-03:00"
  }

Retorno da inclusão PJ

  {
    "pk": "a1a16f99-2f7e-4aad-a0d3-c39f5a769ec0",
    "debt": "a6561c6c-fdea-41f0-bb8b-fa266edc7202",
    "document": "72213046000108",
    "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,
    "reasonLow": null,
    "createdAt": "2022-07-06T13:53:37.776634-03:00"
  }

Listando os coobrigados

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

Listando os coobrigados do negativado

curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/9fab1219-54b8-4a62-96b6-fe49278b0de7/guarantors/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": "5b9f8ba4-aec4-4bde-af98-9a01386f4864",
      "debt": "a6561c6c-fdea-41f0-bb8b-fa266edc7202",
      "document": "85261173000",
      "name": "Roberto Elias Cauã Moura",
      "address": "Avenida Carlos Gomes",
      "neighborhood": "Princesa Isabel",
      "city": "Cacoal",
      "state": "RO",
      "postalCode": "76964108",
      "rg": "130606479",
      "rgUf": "RO",
      "reasonLow": null,
      "createdAt": "2022-07-06T13:20:15.072900-03:00",
      "isInclusionGenerate": false,
      "isRemoveGenerate": false
    },
    {
      "pk": "a1a16f99-2f7e-4aad-a0d3-c39f5a769ec0",
      "debt": "a6561c6c-fdea-41f0-bb8b-fa266edc7202",
      "document": "72213046000108",
      "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,
      "reasonLow": null,
      "createdAt": "2022-07-06T13:53:37.776634-03:00",
      "isInclusionGenerate": false,
      "isRemoveGenerate": false
    }
  ]
}

---

Detalhando um registro

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/guarantors/pk:uuid/

Detalhe de um registro cadastrado anteriormente

curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/9fab1219-54b8-4a62-96b6-fe49278b0de7/guarantors/5b9f8ba4-aec4-4bde-af98-9a01386f4864/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

---

Retorno

---

Retorno do cadastro de uma dívida

{
  "pk": "5b9f8ba4-aec4-4bde-af98-9a01386f4864",
  "debt": "a6561c6c-fdea-41f0-bb8b-fa266edc7202",
  "document": "85261173000",
  "name": "Roberto Elias Cauã Moura",
  "address": "Avenida Carlos Gomes",
  "neighborhood": "Princesa Isabel",
  "city": "Cacoal",
  "state": "RO",
  "postalCode": "76964108",
  "rg": "130606479",
  "rgUf": "RO",
  "reasonLow": null,
  "createdAt": "2022-07-06T13:20:15.072900-03:00",
  "isInclusionGenerate": false,
  "isRemoveGenerate": false
}

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, o mesmo não pode mais ser alterado, apenas dado baixa. 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.

---

Efetuando a baixa do coobrigado

---

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/guarantors/pk:uuid/down/

Para fazer a baixa do coobrigado, é necessário fazer uma requisição POST informando o motivo da baixa; caso o coobrigado tenha sido dado baixa antes de ser efetuado a sincronização com a Serasa, o mesmo não será enviada e não haverá comunicado ao mercado sobre o mesmo.

Após efetuar a baixa do coobrigado, não se pode mais alterar o mesmo.

Ao dar baixa na dívida, o coobrigado também é dado baixa de forma automática, portanto, se for dar baixa na dívida, não se deve baixar também o coobrigado, pois irá gerar rejeição no seu pedido.

Efetuando a baixa do coobrigado

curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/94adb487-1693-4c14-acee-79816ff26683/guarantors/f3e1f87e-b9df-4b9f-a6cc-55b5999bd912/down/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
          \"reason_low\": 1
        }"

---

Retorno

---

Retorno da baixa do coobrigado

{
  "detail": "Coobrigado baixado com sucesso"
}