1. Private API
PCM-OpenApi
  • Private API
    • Inclusão de reports
      POST
    • Consulta um report em específico usando um identificador
      GET
  • Hybrid Flow API
    • Inclusão de report Hybrid Flow de redirecionamento para o servidor (papel client)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento para o destino (papel server)
      POST
    • Inclusão de report Hybrid Flow de autenticação (papel server)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento para o cliente (papel server)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento com erro para o destino (papel client)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento sem erro para o destino (papel client)
      POST
  • Opendata API
    • Inclusão de reports
      POST
  • Consents API
    • Inclusão de report de consent stock
      POST
  • Credit Portability API
    • Inclusão de reports de credit portability para client
      POST
    • Inclusão de reports de credit portability para server
      POST
    • Consulta de um report de credit portability
      GET
  • Security API
    • Geração de novo Token de autênticação
      POST
    • Obtenção de Token de autênticação ativo
      POST
  • Payment Status API
    • Inclusão de reports de payment status
      POST
    • Consulta de um report específico usando identificador
      GET
  • Schemas
    • Opendata
      • OpendataReportRequest
      • OpendataReportModel
    • Private
      • ClientReportRequest
      • ServerReportRequest
      • ReportResponse
      • ReportModel
    • Consents
      • ConsentsStockRequest
      • ConsentStockResponse
    • CreditPortability
      • CreditPortabilityClientRequest
      • CreditPortabilityServerRequest
      • CreditPortabilityModel
    • HybridFlow
      • HybridFlowClientRedirectToServerReportRequest
      • HybridFlowServerRedirectTargetReportRequest
      • HybridFlowServerAuthenticatedRequest
      • HybridFlowServerRedirectTargetWithoutErrorsRequest
      • HybridFlowServerRedirectTargetWithErrorsRequest
      • HybridFlowServerRedirectToClientRequest
      • HybridFlowReportResponse
    • Commons
      • GenericError
    • Security
      • SecurityResponse
    • PaymentStatus
      • PaymentStatusRequest
      • PaymentStatusGetResponse
      • PaymentStatusResponse
  1. Private API

Consulta um report em específico usando um identificador

GET
/report-api/v1/private/report/{fapiInteractonId}
Operação que permite a consulta de um reporte em específico mediante um identificador. A busca por reportes estará sempre no contexto do usuário representado pelo token de acesso, ou seja, o participante só terá acesso a reportes em que instituição que ele pertence é parte, seja como client ou como server.
O processamento do registro ocorre de maneira assíncrona, o que pode gerar um cenário de consistência eventual: caso a consulta seja feita imediatamente após a inclusão, é possível que o registro ainda não esteja disponível para consulta.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Responses

🟢200Correto
application/json
Body

🟠401Não autenticado
🟠403Permissão insuficiente
🟠404Não encontrado
🟠406Não aceitável
🟠429Solicitações demais
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/report-api/v1/private/report/' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
    "pairedReportId": "ff2b2fbc-d97a-4bf2-9fd1-2e50e9060e8e",
    "status": "DISCARDED",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-03-24 17:54:58
Previous
Inclusão de reports
Next
Inclusão de report Hybrid Flow de redirecionamento para o servidor (papel client)
Built with