Skip to navigation
Fetching the resultsPublic administration

Credit registry

View as Markdown

Your customer’s risk position at the Banco de España’s credit registry (CIRBE).

Every loan, credit line and guarantee above the reporting threshold, entity by entity. It is the reference document for indebtedness analysis, and the one that shows debt your own institution cannot see. Field by field in Credit Registry. The official report travels as a document of the execution.

This source is slow by nature. The registry produces its report on its own schedule rather than in real time, so an execution that includes this feature can take substantially longer than one that does not — and the widget-side flow even lets your customer go before it answers. Plan for a webhook rather than a polling loop, and do not size your timeout on the other features.

Requires the credit_registry_data feature

Features are chosen when the execution starts, not here. An execution that did not ask for credit_registry_data answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The registry position.
202feature_not_ready — credit_registry_data is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for credit_registry_data, or it did and the source had nothing to give. No body either way.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
What the central credit register holds on your customer: the risks declared by the institutions that lent to them, by kind and amount. It is the view of their borrowing that does not depend on which bank you asked.

An empty list is an answer, not a gap: the feature ran and the source reported none.

product"credit_registry_data"
The product type identifier.
sub_familyenum

Which report this is: detailed or aggregated — what the document turned out to be, not what was requested. A holder with nothing declared to the register only ever gets the aggregated report.

Allowed values:
fetch_datestringformat: "datetime"
Date this product was fetched.
countrystringformat: "country"
Country of the credit registry.
report_monthstring

Period the operations correspond to, MM-YYYY.

holder_codestringOptional

The holder’s code exactly as the report prints it (e.g. ES44444444A). Not reported when the report could not be read.

holder_namestringOptional

Full name or business name of the holder, as the report prints it. Not reported when the report could not be read: the attached report is then the only reference.

identifierobjectOptional
The holder's national identifier, from the report's holder code. Not reported when the report could not be read.
consultation_datestring or nullOptionalformat: "datetime"
When the register's data was taken, as the report states it.
total_drawnobjectOptional
Total drawn across every operation in the system. In an aggregated report, exact to the thousand.
total_overdueobjectOptional
Total overdue across every operation in the system.
total_arrearsobjectOptional
Total default interest and enforceable expenses in the system.
total_risk_availableobjectOptional
Total still available to draw in the system.
operationslist of objectsOptionalDefaults to []

The operations: one per operation in a detailed report, one per group in an aggregated one.

minor_riskslist of objectsOptionalDefaults to []
Entities whose accumulated risk is below the reporting threshold. Detailed reports only.
attachmentslist of objectsOptionalDefaults to []

The original report (PDF).

Errors

404
Not Found Error
422
Unprocessable Entity Error