Skip to main content

Start Instrument Verification Session

POST 
/v2/customers/:customerId/instrument-verifications

Creates new instrument verification session. The result of successful verification is a VERIFIED instrument, that can be used for withdrawal or deposit operations.

Required Parameters:

  • instrumentType - Currently US_BANK_ACCOUNT is supported.
  • returnUrl - should contain the location to where the customer must be redirected after completing the required actions in Paysafe hosted UI.

The response contains:

  • id - the session identifier
  • redirectUrl - unique instrument verification redirect url associated with this session. The url contains Paysafe hosted UI, that carries the user through the account selection and verification process.
  • secureCode - unique secure code, that provides authentication for the session. This must be passed as query parameter attached to the redirect link.

Тhe status of the session can be tracked using Get Instrument Verification API.

Request​

Responses​

The instrument verification session object, that contains a redirect URL where the User should be redirected to, to complete the payment instrument verification process.