The Safe Payment Verification (SPV) API call indicates whether or not the name and surname (or business name) provided by you in the request are a reasonable match to a name associated with the account. We, in return will provide you with the Pass, Caution or Fail responses.
Request
POST https://api.validate.bankersalmanac.com/safe-payment-verification
Authentication
Authentication occurs using a username and password. It uses a POST
request, consumes application/x-www-form urlencoded
, and produces application/json
.
SPV UK
For SPV UK, request body must contain: Customer Name, Bank Account, Sort code, Account Type (Business or Private).
Example request:
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
SPV Brazil
For Brazil, request body must contain: Customer Name, IBAN number and Registration ID (CPF or CNP) .
{
"cdtrCtryCde": "BR",
"cdtrFirstName": "Peter Smith",
"cdtrLastName": "",
"cdtrAcctType": "",
"cdtrNatId": "",
"cdtrAcct": "BR5599950505000010000000505C2
", "idType": "registration_id", "idValue": "555.666.777-88", }
Mandatory Fields per country
Country | Country Code | First Name or Business | Surname | Account Number | BIC, Routing or National ID | Comments |
cdtrCtryCde | cdtrFirstName | cdtrLastName | cdtrAcct | cdtrNatId | ||
USA | M | M | M | M | routing nr | |
UK | M | M | n/a | M | sort code | |
INDIA | M | M | n/a | M | ifsc code | INR accounts |
INDONESIA | M | M | n/a | M | BIC | |
VIETNAM | M | M | n/a | M | BIC | VND accounts |
NIGERIA | M | M | n/a | M | BIC | |
NEPAL | M | M | n/a | M | BIC | |
PAKISTAN | M | M | n/a | M | BIC | PKR accounts |
S-KOREA | M | M | n/a | M | BIC | KRW accounts |
CHINA | M | M | n/a | Card nr | n/a | UnionPay network, individuals only |
BRAZIL | M | M | n/a | IBAN | n/a | Requires Registration ID nr xxx.xxx-xx |
Any questions then please just ask, just email us at validate@lexisnexisrisk.com
Name matching can be done for individuals or for companies. Name matching will be based on information provided in the cdtrFirstName
and cdtrLastName
values of the object.
If the desired name match is for a company, for the company name the Participant would like evaluated as being associated with the account set the company name as the cdtrFirstName
value and do not provide a surname value.
{ "cdtrCtryCde": "US", "cdtrFirstName": "Peter", "cdtrLastName": "Smith", "cdtrAcctType": "", "cdtrNatId": "11228821", "cdtrAcct": "687456120965", }
SPV UK
For SPV UK, request body must contain: Customer Name, Bank Account, Sort code, Account Type (Business or Private).
Example request:
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
SPV Brazil
For Brazil, request body must contain: Customer Name, IBAN number and Registration ID (CPF or CNP) .
{
"cdtrCtryCde": "BR",
"cdtrFirstName": "Peter Smith",
"cdtrLastName": "",
"cdtrAcctType": "",
"cdtrNatId": "",
"cdtrAcct": "BR5599950505000010000000505C2
", "idType": "registration_id", "idValue": "555.666.777-88", }
Mandatory Fields per country
Country | Country Code | First Name or Business | Surname | Account Number | BIC, Routing or National ID | Comments |
cdtrCtryCde | cdtrFirstName | cdtrLastName | cdtrAcct | cdtrNatId | ||
USA | M | M | M | M | routing nr | |
UK | M | M | n/a | M | sort code | |
INDIA | M | M | n/a | M | ifsc code | INR accounts |
INDONESIA | M | M | n/a | M | BIC | |
VIETNAM | M | M | n/a | M | BIC | VND accounts |
NIGERIA | M | M | n/a | M | BIC | |
NEPAL | M | M | n/a | M | BIC | |
PAKISTAN | M | M | n/a | M | BIC | PKR accounts |
S-KOREA | M | M | n/a | M | BIC | KRW accounts |
CHINA | M | M | n/a | Card nr | n/a | UnionPay network, individuals only |
BRAZIL | M | M | n/a | IBAN | n/a | Requires Registration ID nr xxx.xxx-xx |
Any questions then please just ask, just email us at validate@lexisnexisrisk.com
[/vc_column_text][/vc_column][/vc_row]
Example Request:"curl -H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "username=test_user" \
--data-urlencode "password=test_user_password" \
Sample Request body
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
Sample Response
{ "status":"PASS",
"comment":"With the details that you have entered, a match with an account owner was found. (01av)"
}
Parameter fields
Parameter | Type | Description |
---|---|---|
cdtrCtryCde |
string |
creditor’s country code (per ISO 3166-1 alpha-2)—currently only supports US |
cdtrFirstName | string |
creditor’s first name/business name |
cdtrLastName | string |
creditor’s last name (field applicable to US based accounts only) |
cdtrAcctType |
string |
creditor’s account type (Business vs Private, applicable to GB) |
cdtrNatId |
string |
creditor’s national ID, e.g., routing number for US, sort code for UK |
cdtrAcct | string |
creditor’s account number |
token | string |
value from authentication response |
Responses
The following table shows all possible errors, assuming authentication was successful:
Error | Description | Response Comments | Status |
---|---|---|---|
01av | Match Found | With the details that you have entered, a match with an account owner was found. | PASS |
02av | Partial Match Found | With the details that you have entered, a partial match with an account owner was found. | CAUTION |
03av | No Match Found | With the details that you have entered, there is no match with an account owner. | FAIL |
04av | No Data Found | With the details that you have entered, no data was found. | FAIL |
05av | Service Unavailable | The service seems unavailable at the moment. Please try to connect again later. | FAIL |
12av | Close Match Found | With the details that you have entered, a close match with an account owner was found. | PASS, CAUTION |
17av | Match Unavailable – Account does not support SPV check. | With the details that you have entered, there is no available match. The account does not support SPV check. | FAIL |
18av | Match Unavailable – Customer Opted Out | With the details that you have entered, there is no available match. The customer opted out from verification (GB only) | FAIL |
19av | Match Unavailable – Account Switched | With the details that you have entered, there is no available match. The account has been switched (GB only) | FAIL |
20av | Match Unavailable – Sort Code not found | With the details that you have entered, there is no available match. The sort code was not found (GB only) | FAIL |
21av | Match Found, Account is a Business Account | With the details that you have entered, a match with an account owner was found. Account is a Business account, not a Personal one. | CAUTION |
22av | Match Found, Account is a Personal Account | With the details that you have entered, a match with an account owner was found. Account is a Personal account, not a Business one. | CAUTION |
23av | Partial Match Found, Account is a Business Account | With the details that you have entered, a partial match with an account owner was found. Account is a Business account, not a Personal one. | CAUTION |
24av | Partial Match Found, Account is a Personal Account | With the details that you have entered, a partial match with an account owner was found. Account is a Personal account, not a Business one. | CAUTION |
Country Specific fields
SPV USA
Name matching can be done for individuals or for companies. Name matching will be based on information provided in the cdtrFirstName
and cdtrLastName
values of the object.
If the desired name match is for a company, for the company name the Participant would like evaluated as being associated with the account set the company name as the cdtrFirstName
value and do not provide a surname value.
{ "cdtrCtryCde": "US", "cdtrFirstName": "Peter", "cdtrLastName": "Smith", "cdtrAcctType": "", "cdtrNatId": "11228821", "cdtrAcct": "687456120965", }
SPV UK
For SPV UK, request body must contain: Customer Name, Bank Account, Sort code, Account Type (Business or Private).
Example request:
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
SPV Brazil
For Brazil, request body must contain: Customer Name, IBAN number and Registration ID (CPF or CNP) .
{
"cdtrCtryCde": "BR",
"cdtrFirstName": "Peter Smith",
"cdtrLastName": "",
"cdtrAcctType": "",
"cdtrNatId": "",
"cdtrAcct": "BR5599950505000010000000505C2
", "idType": "registration_id", "idValue": "555.666.777-88", }
Mandatory Fields per country
Country | Country Code | First Name or Business | Surname | Account Number | BIC, Routing or National ID | Comments |
cdtrCtryCde | cdtrFirstName | cdtrLastName | cdtrAcct | cdtrNatId | ||
USA | M | M | M | M | routing nr | |
UK | M | M | n/a | M | sort code | |
INDIA | M | M | n/a | M | ifsc code | INR accounts |
INDONESIA | M | M | n/a | M | BIC | |
VIETNAM | M | M | n/a | M | BIC | VND accounts |
NIGERIA | M | M | n/a | M | BIC | |
NEPAL | M | M | n/a | M | BIC | |
PAKISTAN | M | M | n/a | M | BIC | PKR accounts |
S-KOREA | M | M | n/a | M | BIC | KRW accounts |
CHINA | M | M | n/a | Card nr | n/a | UnionPay network, individuals only |
BRAZIL | M | M | n/a | IBAN | n/a | Requires Registration ID nr xxx.xxx-xx |
Any questions then please just ask, just email us at validate@lexisnexisrisk.com
[/vc_column_text][/vc_column][/vc_row]
Example Request:
"curl -H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "username=test_user" \
--data-urlencode "password=test_user_password" \
Sample Request body
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
Sample Response
{ "status":"PASS",
"comment":"With the details that you have entered, a match with an account owner was found. (01av)"
}
Parameter fields
Parameter | Type | Description |
---|---|---|
cdtrCtryCde |
string |
creditor’s country code (per ISO 3166-1 alpha-2)—currently only supports US |
cdtrFirstName | string |
creditor’s first name/business name |
cdtrLastName | string |
creditor’s last name (field applicable to US based accounts only) |
cdtrAcctType |
string |
creditor’s account type (Business vs Private, applicable to GB) |
cdtrNatId |
string |
creditor’s national ID, e.g., routing number for US, sort code for UK |
cdtrAcct | string |
creditor’s account number |
token | string |
value from authentication response |
Responses
The following table shows all possible errors, assuming authentication was successful:
Error | Description | Response Comments | Status |
---|---|---|---|
01av | Match Found | With the details that you have entered, a match with an account owner was found. | PASS |
02av | Partial Match Found | With the details that you have entered, a partial match with an account owner was found. | CAUTION |
03av | No Match Found | With the details that you have entered, there is no match with an account owner. | FAIL |
04av | No Data Found | With the details that you have entered, no data was found. | FAIL |
05av | Service Unavailable | The service seems unavailable at the moment. Please try to connect again later. | FAIL |
12av | Close Match Found | With the details that you have entered, a close match with an account owner was found. | PASS, CAUTION |
17av | Match Unavailable – Account does not support SPV check. | With the details that you have entered, there is no available match. The account does not support SPV check. | FAIL |
18av | Match Unavailable – Customer Opted Out | With the details that you have entered, there is no available match. The customer opted out from verification (GB only) | FAIL |
19av | Match Unavailable – Account Switched | With the details that you have entered, there is no available match. The account has been switched (GB only) | FAIL |
20av | Match Unavailable – Sort Code not found | With the details that you have entered, there is no available match. The sort code was not found (GB only) | FAIL |
21av | Match Found, Account is a Business Account | With the details that you have entered, a match with an account owner was found. Account is a Business account, not a Personal one. | CAUTION |
22av | Match Found, Account is a Personal Account | With the details that you have entered, a match with an account owner was found. Account is a Personal account, not a Business one. | CAUTION |
23av | Partial Match Found, Account is a Business Account | With the details that you have entered, a partial match with an account owner was found. Account is a Business account, not a Personal one. | CAUTION |
24av | Partial Match Found, Account is a Personal Account | With the details that you have entered, a partial match with an account owner was found. Account is a Personal account, not a Business one. | CAUTION |
Country Specific fields
SPV USA
Name matching can be done for individuals or for companies. Name matching will be based on information provided in the cdtrFirstName
and cdtrLastName
values of the object.
If the desired name match is for a company, for the company name the Participant would like evaluated as being associated with the account set the company name as the cdtrFirstName
value and do not provide a surname value.
{ "cdtrCtryCde": "US", "cdtrFirstName": "Peter", "cdtrLastName": "Smith", "cdtrAcctType": "", "cdtrNatId": "11228821", "cdtrAcct": "687456120965", }
SPV UK
For SPV UK, request body must contain: Customer Name, Bank Account, Sort code, Account Type (Business or Private).
Example request:
{ "cdtrCtryCde": "GB", "cdtrFirstName": "Peter Smith", "cdtrLastName": "", "cdtrAcctType": "Personal", "cdtrNatId": "112288", "cdtrAcct": "68745612", }
SPV Brazil
For Brazil, request body must contain: Customer Name, IBAN number and Registration ID (CPF or CNP) .
{
"cdtrCtryCde": "BR",
"cdtrFirstName": "Peter Smith",
"cdtrLastName": "",
"cdtrAcctType": "",
"cdtrNatId": "",
"cdtrAcct": "BR5599950505000010000000505C2
", "idType": "registration_id", "idValue": "555.666.777-88", }
Mandatory Fields per country
Country | Country Code | First Name or Business | Surname | Account Number | BIC, Routing or National ID | Comments |
cdtrCtryCde | cdtrFirstName | cdtrLastName | cdtrAcct | cdtrNatId | ||
USA | M | M | M | M | routing nr | |
UK | M | M | n/a | M | sort code | |
INDIA | M | M | n/a | M | ifsc code | INR accounts |
INDONESIA | M | M | n/a | M | BIC | |
VIETNAM | M | M | n/a | M | BIC | VND accounts |
NIGERIA | M | M | n/a | M | BIC | |
NEPAL | M | M | n/a | M | BIC | |
PAKISTAN | M | M | n/a | M | BIC | PKR accounts |
S-KOREA | M | M | n/a | M | BIC | KRW accounts |
CHINA | M | M | n/a | Card nr | n/a | UnionPay network, individuals only |
BRAZIL | M | M | n/a | IBAN | n/a | Requires Registration ID nr xxx.xxx-xx |
Any questions then please just ask, just email us at validate@lexisnexisrisk.com
[/vc_column_text][/vc_column][/vc_row]