Retrieve owner | Payroc | Documentation

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 or authorized signatory, and their equity stake in the business.

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](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method or the [Create Funding Recipient Owner](https://docs.payroc.com/api/schema/funding/funding-recipients/create-owner) method. **Note:** If you don't have the ownerId, use the [Retrieve Processing Account](https://docs.payroc.com/api/schema/boarding/processing-accounts/retrieve) method if you are searching for a processing account owner, or use the [List Funding Recipient Owners](https://docs.payroc.com/api/schema/funding/funding-recipients/list-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 or authorized signatory, and their equity stake in the business.

Authentication

AuthorizationBearer

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

Path parameters

ownerIdintegerRequired

Unique identifier that we assigned to the owner.

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 polymorphic objects, which contain contact information.

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.

The value of the type parameter determines which variant you should use:

email - Email address
phone - Phone number
mobile - Mobile number
fax - Fax number

Array of polymorphic objects, which contain contact information. **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. The value of the type parameter determines which variant you should use: - `email` - Email address - `phone` - Phone number - `mobile` - Mobile number - `fax` - Fax number

relationshipobject

Object that contains information about the owner's relationship to the business.

ownerIdinteger or nullRead-only

Unique identifier that we assigned to the owner.

middleNamestring or null<=50 characters

Owner's middle name.

Errors

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.

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 or authorized signatory, and their equity stake in the business.

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.Boarding.Owners;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new BasePayrocClient(
11	clientOptions: new ClientOptions {
12	Environment = PayrocEnvironment.Production
13	}
14	);
15
16	await client.Boarding.Owners.RetrieveAsync(
17	new RetrieveOwnersRequest {
18	OwnerId = 4564
19	}
20	);
21	}
22
23	}

1	{
2	"firstName": "Jane",
3	"lastName": "Doe",
4	"dateOfBirth": "1964-03-22",
5	"address": {
6	"address1": "1 Example Ave.",
7	"city": "Chicago",
8	"state": "Illinois",
9	"country": "US",
10	"postalCode": "60056",
11	"address2": "Example Address Line 2",
12	"address3": "Example Address Line 3"
13	},
14	"identifiers": [
15	{
16	"type": "nationalId",
17	"value": "xxxxx4320"
18	}
19	],
20	"contactMethods": [
21	{
22	"type": "email",
23	"value": "[email protected]"
24	}
25	],
26	"relationship": {
27	"isControlProng": true,
28	"equityPercentage": 48.5,
29	"title": "CFO",
30	"isAuthorizedSignatory": false
31	},
32	"ownerId": 4564,
33	"middleName": "Helen"
34	}