On this page
No Headings
Individual beneficial owners.
arrayitemsobjectDetails of the person or party.
The individual owner of the account.
idstring^[0-9A-Z]+$The encrypted party ID.
namesarrayThe name of the person.
itemsobjectThe name of the party.
The name of the person.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
full_namestringWhen the party is a person, the party's full name.
typerequiredstring"LEGAL"^[0-9A-Z_]+$The type of name. Currently supported values are: LEGAL.
citizenshipstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The citizenship country code of the person.
addressesarrayThe list of addresses associated with the person.
itemsobjectThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
A simple postal address with coarse-grained fields.
address_line_1stringThe first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2stringThe second line of the address. For example, suite or apartment number.
address_line_3stringThe third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
admin_area_4stringThe neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
admin_area_3stringA sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
admin_area_2stringA city, town, or village. Smaller than admin_area_level_1.
admin_area_1stringThe highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_detailsobjectThe 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.
street_numberstringThe street number.
street_namestringThe street name. Just Drury in Drury Lane.
street_typestringThe street type. For example, avenue, boulevard, road, or expressway.
delivery_servicestringThe delivery service. Post office box, bag number, or post office name.
building_namestringA named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
sub_buildingstringThe first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
typerequiredstring"HOME"^[0-9A-Z_]+$The address type under which this is classified.
phonesarrayThe list of phone numbers associated with the person.
itemsobjectThe phone number in its canonical international E.164 numbering plan format.
The phone number, in its canonical international E.164 numbering plan format.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The type of phone number provided. For example, home, work, or mobile.
birth_detailsobjectThe person's birth details.
date_of_birthrequiredstringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$date of birth, fomrat Internet date and time format.
documentsarrayA 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 API calls.
itemsobjectThe document object.
The documents associated with the person.
idstring^[0-9A-Z]+$The encrypted identifier for the document.
labelsarrayThe document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
itemsstringA document label.
namestring^[0-9A-Za-z_-]+$The file name.
identification_numberstring^[a-zA-Z0-9-]+$The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.
issue_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The issue date of the document.
expiry_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The expire data of the document.
issuing_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The country code of the document.
filesarrayThe files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
itemsobjectThe file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
idstringThe ID of the referenced file.
reference_urlstringuriThe reference URL for the file.
create_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the file was created, in Internet date and time format.
sizestring^[0-9]+$The size of the file, in bytes.
linksarrayThe HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
typestring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "NATIONAL_ID_CARD"^[0-9A-Z_]+$The actual type of the document. It could be ID_CARD, PASSPORT, etc.
percentage_of_ownershipstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage of shares this person owns in the company.