SchemaBoardingContacts

Retrieve contact

Use this method to retrieve details about a contact.

To retrieve a contact, you need its contactId. Our gateway returned the contactId in the Create Processing Account method.

Note: If you don’t have the contactId, use the List Contacts method to search for the contact.

Our gateway returns the following information about a contact:

  • Name and contact method, including their phone number or mobile number.
  • Role within the business, for example, if they are a manager.

Path parameters

contactIdintegerRequired
Unique identifier for the contact.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful request. Returns the requested contact.
typeenum
Type of contact.
Allowed values:
firstNamestring<=50 characters
Contact's first name.
lastNamestring<=50 characters
Contact's last name.
identifierslist of objects
Array of identifier objects.
contactMethodslist of objects

Array of contactMethod objects.
Note: If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number.

contactIdinteger or null
Unique identifier of the contact.
middleNamestring or null<=50 characters
Contact's middle name.

Errors