WEBHOOKS
API Event Webhooks

API Events(Non-FI)

7min

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 via management portal

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

JSON


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

JSON


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

JSON


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

JSON


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

JSON


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

JSON


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

JSON


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

JSON


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 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

JSON


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

JSON


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



Updated 11 Oct 2024
Doc contributor
Doc contributor
Did this page help you?