Statistics search

The Pismo platform enables you to query DICT, a national registry of Pix keys and their owners, using the Statistics search endpoint. You search with the participant’s document_number, the Brazilian taxpayer identifying number. There are two types:

• CPF (Cadastro de Pessoas Físicas) is for a person.
• CNPJ (Cadastro Nacional de Pessoas Jurídicas) is for a legal entity.

The information returned provides details of the total settlements, reported frauds, and confirmed frauds of the respective queried user. As with key statistics, these totals are consolidated for the last 3 days, 30 days, and 6 months prior to query time.

Request example:

{  
    "document_number": "00000000000"  
}

When the request is made, the API asks the provider to consult the statistics mentioned above within the DICT environment:

• If successful, the request returns payment information, fraud reports, and fraud confirmations in the time frames of 3 days, 3 months, and 6 months.
• Failure scenarios include BadRequest, timeout, Internal error, and Forbidden access.

Success:

{  
    "last_updated_datetime": "2023-01-20T18:59:44.194Z",  
    "counters": [  
        {  
            "statistic_type": "SETTLEMENTS",  
            "responsible": "",  
            "three_days": "0",  
            "thirty_days": "0",  
            "six_months": "0"  
        },  
        {  
            "statistic_type": "REPORTED_FRAUDS",  
            "responsible": "",  
            "three_days": "0",  
            "thirty_days": "0",  
            "six_months": "0"  
        },  
        {  
            "statistic_type": "CONFIRMED_FRAUDS",  
            "responsible": "",  
            "three_days": "0",  
            "thirty_days": "0",  
            "six_months": "0"  
        },  
        {  
            "statistic_type": "REJECTED",  
            "responsible": "",  
            "three_days": "0",  
            "thirty_days": "0",  
            "six_months": "0"  
        }  
    ]  
}

Fail:

{  
  "code": "EPDA0075",  
  "message": "Invalid document number"  
}

Developers: Statistics Search beta