Guide

Consulta Detalhada de Proposta de FGTS

Este endpoint permite obter todos os dados digitados em uma proposta de saque aniversário FGTS, a partir do identificador único da proposta. Ele retorna todos os campos originalmente enviados no momento da digitação, além de dados complementares e o status atual da operação.

Endpoint de Consulta

  • URL: https://bff.v8sistema.com/fgts/proposal/{id}

  • Método: GET

Parâmetro de Caminho

  • {id} (obrigatório): Identificador da proposta que se deseja consultar. Esse ID é obtido em operações de criação ou listagem de propostas.

Exemplo de Requisição

GET /fgts/proposal/74e22e17-37cf-4a28-9182-3abd462b3168
Authorization: Bearer <token>

Exemplo de Resposta (parcial)

{
	"id": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
	"userId": "793d23f3-323b-427c-86d6-86a7ce772460",
	"score": "95.00",
	"coreId": "c4e0b174-286c-489a-9285-ebfa258d7232",
	"status": "paid",
	"statusReason": null,
	"statusDescription": null,
	"documentIrregularReason": null,
	"provider": "qi",
	"issueAmount": "167.67",
	"disbursedIssueAmount": "113.57",
	"disbursementDate": "2025-02-02",
	"simulationFeesId": "61c9fb2f-c902-4992-b8f5-b0ee368c45b0",
	"name": "cristhian martins ",
	"individualDocumentNumber": "02226262",
	"documentIdentificationNumber": "002020220022",
	"motherName": "viana oliveira ",
	"nationality": "Outros",
	"isPEP": false,
	"email": "email@gmail.com",
	"birthDate": "2003-05-15",
	"maritalStatus": "single",
	"personType": "natural",
	"phone": "995254952",
	"phoneCountryCode": "55",
	"phoneRegionCode": "55",
	"postalCode": "97538000",
	"state": "RS",
	"neighborhood": "Centro",
	"addressNumber": "777",
	"city": "Aceguá",
	"street": "General Neto",
	"complement": "Casa",
	"documentImage": null,
	"formalizationLink": "https://v2-api-core-prd.yellowisland-b252a8a0.eastus.azurecontainerapps.io/formalization/operation/c4e0b174-286c-489a-9285-065096290490",
	"signedContractUrl": null,
	"probationaryDocumentUrl": null,
	"contractNumber": "04926966/COM",
	"createdAt": "2025-02-02T02:56:03.204Z",
	"updatedAt": "2025-02-02T09:12:51.759Z",
	"allowedByUserId": null,
	"canceledByUserId": null,
	"origin": "internal",
	"hasCcbGenerated": true,
	"callId": null,
	"payment": {
		"id": "ba57f45b-7d52-43ee-aa48-4e819e27bbc1",
		"fgtsProposalId": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
		"type": "pix",
		"createdAt": "2025-02-02T02:56:03.204Z",
		"updatedAt": "2025-02-02T02:56:03.204Z",
		"deletedAt": null,
		"fgtsProposalsPaymentPix": {
			"id": "06264400-91cb-444e-8aea-518648cec912",
			"fgtsProposalPaymentId": "ba57f45b-7d52-43ee-aa48-4e819e27bbc1",
			"pix": "5195159162"
		},
		"fgtsProposalsPaymentTransfer": null
	},
	"docs": [
		{
			"approved": false,
			"approvedFaceMatch": false,
			"approvedOcr": true,
			"id": "cca40494-7d9e-48f4-88d5-bed8fa77eb5e",
			"key": "f022e599-72e8-4a03-9ecc-54c4c3ef7940.pdf",
			"preSignedUrl": "",
			"proposalId": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
			"type": "RG"
		},
		{
			"approved": true,
			"approvedFaceMatch": true,
			"approvedOcr": true,
			"id": "fe21ce43-8ca9-458c-9d3f-72e313d490ee",
			"key": "a09d8711-ab1a-4b8f-b2fe-cfd50a211415.png",
			"preSignedUrl": "",
			"proposalId": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
			"type": "USER_PHOTO"
		},
		{
			"approved": true,
			"approvedFaceMatch": true,
			"approvedOcr": true,
			"id": "c25c602a-4d10-4835-97ee-0a13534678c7",
			"key": "c8c42ee2-ff00-42b8-8cfa-196167282b3d.pdf",
			"preSignedUrl": "",
			"proposalId": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
			"type": "CONTRACT"
		},
		{
			"approved": true,
			"approvedFaceMatch": true,
			"approvedOcr": true,
			"id": "b16cd043-686e-4e2d-a931-f4c754624c1c",
			"key": "f2f8c504-8d9e-4825-a534-3c1fa5bda255.pdf",
			"preSignedUrl": "",
			"proposalId": "fbbc83f1-924e-4c7d-b0b4-cb0d89c2ac80",
			"type": "PROBATORY_SET"
		}
	],
	"user": {
		"partnerId": "001"
	}
}

Considerações Técnicas

  • A resposta inclui todos os campos de entrada da proposta, além de status de processamento, timestamps e dados de pagamento.

  • Pode ser utilizada em conjunto com o endpoint de listagem para obter detalhes completos de uma proposta específica listada anteriormente.

  • Para segurança, exige autenticação via token JWT.