Saltar al contenido principal
POST
curl
El endpoint Revocar una conexión bancaria de Didit detiene el acceso al banco, y las consultas al banco se detienen en cuanto lo solicitas. Revocar no elimina nada: para eso usa eliminar. El consentimiento muestra revocation_pending y, cuando el banco lo confirma, pasa a revoked.

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, desde Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener permisos limitados: ninguno, lectura o escritura por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, está revocada o ha caducado; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud procede de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, vídeos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Encabezados

Idempotency-Key
string

Clave opcional que eliges para garantizar la seguridad de los reintentos en una operación, de hasta 255 caracteres (puede usarse un UUID). Una solicitud repetida con la misma clave, endpoint, parámetros de consulta y cuerpo recibe la primera respuesta, con el mismo código de estado y el mismo cuerpo, y no se ejecuta ni se factura de nuevo. La misma clave con otro endpoint, otros parámetros de consulta o un cuerpo distinto devuelve 409 idempotency_key_reused. Si la primera solicitud sigue en curso, devuelve 409 idempotency_key_in_progress con Retry-After. Una solicitud fallida (cualquier 4xx o 5xx) no se almacena, así que puedes volver a enviarla con la misma clave. Las claves pertenecen a tu aplicación, tanto si llamas con una clave de API como con un token de acceso. Consulta Reintentos e idempotencia.

Required string length: 1 - 255

Parámetros de ruta

id
string<uuid>
requerido

El id de la conexión.

Respuesta

La conexión con el estado de revocación.

El permiso de la persona para que tu aplicación lea un banco. Una renovación conserva el id de la conexión y todos los ids de cuenta. Una conexión eliminada responde solo id, status, status_reason, created_at y erasure: no aparece ningún otro campo y no queda en ella ningún dato del banco, de la persona ni de la cuenta.

id
string<uuid>
requerido

Identificador de la conexión.

status
enum<string>
requerido

pending: la primera sincronización está en curso. active: consentimiento válido. renewal_required: el consentimiento terminó o el banco pide a la persona que vuelva a iniciar sesión; los datos siguen legibles tal como se sincronizaron por última vez y no se cobra nada. paused: saldo insuficiente para el mes. revoked: acceso detenido por la persona, por el banco o por usted. deleted: solo quedan id, status, status_reason, created_at y erasure. failed: la primera sincronización nunca se realizó correctamente.

Opciones disponibles:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
requerido

Por qué la conexión tiene este estado. paused_by_customer está reservado. En una conexión deleted: deleted_by_customer, consent_lapsed, retention_elapsed o application_deleted.

Opciones disponibles:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
requerido

Se establece tras delete_connection; en caso contrario, null.

created_at
string<date-time>
requerido
environment
enum<string>
Opciones disponibles:
live,
sandbox
access
enum<string>
Opciones disponibles:
one_time,
ongoing
institution
object

El banco al que corresponde una conexión o un enlace.

segment
enum<string> | null
Opciones disponibles:
personal,
business,
null
data
enum<string>[]

Los alcances que la persona aceptó.

Opciones disponibles:
accounts,
balances,
transactions

El consentimiento de la persona para esta conexión.

sync
object

Estado de sincronización de una conexión.

accounts
object[]

Resumen de cada cuenta de la conexión. Lee la cuenta completa con get_account.

ownership
object

La comparación opcional del titular de la cuenta con una persona o una empresa.

end_user
object
manage_url
string<uri> | null

La página de acceso propia de la persona. null hasta que la página de acceso esté disponible.

billing
object

Lo que cuesta esta conexión. El sandbox nunca genera cargos.

possible_duplicate_of
string<uuid> | null

Se establece cuando esta conexión puede duplicar otra activa, pero ningún end_user.reference permitió confirmar una coincidencia determinada.

vendor_data
string | null
updated_at
string<date-time>
Última modificación el 22 de noviembre de 2026