API Events

7 min

api events event name description link created event after post the links endpoint consent authorised consent authorized by the end user (valid status to call data endpoints) consent error there was an issue in the consent authorization flow consent rejected end user rejected the consent authorization consent expired consent expired consent revoked consent revoked (can be revoked by the end user or the application) consent deleted by user end user requested data deletion product request received the klavi backend has received a request to start requesting product reports product generated success each product report is successfully generated and begins to be sent product generated failed specific product report generation failure and reasons event examples link created \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "link created", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent authorised \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent authorised", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of authorised consent externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent error \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent error", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of consent with error externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent rejected \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent rejected", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of rejected consent externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent expired \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent expired", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of expired consent externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent revoked \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent revoked", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of revoked consent externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter consent deleted by user \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent deleted by user", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] if the user revokes the consent, it may not be possible to send the event (as this depends on the open finance directory or bank) name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj linkid link's id consentid id of deleted consent externaltrackid if the products integration is through api, it's the mandatory parameter inserted when creating a consent else, it's an additional unique value that can be used for tracking institutioncode code of the institution where the consent was given for all the institution codes available, check participant institutions page permissionsapply list of all requested permissions for this consent permissionsgranted list of granted permissions for this consent expireat date and time when the consent will expire externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter product request received \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product request received", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "requestbody" { "taxid" "12345678901", "institutioncode" "033", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consentids" \[ "at932 61fc6c 0ec02 9fa7d29 2b3188b78" ], "products" \[ "pf checking account", "pf credit card" ], "productcallbackurl" { "pf checking account" "https //www yourdomain com/checking/yourpath", "pf credit card" "https //www yourdomain com/creditcard/yourpath" } } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj requestid id of the request used to generate the report requestbody content of the request used to generate the report check more details in institutional level report section externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter product generated success \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product generated success", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "product" "pf checking account" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj requestid id of the request used to generate the report product name of the generated product check more details in the products section externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter product generated failed \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product generated failed", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "product" "pf checking account", "failurereason" "no checking account" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] name description partnerappid application's id eventid event's id eventtype type of the event all api event's will be "api" eventname event's name eventtime date and time when event was generated personaltaxid cpf businesstaxid cnpj requestid id of the request used to generate the report product name of the generated product check more details in the products section failurereason the reason why product generation failed externalinfo any additional customized parameter inserted when creating a link will appear here mytraceid example of additional parameter myuuid example of additional parameter