Copyright Teleinte SAS 2021
Para mayor información en operaciones@teleinte.com

Nota: Los datos retornados por el API provienen directamente de la DIAN

EndPoint


Método: POST

EndPoint:

Producción
https://servicios.afacturar.com/api/vp/consultar_datos_adquiriente

Seguridad SSL: Afacturar cuenta en sus endpoint con certificados de seguridad (DigiCert SHA2 Extended Validation Server CA), su aplicación debe ser capaz de negociar y validar dicho certificado.

Parámetros de entrada


HEADERS


Accept: application/json

Authorization: Bearer Token asignado a cada cliente


BODY


documento_obligado

Descripción

Número de identificación del OFE - Obligado a facturar electronicamente.

Tipo de dato

Númerico.

Especificaciones

Debe estar registrado en servicios.afacturar.com

Obligatorio

Si

tipo_identificacion

Descripción

Tipo de identificación del adquiriente.

Tipo de dato

Parametrizado.

Especificaciones

  • 11= Registro civil
  • 12= Tarjeta de identidad
  • 13= Cedula ciudadania
  • 21= Tarjeta de extranjería
  • 22= Cedula de extranjería
  • 31= NIT
  • 41= Pasaporte
  • 42= Documento de identificación extranjero
  • 47=PEP (Permiso Especial de Permanencia)
  • 48=PPT (Permiso Protección Temporal)
  • 50= NIT de otro país
  • 91=NUIP
  • Obligatorio

    Si

    identificacion

    Descripción

    Número completo de la identificación de la empresa o persona..

    Tipo de dato

    Alfanúmerico

    Especificaciones

    Permite números y letras

    Obligatorio

    Si



    Estructura JSON de respuesta


    Salida Exitosa


    
    {
        "codigo_error": 0,
        "descripcion_error": "OK",
        "tiempo_ejecucion": 0.19756507873535156,
        "transaccion": "680bbc2cc9fbb",
        "resultado": {
            "tipo_identificacion": "31",
            "identificacion": "830020470",
            "entorno": "PRODUCCION",
            "nombre": "TELEINTE  S A S",
            "email": "info@teleinte.com"
        }
    }							  
    							 
    Salida con errores de semantica
    
    {
        "codigo_error": 10,
        "descripcion_error": [
            "The identificacion field is required."
        ]
    }}
    							

    Codigo de respuesta


    Cuando usted hace un llamado a la API, puede recibir los siguientes mensajes de error en la respuesta. Puede que haya algo mal con su solicitud o puede que algo esté mal de nuestra parte. Los errores responden con un código de error y JSON que contiene un mensaje, una descripción y un código API más preciso.

    Códigos de ERROR


    Tabla de Errores
    Código Estado Descripción Acción sugerida
    28 Timeout La operación duro más de 60 seg
    15 Error retornado por la DIAN La información enviada no cumple con el estandar del XML o los valores no estan bien calculados
    400 Solicitud incorrecta Hay un problema con su solicitud Compruebe que su solicitud sigue la documentación de la API y utiliza la sintaxis correcta.
    401 No autorizado No tiene la autorización necesaria para realizar la solicitud. Asegúrese de estar utilizando una clave API válida con los permisos necesarios para su solicitud.
    403 Prohibido El servidor entendió la solicitud, pero se negó a cumplirla. Vea si su plan en Afacturar.com incluye el recurso que está solicitando y su clave API tiene las autorizaciones necesarias.
    404 No encontrado El servidor no pudo encontrar el recurso solicitado. Cambie su URL de solicitud para que coincida con un punto final API válido.
    405 Método no permitido El recurso no tiene el método especificado. (por ejemplo, PUT en las transmisiones) Cambie el método para seguir la documentación del recurso.
    409 Conflicto Un conflicto surgió de su solicitud. (por ejemplo, el OFE no esta asociado al código de autorización) Modificar la carga útil para eliminar el conflicto..
    415 Tipo de medio no admitido La solicitud no está en un formato compatible. Verifique que su encabezado Content-Type sea compatible y que su solicitud cumpla con la documentación.
    422 Entidad no procesable La solicitud fue sintácticamente correcta pero falló debido a errores semánticos. Asegúrese de que su solicitud incluya todos los campos obligatorios y que sus datos sean válidos.
    429 Exceder el límite de envío Se excede el numero de transacciones permitido (120 por minuto). Verifique que se encuentra dentro de los límites acordados con Afacturar.
    500 Error de servidor interno Algo salió mal de nuestro lado. Pruebe la solicitud nuevamente más tarde. Si el error no se resuelve, póngase en contacto con el soporte técnico soporte@afacturar.com.
    503 Servicio no disponible Estamos experimentando niveles de tráfico más altos de lo normal. Prueba la solicitud nuevamente, ya estamos enterado del problema para aumentar la capacidad.


    Ejemplo 1.

    IN
    
    
    --form 'documento_obligado="830020470"' \
    --form 'tipo_identificacion="13"' \
    --form 'identificacion="222222222222"'
    
    
    OUT
    {
        "codigo_error": 0,
        "descripcion_error": "OK",
        "tiempo_ejecucion": 0.23995113372802734,
        "transaccion": "680bbd36b114d",
        "resultado": {
            "tipo_identificacion": "13",
            "identificacion": "222222222222",
            "entorno": "PRODUCCION",
            "nombre": "CONSUMIDOR FINAL .",
            "email": "yiselagaray@hotmail.com"
        }
    }

    Ejemplo 2.

    IN
    
    
    --form 'documento_obligado="830020470"' \
    --form 'tipo_identificacion="31"' \
    --form 'identificacion="830020470"'
    
    OUT
    
    {
        "codigo_error": 0,
        "descripcion_error": "OK",
        "tiempo_ejecucion": 0.34528207778930664,
        "transaccion": "680bbd6a4f86e",
        "resultado": {
            "tipo_identificacion": "31",
            "identificacion": "830020470",
            "entorno": "PRODUCCION",
            "nombre": "TELEINTE  S A S",
            "email": "info@teleinte.com"
        }
    }

    Consumo del API


    CURL

    								curl --location 'https://servicios.afacturar.com/api/vp/consultar_datos_adquiriente' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer TOKEN_OBLIGADO' \
    --form 'documento_obligado="830020470"' \
    --form 'tipo_identificacion="31"' \
    --form 'identificacion="830020470"'								

    C#

    								var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://servicios.afacturar.com/api/vp/consultar_datos_adquiriente");
    request.Headers.Add("Accept", "application/json");
    request.Headers.Add("Authorization", "Bearer TOKEN_OBLIGADO");
    var content = new MultipartFormDataContent();
    content.Add(new StringContent("830020470"), "documento_obligado");
    content.Add(new StringContent("31"), "tipo_identificacion");
    content.Add(new StringContent("830020470"), "identificacion");
    request.Content = content;
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());
    								

    Historico de cambios


    Versión Cambios Fecha de liberación
    1 Publicación el API 25 de Abril de 2025