Typical API Calls

Create a Verification

The Create Verification API will initiate a session at Paysafe for customer’s identity verification and responds with a redirect URL.

Click Create a Verification to view the API documentation and learn how to send a User Identity verification request to Paysafe.

POST/bankaccountvalidator/v1/verifiedme/accounts/{account_id}/verifications

Request Parameter	Description	Type	Mandatory	Sample Values
accountId	This is the merchant account number	String	Yes	123456789
merchantRefNum	Unique Reference number to identity duplicate transactions	String	Yes	123456677
returnLinks	The URL endpoint to redirect the consumer to. You can customize the return URL based on the transaction status. The 'default' value is mandatory. Options: default - The default return URL, which will be used if specific status return URL is not defined. on_completed - It will be Used in case of successful bank account validation on_failed - It will be used in case of Unsuccessful bank account validation	Array	Yes	"returnLinks": [ { "rel": "default", "href": "https://mysite.com/return" }, { "rel": "on_completed", "href": "https://mysite.com/receipt" }, { "rel": " on_failed ", "href": "https://mysite.com/error" } ]
metadata	The information passed in this field in the request will be exactly echoed in the response	JSON Object	No	"metadata": { "customerId": "879389846335" }
locale	To identify the locale and present the UI in desired language. If opted locale is not available, default would be en_CA.	String(enum)	No	en_CA

Sample Request

{

  "merchantRefNum": "1323563",

  "accountId": "PMLE100",

  "locale": "en_CA"

  "returnLinks": [

    {

      "rel": "default",

      "href": "https://mysite.com/return"

    }

  ],

  "metadata": {

    "customerId": "879389846335"

  }

}

Locale Information

S. No	Locale to be passed in request	Name
1	en_CA	English (Canada)
2	fr_CA	French (Canada)

Other locale information are available on request.

Sample Response

{

  "merchantRefNum": "1323563",

  "returnLinks": [

    {

      "rel": "default",

      "href": "https://mysite.com/return"

    }

  ],

  "id": "6a275b7c-6f11-4ed1-ae77-21071724574a",

  "sessionId": "MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz",

  "status": "INITIATED",

  "links": [

    {

      "rel": "redirect_bank_validation",

      "href": "https://api.paysafe.com/bankaccountvalidator/v1/verifiedme/redirect?sessionId=MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz"

    }

  ],

  "metadata": {

    "customerId": "879389846335"

  }

}

Response Parameter	Description	Type	Mandatory	Sample Values
merchantRefNum	This is the same merchant ref number echoed back from the request	String	Yes	123456789
returnLinks	This is the same return links echoed back from the request	Array	yes	"returnLinks": [ { "rel": "default", "href": "https://mysite.com/return" }, { "rel": "on_completed", "href": "https://mysite.com/receipt" }, { "rel": " on_failed ", "href": "https://mysite.com/error" } ]
id	Verification Id for this transaction and same to be used for getting the Customer's information through Look up call.	String	Yes	6a275b7c-6f11-4ed1-ae77-21071724574a
sessionId	Session Id for this entire flow	String	Yes	MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz
status	Status of the Transaction	String	Yes	INITIATED
links	To navigate to the vendor’s UI where online banking	Array	Yes	"links": [ { "rel": "redirect_bank_validation", "href": "https://api.paysafe.com/bankaccountvalidator/v1/verifiedme/redirect?sessionId=MjM5NWRlMTQtNDE4Yy0xMWU5LWIyMTAtZDY2M2JkODczZDkz" } ]
metadata		JSON Object	no	"metadata": { "customerId": "879389846335" }

Redirect the Customer

GET /bankaccountvalidator/v1/redirect?sessionId={sessionId}

Click Redirect the Customer to view the API documentation and learn how to redirect a customer, so they can validate their bank account details.

Note: Because this is a redirect request, there is no synchronous response available.

Response Parameter	Description	Type	Mandatory	Sample Values
sessionId	SessionId provided in the create Verification Response	String	Yes	MmM2OGNiNWMtMWNmYS0xMWU5LWFiMTQtZDY2M2JkODczZDkz

Fetch User Information

GET/bankaccountvalidator/v1/verifiedme/verifications/{verificationId}

The Paysafe Fetch User Information from Identity Verification API allows a merchant to fetch the user information from a customer's bank account by prompting the customer to enter their online banking credentials via a user interface presented by Interac. Once the customer has verified that they own the bank account, the merchant can then proceed to fetch the corresponding user's information.

Request Parameter	Description	Type	Mandatory	Sample Values
sessionId	Id provided in the create Verification Response	String	Yes	6a275b7c-6f11-4ed1-ae77-21071724574a

Sample Request:/bankaccountvalidator/v1/verifiedme/verifications/6a275b7c-6f11-4ed1-ae77-21071724574a

Response Parameter	Description	Type	Mandatory	Sample Values
addresses	this is the person's address. Refer to Address files section	Array	yes	"addresses": [ { "country": "CA", "streetAddress": "676 RUE FOURNIER", "addressType": "CA", "locality": "SLLE", "postalCode": "J7E 3K9", "region": "QC" } ]
birthdate	This is the customer's date of birth	String	Yes	8/1/1933
singleSource	This indicates whether the single source product has been used.	boolean	yes	TRUE
dualSource	This indicates whether the dual source product has been used.	boolean	yes	FALSE
singleSourceDecision	This is the result of the decisioning model for the single source product.	boolean	yes	TRUE
dualSourceDecision	This is the result of the decisioning model for the dual source product.	boolean	yes	FALSE
uniqueNumber	This is the credit file number received from the downstream provider.	String	yes	59465419
givenName	This is the given name retrieved from the verifiedme output.	String	yes	ISABELLE
familyName	This is the family name retrieved from the verifiedme output.	String	yes	CORREIA
ageOfCreditFile3yMoreOlder	This indicates whether the credit file is greater than three years old.	boolean	yes	TRUE
decision	hyper link to Over All decision matrix	String	yes	SUCCESS
tradelines	hyper link to tradeLines	Object	yes	[ { "addressProvinceMatch": "YES", "middleNameMatch": "NOT PROVIDED", "addressPostalCodeMatch": "YES", "lastNameMatch": "YES", "firstNameMatch": "YES", "addressAsReported": "676,RUE FOURNIER,ST-THER-BLAIN,QC,J7E3K9", "suffixNameMatch": "NOT PROVIDED", "dateOfBirthMatch": "YES", "addressCityMatch": "YES", "dobAsReported": "1933-08-01", "addressStreetNameMatch": "YES", "nameAsReported": "CORREIA,ISABELLE,C,", "addressCivicMatch": "YES" } ]

Address fields

Element	Type	Description
country	String	country code
streetAddress	String	street address in a standard canadian format
addressType	String	Address Type
locality	String	Locality of this address.
postalCode	String	Postal code of this address
region	String	Region of this address

tradeLines

Element	Type	Possible Values	Description
addressProvinceMatch	String	YES/NO/NOT PROVIDED	This indicates whether the address province matched.
middleNameMatch	String	YES/NO/NOT PROVIDED	This indicates whether the middle name matched.
addressPostalCodeMatch	String	YES/NO/NOT PROVIDED	This indicates whether the address postal code matched.
lastNameMatch	String	YES/NO/NOT PROVIDED	This indicates whether the last name matched.
firstNameMatch	String	YES/NO/NOT PROVIDED	This indicates whether the first name matched.
addressAsReported	String		This is the address retrieved from the downstream provider output.
suffixNameMatch	String	YES/NO/NOT PROVIDED	This indicates whether the suffix name matched
dateOfBirthMatch	String	YES/NO/NOT PROVIDED	This indicates whether the date of birth matched.
addressCityMatch	String	YES/NO/NOT PROVIDED	This indicates whether the address city matched.
dobAsReported	String		This is the date of birth retrieved from the downstream provider output.
addressStreetNameMatch	String	YES/NO/NOT PROVIDED	This indicates whether the address street name matched
nameAsReported	String		This is the name retrieved from the downstream provider output.
addressCivicMatch	String	YES/NO/NOT PROVIDED	This indicates whether the civic number of the address matched.

Overall Decision Matrix

Single Source	Single Source Decision	Dual Source	Dual Source Decision	Final Status
Credit file found	Fail	Trade info found	Fail	FAIL
Credit file found	Fail	Trade info found	Success	SUCCESS
Credit file found	Success	Trade info not found	Fail	SUCCESS
Credit file not found	Fail	Trade info found	Fail	FAIL
Credit file not found	Fail	Trade info found	Success	SUCCESS
Credit file not found	Fail	Trade info not found	Fail	FAIL

Was this page helpful?

On this Page

Create a Verification
Locale Information
Redirect the Customer
Fetch User Information

Search Overlay

Typical API Calls

Was this page helpful?

Thank you for your response!