Manual Consignado Privado - Configuração dos Filtros de Recebimento de Propostas de Leilão

Introdução

O Fluxo de emissão das operações via leilão se inicia no momento em que um tomador solicita um empréstimo no app da CTPS digital, a QI Tech consulta todas as solicitações realizadas periodicamente e, para cada pedido, abre um leilão interno de propostas de empréstimo notificando os parceiros via webhook. Neste manual estão os endpoints necessários para configurar os filtros de solicitação que possibilitam controlar o público alvo da operação.

Modificando regras de filtragem

ENDPOINT

- /private_payroll_auction/requester_configuration/custom_data

MÉTODO

- PATCH

Nessa requisição existem dois tipos de campos passiveis de serem alterados; O status do cliente e os filtros do cliente. Em relação ao status do cliente, pode ser alterado entre ativo e inativo, sinalizando se o cliente deseja ou não receber novas solicitações de leilão.

{
    "status": "active"
}

O campo custom_data contêm os filtros de fato. Nele devem ser enviados todos os campos de filtragem como no exemplo abaixo:

{
    "custom_data": {
        "disbursed_issue_amount": {"min": null, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": null, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": null},
    }
}

cada campo deve ter obrigatoriamente as chaves min e max, com exceção do received_daily_proposals e days_since_employment. OBS: Todos os campos de custom data devem ser enivados, mesmo que não seja necessário mudar todos os valores. Além disso, o envio de todas as chaves min/max é obrigatório, sendo passado 'null' caso não seja necessário utilizar esse filtro.

Exemplo de Body

{
    "status": "inactive",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

Response

STATUS

- 201 (Accepted)

Response Body: Configuração Atualizada

{
    "status": "active",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

Adicionando CNPJs de filtragem

Para clientes que desejam receber solicitações apenas de funcionários de CNPJs específicos, existe a opção de adicionar esses CNPJs em lote:

ENDPOINT

- /private_payroll_auction/requester_configuration/related_employer

MÉTODO

- POST

Atenção!

A DATAPREV somente opera com a raíz dos CNPJs, portanto para a filtragem a partir do documento do empregador devem ser enviados apenas os 8 primeiros dígitos do CNPJ.

Body

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

A lista pode conter no máximo 100 CNPJs.

Response

STATUS

- 201

Response Body: CNPJs adicionados

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

Observação

Apenas os CNPJs efetivamente adicionados serão retornados. No caso em que um CNPJ já tenha sido cadastrado, não será retornado na lista da resposta. Caso nenhum CNPJ seja adicionado será retornada uma lista vazia.

Removendo CNPJs de filtragem

ENDPOINT

- /private_payroll_auction/requester_configuration/remove_related_employers

MÉTODO

- POST

Body

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

Os CNPJs devem ser enviado apenas com os 8 primeiros dígitos e a lista pode conter no máximo 100 CNPJs.

Response

STATUS

- 200

Response Body: CNPJ removidos

{
    "employer_document_numbers": ["01234567", "12345678"]
}

Buscando CNPJs de filtragem

Para consultar os CNPJs cadastrados como filtros para um solicitante, utilize o endpoint abaixo com suporte a paginação.

Endpoint

ENDPOINT

- /private_payroll_auction/requester_configuration/related_employers

MÉTODO

- GET

Query Params

Campo	Tipo	Descrição	Padrão
page_number	int	Número da página atual	1
page_rows	int	Quantidade de registros por página	100

Exemplo de Resposta - 200

{
  "data": [
    {
      "employer_document_number": "01234567"
    },
    {
      "employer_document_number": "12345678"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2,
    "rows_per_page": 2,
    "total_pages": 3,
    "total_rows": 6
  }
}

Anexos

Detalhamento do Payload de Alteração de Regras de Filtragem

Campo	Tipo	Descrição	Obrigatório
status	string	novo status do cliente	Não
custom_data	dict	Novos filtros para o cliente	Não

Status do Cliente

Status	Descrição
active	Cliente deseja receber novas solicitação de proposta no leilão
inactive	Cliente Nâo deseja receber novas solicitações de proposta

Parâmetros do Custom Data

Campo	Tipo	Descrição	Obrigatório
disbursed_issue_amount	dict	Valor do contrato emitido (mínimo e máximo)	Sim
number_of_installments	dict	Número de parcelas (mínimo e máximo)	Sim
consigned_credit_balance	dict	Saldo de crédito consignado (mínimo e máximo)	Sim
days_since_employment	dict	Dias desde o início do vínculo empregatício (mínimo)	Sim
age	dict	Idade do proponente (mínimo e máximo)	Sim
received_daily_proposals	dict	Número de propostas recebidas por dia (máximo)	Sim

Detalhamento do Payload de Adição e Remoção de CNPJs de Filtragem

Campo	Tipo	Descrição	Obrigatório
employer_document_number	array de strings	Lista de raízes de CNPJ (com 8 dígitos cada). Deve conter entre 1 e 100 itens	Sim