Consultar documento

Sandbox

https://sandbox.sgitec.com.br

POST

/relato/v2/consulta

Ao consultar o documento, terá varias opções de retorno, porém pode ocorrer que alguns campos não serão retornados na consulta. Somente serão retornados os campos que a Serasa disponibilizar informações.

Caso tenha dificuldades na elaboração da estrutura da consulta com os adicionais, favor abrir um chamado em Suporte ao Cliente.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Body

🟢203

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://sandbox.sgitec.com.br/relato/v2/consulta' \
--header 'Authorization: Bearer '\''token de acesso'\''' \
--header 'x-api-key: '\''api key'\''' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documento": "00000000000000",
    "features": [
        "codigo da feature a ser consultada",
        "codigo da feature a ser consultada"
    ]
}'

Response Example

200 - Sucesso

{
    "error": false,
    "result": {
        "document": "",
        "report": {
            "identificationReport": {
                "updateDate": "",
                "statusRegistration": "",
                "companyName": "",
                "companyAlias": "",
                "address": {
                    "addressLine": "",
                    "zipCode": "",
                    "district": "",
                    "country": "",
                    "city": "",
                    "state": "",
                    "countryCode": ""
                },
                "phone": {
                    "areaCode": "",
                    "phoneNumber": ""
                },
                "companyUrl": "",
                "partnership": "",
                "companyRegister": "",
                "companyRegisterDate": "",
                "companyFoundation": "",
                "numberEmployees": "",
                "taxOption": "",
                "stateRegistration": "",
                "economicActivity": "",
                "importPurchases": "",
                "exportSales": "",
                "cnae": "",
                "serasaActiveCode": "",
                "branchOffices": "",
                "nireNumber": "",
                "predecessorList": [
                    {
                        "predecessorName": "",
                        "predecessorDate": ""
                    }
                ],
                "legalNatureCode": ""
            },
            "QSAReport": {
                "companyData": {
                    "socialCapitalValue": "",
                    "accomplishedValue": "",
                    "informationUpdateDate": "",
                    "countryOrigin": "",
                    "controlType": "",
                    "nature": ""
                },
                "partnerCompleteReport": {
                    "partnersList": [
                        {
                            "documentType": "",
                            "documentId": "",
                            "name": "",
                            "sinceDate": "",
                            "nationality": "",
                            "restrictionSign": "",
                            "documentConsistency": "",
                            "capitalTotalValue": "",
                            "capitalVoterValue": ""
                        }
                    ]
                },
                "directorCompleteReport": {
                    "directorsList": [
                        {
                            "documentType": "",
                            "documentId": "",
                            "name": "",
                            "role": "",
                            "maritalStatus": "",
                            "sinceDate": "",
                            "mandateStart": "",
                            "mandateEnd": "",
                            "nationality": "",
                            "restrictionSign": "",
                            "documentConsistency": "",
                            "informationUpdateDate": "",
                            "typeOfMandate": ""
                        }
                    ],
                    "summary": {
                        "count": "",
                        "infoMessages": {
                            "message": []
                        }
                    }
                }
            },
            "negativeData": {
                "pefin": {
                    "pefinResponse": [
                        {
                            "occurrenceDate": "",
                            "legalNatureId": "",
                            "legalNature": "",
                            "contractId": "",
                            "creditorName": "",
                            "amount": "",
                            "federalUnit": "",
                            "principal": ""
                        }
                    ],
                    "summary": {
                        "count": "",
                        "balance": "",
                        "firstOccurrence": "",
                        "lastOccurrence": ""
                    },
                    "error": {
                        "code": "",
                        "message": ""
                    }
                },
                "refin": {
                    "refinResponse": [
                        {
                            "occurrenceDate": "",
                            "legalNatureId": "",
                            "legalNature": "",
                            "contractId": "",
                            "creditorName": "",
                            "amount": "",
                            "principal": ""
                        }
                    ],
                    "summary": {
                        "count": "",
                        "balance": "",
                        "firstOccurrence": "",

Modificado em 2026-04-16 21:10:27

Página anterior

Consultar Adicionais Disponíveis

Próxima página

Consultar Adicionais Disponíveis