API REFERENCE
Consents
Get a Consent
2 min
response name type required description consentid string yes consent identify linkid string yes unique link externaltrackid string yes partners to transfer tracking information personaltaxid string yes the cpf of the end user, for personal accounts only businesstaxid string yes the cnpj of the company, for business accounts only institutioncode string yes institution code, it returned by the /institutions status string yes started consent created; awaiting authorisation waiting for end user authorization; awaiting lgpd authorisation waiting for end user lgpd acceptance; (required for financial data) authorised consent authorized by the end user (valid status to call data endpoints); error there was an issue in the consent authorization flow rejected end user rejected the consent authorization expired consent expired by timeout (inactive for 30 minutes) revoked consent revoked (can be revoked by the end user or the application) deleted by user end user requested data deletion permissionsapply array yes the permission required by partners for end user permissionsgranted array yes the permissions granted by end users expireat string yes consent expire time(utc time) createdat string yes create consent time(utc time) updatedat string yes update data time(utc time)