Guide
IBAN ownership verification
On this page
The Banklink API can verify that a user has access to a bank account and, when the bank provides the owner's name, that the user owns it. The user logs in to their bank and grants read-only access; Banklink then compares the account owner with the name you sent. Some banks do not provide the owner's name; for them, Banklink only verifies that the user has access to the account.
The endpoints are protected by PayoutID and require the scope VERIFY (uppercase). Request the token with the client credentials grant. This is a different scope from the lowercase verify of PayoutID identity verification.
- Create the verification. Call Create verification with the
ibanand the user'sfirst_nameandlast_name; without the names, ownership cannot be confirmed. The response contains the verificationid, aredirect_urland the statusinitialized. - Redirect the user. Append the query parameter
redirect_uriand, optionally,statetoredirect_url, and send the user's browser there.redirect_urimust be one of the redirect URIs registered for your client. - The user grants access. The user logs in to their bank and gives read-only access to the account. Banklink then redirects the browser to your
redirect_uriwith yourstate. If something went wrong, the redirect also carrieserroranderrorDescription. - Get the result. Call Get verification status with the verification
idfrom step 1.
The verification ends in one of these statuses:
| Status | Meaning |
|---|---|
initialized |
The verification was created, but the user has not completed the bank login. A cancelled or failed login also leaves this status. |
verified_access |
The user accessed the account, but the bank does not provide the owner's name. |
verified_ownership |
The user accessed the account, and the owner's name provided by the bank matches the name you sent. |
unverified_ownership |
The user accessed the account, but the owner's name provided by the bank differs from the name you sent. |
unverified_access |
The user could not access the account. Currently not set: a failed login leaves the status initialized. |
error |
Communication with the bank failed. |
- Need help? Contact support.
- Questions? Contact sales.
- Service status? status.payout.one.
- LLM? Read llms.txt.