Envio de Documentos e Formalização

Envio dos dados complementares exigidos pela IN 138 do INSS e formalização da proposta de portabilidade e refinanciamento.

Envio de documentos

Segundo IN 138 do INSS é obrigatório o envio dos dados complementares do contrato.

Os documentos devem ser enviados através do endpoint de upload de documentos. e devem seguir a seguinte formatação:

Validações	Valores
Formato	JPEG
Tamanho mínimo	250 x 250 px
Tamanho máximo	2 MB

Atenção

Contratos que tiverem documentos vinculados que não respeitam as regras de tamanho mínimo ou máximo serão cancelados permanentemente.

Caso as validações não sejam atendidas, no momento que o parceiro seguir com a proposta após receber o saldo devedor, iremos devolver os seguintes erros :

Ver exemplos de erro

Formato inválido
Tamanho inválido

{
    "title": "Invalid document format",
    "description": "The document: document_identification_back should be in JPEG format.",
    "translation": "O documento: document_identification_back deve estar no formato JPEG.",
    "code": "SSC000061"
}

{
    "title": "Invalid document size",
    "description": "The document: document_identification_back should have at least 250x250px.",
    "translation": "O documento: document_identification_back deve ter no mínimo 250x250px.",
    "code": "SSC000060"
}

Após o upload de documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da proposta no tópico anterior dentro do campo borrower ou dentro do objeto de related_parties* correspondente ao representante legal ("role_type": "issuer_legal_representative"):

{
    "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
    "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
    "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}

Ou ainda, após a criação da proposta, podem ser informadas através do seguinte endpoint:

ENDPOINT

/v2/credit_transfer/proposal/PROPOSAL-KEY/related_party/RELATED-PARTY-KEY/attached_document

MÉTODO

POST

Testar no Playground

Request Body

{
    "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
    "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
    "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}

Informação

A related_party_key é retornada na response da criação de dívida dentro do objeto borrower e dentro de cada uma das partes relacionadas dentro de related_party_list se for o caso.

Formalização da Proposta

Atenção

Para propostas que envolvam troco após o refinanciamento, é necessário o valor do troco calculado de acordo com as condições do contrato seja de pelo menos 5% da diferença entre a soma de todas as parcelas do refinanciamento subtraida da soma de todas as parcelas da portabilidade. Caso contrário, a requisição receberá o seguinte erro:

STATUS

400

Response Body

{
    "title": "Bad Request", 
    "code": "CT000118",
    "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", 
    "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00."
}

Para formalização das operações de Portabilidade e/ou Refinanciamento (Troco), deve-se enviar as evidências de assinatura dos contratos gerados na digitação da Proposta.

No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 5. Os campos obrigatórios são os seguintes: ip_address e signature_datetime.

6.1. Para assinatura da Operação de Portabilidade o Parceiro deve realizar a seguinte chamada:

Request

MÉTODO
POST
STATUS
/v2/credit_transfer/proposal/PROPOSAL-KEY/portability_credit_operation/signature

Testar no Playground

Payload:

payload.json

{
    "type": "pdf-signature",
    "biometry_analysis_reference": "SERPRO",
    "signature_datetime": "2023-12-22T15:01:32.482Z",
    "signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9",
    "ip_address": "179.145.48.219",
    "similarity_score": "0.9750000000000001"
}

Enumeradores Biometry Analysis Reference

Enumerador	Descrição
serpro	Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro)
tse	Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE
not_found	Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro.

A conclusão da assinatura será notificada de forma assíncrona:

Webhook

WEBHOOK_TYPE
credit_transfer.proposal.credit_operation

body.json

{
	"webhook_type": "credit_transfer.proposal.credit_operation",
	"proposal_key": "<PROPOSAL-KEY>",
	"event_datetime": "2022-11-24T15:42:12",
	"data": {
		"credit_operation_type": "portability",
		"credit_operation_key": "<CREDIT-OPERATION-KEY>",
		"document_key": "<GUID DO DOCUMENTO NA QI>",
		"signed_document_url": "<LINK DO URL DO PDF ASSINADO>",
		"credit_operation_status": "signed"
	}
}

6.2. Para assinatura da Operação de Refinanciamento (Troco) o Parceiro deve realizar a seguinte chamada:

Request

MÉTODO
POST
ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY/refinancing_credit_operation/signature

Testar no Playground

Payload:

payload.json

{
    "type": "pdf-signature",
    "signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9",
	"ip_address": "192.168.0.0",
	"signature_datetime": "2020-03-20T14:28:23.382748Z",
	"similarity_score": "0.98",
	"biometry_analysis_reference": "serpro"
}

A conclusão da assinatura será notificada de forma assíncrona:

Webhook

WEBHOOK_TYPE
credit_transfer.proposal.credit_operation

body.json

{
	"webhook_type": "credit_transfer.proposal.credit_operation",
	"proposal_key": "<PROPOSAL-KEY>",
	"event_datetime": "2022-11-24T15:42:12",
	"data": {
		"credit_operation_type": "refinancing",
		"credit_operation_key": "<CREDIT-OPERATION-KEY>",
		"document_key": "<GUID DO DOCUMENTO NA QI>",
		"signed_document_url": "<LINK DO URL DO PDF ASSINADO>",
		"credit_operation_status": "signed"
	}
}