Common Format
The common format for each product is as follows:
Name | Type | Description |
|---|---|---|
code | Number | Return code |
message | String | Return message |
requestId | String | The unique representation identifier returned by the request report generation APIs |
productName | String | Product name(specific report) |
productVersion | String | Product version(The current default is V3) |
productReportId | String | Product report identify |
productReportTime | String | Product report time(UTC timezone) |
enquiryCpf | String | The CPF of the person who queries the data, due to its sensitive information, it has been encoded by AES. |
links | Array | The links is a array object that depends on whether your end user has multiple authorizations in the same insititution, or if different institution have authorizations |
product | Object | The specific product data can be found in the Open finance data and Open data Different products correspond to different key( product ) |
externalInfo | Object | The external parameters carried by creating links will be sent to you again in each report |
The common format example:
Product reports are divided into institution-level and user-level:
- Institutional-level product report: By default, the shared data is obtained through the permissions in the most recent consent and a report is generated based on it;
- User-level product report: By default, the shared data is obtained through the most widely permission in consent(Scope: all consentId in multiple apps under the same partner), and a report is generated based on it;
The above default rules do not include situations where you actively request specific linkId or consentId reports through APIs.
The specific product data structure can be found in the Open finance data and Open data sections later in this section.
pf_categorized_checking_l2 example:
In order to accurately express the meaning of different products, different product keys are different. It is recommended to define different structures according to different products during the development process.
This object only exists in the case of a Global Webhook If you request a report through the Request product API, this object will not exist. Because in user level reports, the system update data based on the most extensive permissions consent, and it is no longer important which linkId created that permission. You can associate through requestId.
