---
title: API Events
slug: connect/api-events
docTags:
createdAt: 2023-11-26T01:33:52.300Z
---
# 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
:::ExpandableHeading
## link\_created
```json
[
{
"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 |
:::
:::ExpandableHeading
## consent\_authorised
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## consent\_error
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## consent\_rejected
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## consent\_expired
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## consent\_revoked
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## consent\_deleted\_by\_user
```json
[
{
"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](https://docs.klavi.ai/connect/create-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](https://docs.klavi.ai/connect/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 |
:::
:::ExpandableHeading
## product\_request\_received
```json
[
{
"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 [Request product report](docId:4rinIOvI1I501NOpBXprc) section |
| externalInfo | Any additional customized parameter inserted when creating a link will appear here |
| myTraceId | Example of additional parameter |
| myUUID | Example of additional parameter |
:::
:::ExpandableHeading
## product\_generated\_success
```json
[
{
"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](https://docs.klavi.ai/connect/xkr8-overview#vk-wS) section |
| externalInfo | Any additional customized parameter inserted when creating a link will appear here |
| myTraceId | Example of additional parameter |
| myUUID | Example of additional parameter |
:::
:::ExpandableHeading
## product\_generated\_failed
```json
[
{
"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](https://docs.klavi.ai/connect/xkr8-overview#vk-wS) 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 |
:::