Get Data Refresh Job
Gets the current status and details of a data refresh job.
Consent status: If the consent is expired, revoked, failed, or suspended, this endpoint returns 400 with code consent_not_active.
Job Statuses
job_started: Job createdaccounts_ready: Accounts fetched and stored in the databasebalances_ready: Balances fetched and stored in the databasetransactions_fetching: Transactions fetching has startedjob_partially_completed: Job completed partially (some data was fetched and stored)job_completed: Job completed successfullyjob_failed: Job failed (no data was fetched and stored)
Body Parameters
API client identifier
API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.
Job ID to retrieve
Consent ID that the job belongs to (for validation)
Response
Response Attributes
Unique identifier for the API request
Unique identifier of the job
Data refresh job status:
job_started: Job created and queued for executionaccounts_ready: Accounts fetched and stored in the databasebalances_ready: Balances fetched and stored in the databasetransactions_fetching: Transactions fetching has startedjob_partially_completed: Job completed partially (some data was fetched and stored)job_completed: Job completed successfully with all data fetchedjob_failed: Job failed (no data was fetched and stored)
job_startedaccounts_readybalances_readytransactions_fetchingjob_partially_completedjob_completedjob_failedID of the consent this job is associated with
Webhook URL for job status notifications (from callback_url or consent config)
Service provider (bank) details from the consent
Show child attributes
AIS method details from the consent
Show child attributes
Job execution results and statistics
Show child attributes
Name of the API client application
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 400 errors:
bad_request: Generic validation or request errorvalidation_error: Request payload validation failedinvalid_input: Invalid input data providedunprocessable_entity: Valid request but cannot be processedcooldown_failed: Data refresh cooldown period not yet elapsedconsent_not_active: Consent is not usable...
bad_requestvalidation_errorinvalid_inputunprocessable_entitycooldown_failedconsent_not_activemethod_selection_errormethod_input_validation_errorlink_expiredHuman-readable error message
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 401 errors:
unauthorized: Authentication failed or insufficient permissions
unauthorizedHuman-readable error message
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 404 errors:
not_found: Generic resource not foundconsent_not_found: Specified consent does not existjob_not_found: Specified job does not exist or outside accessible date range
not_foundconsent_not_foundjob_not_foundHuman-readable error message