Interac® Verification Service (VerifiedMe).
Prompts a customer to perform AML Assist Verification — proving their identity via their bank's login credentials through the Interac digital identity network — before you onboard them. Available only in Canada.
Shares the /bankaccountvalidator/v1 base path with the Bank Account
Validation API, under the /verifiedme sub-path.
Flow
create/3—POST /bankaccountvalidator/v1/verifiedme/accounts/{account_id}/verifications. Returns a redirect link (no synchronous response).- Redirect the customer to the link returned. They select their bank and log in with their online banking credentials.
get/3—GET /bankaccountvalidator/v1/verifiedme/verifications/{verificationId}. Once the customer completes the bank-page flow, fetch their verified identity information (address fields, trade lines, overall decision).
Example
{:ok, verification} = Paysafe.InteracVerificationService.create(config, %{
merchant_ref_num: "1323563",
account_id: "PMLE100",
locale: "en_CA",
return_links: [%{rel: "default", href: "https://mysite.com/return"}]
})Summary
Functions
Create an Interac AML Assist verification session.
Fetch the user's verified information once they have completed the redirect flow on Interac's bank page.
Functions
@spec create(Paysafe.Config.t(), map(), keyword()) :: {:ok, Paysafe.Types.BankVerification.t()} | {:error, Paysafe.Error.t()}
Create an Interac AML Assist verification session.
Parameters
:merchant_ref_num(required) — Unique reference.:account_id— Your reference/account identifier for this verification (distinct from the Paysafe account ID used in the URL path).:locale— e.g."en_CA".:return_links— Where to redirect the customer after completion.:metadata— Arbitrary key/value pairs (e.g. your internal customer ID).
@spec get(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, Paysafe.Types.BankVerification.t()} | {:error, Paysafe.Error.t()}
Fetch the user's verified information once they have completed the redirect flow on Interac's bank page.