contacts/add

post

https://earthnode-dev.vopay.com/api/v2/contacts/add

This endpoint is used to add a new contact record for the given account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ContactID

string

Custom ID of the contact you want to create

EmailAddress

string

required

The email address to be associated with this contact

PhoneNumber

string

required

The phone number to be associated with this contact

FirstName

string

required

The first name to be associated with this contact

LastName

string

required

The last name to be associated with this contact

BusinessName

string

Client's business name

Address1

string

Contact's address line 1

City

string

Contact's city

Province

string

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

Country

string

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

Nationality

string

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

PostalCode

string

Contact's postal code.

Token

string

An iQ11 Token that has been generated using Custom Iframe.

FlinksLoginID

string

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

PlaidProcessorToken

string

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

MxProcessorToken

string

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

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200