Consultar documento
Sandbox
https://sandbox.sgitec.com.br
Sandbox
https://sandbox.sgitec.com.br
POST
/relatorioAvancadoPf/v2/consulta
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.sgitec.com.br/relatorioAvancadoPf/v2/consulta' \
--header 'Authorization: Bearer '\''token de acesso'\''' \
--header 'x-api-key: '\''api key'\''' \
--header 'Content-Type: application/json' \
--data-raw '{
"documento": "00000000000000",
"features": [
"código da feature a ser consultada",
"código da feature a ser consultada"
]
}'Response Response Example
200 - Sucesso
{
"error": false,
"result": {
"document": "",
"report": {
"registration": {
"documentNumber": "",
"alternativeDocumentNumber": "",
"alternativeDocumentCode": "",
"alternativeDocumentDescription": "",
"alternativeDocumentDate": "",
"issuingAgency": "",
"issuingAgencyState": "",
"consumerName": "",
"motherName": "",
"consumerGender": "",
"maritalStatus": "",
"maritalStatusDescription": "",
"birthSquareCity": "",
"birthSquareState": "",
"birthDate": "",
"profession": "",
"professionCode": "",
"occupation": "",
"occupationCode": "",
"jobDescription": "",
"educationLevelCode": "",
"educationLevelDescription": "",
"dependentsNumber": "",
"statusRegistration": "",
"statusDate": "",
"address": {
"addressLine": "",
"addressNumber": "",
"district": "",
"zipCode": "",
"country": "",
"city": "",
"state": ""
},
"addresses": [
{
"addressLine": "",
"addressTypeCode": "",
"addressTypeDescription": "",
"addressNumber": "",
"district": "",
"zipCode": "",
"country": "",
"city": "",
"state": "",
"addressComplement": "",
"updateDate": ""
}
],
"phones": [
{
"regionCode": "",
"areaCode": "",
"phoneNumber": "",
"phoneType": "",
"phoneTypeCode": ""
}
],
"error": {
"code": "",
"message": ""
}
},
"negativeData": {
"pefin": {
"pefinResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"refin": {
"refinResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"notary": {
"notaryResponse": [
{
"occurrenceDate": "",
"amount": "",
"officeNumber": "",
"city": "",
"federalUnit": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"check": {
"checkResponse": [
{
"occurrenceDate": "",
"alinea": "",
"bankId": "",
"bankName": "",
"bankAgencyId": "",
"checkNumber": "",
"checkCount": "",
"city": "",
"federalUnit": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"collectionRecords": {
"collectionRecordsResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"city": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
}
},
"partner": {
"partnershipResponse": [
{
"businessDocument": "",
"companyName": "",
"participationInitialDate": "",
"participationPercentage": "",
"companyStatus": "",
"companyStatusCode": "",
"companyState": "",
"companyStatusDate": "",
"updateDate": ""
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"scoresFraud": {
"scoresFraudResponse": [
{
"scoreModel": "",
"score": "",
"recommendationRisk": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
]
},
"facts": {
"inquiry": {
"inquiryResponse": [
{
"occurrenceDate": "",
"segmentDescription": "",
"daysQuantity": ""
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"inquirysummary": {
"inquiryQuantity": {
"actual": "",
"checkActual": "",
"creditInquiriesQuantity": [
{
"inquiryDate": "",
"occurrences": ""
}
],
"checkInquiriesQuantity": [
{
"inquiryDate": "",
"occurrences": ""
}
]
},
"summary": {
"count": "",
"checkCount": "",
"creditCount": ""
}
},
"stolenDocuments": {
"stolenDocumentsResponse": [
{
"occurrenceDate": "",
"documentType": "",
"documentNumber": "",
"detailedReason": "",
"phone": {
"regionCode": "",
"areaCode": "",
"phoneNumber": ""
}
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"judgementFilings": {
"judgementFilingsResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"amount": "",
"distributor": "",
"civilCourt": "",
"city": "",
"state": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"bankrupts": {
"bankruptsResponse": [
{
"eventDate": "",
"eventType": "",
"origin": "",
"varaCourt": "",
"city": "",
"state": ""
}
],
"summary": {
"count": "",
"balance": "",
"firstOccurrence": "",
"lastOccurrence": ""
},
"error": {
"code": "",
"message": ""
}
}
},
"score": {
"score": "",
"scoreModel": "",
"range": "",
"defaultRate": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
},
"scores": {
"scoreResponse": [
{
"score": "",
"scoreModel": "",
"range": "",
"defaultRate": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
]
},
"attributes": {
"attributesResponse": [
{
"attributeModel": "",
"codeMessage": "",
"message": "",
"data": [
{
"code": "",
"codeDescription": "",
"codeMessage": "",
"message": ""
}
],
"error": {
"code": "",
"message": ""
}
}
],
"onTimePaymentsIndex": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
},
"affordability": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
},
"incomeCommitment": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
},
"paymentsHistory": {
"paymentsHistoryResponse": [
{
"initialDayRange": "",
"finalDayRange": "",
"score": "",
"range": "",
"error": {
"code": "",
"message": ""
}
}
]
},
"deathAlert": {
"deathResponse": [
{
"document": "",
"alert": "",
"codes": [
{
"messageCode": "",
"fullMessage": ""
}
]
}
]
},
"mosaic": {
"code": "",
"group": "",
"description": ""
}
},
"optionalFeatures": {
"registration": {
"documentNumber": "",
"alternativeDocumentNumber": "",
"alternativeDocumentCode": "",
"alternativeDocumentDescription": "",
"alternativeDocumentDate": "",
"issuingAgency": "",
"issuingAgencyState": "",
"consumerName": "",
"motherName": "",
"consumerGender": "",
"maritalStatus": "",
"maritalStatusDescription": "",
"birthSquareCity": "",
"birthSquareState": "",
"birthDate": "",
"profession": "",
"professionCode": "",
"occupation": "",
"occupationCode": "",
"jobDescription": "",
"educationLevelCode": "",
"educationLevelDescription": "",
"dependentsNumber": "",
"statusRegistration": "",
"statusDate": "",
"address": {
"addressLine": "",
"addressNumber": "",
"district": "",
"zipCode": "",
"country": "",
"city": "",
"state": ""
},
"addresses": [
{
"addressLine": "",
"addressTypeCode": "",
"addressTypeDescription": "",
"addressNumber": "",
"district": "",
"zipCode": "",
"country": "",
"city": "",
"state": "",
"addressComplement": "",
"updateDate": ""
}
],
"phones": [
{
"regionCode": "",
"areaCode": "",
"phoneNumber": "",
"phoneType": "",
"phoneTypeCode": ""
}
],
"error": {
"code": "",
"message": ""
}
},
"negativeData": {
"pefin": {
"pefinResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"refin": {
"refinResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"notary": {
"notaryResponse": [
{
"occurrenceDate": "",
"amount": "",
"officeNumber": "",
"city": "",
"federalUnit": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"check": {
"checkResponse": [
{
"occurrenceDate": "",
"alinea": "",
"bankId": "",
"bankName": "",
"bankAgencyId": "",
"checkNumber": "",
"checkCount": "",
"city": "",
"federalUnit": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"collectionRecords": {
"collectionRecordsResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"contractId": "",
"creditorName": "",
"amount": "",
"city": "",
"federalUnit": "",
"legalSquare": "",
"principal": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
}
},
"partner": {
"partnershipResponse": [
{
"businessDocument": "",
"companyName": "",
"participationInitialDate": "",
"participationPercentage": "",
"companyStatus": "",
"companyStatusCode": "",
"companyState": "",
"companyStatusDate": "",
"updateDate": ""
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"scoresFraud": {
"scoresFraudResponse": [
{
"scoreModel": "",
"score": "",
"recommendationRisk": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
]
},
"facts": {
"inquiry": {
"inquiryResponse": [
{
"occurrenceDate": "",
"segmentDescription": "",
"daysQuantity": ""
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"inquirysummary": {
"inquiryQuantity": {
"actual": "",
"checkActual": "",
"creditInquiriesQuantity": [
{
"inquiryDate": "",
"occurrences": ""
}
],
"checkInquiriesQuantity": [
{
"inquiryDate": "",
"occurrences": ""
}
]
},
"summary": {
"count": "",
"checkCount": "",
"creditCount": ""
}
},
"stolenDocuments": {
"stolenDocumentsResponse": [
{
"occurrenceDate": "",
"documentType": "",
"documentNumber": "",
"detailedReason": "",
"phone": {
"regionCode": "",
"areaCode": "",
"phoneNumber": ""
}
}
],
"summary": {
"count": ""
},
"error": {
"code": "",
"message": ""
}
},
"judgementFilings": {
"judgementFilingsResponse": [
{
"occurrenceDate": "",
"legalNatureId": "",
"legalNature": "",
"amount": "",
"distributor": "",
"civilCourt": "",
"city": "",
"state": "",
"legalSquare": ""
}
],
"summary": {
"firstOccurrence": "",
"lastOccurrence": "",
"count": "",
"balance": ""
},
"error": {
"code": "",
"message": ""
}
},
"bankrupts": {
"bankruptsResponse": [
{
"eventDate": "",
"eventType": "",
"origin": "",
"varaCourt": "",
"city": "",
"state": ""
}
],
"summary": {
"count": "",
"balance": "",
"firstOccurrence": "",
"lastOccurrence": ""
},
"error": {
"code": "",
"message": ""
}
}
},
"scores": {
"scoreResponse": [
{
"score": "",
"scoreModel": "",
"range": "",
"defaultRate": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
]
},
"attributes": {
"attributesResponse": [
{
"attributeModel": "",
"codeMessage": "",
"message": "",
"data": [
{
"code": "",
"codeDescription": "",
"codeMessage": "",
"message": ""
}
],
"error": {
"code": "",
"message": ""
}
}
],
"onTimePaymentsIndex": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
},
"affordability": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
},
"incomeCommitment": {
"scoring": "",
"attributeModel": "",
"codeMessage": "",
"message": "",
"error": {
"code": "",
"message": ""
}
}
},
"deathAlert": {
"deathResponse": [
{
"document": "",
"alert": "",
"codes": [
{
"messageCode": "",
"fullMessage": ""
}
]
}
]
},
"mosaic": {
"code": "",
"group": "",
"description": ""
}
}
}
}Modificado em 2026-04-16 21:11:55