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](/guides/data-models/credit-registry). The official report travels as a [document](api:GET/executions/results/{execution_id}/attachments/v1/all) of the execution. <Warning> **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. </Warning> <Note title="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. </Note> | Status | Meaning | | :--- | :--- | | `200` | The registry position. | | `202` | `feature_not_ready` — `credit_registry_data` is still running. **Only this family waits**: the ones that already closed answer now. | | `204` | The execution never asked for `credit_registry_data`, or it did and the source had nothing to give. No body either way. | | `404` | No execution with that id for your application, or it has been deleted. | <Note> **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. </Note>

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

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

Response

**200 OK**<br>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

The sub-family specifying detailed or aggregated registry data.

fetch_datestringformat: "datetime"
Date this product was fetched.
countrystringformat: "country"
Country of the credit registry.
holder_namestring
Full name or business name of the holder.
report_monthstring

Target month and year of the operation report in MM-YYYY format.

holder_codestring or nullOptional
Identification code of the holder in the registry.
identifierobject or nullOptional
National identifier of the holder.
consultation_datestring or nullOptionalformat: "datetime"

Timestamp when the report was issued/consulted.

total_drawnmap from strings to stringsOptional
Total active drawn risk amount in the system.
total_overduemap from strings to stringsOptional
Total risk amount that is overdue in the system.
total_arrearsmap from strings to stringsOptional
Total overdue interest and expenses in the system.
total_risk_availablemap from strings to stringsOptional
Total available risk amount in the system.
operationslist of objectsOptionalDefaults to []
List of operations reported in the registry.
minor_riskslist of objectsOptionalDefaults to []
List of entities with accumulated risks below the threshold.
attachmentslist of objectsOptionalDefaults to []

List of attached original documents (e.g. PDF).

Errors

404
Not Found Error
422
Unprocessable Entity Error