SchemaBoardingOwners

Retrieve owner

Use this method to retrieve details about an owner of a processing account or an owner associated with a funding recipient.

To retrieve an owner, you need their ownerId. Our gateway returned the ownerId in the response of the Create Processing Account method or the Create Funding Recipient Owner method.

Note: If you don’t have the ownerId, use the Retrieve Processing Account method if you are searching for a processing account owner, or use the List Funding Recipient Owners method if you are searching for a funding recipient owner.

Our gateway returns the following information about an owner:

  • Name, date of birth, and address.
  • Contact details, including their email address.
  • Relationship to the business, including whether they are a control prong.

Path parameters

ownerIdintegerRequired
Unique identifier that we assigned to the owner.

Headers

AuthorizationstringRequired

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

Response

Successful request. Returns the requested owner.
firstNamestring<=50 characters
Owner's first name.
lastNamestring<=50 characters
Owner's last name.
dateOfBirthdate

Owner’s date of birth. The format of this value is YYYY-MM-DD.

addressobject
Object that contains information about the address.
identifierslist of objects
Array of IDs.
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.

relationshipobject
Object that contains information about the owner's relationship to the business.
ownerIdinteger or null
Unique identifier of the owner.
middleNamestring or null<=50 characters
Owner's middle name.

Errors