Beneficiary SCA
For some accounts, the regulator requires Strong Customer Authentication (SCA) before a new beneficiary can be used. When SCA is needed, the Create Beneficiary response includes an scaLink. The end user must open this link and finish the verification. When they finish, the beneficiary is approved immediately.
Strong Customer Authentication (SCA) for Beneficiaries
For some accounts, the regulator requires Strong Customer Authentication (SCA) before a new beneficiary can be used.
When SCA is needed, the Create Beneficiary response includes an scaLink. The end user must open this link and finish the verification.
When they finish, the beneficiary is approved immediately.
Flow overview
- You call
POST /api/v1/Beneficiaries. - If SCA is needed, the API returns
202 Accepted. The beneficiary has statusPendingand the response includes anscaLink. - The end user opens the
scaLink. - The end user finishes the SCA steps (see below).
- The beneficiary moves to
Approvedright away and can be used for payments.
- Create the beneficiary
- Create the beneficiary
POST /api/v1/Beneficiaries
Authorization: Bearer <token>
Content-Type: application/json
{ ...beneficiary details... }
Response when SCA is needed (202 Accepted):
{
"id": "b7e3c1a2-4d5f-4e6a-8b9c-0d1e2f3a4b5c",
"status": "Pending",
...
"scaLink": "https://.../sca/Xy7Kp2Qa"
}
If scaLink is null or missing, no SCA is needed and you can ignore this flow.
- Send the end user to the SCA link
- Send the end user to the SCA link
Open scaLink in the end user's browser, in a new tab or an in-app web view.
The end user must complete the process themselves; it cannot be done on their behalf through the API.
- SCA steps for the end user
- SCA steps for the end user
- Set a password: create a password for the secure session.
- Confirm phone number: enter the one-time code sent by SMS to the user's phone.
- Verify identity: complete the identity verification step.
- Beneficiary is approved
- Beneficiary is approved
When the SCA process ends successfully, the beneficiary moves from Pending to Approved straight away. No manual review is needed.
You can then use the beneficiary for payments.
To confirm the status, call:
GET /api/v1/Beneficiaries/{id}
Good to know
- The link stays valid while the beneficiary is
Pending. If the user closes the page before finishing, they can open the same link again. A new secure session is created automatically each time the link is opened. - Lost the link?
GET /api/v1/Beneficiaries/{id}andGET /api/v1/Beneficiariesreturn thescaLinkfor every beneficiary that is still waiting for SCA. - When SCA is done,
scaLinkis no longer returned. - A beneficiary that should not go through the SCA process, and in
Pendingstatus cannot be used for payments.
Updated 4 days ago