Guías
Inicia sesión en Prometeo

Conexiones directas

Establecemos conexiones banco a banco en los países que no se encuentran bajo un esquema de Open Finance

Suggest Edits

Endpoints disponibles

Para poder obtener información bancaria en los diferentes providers, se encuentran desarrollados los siguientes endpoints:

Para acceder a dichas funcionalidades deberás iniciar sesión en el provider deseado con las credenciales del usuario bancario que deseas consultar.

Parámetros requeridos

📘

¡Recuerda tu API KEY!

Recuerda que todas las requests deben incluir el API key, usando el header X-API-Key.

ParámetrosDescripción
providerCorresponde al nombre del banco, en minúsculas y sin tildes (Devuelto por el endpoint de listado de providers).
usernameDocumento o nombre de usuario utilizado para ingresar al home banking o app de la institución financiera.
passwordContraseña del usuario web de la institución financiera.

🚧

Parámetros opcionales

Para algunos bancos no alcanza con los parámetros requeridos, por lo tanto antes de iniciar sesión con el banco deseado, puedes consultar las especificaciones de cada uno en:

Posibles respuestas

STATUSDESCRIPCIÓN
statusPosibles respuestas:

- select_client, es necesario seleccionar un cliente.
- wrong_credentials, usuario o password inválidos.
- missing_credentials, falta algún campo de credenciales.
- interaction_required, se requiere algún tipo de inicio de sesión interactiva, podría ser un captcha o una pregunta de seguridad (más adelante se explica en detalle).
- logged_in, sesión iniciada correctamente (y te devuelve una key junto con este status).
keyClave de autenticación devuelta junto con el status logged_in que deberá ser usada en todas las requests siguientes (no estará presente si el status es un error)

Ejemplos

Iniciar sesión

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

provider=test&username=12345&password=gfdsa

curl -X POST "https://banking.sandbox.prometeoapi.com/login/" -d "provider=test&username=12345&password=gfdsa" -H "X-API-Key: <API-Key>"

import requests

requests.post('https://banking.sandbox.prometeoapi.com/login/', data={
    'provider': 'test',
    'username': '12345',
    'password': 'gfdsa',
}, headers={
    'X-API-Key': '<API-Key>'
})

var request = require('request');

request.post({
  "url": "https://banking.sandbox.prometeoapi.com/login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API-Key>"
  },
  "form": {
    "provider": "test",
    "username": "12345",
    "password": "gfdsa"
  }
});

Respuesta exitosa: 

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Respuesta errónea: 

{"status": "wrong_credentials"}

Respuesta con interacción requerida:

Para reforzar el sistema de seguridad, algunas instituciones financieras requieren una interacción por parte del usuario, como un Token otp, preguntas de seguridad o confirmación 2FA.

{
    "context": "Nombre de la empresa más grande de OpenBanking en LATAM",
    "field": "personal_question",
    "key": "be612b0a-c972-4fb1-bb16-798956a3efa1",
    "status": "interaction_required"
}

Iniciar sesión con interacción:

Para los inicios de sesión con interacción primero debe enviar los parámetros que figuran como no interactivos (Consúltelos en Campos requeridos para iniciar sesión) y luego hacer un segundo login adicionando los campos interactivos.

POST /login/?key=be612b0a-c972-4fb1-bb16-798956a3efa1 HTTP/1.1
Host: banking.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

provider=test&username=12345pq&password=asdfg&personal_question=prometeo

curl -X POST "https://banking.sandbox.prometeoapi.com/login/?key=163d06b2-3378-4383-9868-71c2b6fb28da" -d "provider=test&username=12345&password=asdfg&personal_question=uno" -H "X-API-Key: <API KEY>"

import requests

requests.post('https://banking.sandbox.prometeoapi.com/login/', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, data={
    'provider': 'test',
    'username': '12345',
    'password': 'asdfg',
    'personal_question': 'uno',
}, headers={
    'X-API-Key': '<API KEY>'
})

var request = require('request');

request.post({
  "url": "https://banking.sandbox.prometeoapi.com/login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  },
  "form": {
    "provider": "test",
    "username": "12345",
    "password": "asdfg",
    "personal_question": "uno"
  }
});

Updated 3 months ago

Siguiente