SchemaFundingFunding Recipients

Create funding recipient owner

Create a new owner, and add it to the funding recipient.

Path parameters

recipientIdintegerRequired
Unique identifier of the funding recipient.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

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 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.

relationshipobjectRequired
Object that contains information about the owner's relationship to the business.
middleNamestringOptional<=50 characters
Owner's middle name.

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 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