individual_owner_list

List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.

An array of individual_owner objects.

namesobject<person_name>[]Optional

The name of the person.

Items0 <= length <= 5

addressesobject<person_address_detail>[]Optional

The list of addresses associated with the person.

Items0 <= length <= 5

person_address_detail properties

11 properties

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

address_detailsobject<address_details>Optional

The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

phonesobject<person_phone_detail>[]Optional

The list of phone numbers associated with the person.

Items0 <= length <= 5

documentsobject<person_document>[]Optional

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST [/v2/customer/partner-referrals](/docs/api/partner-referrals/v2/#partner-referrals_create) API calls.

Items0 <= length <= 20

person_document properties

10 properties

filesobject<file_reference>[]Optional

The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.

Items1 <= length <= 50

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

typeenum<person_document_type>Optional

The actual type of the document. It could be `ID_CARD`, `PASSPORT`, etc.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SOCIAL_SECURITY_NUMBER"
"EMPLOYMENT_IDENTIFICATION_NUMBER"
"TAX_IDENTIFICATION_NUMBER"
"PASSPORT_NUMBER"
"PENSION_FUND_ID"
"MEDICAL_INSURANCE_ID"
"CNPJ"
"CPF"
"PAN"
"NATIONAL_ID_CARD"

List of owners in the account. There should be only one primary account owner which is mentioned in their role_type.

An array of individual_owner objects.

namesobject<person_name>[]Optional

The name of the person.

Items0 <= length <= 5

addressesobject<person_address_detail>[]Optional

The list of addresses associated with the person.

Items0 <= length <= 5

person_address_detail properties

11 properties

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

address_detailsobject<address_details>Optional

phonesobject<person_phone_detail>[]Optional

The list of phone numbers associated with the person.

Items0 <= length <= 5

documentsobject<person_document>[]Optional

A person's or party's related document data collected from the customer. For example SSN, ITIN, or business registration number collected from the user.

Note: This field is not applicable for POST [/v2/customer/partner-referrals](/docs/api/partner-referrals/v2/#partner-referrals_create) API calls.

Items0 <= length <= 20

person_document properties

10 properties

filesobject<file_reference>[]Optional

The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.

Items1 <= length <= 50

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

typeenum<person_document_type>Optional

The actual type of the document. It could be `ID_CARD`, `PASSPORT`, etc.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SOCIAL_SECURITY_NUMBER"
"EMPLOYMENT_IDENTIFICATION_NUMBER"
"TAX_IDENTIFICATION_NUMBER"
"PASSPORT_NUMBER"
"PENSION_FUND_ID"
"MEDICAL_INSURANCE_ID"
"CNPJ"
"CPF"
"PAN"
"NATIONAL_ID_CARD"

individual_owner_list

person_name properties

person_address_detail properties

address_details properties

person_phone_detail properties

birth_details properties

person_document properties

file_reference properties

link_description properties

Back to top

On this page

On this page

individual_owner_list

person_name properties

person_address_detail properties

address_details properties

person_phone_detail properties

birth_details properties

person_document properties

file_reference properties

link_description properties

Back to top

On this page

individual_owner_list

person_name properties

person_address_detail properties

address_details properties

person_phone_detail properties

birth_details properties

person_document properties

file_reference properties

link_description properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

individual_owner_list

person_name properties

person_address_detail properties

address_details properties

person_phone_detail properties

birth_details properties

person_document properties

file_reference properties

link_description properties

Back to top

On this page