MGBI proporciona una API completa para descargar datos de registros públicos, incluido el Registro Central de Beneficiarios Finales (CRBR).
Puede encontrar una lista de las fuentes de datos disponibles en este servicio en:
👉 API de Registros Públicos
Esta guía trata sobre la API del motor de búsqueda de entidades CRBR , que proporcionamos como parte del producto:
👉 API del Registro Central de Beneficiarios Finales (CRBR API) - Motor de búsqueda de entidades
A continuación, describimos cómo descargar una lista de los beneficiarios finales de una entidad desde CRBR utilizando la API en función de su número de identificación fiscal.
Paso 1: Obtenga una clave de autorización de API
Para obtener la clave de autorización necesaria para llamar a los endpoints disponibles en la API de MGBI, contáctenos a través del formulario de contacto en la página del producto:
👉 API del Registro Central de Beneficiarios (CRBR API) - Motor de búsqueda de entidades
Paso 2: Llamar al punto final Crear actualización
Los datos disponibles en el motor de búsqueda de entidades CRBR se ponen a disposición en la API de MGBI en el modelo de datos con el identificador pl-crbr-wp-record .
Este modelo se sincroniza bajo demanda, lo que significa que no disponemos de una copia completa de los datos del registro de origen en nuestra colección.
Para obtener datos actualizados del modelo sobre un deudor específico, primero debe crear una solicitud para descargarlos del CRBR utilizando el Create Refresh .
👉 Documentación del punto final Create Refresh
Ejemplo de llamada al punto final Create Refresh con el número de identificación fiscal:
POST /v1/refresh HTTP/1.1 Host: api.mgbi.pl Authorization: [authorization key] { "query: { "model": "pl-crbr-wp-record", "identifiers.pl_nip": [Número NIP] } }
Una llamada correcta al punto final Create Refresh devuelve un diccionario como respuesta que contiene el identificador del pedido en el campo id.
Paso 3: Llamar al punto final Get Refresh
Las solicitudes para recuperar datos del registro de origen suelen tardar entre unos pocos y varios segundos desde el momento en que son creadas por el punto final Create Refresh.
Para comprobar el estado actual de una solicitud, llame al punto final Get Refresh, especificando el ID de solicitud obtenido en el paso anterior en la URL.
👉 Documentación del punto final Get Refresh
Ejemplo de cómo llamar al punto final Get Refresh con un identificador de pedido:
GET /v1/refresh/[ID de solicitud] HTTP/1.1 Host: api.mgbi.pl Autorización: [clave de autorización]
status del diccionario devuelto tiene el valor pending , la tarea aún se está ejecutando y al punto final Get Refresh en unos segundos.
Si el de estado tiene el valor " éxito" , significa que el pedido se ha ejecutado y que los datos relativos al deudor indicado ya se han descargado del registro de origen.
Paso 4: Invocar el punto final Obtener registros
La API del pl-crbr-wp-record proporciona un Get Records que devuelve registros con el contenido completo de la respuesta del motor de búsqueda de entidades CRBR para el deudor especificado.
👉 Documentación del endpoint Get Records para el modelo pl-crbr-wp-record
Para recibir datos recuperados del registro de origen en un pedido creado previamente, llame al Obtener registros pasando el ID del pedido en el refresh_id .
Ejemplo de cómo llamar al punto final Obtener registros con un ID de pedido:
GET /v1/models/pl-crbr-wp-record/records?refresh_id=[order ID] HTTP/1.1 Host: api.mgbi.pl Authorization: [authorization key]
Paso 5: Lea la lista de beneficiarios finales de la respuesta
punto final Get Records devuelve una lista de registros que cumplen con los criterios especificados.
En el ejemplo anterior, el punto final debería devolver una lista de resultados que contenga un único registro:
{ "count": 1, "pages": 1, "results": [ { "id": [identificador de registro], "identifiers": [identificadores de entidad], "version": [información de versión del registro], "content": [contenido de la respuesta del motor de búsqueda], "meta": [metadatos del registro] } ] }
La lista de beneficiarios finales de la entidad está disponible en el content.raw_result.listaBeneficjentow .
Cada elemento de la lista contiene datos sobre un beneficiario individual, como nombre, país de ciudadanía e información sobre su participación u otros derechos.
Contenido de ejemplo del elemento:
{ "pesel": [número PESEL], "dateOfBirth": [fecha de nacimiento], "firstName": [nombre], "middleName": [segundo nombre], "surname": [apellido], "citizenship": [países de ciudadanía], "countryOfResidence": [país de residencia], "nameOfGroupBeneficiary": [nombre del beneficiario del grupo], "informationOfTrustEntitlements": [información sobre los derechos en el fideicomiso], "informationOfShareOrEntitlements": [información sobre acciones u otros derechos], "idTech": [identificador interno del beneficiario] }
Obtenga más información:
👉 Estructura de datos en el modelo pl-crbr-wp-record
👉 Documentación de endpoints para el modelo pl-crbr-wp-record
