Manual Técnico del Web Service de Calidad de Datos Identificativos

Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
Web Service
de Calidad de datos identificativos
Autor: AEAT
Fecha: 27/11/2015
Versión: 1.0
Revisiones
Edi.
1
Rev.
Fecha
Descripción
0
27/11/2015 Versión inicial
(*) Acción:
A= Añadir;
A(*) Páginas
A
Todas
R= Reemplazar
Índice:
1. INTRODUCCIÓN.
3
2. UTILIZACIÓN DEL WEB SERVICE.
3
3. CONTROL DE VERSIONES.
3
3.1 Versión 1.0.
3
4. SERVICIO WEB VNIFV1.WSDL.
3
5. MENSAJE DE PETICIÓN DE DATOS.
4
5.1 NIF.
4
5.2 Apellidos y Nombre o Razón Social.
4
6. MENSAJE DE RESPUESTA DE DATOS.
Impreso: 02/12/2015
4
Página: 1/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
6.1.
NIF.
4
6.2.
Apellidos y Nombre o Razón Social.
4
7. MENSAJE DE ERROR.
4
8. DEFINICIÓN SERVICIO Y ESQUEMAS.
5
8.1 – Definición del servicio – VNifV1.wsdl
5
8.2 – Mensaje de entrada – VNifV1Ent.xsd
5
8.3 – Mensaje de salida correcta – VNifV1Sal.xsd
6
8.4 – URL de acceso al servicio
6
9. EJEMPLOS.
7
9.1 – Mensaje de entrada
7
9.2 – Mensaje de respuesta
7
9.3 – Mensaje de respuesta con error
7
Impreso: 02/12/2015
Página: 2/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
1. Introducción.
Este servicio web se ofrece con la finalidad de ayudar a los declarantes de declaraciones informativas a
identificar y comprobar el alta en el censo de la AEAT de los declarados en dichas declaraciones.
2. Utilización del web service.
El posible uso para otras finalidades o el abuso de este servicio podrá suponer el bloqueo del acceso al
mismo, de forma temporal o permanente.
La información proporcionada por este servicio web se realiza consultando los datos identificativos
disponibles en el momento. Esta información podría variar si se producen posteriores cambios en los datos
identificativos.
3. Control de versiones.
3.1 Versión 1.0.
Versión inicial.
4. Servicio web VNifV1.wsdl.
Este Servicio requiere tener instalado un certificado de usuario admitido por la AEAT en el ordenador
desde el que se produzca el envío de la información.
La representación gráfica del servicio web es la siguiente:
En la definición de este servicio se describe que el mensaje de entrada se basa en el esquema
VNifV1Ent.xsd y que la respuesta cuando no se detectan errores en la entrada y el contribuyente se
encuentra censado en la AEAT se basa en el esquema VNifV1Sal.xsd. En caso contrario, la respuesta
consistirá en un mensaje SOAP Fault.
La representación gráfica de los datos del mensaje de entrada es la siguiente:
Impreso: 02/12/2015
Página: 3/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
La representación gráfica de los datos del mensaje de salida es la siguiente:
5. Mensaje de Petición de datos.
El mensaje de petición no requerirá firma digital.
5.1 NIF.
Descripción: NIF de la persona física o jurídica sobre la que se quiere efectuar la consulta de verificación.
Formato: Alfanumérico de 9 caracteres.
Obligatorio: Sí
5.2 Apellidos y Nombre o Razón Social.
Descripción: Apellidos y Nombre de la persona física o Razón Social de la persona jurídica sobre la que se
quiere efectuar la consulta de verificación.
Formato: Alfanumérico.
Obligatorio: Obligatorio para personas físicas. Opcional en personas jurídicas.
6. Mensaje de Respuesta.
El mensaje de respuesta no tendrá firma digital.
6.1. NIF.
Descripción: NIF de la persona física o jurídica, validado y ajustado a 9 posiciones con ceros no
significativos si fuera necesario.
Formato: Alfanumérico.
6.2. Apellidos y Nombre o Razón Social.
Descripción: En caso de persona física, Apellidos y Nombre recibidos en el mensaje de petición. En caso
de persona jurídica, Razón Social tal como se encuentra en el censo de contribuyentes de la AEAT.
Formato: Alfanumérico.
7. Mensaje de error.
Cualquier error producirá un mensaje SOAP FAULT como respuesta. El faultstring contendrá el motivo del
rechazo.
Codigo[-1].No identificado
Impreso: 02/12/2015
Página: 4/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
8. Definición del servicio y Esquemas.
8.1 – Definición del servicio – VNifV1.wsdl
La definición del servicio se puede consultar en la dirección
http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/w
s/VNifV1.wsdl
y su contenido es el siguiente:
<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions
xmlns:VNifV1="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jd
it/ws/VNifV1.wsdl"
xmlns:VNifV1Ent="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Ent.xsd"
xmlns:VNifV1Sal="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Sal.xsd" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1.wsdl">
<wsdl:types>
<schema elementFormDefault="qualified"
targetNamespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1.wsdl"
xmlns:VNifV1Ent="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Ent.xsd"
xmlns:VNifV1Sal="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Sal.xsd" xmlns="http://www.w3.org/2001/XMLSchema">
<xsd:import
namespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/
ws/VNifV1Ent.xsd" schemaLocation="VNifV1Ent.xsd"/>
<xsd:import
namespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/
ws/VNifV1Sal.xsd" schemaLocation="VNifV1Sal.xsd"/>
</schema>
</wsdl:types>
<wsdl:message name="Entrada">
<wsdl:part name="VNifV1Ent" element="VNifV1Ent:VNifV1Ent"/>
</wsdl:message>
<wsdl:message name="Salida">
<wsdl:part name="VNifV1Sal" element="VNifV1Sal:VNifV1Sal"/>
</wsdl:message>
<wsdl:portType name="VNifV1">
<wsdl:operation name="VNifV1">
<wsdl:input name="Entrada" message="VNifV1:Entrada"/>
<wsdl:output name="Salida" message="VNifV1:Salida"/>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="VNifV1SoapBinding" type="VNifV1:VNifV1">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="VNifV1">
<wsdlsoap:operation soapAction="" style="document"/>
<wsdl:input name="Entrada">
<wsdlsoap:body use="encoded"/>
</wsdl:input>
<wsdl:output name="Salida">
<wsdlsoap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="VNifV1Service">
<!--Puerto para conexiones desde internet en PRO -->
<wsdl:port name="VNifPort1" binding="VNifV1:VNifV1SoapBinding">
<wsdlsoap:address location="https://www1.agenciatributaria.gob.es/wlpl/BURTJDIT/ws/VNifV1SOAP"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
8.2 – Mensaje de entrada – VNifV1Ent.xsd
El diseño del esquema de entrada se puede consultar en la dirección
http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/w
s/VNifV1Ent.xsd
Impreso: 02/12/2015
Página: 5/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
y su contenido es el siguiente:
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:VNifV1Ent="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Ent.xsd"
targetNamespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Ent.xsd" elementFormDefault="qualified">
<annotation>
<documentation>
Esquema para solicitar la verificación de un NIF
</documentation>
</annotation>
<element name="VNifV1Ent" type="VNifV1Ent:VNifV1Ent"/>
<complexType name="VNifV1Ent">
<annotation>
<documentation>
Nif : Nif a verificar
Nombre: Nombre o Razón Social
</documentation>
</annotation>
<sequence>
<element name="Nif" type="string"/>
<element name="Nombre" type="string"/>
</sequence>
</complexType>
</schema>
8.3 – Mensaje de salida correcta – VNifV1Sal.xsd
El diseño del esquema de salida se puede consultar en la dirección
http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/w
s/VNifV1Sal.xsd
y su contenido es el siguiente:
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:VNifV1Sal="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Sal.xsd"
targetNamespace="http://www2.agenciatributaria.gob.es/static_files/common/internet/dep/aplicaciones/es/aeat/burt
/jdit/ws/VNifV1Sal.xsd" elementFormDefault="qualified">
<annotation>
<documentation>
Esquema de respuesta del servico de verificación de NIF.
</documentation>
</annotation>
<element name="VNifV1Sal" type="VNifV1Sal:VNifV1Sal"/>
<complexType name="VNifV1Sal">
<annotation>
<documentation>
Nif : Nif verificado
Nombre: Razón Social en caso de Persona Jurídica. En caso de Persona
Física se responde un eco de los datos de entrada
por temas de Protección de Datos Personales
</documentation>
</annotation>
<sequence>
<element name="Nif" type="string"/>
<element name="Nombre" type="string"/>
</sequence>
</complexType>
</schema>
8.4 – URL de acceso al servicio
La URL es la siguiente:
https://www1.agenciatributaria.gob.es/wlpl/BURT-JDIT/ws/VNifV1SOAP
Impreso: 02/12/2015
Página: 6/7
Departamento de Informática Tributaria
Subdirección General de Aplicaciones
Web Service de Calidad de datos identificativos
Versión: 1.0
9. Ejemplos.
9.1 – Mensaje de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vnif="http://www2.agenciatributaria.gob.aeat/static_files/common/internet/dep/aplicaciones/es/aeat/burt/jdit/ws/VNifV1Ent.xsd">
<soapenv:Header/>
<soapenv:Body>
<vnif:VNifV1Ent>
<vnif:Nif>99999999R </vnif:Nif>
<vnif:Nombre> ESPAÑOL ESPAÑOL JUAN </vnif:Nombre>
</vnif:VNifV1Ent>
</soapenv:Body>
</soapenv:Envelope>
9.2 – Mensaje de respuesta
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<env:Body>
<VNifV1Sal:VNifV1Sal
xmlns:VNifV1Sal="http://www2.agenciatributaria.gob.aeat/static_files/common/internet/dep/aplicaciones/es/aeat/bu
rt/jdit/ws/VNifV1Sal.xsd">
<VNifV1Sal:Nif>99999999R </VNifV1Sal:Nif>
<VNifV1Sal:Nombre>ESPAÑOL ESPAÑOL JUAN</VNifV1Sal:Nombre>
</VNifV1Sal:VNifV1Sal>
</env:Body>
</env:Envelope>
9.3 – Mensaje de respuesta con error
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Body>
<env:Fault>
<faultcode>env:Client</faultcode>
<faultstring>Codigo[-1].No identificado</faultstring>
</env:Fault>
</env:Body>
</env:Envelope>
Impreso: 02/12/2015
Página: 7/7