Introduction to the Paysafe Customer Identity API

The Paysafe Customer Identity API allows merchants to perform KYC (know your customer) identity checks on their customers with a single request to the API.

The API is easy to use, and once you get a successful KYC response from Paysafe, you can board your customer with confidence. Here's an overview of the process.

Customer Identity Overview

  1. Gather some minimal, basic information about the customer.
  2. Submit a Customer Identity Check request to Paysafe – required parameters are listed here. The request will look something like this, but you don't need all the information in this example:
  3. POST https://api.test.paysafe.com/customeridentification/v1/identityprofiles
    {
    	"merchantRefNum": "KYC_1520461749",
    	"card": {
    		"cardNum": "4111111111111111",
    		"cardExpiry": {
    			"month": 2,
    			"year": 2019
    		},
    		"cvv": 123
    	},
    	"profile": {
    		"firstName": "John",
    		"lastName": "Smith",
    		"email": "john.smith@myemail.com",
    		"currentAddress": {
    			"street": "100 Queen Street West",
    			"street2": "Unit 201",
    			"city": "Toronto",
    			"state": "ON",
    			"country": "CA",
    			"zip": "M5H 2N2",
    			"monthsAtAddress": "50",
    			"phone": "647-788-3901"
    		},
    		"dateOfBirth": {
    			"day": "25",
    			"month": "12",
    			"year": "1980"
    		},
    		"sin": "123456789"
    	},
    	"customerIp": "1.1.1.1",
    	"vendorCheck": "EID_COMPARE"
    }
  4. Paysafe sends your request to downstream providers, which are determined by the vendorCheck or workflowId parameter used in the request.
  5. When you sign on, Paysafe will advise you on which of these two parameters to use, as well as what value to provide for it in the request.
  6. The response from Paysafe will look something like the example below.
  7. {
    	"id": "86dcb68d-cbd0-4878-8da7-ffc0e6554513",
    	"decision": "SUCCESS",
    	"merchantRefNum": "KYC_1520461749",
    	"card": {
    		"lastDigits": "1111",
    		"cardExpiry": {
    			"month": 2,
    			"year": 2019
    		}
    	},
    	"profile": {
    		"firstName": "John",
    		"lastName": "Smith",
    		"email": "john.smith@myemail.com",
    		"currentAddress": {
    			"street": "100 Queen Street West",
    			"street2": "Unit 201",
    			"city": "Toronto",
    			"state": "ON",
    			"country": "CA",
    			"zip": "M5H 2N2",
    			"monthsAtAddress": "20",
    			"phone": "647-788-3901"
    		},
    		"dateOfBirth": {
    			"day": "25",
    			"month": "12",
    			"year": "1980"
    		},
    		"sinLastFour": "6789"
    	},
    	"customerIp": "1.1.1.1",
    	"vendorCheck": "EID_COMPARE",
    	"providerResponses": {
    		"eidCompare": {
    			"id": "0f1266b9-ce28-4df2-bc3f-d4b746cc1ced",
    			"status": "SUCCESS",
    			"response": {
    
    				"assessmentComplete": {
    					"reasonCodes": [{
    						"description": "Telephone exchange does not match the FSA (first three characters) of the postal code for Current Address",
    						"code": "08"
    					}],
    					"decision": "Y",
    					"score": 25
    				}
    			}
    		}
    	}
    }
  8. In this response, you can see that value for the decision parameter is SUCCESS. This means the customer has successfully passed the KYC Customer Identity check.
  9. If the value for the decision parameter is ERROR, it could indicate that the request could not be completed for some reason, e.g., a timeout with a downstream provider. In the case of ERROR, you can rerun the Customer Identity check request with the rerunfailedchecks endpoint using the id returned in the response. For example, the id returned above is 86dcb68d-cbd0-4878-8da7-ffc0e6554513.
  10. POST https://api.test.paysafe.com/customeridentification/v1/identityprofiles/86dcb68d-cbd0-4878-8da7-ffc0e6554513/rerunfailedchecks
  11. If the Customer Identity check request is processed successfully when you rerun it, you would receive a response like the one in step 4 above.
Did you find this page useful?