Skip to main content
GET
curl
Didit’s Get a Bank Connection endpoint returns one connection with its status, consent dates, sync state, account summaries and cost. sync.initial_status tells you when the first data is readable, consent.expires_at when to renew and sync.budgets how many refreshes the bank still allows. See Connections.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

id
string<uuid>
required

The connection id.

Response

The connection.

The person's permission for your application to read one bank. A renewal keeps the connection id and every account id. A deleted connection answers only id, status, status_reason, created_at and erasure: every other field is absent, and no bank, person or account data remains in it.

id
string<uuid>
required

Identifier of the connection.

status
enum<string>
required

pending: first sync running. active: consent valid. renewal_required: the consent ended or the bank wants the person to sign in again, data readable as last synced and nothing charged. paused: balance too low for the month. revoked: access stopped by the person, the bank or you. deleted: only id, status, status_reason, created_at and erasure remain. failed: the first sync never succeeded.

Available options:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
required

Why the connection is in this status. paused_by_customer is reserved. On a deleted connection: deleted_by_customer, consent_lapsed, retention_elapsed or application_deleted.

Available options:
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
required

Set after delete_connection; otherwise null.

created_at
string<date-time>
required
environment
enum<string>
Available options:
live,
sandbox
access
enum<string>
Available options:
one_time,
ongoing
institution
object

The bank a connection or link is for.

segment
enum<string> | null
Available options:
personal,
business,
null
data
enum<string>[]

The scopes the person accepted.

Available options:
accounts,
balances,
transactions

The person's consent for this connection.

sync
object

Synchronisation state of a connection.

accounts
object[]

Summary of every account in the connection. Read the full account with get_account.

ownership
object

The optional comparison of the account holder with a person or company.

end_user
object
manage_url
string<uri> | null

The person's own access page. null until the access page is available.

billing
object

What this connection costs. Sandbox is never charged.

possible_duplicate_of
string<uuid> | null

Set when this connection may duplicate another active one but no end_user.reference allowed a certain match.

vendor_data
string | null
updated_at
string<date-time>
Last modified on November 22, 2026