Skip to main content
GET
/
api
/
v1
/
contacts
/
{contactId}
Get Contact
curl --request GET \
  --url https://www.{baseurl}.com/api/v1/contacts/{contactId}
{
  "id": "dc48faa6-ea0e-484d-8e1b-a73887a11d49",
  "firstName": "Jane",
  "lastName": "Doe",
  "legalName": "<string>",
  "middleName": "<string>",
  "shortName": "<string>",
  "emailAddress": "jane.doe@example.com",
  "phoneNumber": "<string>",
  "contactType": "Individual",
  "addresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isPrimary": true,
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "unit": "<string>",
      "city": "<string>",
      "province": "<string>",
      "country": "<string>",
      "postalCode": "<string>"
    }
  ],
  "accounts": {
    "eftAccounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "institutionCode": "<string>",
        "transitNumber": "<string>",
        "accountNumber": "<string>",
        "isValid": true
      }
    ],
    "interacAccounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>"
      }
    ]
  }
}
Work in progressThis section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.If you’re interested in early access or want to learn more about what’s coming, feel free to reach out to the team.
Retrieve a stored contact by its ID. This is typically used to look up contact details before creating an EFT transaction using a contactId reference instead of providing name fields inline.

​
Usage in the EFT Flow

When creating a transaction, you can pass either inline name fields (firstName + lastName, or legalName) or a contactId in the contactInfo object. Use this endpoint to verify the stored contact details before submitting the transaction.

Headers

​
x-client-id
string

Path Parameters

​
contactId
string<uuid>
required

Response

Success

​
id
string<uuid>

Unique contact identifier.

Example:

"dc48faa6-ea0e-484d-8e1b-a73887a11d49"

​
firstName
string | null

Contact's first name.

Example:

"Jane"

​
lastName
string | null

Contact's last name.

Example:

"Doe"

​
legalName
string | null

Legal entity name.

​
middleName
string | null
​
shortName
string | null
​
emailAddress
string | null

Contact's email address.

Example:

"jane.doe@example.com"

​
phoneNumber
string | null
​
contactType
enum<string>

Contact type classification.

Available options:
Individual,
Business
​
addresses
object[] | null
​
accounts
object