Domínios — Termos de Autorização

Usados em Termos de Autorização.

AuthorizationTermStatus

Devolvido em status como StatusField.

Code	Key	Nome	Cor	Significado
1	pending	Pendente	Amarelo	Criado, aguardando o aceite do titular e, depois dele, a autorização do provedor, feita em segundo plano. Sem token.
2	active	Ativo	Verde	Válido para consultas até expiresAt.
3	expired	Expirado	Laranja	Vigência encerrada.
4	revoked	Revogado	Vermelho	Revogado pelo titular ou pela operação.
5	rejected	Rejeitado	Vermelho	Recusado. No consignado privado, a Dataprev recusou a autorização ou o trabalhador recusou o termo na jornada de aceite; note traz o motivo.
6	canceled	Cancelado	Cinza	Cancelado.

AuthorizationTermType

Code	Key	Nome
1	data_inquiry	Autorização para Consulta de Dados
2	data_sharing	Autorização para Compartilhamento de Dados
3	payroll_deduction	Autorização para Desconto em Folha
4	social_security_data_inquiry	Autorização para Consulta de Dados do Benefício INSS
5	private_payroll_data_inquiry	Autorização para Consulta de Dados do Trabalhador CLT — fixo em POST /v5/loan-private-payrolls/terms
99	other	Outro

AuthorizationTermProvider

Code	Key	Nome
1	internal	Interno — o termo fica active assim que o aceite é registrado, sem autorização externa.
100	dataprev	Dataprev — fixo em POST /v5/loan-private-payrolls/terms. O termo só fica active depois que a Dataprev autoriza.
300	open_finance	Open Finance
400	scr	SCR - Banco Central
999	other	Outro

Domínios do aceite

Os três domínios abaixo são usados no payload de aceite (signatures[] na criação e corpo de POST /v5/authorization-terms/{id}/sign). Cada aceite é gravado como um envelope de assinatura eletrônica, e por isso o valor enviado aparece na resposta traduzido para o domínio equivalente da assinatura — a coluna No envelope mostra a key correspondente.

AuthorizationTermSignerRole

Campo signerRole. Padrão owner. Inválido → 4060010. No envelope, aparece em signatures[].requirements[].role.

Code	Key	Nome	No envelope
1	owner	Titular	owner
2	legal_representative	Representante Legal	legal_representative
3	proxy	Procurador	attorney
4	guardian	Tutor/Curador	legal_guardian
5	witness	Testemunha	witness
6	signer_by_request	Assinatura a Rogo	signer_by_request

AuthorizationTermAuthenticationType

Campo authenticationType: como o titular confirmou o aceite. Inválido → 4060011. No envelope, aparece em signatures[].signers[].authenticationType.

Code	Key	Nome	No envelope
1	opt_in	Opt-in	opt_in
2	electronic_signature	Assinatura Eletrônica	electronic_signature
3	digital_certificate	Certificado Digital	icp_brasil
4	sms_otp	OTP por SMS	token_sms
5	email_otp	OTP por E-mail	token_email
6	biometric	Biometria	facial_biometrics
7	handwritten	Assinatura Manuscrita	handwritten
8	whatsapp_otp	OTP por WhatsApp	token_whatsapp
9	click	Aceite Simples	click — usado no aceite feito pelo próprio trabalhador na jornada de aceite.

AuthorizationTermChannel

Campo authenticity.channel. Padrão web na criação pelo consignado privado. Inválido → 4060012. No envelope, aparece em signatures[].requirements[].authenticity.channel.

Code	Key	Nome	No envelope
1	web	Web	web
2	mobile	Mobile	mobile
3	api	API	api
4	branch	Agência	presential
5	whatsapp	WhatsApp	whatsapp