API Endpoints

The API endpoint (URI or URL) must point to either the Test or Production (live) environment.

Test API endpoint: https://api.test.paysafe.com/
For example: https://api.test.paysafe.com/customeridentification/monitor
Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/customeridentification/monitor

API Endpoint Patterns

The API endpoints typically conform to the pattern of the example below:

https://api.test.paysafe.com/customeridentification/v1/identityprofiles/identity_check_id/APIrequest

Replace the elements in the API endpoint example above as follows:

Element	Usage
test	Use test for a Test transaction. Remove the word test for a live (i.e., Production) transaction.
identity_check_id	In this case, replace identity_check_id with the unique ID returned in the response to the original Customer Identity Check request.
APIrequest	Replace with the type of API request, such as rerunfailedchecks.
v1	This is the version of the API. Currently all APIs are on version 1.

Refer to the table below for further examples.

API Request	Used To	Endpoint Pattern
Customer Identity Checks	Run a Customer Identity check on a customer.	POST/customeridentification/v1/identityprofiles/
Rerun a Customer Identity Check	Rerun a Customer Identity check on a customer in the case where the original Customer Identity check resulted in an error.	POST/customeridentification/v1/identityprofiles/identity_check_id/rerunfailedchecks

In the above examples, replace identity_check_id with the unique ID returned to the response to the original Customer Identity Check request.
The examples point to the Production system.

On this Page