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 aPOSTrequest, consumesapplication/x-www-form urlencoded, and producesapplication/json. 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":     "123456",
    "cdtrAcct":      "12345678"
}

Sample Response

{ 
"status":"PASS",
"comment":"With the details that you have entered, a match with an account owner was found. (01av)" 
}

 Parameter fields

 Responses

The following table shows all possible errors, assuming authentication was successful:

Additional errors

The following table shows additional errors related to data structure:

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"
}                                                   (not an actual sample)

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"
}                                                   (not an actual sample)

SPV Brazil

For Brazil, request body must contain: Customer Name, IBAN number and Registration ID (CPF or CNPJ) .

{
    "cdtrCtryCde": "BR",
    "cdtrFirstName": "Peter Smith",
    "cdtrLastName": "",
    "cdtrAcctType": "",
    "cdtrNatId": "",
    "cdtrAcct": "BR5599950505000010000000505C2",  
    "idType": "registration_id",  
    "idValue": "555.666.777-88"  
}                                                 (not an actual sample)