VOvopay
Account Verification Endpoints

account-verification/interac

This endpoint is used to verify an Interac email address.

post/account-verification/interac

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account-verification/interac
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VerificationTierstring

Tier of the verification request. Options are 'basic' and 'enhanced'. Defaults to 'basic' if not specified.

EmailAddressstring required

Email address of the account holder

AccountHolderNamestring

Name of the account holder - required for associating the email address (not required if ClientAccountID/ContactID is present)

ClientAccountIDstring

Client account ID - required for associating the email address (not required if AccountHolderName is present)

ContactIDstring

Contact ID - required for associating the email address (not required if AccountHolderName is present)

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

VerificationRequestIDinteger

Verification Request ID for the Bank Account to be verified

VerificationStatusstring

Status of the verification

RegistrationInfoobject

Registration information for the verification request (enhanced only)

Example response

{
  "VerificationStatus": "Verified",
  "RegistrationInfo": {
    "registeredName": "Johnathan M Rogers",
    "alias": "John Rogers",
    "autoDepositEnabled": true,
    "customerType": "RETAIL",
    "maxPaymentOutgoingAmount": "25000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.