Listar solicitações de consulta de CPR na CERC

GET

/v2/cpr/requests

Lista solicitações de consulta de CPR na CERC, vindas do serviço de CPRs na CERC. Os cinco parâmetros de consulta são obrigatórios: limit e offset paginam; orderBy ordena por requestedAt (data da solicitação), clientTaxId (CPF ou CNPJ do cliente), clientName (nome do cliente) ou companyName (nome da empresa), na direção de order (asc ou desc); requestStatus filtra por Pendente ou Finalizado. A resposta é a lista da página, sem total. Parâmetro ausente ou inválido devolve 422. Quando o serviço de CPRs na CERC responde com erro, a API devolve o mesmo status que ele devolveu, ou 500 quando ele não responde, com a mensagem Falha na integração com o serviço de consulta de CPRs na CERC., em message como lista dentro de lista (formato mostrado nas respostas). Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Solicitações de consulta de CPR na CERC

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠422Parâmetros de consulta inválidos

🔴500Falha na integração com a CERC ou erro interno

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/cpr/requests?limit=20&offset=0&orderBy=requestedAt&order=desc&requestStatus=Pendente' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

[
    {
        "authorizationStatus": "Pendente",
        "clientId": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
        "clientName": "Maria Exemplo da Silva",
        "clientTaxId": "11144477735",
        "companyId": "5b1c8d3e-2f64-4a07-9c1e-6d8f0a2b4c71",
        "companyName": "Cooperativa Exemplo",
        "id": "3f2a9c10-7b5d-4e86-a1c4-9d0e5b7f2a63",
        "personType": "CPF",
        "productCode": "cerc-publicidade",
        "queryId": "c81d4f06-52a9-4b3e-8e17-0a6b9d2c5f48",
        "requestStatus": "Pendente",
        "requestedAt": "2026-10-05T12:08:19.425000",
        "serviceCode": "cerc-publicidade",
        "userEmail": "usuario@exemplo.com.br",
        "userId": "8a4e6b12-3c97-4d05-b2f1-7e9c0d5a1b36"
    },
    {
        "authorizationStatus": "Pendente",
        "clientId": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
        "clientName": "Fazenda Exemplo Ltda",
        "clientTaxId": "11222333000181",
        "companyId": "5b1c8d3e-2f64-4a07-9c1e-6d8f0a2b4c71",
        "companyName": "Cooperativa Exemplo",
        "id": "a90c5e27-3b14-4d68-8f02-6e7d1b4c9a35",
        "personType": "CNPJ",
        "productCode": "avulso-cerc-publicidade",
        "queryId": "5d2b8f41-7e03-4a96-b1c8-0f3a9e6d2c74",
        "requestStatus": "Pendente",
        "requestedAt": "2026-10-03T17:37:29.916000",
        "serviceCode": "cerc-publicidade",
        "userEmail": "usuario@exemplo.com.br",
        "userId": "8a4e6b12-3c97-4d05-b2f1-7e9c0d5a1b36"
    }
]

Modificado em 2026-10-13 09:47:06

Página anterior

Listar CPRs de um cliente

Próxima página

Visualizar solicitação de consulta de CPR na CERC