Create funding recipient owner

Use this method to add an additional owner to a funding recipient.

To add an owner to a funding recipient, you need the recipientId. Our gateway returned the recipientId in the response of the Create Funding Recipient method.

Note: If you don’t have the recipientId, use our List Funding Recipients method to search for the funding recipient.

In the request, include the following information about the owner:

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

In the response, our gateway returns the ownerId, which you can use to run follow-on actions.

Use this method to add an additional owner to a funding recipient. To add an owner to a funding recipient, you need the recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. **Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. In the request, include the following information about the owner: - Name, date of birth, and address. - Contact details, including their email address. - Relationship to the funding recipient, including whether they are a control prong. In the response, our gateway returns the ownerId, which you can use to run follow-on actions.

Authentication

AuthorizationBearer

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

Path parameters

recipientIdintegerRequired

Unique identifier that we assigned to the funding recipient.

Request

This endpoint expects an object.

firstNamestringRequired<=50 characters

Owner's first name.

lastNamestringRequired<=50 characters

Owner's last name.

dateOfBirthdateRequired

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

addressobjectRequired

Object that contains information about the address.

identifierslist of objectsRequired

Array of IDs.

contactMethodslist of objectsRequired

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

relationshipobjectRequired

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

middleNamestringOptional<=50 characters

Owner's middle name.

Response headers

locationstring or null

URI reference to created resource.

Response

Successful request. We created the owner and added it to the funding recipient.

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

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