Permanently delete Financial Information (FI) data associated with a specific consent from the FinPro system.
| Header | Type | Description |
|---|---|---|
Content-Type | string | Must be set to application/json for proper request processing |
client_id | string | The unique client identifier assigned to your FIU organization during onboarding |
client_secret | string | The secret key paired with your client_id for secure authentication |
organisationId | string | Your organization’s unique identifier in the FinPro system |
appIdentifier | string | The application identifier that distinguishes different applications within your organization |
| Parameter | Type | Required | Description |
|---|---|---|---|
consentId | string | Mandatory | The unique consent identifier for which all associated Financial Information should be permanently deleted. This is the consent ID returned when the consent was approved and is also included in webhook notifications. |
| Field | Type | Description |
|---|---|---|
status | string | The outcome of the API call. Possible values: success, failure |
ver | string | The version of the FinPro API that processed the request |
data.status | string | The specific outcome of the data deletion operation. SUCCESS indicates data was deleted successfully, FAILURE indicates the deletion could not be completed |
data.message | string | A human-readable message providing additional context about the deletion operation result |
consentId does not exist in the FinPro system or does not belong to your organization, the API may return a failure response or a 404 error.
Resolution:
consentId, the following data is permanently deleted:
X-RateLimit-Limit: The maximum number of requests allowed in the time windowX-RateLimit-Remaining: The number of requests remaining in the current windowX-RateLimit-Reset: The Unix timestamp when the rate limit window resets