Enumeradores

Tabelas de referência compartilhadas por todos os fluxos INSS — crédito novo, refinanciamento, portabilidade e cartão consignado. Esta é a única página onde estes enumeradores são definidos; as demais páginas linkam para as âncoras daqui.

Retorno da Dataprev

Os códigos de duas letras (HW, BD, CR…) são os da própria Dataprev. O campo que a QI Tech entrega nos webhooks e nas consultas é o enumerador, na segunda coluna.

Enumeradores Retention Reason

Enumerador	Descrição
issuer_retention	Retenção do Cliente
different_from_original	Condições da proposta divergentes do contrato original
issuer_lawsuit	Cliente com ação judicial
insurance_in_progress	Indenização de seguro em andamento
collateral_in_execution	Garantia em Execução
contract_not_found	Contrato não encontrado
invalid_contract_type	Tipo de contrato inválido
portability_in_progress	Portabilidade em andamento
assigned_contract	Contrato cedido
issuer_document_number_invalid	CPF não é do contrato
unrelated_issuer_document_number	CPF informado não é o do titular
assigned_without_co_obligation	Contrato cedido sem coobrigação
fgts_in_use	FGTS AMORTIZAR em uso
fgts_funding	FGTS funding
portability_not_requested	O cliente não solicitou a portabilidade
wrong_original_financial_institution	IF Credora Original Incorreta

Tabela de retorno de erros Dataprev - averbação

Um retorno pode trazer vários erros

A Dataprev responde com uma lista de erros, não com um só. É comum vir mais de um ao mesmo tempo — por exemplo agência inválida junto com conta de desembolso inválida. Corrigir apenas o primeiro não libera a operação: trate todos os erros da lista.

O mesmo código muda de significado conforme a consulta

Cada família de chamada tem a sua própria tabela de retorno. NB significa "número do benefício ausente" na averbação e "consulta sem número de benefício" na consulta de saldo; OT e DR também mudam. Use sempre a tabela da operação que você chamou.

Vale para averbação de crédito novo, refinanciamento e portabilidade.

Código Dataprev	Enumerador	O que significa	O que a plataforma faz
HW	consignable_margin_excceded	Margem consignável excedida no instante da averbação, não na consulta: entre consultar a margem e averbar, outra operação pode tê-la consumido.	Em portabilidade, recalcula automaticamente para a margem que a Dataprev devolve. Nos demais casos, move a operação para pending_requester_action para o parceiro recalcular.
IE	benefit_blocked_by_beneficiary	Benefício bloqueado para empréstimo. Nem sempre é bloqueio feito pelo titular: uma averbação no mesmo benefício cria o bloqueio imediatamente.	Retenta automaticamente. O desbloqueio, quando é ação do titular, é feito pelo Meu INSS.
IF	benefit_blocked_by_granting_process	Benefício bloqueado por estar em processo de concessão.	Retenta automaticamente na frequência máxima. Resolve quando a concessão é concluída.
IT	benefit_blocked_by_tbm	Benefício bloqueado por transferência de benefício (TBM).	Retenta no dia seguinte pela manhã.
HR	exceeded_number_of_allowed_contracts	O benefício atingiu o número máximo de contratos ativos permitidos.	Retenta em baixa frequência e move para pending_requester_action até o benefício liberar espaço.
OZ	suspended_service	Serviço da Dataprev suspenso. Indisponibilidade dela, não erro do payload.	Retenta automaticamente. Normaliza sozinho.
HX	reservation_already_included	A averbação já está registrada na Dataprev. Costuma ocorrer quando uma chamada foi bem-sucedida mas a resposta se perdeu.	Consulta o contrato e, se estiver ativo, trata como sucesso. Não é erro.
RB	invalid_change_interest_rate	Taxa interna de retorno acima do teto. A TIR avaliada não é a taxa do contrato novo, é a do troco isoladamente: o valor liberado ao cliente contra a parcela que sobra depois de amortizar os contratos quitados. O teto é de 1,85% ao mês, e carência piora o resultado.	Retenta, mas reapresentar sem alterar as condições não resolve. É preciso reduzir a taxa, aumentar o troco ou remover a carência.
OG	benefit_being_updated_by_other_operation	Duas operações atingiram o mesmo benefício no mesmo instante — averbação, exclusão, portabilidade, refinanciamento, alteração ou RMC. Não é outro banco ocupando o benefício.	Retenta automaticamente. Costuma passar já na reapresentação seguinte.
OT	invalid_fields_length	Um ou mais campos têm tamanho fora do aceito. O limite mais comum é o do número do contrato, de 18 caracteres.	Retenta. Exige correção do payload pelo parceiro.
HZ	operation_not_allowed_on_this_reservation_status	O contrato na Dataprev não está no estado que a operação exige — normalmente porque a operação já foi executada.	Consulta o contrato e ajusta o estado da reserva conforme o que encontrar.
FH	operation_out_of_dataprev_opening_hours	Operação enviada fora da janela de funcionamento da Dataprev.	Devolve a mensagem para a fila e retenta dentro da janela.
RA	invalid_paid_contract_list	A lista de contratos quitados é inválida. Duas causas distintas: (a) carência de 7 dias úteis entre dois refinanciamentos; (b) o contrato informado não está mais ativo na Dataprev.	Retenta. Na causa (a) resolve com o tempo, e o contrato recriado recebe um _ no número — o refinanciamento seguinte precisa informá-lo com o _. Na causa (b) não resolve com o tempo.
HM	benefit_number_not_found	Número do benefício ou titular não encontrado na Dataprev.	Marca o benefício como inválido e move a operação para pending_requester_action para correção do número.
IR	operation_not_allowed_IR	O prazo da operação ultrapassa a data de extinção da cota do benefício.	Cancela. Retentar não resolve: é preciso redigitar com prazo menor.
D17	incorrect_consignable_margin_data	O valor da margem consignável está nulo, incompleto ou inconsistente na base da Dataprev.	Retenta.
OM	balance_not_registered	O benefício não tem saldo registrado na Dataprev.	Retenta em baixa frequência.
PH	wrong_benefit_number_on_portability	O número da portabilidade existe na Dataprev, mas registrado em outro número de benefício.	Retenta. A correção depende do banco cedente, que gerou o número e precisa cancelá-lo e reemiti-lo no benefício correto.
PI	invalid_contract_total_amount	O valor total do contrato está abaixo da referência da Dataprev. Ocorre quando o contrato fica muito tempo sem ser averbado e os valores previamente estabelecidos envelhecem.	Em portabilidade, após 30 dias ajusta a taxa ao teto vigente e retenta.
OF	invalid_cbc	CBC inválido.	Refaz a consulta de saldo para recarregar os dados bancários e retenta. Persistindo, move para pending_requester_action para correção dos dados bancários.
T9	contract_already_deleted	Não é possível alterar um contrato que já foi excluído com aquela origem de exclusão.	Trata conforme a operação em curso.
IQ	loan_already_suspended	O contrato já está suspenso pelo banco.	Retenta.
RH	expired_refinancing_reversion_period	Passou o prazo para reverter a operação de refinanciamento.	Não insiste na reversão: refinancia o refinanciamento e segue.
AN	invalid_disbursement_account	Conta de desembolso inválida.	Refaz a consulta de saldo para recarregar os dados bancários e retenta. Persistindo, move para pending_requester_action para correção dos dados bancários.
IB	benefit_suspended_or_canceled	Benefício suspenso ou cessado por APS ou SISOBI.	Marca o benefício como inválido. Em reversão de refinanciamento, cancela.
TN	invalid_monthly_interest_rate	A taxa de juros mensal do contrato está fora do permitido. Não confundir com RB: aqui é a taxa do próprio contrato, não a TIR do troco.	Retenta. Exige nova digitação com taxa dentro do teto.
PK	wrong_bank_code_destination	O número da portabilidade foi encontrado com banco de destino diferente do informado.	Retenta. A correção depende do banco que liberou o número.
AM	invalid_branch_code	Agência inválida.	Refaz a consulta de saldo para recarregar os dados bancários e retenta. Persistindo, move para pending_requester_action.
HC	benefit_with_legal_representative	O benefício tem representante legal e a operação não o contemplou.	Cancela e marca o benefício como inválido.
PQ	invalid_contract_list	Lista de contratos inválida. O retorno traz listaErrosContratos com o erro de cada contrato individualmente.	Lê os erros por contrato. Quando indicam contrato repetido ou já excluído, marca como excluído.
HN	benefit_not_allowed_to_loan	A espécie do benefício não permite empréstimo consignado.	Retenta.
AP	invalid_contract_date	Competência de início de desconto, ou data de início ou fim do contrato, inválida. Normalmente a competência informada já passou.	Retenta. Exige nova digitação com competência futura.
HP	benefit_received_by_attorney	Benefício recebido por procurador.	Retenta.
IA	first_name_mismatch	Primeiro nome do titular ou do representante legal diverge do registrado na Dataprev.	Corrige automaticamente a partir da última consulta de saldo bem-sucedida e retenta. Sem representante legal na reserva, move para pending_requester_action.
RM	reservation_is_not_refinancing	Pedido de reversão de refinanciamento sobre uma reserva que não foi criada por refinanciamento.	Trata à parte, sem reverter.
HQ	alimony_benefit_type_not_allowed	Benefício do tipo pensão alimentícia não permite empréstimo.	Cancela. Não há o que retentar.
TP	invalid_first_period_date	Data da primeira parcela inválida.	Retenta.
PE	portability_number_found_for_different_benefit	O número da portabilidade está registrado na base para um benefício diferente.	Move para pending_requester_action para correção do número do benefício.
AV	processing_payroll	Operação enviada durante o processamento da folha do INSS.	Retenta no dia seguinte.
PF	mismatch_cpf	O CPF da requisição não corresponde ao CPF do benefício.	Move para pending_requester_action para correção.
CA	invalid_bank_code	Código do banco inválido.	Move para pending_requester_action para correção dos dados bancários.
BC	cbc_missing	CBC não informado.	Move para pending_requester_action para correção dos dados bancários.
OS	legal_representative_document_number_mismatch	CPF do representante legal divergente.	Dispara verificação do benefício.
AY	invalid_state	UF inválida.	Retenta.
GA	required_fields_missing	Campos obrigatórios ausentes no payload.	Retenta. Exige correção do payload.
NB	benefit_number_missing	Número do benefício não informado.	Retenta. Exige correção do payload.
NC	contract_number_missing	Número do contrato não informado.	Retenta. Exige correção do payload.
PV	invalid_image_format	Imagem enviada em formato inválido.	Retenta. Exige reenvio do documento.
GP	invalid_date	A data informada não pode estar no futuro.	Retenta. Exige correção do payload.
BL	invalid_loan_value	Valor do empréstimo inválido.	Retenta.
D5	incorrect_benefit_data	Dados do benefício incompletos, inconsistentes ou nulos.	Retenta.
ID	benefit_blocked_for_portability	Benefício bloqueado especificamente para portabilidade.	Retenta.
OD	invalid_card_limit	Limite de cartão inválido. Aplica-se aos fluxos de cartão.	Retenta.
OU	invalid_annual_fee_amount	Valor da tarifa anual inválido.	Retenta.
PA	invalid_proponent_code	Código do proponente inválido.	Retenta.
PS	if_without_agreement	A instituição financeira não tem convênio para processar portabilidade.	Retenta.
PU	portability_number_found_for_different_contract	O número da portabilidade foi encontrado com o mesmo benefício e a mesma instituição, mas para outro contrato.	Retenta.

Atenção!

Todas as taxas e valores do contrato são validados no momento da criação da reserva.

A crítica "invalid_contract_total_amount" ocorre nos casos em que os contratos se estendem por muito tempo sem serem averbados, o que impacta os valores previamente estabelecidos.

Motivos de cancelamento que não são da Dataprev

Nem todo cancelamento é recusa da Dataprev. Os motivos abaixo não têm código Dataprev: são decisões da plataforma ou do próprio parceiro, e aparecem no mesmo campo dos retornos acima.

Enumerador	O que significa
deletion_request	Exclusão solicitada pelo parceiro antes de a averbação se concretizar.
confirmation_denied_by_beneficiary	O beneficiário recusou a confirmação da reserva.
confirmation_expired	O prazo de confirmação do beneficiário expirou.
rate_limit_exceeded	Limite de requisições por segundo à Dataprev excedido.
unlisted_error	Erro devolvido pela Dataprev que não está mapeado.
social_security_minimum_wage_increase_error	Erro na rotina anual de reajuste do salário mínimo.
ineligible_benefit	Benefício inelegível para reserva.
invalid_beneficiary_data	Dados do beneficiário inválidos.
invalid_balance	Dados de saldo registrados são inválidos.
contract_limit_exceeded	Número máximo de contratos excedido.
operation_not_allowed	Operação não permitida por prazo, taxa ou tipo inválido.
operation_not_allowed_due_to_system	Operação não permitida por alteração, falha ou janela do sistema.
benefit_blocked	Benefício bloqueado para empréstimo pelo beneficiário.
invalid_contract_number	Número do contrato vazio ou com dígito inválido.
invalid_document_number	CPF vazio ou com dígito inválido.
benefit_not_granted	Benefício não pertence ao banco, está sendo atualizado por outra operação ou não tem margem.
invalid_value	Valor de parcela, empréstimo, tarifa anual ou custo pessoal inválido.
invalid_service_channel	Canal de atendimento inválido.

Tabela de retorno de sucesso - averbação

Código Dataprev	Enumerador	Descrição
BD	successfully_reserved	Inclusão realizada com sucesso
BF	successfully_removed	Exclusão realizada com sucesso
BR	successfully_reactivated	Reativação realizada com sucesso
BS	successfully_suspended	Suspensão realizada com sucesso
BZ	successfully_reserved_pending_confirmation	Inclusão realizada com sucesso, pendente de confirmação do beneficiário
—	titularity_successfully_changed	Troca de titularidade realizada com sucesso

Tabela de retorno de erros na consulta de saldo

Código	Enumerador	O que significa
IE	benefit_blocked_by_beneficiary	Benefício bloqueado para empréstimo. É, de longe, o retorno mais comum da consulta de saldo.
IF	benefit_blocked_by_granting_process	Benefício bloqueado por estar em processo de concessão.
IT	benefit_blocked_by_tbm	Benefício bloqueado por transferência de benefício (TBM).
FH	operation_out_of_dataprev_opening_hours	Consulta enviada fora da janela de funcionamento da Dataprev.
BI	inexistent_benefit	Número de benefício não encontrado.
CD	inexistent_beneficiary	CPF não encontrado.
NB	balance_without_benefit_number	Consulta enviada sem número de benefício.
SF	invalid_document_number	CPF inválido.
CR	not_found_legal_representative	O beneficiário tem representante legal e ele não foi informado.
AS	benefity_without_legal_representative	Foi informado representante legal, mas o beneficiário não tem.
RI	invalid_beneficiary_or_legal_representative_cpfs	O CPF do beneficiário e/ou o do representante legal é inválido.
DR	invalid_legal_representative	O representante legal informado está incorreto ou vencido.
DR	invalid_legal_representative_document_number	O CPF do representante legal não foi encontrado na base.
IV	invalid_token	Não há termo de autorização válido para o CPF e o código de solicitante informados.
EX	expired_token	Termo de autorização vencido. A validade é de 30 dias após a assinatura.
D1	inconsistent_balance_benefit_data	Os dados de saldo do benefício estão inconsistentes, nulos ou incompletos na Dataprev.
D10	incorrect_benefit_data	Os dados do benefício estão incompletos, inconsistentes ou nulos.
OT	incorrect_field_size	O tamanho de um ou mais campos está incorreto.
OZ	suspended_service	Serviço da Dataprev suspenso.
QIE	mock_error	Apenas em sandbox: o CPF informado não faz parte da massa de teste.
—	dataprev_error	Erro devolvido pela Dataprev sem código mapeado.
—	unlisted_error	Erro não mapeado.

Tabela de retorno de erros na consulta de benefícios

Código	Enumerador	O que significa
CR	not_found_legal_representative	O beneficiário tem representante legal e ele não foi informado.
CD	inexistent_beneficiary	CPF não encontrado.
AS	benefity_without_legal_representative	Foi informado representante legal, mas o beneficiário não tem.
SF	invalid_document_number	CPF inválido.
RI	invalid_beneficiary_or_legal_representative_cpfs	O CPF do beneficiário e/ou o do representante legal é inválido.
DR	invalid_legal_representative	O representante legal informado está incorreto ou vencido.
DA	invalid_signature_date	A data de assinatura do termo é inválida ou está no futuro.
IV	invalid_token	Não há termo de autorização válido para o CPF e o código de solicitante informados.
EX	expired_token	Termo de autorização vencido. A validade é de 30 dias após a assinatura.
FH	operation_out_of_dataprev_opening_hours	Consulta enviada fora da janela de funcionamento da Dataprev.
OZ	suspended_service	Serviço da Dataprev suspenso.
QIE	mock_error	Apenas em sandbox: o CPF informado não faz parte da massa de teste.
—	dataprev_error	Erro devolvido pela Dataprev sem código mapeado.

Tabela de retorno de erros no termo de autorização

O termo de autorização é pré-requisito da consulta de saldo e da consulta de benefícios, e vale 30 dias após a assinatura.

Código	Enumerador	O que significa
CR	not_found_legal_representative	O beneficiário tem representante legal e ele não foi informado.
AS	benefity_without_legal_representative	Foi informado representante legal, mas o beneficiário não tem.
CD	inexistent_beneficiary	CPF não encontrado.
SF	invalid_document_number	CPF inválido.
RI	invalid_beneficiary_or_legal_representative_cpfs	O CPF do beneficiário e/ou o do representante legal é inválido.
DR	invalid_legal_representative	O representante legal informado está incorreto ou vencido.
DRA	invalid_legal_representative_document_number	O CPF do representante legal não foi encontrado na base.
DA	invalid_signature_date	A data de assinatura é inválida ou está no futuro.
OZ	suspended_service	Serviço da Dataprev suspenso.
FH	operation_out_of_dataprev_opening_hours	Requisição enviada fora da janela de funcionamento da Dataprev.
—	dataprev_error	Erro devolvido pela Dataprev sem código mapeado.

Tabela de retorno de erros na consulta do contrato de origem

Retornos da consulta do contrato de origem de uma portabilidade.

Código	Enumerador	O que significa
GE	portability_not_found_by	Contrato não encontrado.
GS	portability_not_found_by_nu	Portabilidade não encontrada para o número informado. Uma consulta vazia por número de portabilidade costuma indicar portabilidade não registrada, e não número incorreto.
CA	invalid_bank_code	Código do banco inválido.
QI	reservation_not_found	Retorno da própria QI Tech, não da Dataprev: não foi encontrada a reserva correspondente a este contrato de origem.
FH	operation_out_of_dataprev_opening_hours	Consulta enviada fora da janela de funcionamento da Dataprev.
—	unlisted_error	Erro não mapeado.

Tabela de situação de benefícios

Items
active
excluded
terminated
suspended
suspended_by_CONPAG
terminated_by_SISOBI
receiving_monthly_recover_6_months
receiving_monthly_recover_18_months
suspended_by_name_error
suspended_by_credentialed_payer
suspended_by_inspection
suspended_by_audit
terminated_by_inspection
terminated_by_audit
receiving_monthly_recover_6_months_inspection
receiving_monthly_recover_18_months_inspection
suspended_by_SISOBI
canceled_by_audit

Tabela de status de benefícios

Enumerador	Descrição
Elegible	Elegível para empréstimo
Inelegible	Benefício inelegível para empréstimo
Blocked	Benefício elegível, porém bloqueado para empréstimo

Tabela de tipos de bloqueio

A Dataprev devolve o código em tipoBloqueio.codigo; a QI Tech entrega o enumerador correspondente no campo block_type.

Código Dataprev	Enumerador (block_type)	Descrição
0	not_blocked	Sem bloqueio
1	blocked_by_benefitiary	Bloqueado pelo Segurado
2	blocked_by_tbm	Bloqueado por TBM
3	blocked_in_concession	Bloqueado na Concessão

Tabela de tipos de politicamente exposto

Enumerador	Descrição
0	Pessoa Não Exposta Politicamente
1	Pessoa Exposta Politicamente - Nível 1

Tabela de benefícios

código	benefício
1	pension_by_death_rural_worker
2	pension_by_death_accident_rural_worker
3	pension_by_death_rural_employer
4	retirement_invalidity_rural_emploee
5	retirement_invalidity_accident_rural_worker
6	retirement_invalidity_rural_employer
7	retirement_by_eldness_rural_worker
8	retirement_by_age_rural_employer
9	complement_by_work_accident_rural_worker
11	support_invalidity_rural_worker
12	support_by_age_rural_worker
13	aid_sickness_rural_worker
15	aid_time_off_rural_worker
16	aid_federal
17	international_agreement
18	inclusion_benefit
19	pension_student_law7004
20	pension_by_death_diplomat
21	pension_by_death
22	pension_by_death_statute
23	pension_by_death_veteran
24	pension_special_institutional_act
25	aid_time_off
26	pension_by_death_special_law593
27	pension_by_death_federal_emploee
28	pension_by_death_general_regime_law20465
29	pension_by_death_marine_veteran
30	monthly_income_lifetime_invalidity
31	aid_sickness
32	retirement_invalidity_social_security
33	retirement_invalidity_aeronautic
34	retirement_invalidity_marine_law1756
35	aid_sickness_veteran
36	aid_social_security_accident
37	retirement_capin_extra_emploee
38	retirement_federal_extra_emploee
39	aid_invalidity_student_law7004
40	monthly_income_lifetime_by_age_upper70_law6179
41	retirement_by_age
42	retirement_by_contribution_time
43	retirement_by_time_of_service_veteran
44	retirement_special_aeronautic
45	retirement_by_time_of_service_journalist
46	retirement_special
47	allowance_25
48	allowance_20
49	retirement_ordinary
50	aid_sickness_extinct_basic_plan
51	retirement_invalidity_extinct_basic_plan
52	retirement_by_age_extinct_basic_plan
53	aid_time_off_extinct_basic_plan
54	pension_indemnity_federal
55	pension_by_death_extinct_basic_plan
56	pension_lifetime_syndrome_thalidomide
57	retirement_by_teacher_labor_time
58	retirement_anisty
59	pension_by_death_amnesty
60	indemnity
61	aid_birth
62	aid_funeral
63	aid_funeral_rural_worker
64	aid_funeral_rural_employer
65	savings_special_autarchy
67	savings_mandatory_ipase_law5128
68	savings_special_retirement_ps_affiliated_upper60
69	savings_student_law7004
70	restitution
71	monthly_income
72	retirement_by_time_of_service_law1756
73	monthly_income_family_statute
74	complement_pension_federal
75	complement_retirement_federal
76	monthly_income_statute
77	monthly_income_sinpas_family_statute
78	retirement_by_age_law1756
79	advantage
80	monthly_income_maternity
81	compulsory_retirement
82	retirement_by_time_of_service_sasse
83	retirement_invalidity_ex_sasse
84	pension_by_death_sasse
85	pension_lifetime_rubber_tapper_law7986
86	pension_lifetime_rubber_tapper_dependent_law7986
87	continuous_aid_physical_disabilities
88	continuous_aid_eldness
89	pension_special_hemodialysis_victim_caruaru
90	medic_assistency_work_accident
91	aid_sickness_by_work_accident
92	retirement_invalidity_work_accident
93	pension_by_death_work_accident
94	aid_work_accident
95	aid_additional_work_accident
96	pension_special_leprosy_law11520
97	savings_by_death_work_accident
98	aid_longshoreman
99	time_off_15