Purge connection data

post

https://au-api.basiq.io/users/{userId}/connections/{connectionId}/purge

Use this endpoint to remove all user data related to a specific institution. Purging is only applicable for active user connections.

When Enrich data is updated, the Enrich results under transactions won’t automatically reflect these updates. To ensure the latest Enrich results are available, partners should first purge and then refresh connections. Without this step, any new insight reports generated will not include the latest enriched data.

Note: Remember to purge and refresh connections to keep Enrich insights current.

Responses

204

Returns an empty body if the delete succeeded.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Returns error that server cannot or will not process the request due to something that is perceived to be a client error

403Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.

404Returns error indicating that server can't find requested resource.

500Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

503Returns error response code indicates that the server is not ready to handle the request.