Skip to main content

Manual Consignado Privado - Vinculos Empregaticios

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.

Contratos ativos estão sujeitos a variações no estado dos vínculos empregatícios do tomador de crédito. Por esse motivo, a Dataprev será consultada diariamente para monitorar possíveis alterações. Eventuais mudanças serão comunicadas ao cliente detentor de cada contrato por meio de webhooks.

1 - Webhook de Encerramento de Vínculos Empregatícios​

Webhook enviado para notificar a perda de vínculo de trabalhadores com contrato ativo, cujo contrato estava consignado a um vínculo que foi encerrado.

WEBHOOK_TYPE
laas.private_payroll.terminated_employment_relationship

{
    "status": "ongoing",
    "event_datetime": "2025-03-20T14:47:43Z",
    "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
    "webhook_type": "laas.private_payroll.laas.private_payroll.terminated_employment_relationship",
    "data": {
        "document_number": "71742311016",
        "registration_number": "123456789ABCDEFR",
        "employer_document_number": "02302554000179",
        "employment_relationship_data": {
            "name": "ANTONIO DA SILVA MATOS",
            "loan_status": "Encerrado por término do vínculo",
            "issue_amount": 8766.53,
            "employer_name": "BECKER S.A.",
            "contract_number": "0168355612PFD",
            "proposal_number": "QITECH_4087721518011",
            "last_update_date": "2025-05-22T12:23:49",
            "termination_date": "05052025",
            "contract_end_date": "2029-06-28",
            "payments_received": 0,
            "contract_start_date": "2025-05-20",
            "lending_institution": "QI SOCIEDADE DE CREDITO DIRETO S A",
            "recorded_transactions": 0,
            "disbursed_issue_amount": 8473.05,
            "employer_document_type": "CNPJ",
            "installment_face_value": 382.92,
            "number_of_installments": 48,
            "contract_inclusion_date": "2025-05-20T14:40:11",
            "last_discount_competence": "2029-05",
            "first_discount_competence": "2025-06"
        },
    }
}

Sendo a key do webhook a credit_operation_key da proposta no caso de solicitação vinda de leilão, ou a debt_key caso a proposta tenha sido feita fora do leilão.

2 - Webhook de Novos Vínculos Empregatícios​

Webhook enviado para notificar a existência de novo vínculo de trabalhador, cujo contrato estava anteriormente consignado a um vínculo que foi encerrado.

WEBHOOK_TYPE
laas.private_payroll.new_employment_relationship

{
    "status": "ongoing",
    "event_datetime": "2025-03-20T14:47:43Z",
    "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
    "webhook_type": "laas.private_payroll.new_employment_relationship",
    "data": {
        "document_number": "71742311016",
        "registration_number": "123456789ABCDEFR",
        "employer_document_number": "02302554000179",
        "employment_relationship_data": {
            "name": "LETYCIA AGUILAR DA SILVA",
            "eligible": true,
            "loan_count": 0,
            "employer_name": "VIPER SERVICOS DO NORDESTE LTDA",
            "admission_date": "13042025",
            "total_due_amount": 1642.16,
            "base_margin_amount": 911.67,
            "political_exposition": "not_exposed",
            "worker_category_code": 101,
            "employer_document_type": "CNPJ",
            "available_margin_amount": 319.08
        },
    }
}

Sendo a key do webhook a credit_operation_key da proposta no caso de solicitação vinda de leilão, ou a debt_key caso a proposta tenha sido feita fora do leilão.