account/client-accounts/individual

Use this endpoint to create a new individual client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers.

Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

Custom ID of the client account you want to create

string
required

Client's first name

string
required

Client's last name

string
required

Client's email address - Must be a valid email

string

Client's address line 1

string

Client's city

string

Client's province specified using two character abbreviations (eg. BC, AB)

string

Client's country specified using full country name or ISO 3166-1 alpha-2 code. If not provided, we will default to the VoPay account's country.

string

Client's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

string

Client's postal code.

string
required

3-character currency code defined by the ISO-4217 standard (e.g. CAD, USD). Used to set the default currency used by this client account. Can be CAD or USD for Canadian accounts. Must be set to USD for US accounts.

string
required

Client's phone number. Digits only - no parentheses or dashes allowed.

string
required

Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15).

integer
required

Last four digits of the client's SIN number.

string

Client's driver's licence.

string

An iQ11 Token that has been generated using Custom Iframe.

string

This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.

string

Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated user and bank account details from Flinks.

string

Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated user and bank account details from Flinks.

string

Plaid Processor Token. VoPay will fetch the associated user bank account details from Plaid.

string

Mx Processor Token. VoPay will fetch the associated user bank account details from Mx.

Response

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json