Iniciar sesión

Endpoint: POST /login/

🚧 Usuarios de Sandbox:

A continuación listamos las dos cuentas definidas para el ambiente de sandbox:

Tipo de UsuarioDocumentNITPassword
Personal10000000sandbox_password
Empresa20000000900000000sandbox_password

¿Para qué sirve?

Al iniciar la operativa con nuestra API de la DIAN, lo primero que debes hacer es iniciar sesión a la Entidad con las credenciales del usuario final.

Parámetros requeridos

ParámetrosDescripción
document Identificador del usuario.
password Contraseña de acceso.

Parámetros opcionales

Estos campos pueden ser requeridos en algunas instituciones.

nit

* Campo requerido sólo en empresas.
Numero de nit, sin guiones

Posibles respuestas

📘

Tiempo de respuesta

El login puede demorar hasta 20s en generar una respuesta dependiendo de la carga que tenga la página de la Hacienda.

STATUSDESCRIPCIÓN
status - wrong_credentials usuario o password inválidos.

- missing_credentials falta un campo de credenciales.

- logged_in sesión iniciada correctamente.

- interaction_required se requiere algún tipo de inicio de sesión interactiva, podría ser un captcha o una pregunta de seguridad.
session_key Clave de autenticación que deberá ser usada en todas las requests siguientes (no estará presente si el status es un error).
messageMensaje de error (obtenido en caso de que las credenciales sean erróneas).
missing_fields Campos faltantes para la consulta (obtenido en caso de que falte algún campo requerido).

Ejemplos

Iniciar sesión

POST /login/ HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

nit=900000000&document=20000000&password=sandbox_password
curl -X POST "https://fiscal.sandbox.prometeoapi.com/login/" -d "nit=900000000&document=20000000&password=sandbox_password" -H "X-API-Key: <API KEY>"
import requests

requests.post('https://fiscal.sandbox.prometeoapi.com/login/', data={
    'nit': '900000000',
    'document': '20000000',
    'password': 'sandbox_password',
}, headers={
    'X-API-Key': '<API KEY>'
})
var request = require('request');

request.post({
  "url": "https://fiscal.sandbox.prometeoapi.com/login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "form": {
    "nit": "900000000",
    "document": "20000000",
    "password": "sandbox_password"
  }
});

Respuesta exitosa

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta errónea

{
    "status" : "wrong_credentials",
    "message" : ":40035: Se presento un error al autenticar el usuario. El nombre de usuario, la clave o la organizacion son err?neos  "
}

Respuesta errónea por falta de parámetros

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API key

{
    "data": null,
    "error": "Missing API key"
}