curl -X POST 'https://verification.didit.me/v3/bank/links/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"mode": "connect",
"access": "ongoing",
"country": "ESP",
"segment": "business",
"data": [
"accounts",
"balances",
"transactions"
],
"history_from": "2026-01-01",
"consent_days": 180,
"ownership": {
"compare": "none"
},
"end_user": {
"reference": "client-7731",
"email": "ana@example.com"
},
"redirect_url": "https://app.example.com/bank/return",
"allowed_origins": [
"https://app.example.com"
],
"language": "es",
"vendor_data": "client-7731"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.create_link(
mode="connect",
access="ongoing",
country="ESP",
segment="business",
data=["accounts", "balances", "transactions"],
history_from="2026-01-01",
consent_days=180,
ownership={
"compare": "none",
},
end_user={
"reference": "client-7731",
"email": "ana@example.com",
},
redirect_url="https://app.example.com/bank/return",
allowed_origins=["https://app.example.com"],
language="es",
vendor_data="client-7731",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.createLink({
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{
Body: didit.BankLinkCreateRequest{
Mode: didit.Some(didit.BankLinkCreateRequestMode("connect")),
Access: didit.Some(didit.BankLinkCreateRequestAccess("ongoing")),
Country: didit.String("ESP"),
Segment: didit.Some(didit.BankLinkCreateRequestSegment("business")),
Data: didit.Some([]didit.BankLinkCreateRequestData{"accounts", "balances", "transactions"}),
HistoryFrom: didit.String("2026-01-01"),
ConsentDays: didit.Int(180),
Ownership: didit.Some(didit.BankLinkOwnershipRequest{
Compare: didit.Some(didit.BankLinkOwnershipRequestCompare("none")),
}),
EndUser: didit.Some(didit.BankLinkEndUser{
Reference: didit.String("client-7731"),
Email: didit.String("ana@example.com"),
}),
RedirectURL: didit.String("https://app.example.com/bank/return"),
AllowedOrigins: didit.Some([]string{"https://app.example.com"}),
Language: didit.String("es"),
VendorData: didit.String("client-7731"),
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.BankLinkCreateRequest;
import me.didit.types.BankLinkEndUser;
import me.didit.types.BankLinkOwnershipRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().createLink(BankLinkCreateRequest.builder()
.mode(BankLinkCreateRequest.Mode.of("connect"))
.access(BankLinkCreateRequest.Access.of("ongoing"))
.country("ESP")
.segment(BankLinkCreateRequest.Segment.of("business"))
.data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
.historyFrom(LocalDate.parse("2026-01-01"))
.consentDays(180L)
.ownership(BankLinkOwnershipRequest.builder()
.compare(BankLinkOwnershipRequest.Compare.of("none"))
.build())
.endUser(BankLinkEndUser.builder()
.reference("client-7731")
.email("ana@example.com")
.build())
.redirectUrl("https://app.example.com/bank/return")
.allowedOrigins(List.of("https://app.example.com"))
.language("es")
.vendorData("client-7731")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->createLink([
'mode' => 'connect',
'access' => 'ongoing',
'country' => 'ESP',
'segment' => 'business',
'data' => ['accounts', 'balances', 'transactions'],
'history_from' => '2026-01-01',
'consent_days' => 180,
'ownership' => [
'compare' => 'none',
],
'end_user' => [
'reference' => 'client-7731',
'email' => 'ana@example.com',
],
'redirect_url' => 'https://app.example.com/bank/return',
'allowed_origins' => ['https://app.example.com'],
'language' => 'es',
'vendor_data' => 'client-7731',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.create_link(
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CreateLinkAsync(new BankLinkCreateRequest
{
Mode = new BankLinkCreateRequestMode("connect"),
Access = new BankLinkCreateRequestAccess("ongoing"),
Country = "ESP",
Segment = new BankLinkCreateRequestSegment("business"),
Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
HistoryFrom = "2026-01-01",
ConsentDays = 180,
Ownership = new BankLinkOwnershipRequest
{
Compare = new BankLinkOwnershipRequestCompare("none"),
},
EndUser = new BankLinkEndUser
{
Reference = "client-7731",
Email = "ana@example.com",
},
RedirectUrl = "https://app.example.com/bank/return",
AllowedOrigins = new string[] { "https://app.example.com" },
Language = "es",
VendorData = "client-7731",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "created",
"url": "https://verify.didit.me/bank/link/example-link-token",
"client_token": "example-client-token",
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}API de création de lien bancaire : connecter ou renouveler une banque
L’endpoint Create a Bank Link de Didit lance une session Bank Link sur votre serveur et renvoie l’url hébergée où la personne connecte sa banque.
curl -X POST 'https://verification.didit.me/v3/bank/links/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"mode": "connect",
"access": "ongoing",
"country": "ESP",
"segment": "business",
"data": [
"accounts",
"balances",
"transactions"
],
"history_from": "2026-01-01",
"consent_days": 180,
"ownership": {
"compare": "none"
},
"end_user": {
"reference": "client-7731",
"email": "ana@example.com"
},
"redirect_url": "https://app.example.com/bank/return",
"allowed_origins": [
"https://app.example.com"
],
"language": "es",
"vendor_data": "client-7731"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.create_link(
mode="connect",
access="ongoing",
country="ESP",
segment="business",
data=["accounts", "balances", "transactions"],
history_from="2026-01-01",
consent_days=180,
ownership={
"compare": "none",
},
end_user={
"reference": "client-7731",
"email": "ana@example.com",
},
redirect_url="https://app.example.com/bank/return",
allowed_origins=["https://app.example.com"],
language="es",
vendor_data="client-7731",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.createLink({
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{
Body: didit.BankLinkCreateRequest{
Mode: didit.Some(didit.BankLinkCreateRequestMode("connect")),
Access: didit.Some(didit.BankLinkCreateRequestAccess("ongoing")),
Country: didit.String("ESP"),
Segment: didit.Some(didit.BankLinkCreateRequestSegment("business")),
Data: didit.Some([]didit.BankLinkCreateRequestData{"accounts", "balances", "transactions"}),
HistoryFrom: didit.String("2026-01-01"),
ConsentDays: didit.Int(180),
Ownership: didit.Some(didit.BankLinkOwnershipRequest{
Compare: didit.Some(didit.BankLinkOwnershipRequestCompare("none")),
}),
EndUser: didit.Some(didit.BankLinkEndUser{
Reference: didit.String("client-7731"),
Email: didit.String("ana@example.com"),
}),
RedirectURL: didit.String("https://app.example.com/bank/return"),
AllowedOrigins: didit.Some([]string{"https://app.example.com"}),
Language: didit.String("es"),
VendorData: didit.String("client-7731"),
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.BankLinkCreateRequest;
import me.didit.types.BankLinkEndUser;
import me.didit.types.BankLinkOwnershipRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().createLink(BankLinkCreateRequest.builder()
.mode(BankLinkCreateRequest.Mode.of("connect"))
.access(BankLinkCreateRequest.Access.of("ongoing"))
.country("ESP")
.segment(BankLinkCreateRequest.Segment.of("business"))
.data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
.historyFrom(LocalDate.parse("2026-01-01"))
.consentDays(180L)
.ownership(BankLinkOwnershipRequest.builder()
.compare(BankLinkOwnershipRequest.Compare.of("none"))
.build())
.endUser(BankLinkEndUser.builder()
.reference("client-7731")
.email("ana@example.com")
.build())
.redirectUrl("https://app.example.com/bank/return")
.allowedOrigins(List.of("https://app.example.com"))
.language("es")
.vendorData("client-7731")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->createLink([
'mode' => 'connect',
'access' => 'ongoing',
'country' => 'ESP',
'segment' => 'business',
'data' => ['accounts', 'balances', 'transactions'],
'history_from' => '2026-01-01',
'consent_days' => 180,
'ownership' => [
'compare' => 'none',
],
'end_user' => [
'reference' => 'client-7731',
'email' => 'ana@example.com',
],
'redirect_url' => 'https://app.example.com/bank/return',
'allowed_origins' => ['https://app.example.com'],
'language' => 'es',
'vendor_data' => 'client-7731',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.create_link(
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CreateLinkAsync(new BankLinkCreateRequest
{
Mode = new BankLinkCreateRequestMode("connect"),
Access = new BankLinkCreateRequestAccess("ongoing"),
Country = "ESP",
Segment = new BankLinkCreateRequestSegment("business"),
Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
HistoryFrom = "2026-01-01",
ConsentDays = 180,
Ownership = new BankLinkOwnershipRequest
{
Compare = new BankLinkOwnershipRequestCompare("none"),
},
EndUser = new BankLinkEndUser
{
Reference = "client-7731",
Email = "ana@example.com",
},
RedirectUrl = "https://app.example.com/bank/return",
AllowedOrigins = new string[] { "https://app.example.com" },
Language = "es",
VendorData = "client-7731",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "created",
"url": "https://verify.didit.me/bank/link/example-link-token",
"client_token": "example-client-token",
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}url hébergée.
Chaque champ a une valeur par défaut : la requête la plus simple est {}, à laquelle vous ajoutez les paramètres souhaités.
Associez l’id renvoyé à votre utilisateur et confirmez le résultat vous-même avec Récupérer un lien bancaire ou le webhook bank.link.completed.
Voir le guide de démarrage rapide et Bank Link.Autorisations
La clé API de votre application, disponible dans Developers -> API keys de la Business Console. La clé principale a un accès complet. Une clé nommée peut être limitée : aucun accès, lecture ou écriture par ressource, restreinte à certains workflows ou à certaines sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou à cette action, ou que la requête provient d'une adresse hors de sa liste d'adresses IP ; 404 sur une route de session signifie que la session se trouve hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL des images, vidéos et PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.
En-têtes
Clé facultative de sécurisation des nouvelles tentatives, que vous choisissez pour une opération, d'au plus 255 caractères (un UUID convient). Une requête répétée avec la même clé, le même endpoint, les mêmes paramètres de requête et le même corps reçoit la première réponse, avec le même statut et le même corps, et n'est ni exécutée ni facturée une seconde fois. La même clé avec un autre endpoint, d'autres paramètres de requête ou un autre corps renvoie 409 idempotency_key_reused. Tant que la première requête est encore en cours, elle renvoie 409 idempotency_key_in_progress avec Retry-After. Une requête échouée (tout 4xx ou 5xx) n'est pas enregistrée, vous pouvez donc la renvoyer avec la même clé. Les clés sont propres à votre application, que vous appeliez avec une clé API ou un jeton d'accès. Voir Nouvelles tentatives et idempotence.
1 - 255Corps
Créez un lien bancaire. La requête la plus simple est {} plus ce que vous voulez : chaque champ a une valeur par défaut.
one_time (par défaut) lit les données une seule fois. ongoing maintient l'accès ouvert jusqu'à la fin du consentement ou jusqu'à ce que quelqu'un y mette fin. Lorsque institution_id est renseigné, une banque qui ne peut pas maintenir l'accès ouvert répond 400 ongoing_access_not_available avant tout écran. Sans ce paramètre, le sélecteur de banques ne liste que les banques qui le peuvent.
one_time, ongoing Uniquement pour l'accès continu. Nombre de jours pendant lesquels demander à la banque de maintenir l'accès ouvert, 1 ou plus. Par défaut : la durée maximale autorisée par la banque. La connexion indique la date que la banque a effectivement accordée dans consent.expires_at. Avec access: one_time, elle répond 400 invalid_request avec field: consent_days.
1 <= x <= 32767Où le navigateur est redirigé à la fin, avec link_id, status et un state signé (à titre indicatif uniquement : le webhook et get_link font foi). Dans une application sandbox, une adresse http simple vers localhost, 127.0.0.1 ou [::1] (quel que soit le port ou le chemin, sans identifiants ni fragment) ne nécessite aucun enregistrement. Toute autre adresse renvoie 400 redirect_url_not_registered : l'enregistrement d'autres adresses n'est pas encore disponible. Sans redirect_url, la personne termine sur la page de résultat propre à Didit.
2048Avec ongoing, permet à la personne de poursuivre avec une lecture ponctuelle auprès d'une banque qui ne peut pas maintenir l'accès ouvert, après avoir confirmé l'accès réduit sur son propre écran. Le devis indique le coût de cette option. Uniquement avec access: ongoing : avec un accès ponctuel, la réponse est 400 invalid_request avec field: allow_one_time_fallback.
Réponse
Le lien a été créé.
Une exécution de Bank Link pour une personne : connecter une banque ou renouveler une connexion. Confirmez vous-même un lien avec get_link : ne faites jamais confiance à un identifiant envoyé par le navigateur.
Le jeton du Bank Link intégré de Didit, qui n'est pas encore disponible : ouvrez url dès aujourd'hui. Renvoyé uniquement à la création du lien ; null lors des lectures suivantes. Usage unique et de courte durée. Il ne contient aucune donnée personnelle. Ne le journalisez jamais.