Institute of Studies of Protests of Title of Brazil

Description

Consult the IEPTB database, the entity representing the Protest Registry in Brazil, which gathers information on Securities Protest related to a person for not complying with the payment of checks, tax taxes, purchase and sale contracts for property such as real estate, furniture and vehicles, among other debt documents.

HTTP method GET

Endpoint

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/br-identity/{documentNumber}/check-institute-studies-protests-title

info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
CPF	✅	string	Brazilian id number

Status code responses

Code	Description
200	OK
400	Bad request
401	Unauthorized
404	Not found
500	Internal server error.

The full documentation error codes can be found here.

Response 200 status code

{
    "traceId": "b2345cfc7bee621e",
    "timestamp": "2023-05-15 11:59:35",
    "data": {
        "states_without_protests": [
            "TO",
            "SE",
            "SP",
            "SC",
            "RR",
            "RO",
            "RS",
            "RN",
            "RJ",
            "PI",
            "PE",
            "PR",
            "PB",
            "PA",
            "MG",
            "MS",
            "MT",
            "MA",
            "GO",
            "ES",
            "CE",
            "BA",
            "AM",
            "AP",
            "AL",
            "AC"
        ],
        "states_with_protests": [
            "DF"
        ],
        "details": [
            {
                "consultation_date": "XXXXXXXXX",
                "protest_date": "2020-08-19",
                "amount": 450,
                "municipio": "Brasília",
                "description": "3º Ofício de Notas e Protesto de Títulos de Brasília",
                "uf": "DF"
            }
        ]
    }
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "-",
    "data": null
}

Response 401 status code

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/idv-govcheck/v1/br-identity/{documentNumber}/check-institute-studies-protests-title"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}