Skip to main content
GET
curl
Didit’s Get a Bank Link endpoint returns the status of a link and, once it is completed, its connection_id and check_id. Call it from your server after onSuccess or on bank.link.completed: never trust a link id sent by a browser. A failed link reads 200 with status: failed and an error with a code such as duplicate_conflict or reduced_grant.

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 link id.

Response

The link.

One run of Bank Link for one person: connect a bank, or renew a connection. Confirm a link yourself with get_link: never trust an id sent by the browser.

id
string<uuid>
required

Identifier of the link.

mode
enum<string>
required
Available options:
connect,
renew
access
enum<string>
required
Available options:
one_time,
ongoing
status
enum<string>
required

State of the link. completed, cancelled, expired and failed are final.

Available options:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
required

The hosted page to send the person to. Returned only when the link is created; null on later reads, because the token is not stored.

client_token
string | null
required

The token for Didit's embedded Bank Link, which is not released yet: open url today. Returned only when the link is created; null on later reads. Single purpose and short lived. It carries no personal data. Never log it.

expires_at
string<date-time>
required

When an unredeemed link stops working.

connection_id
string<uuid> | null
required

The connection this link created or renewed, once status is completed.

check_id
string<uuid> | null
required

The ownership result of this link, when it asked for ownership.compare other than none.

reused
boolean
required

true when the link completed as a renewal of an existing connection because the person already shares exactly these accounts (duplicates: reuse). Nothing is charged twice.

error
object | null
required

Why the link failed, when status is failed. Otherwise null.

quote
object
required

The price of a link, pinned when it is created. The price charged is the quote's. Reads never bill.

vendor_data
string | null
required

Your reference from the request.

Last modified on November 22, 2026