On this page
No Headings
The customer's personal details.
objectemail_addressstringppaas_common_email_address_v2^.+@[^"\-].+$The primary email address of the account.
nameobjectThe legal name of the customer.
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.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
phone_contactsarrayAn array of contact phone numbers for the customer.
itemsobjectThe phone number and the phone type.
phone_number_detailsrequiredobjectThe phone number details.
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.
phone_typerequiredstring"FAX", "HOME", "MOBILE", "OTHER", "PAGER"The phone type.
home_addressobjectThe home address of the account holder.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_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.
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.
nationality_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO-3166-1 country code for the nationality of the account holder. Can include one of the PayPal-supported countries.
identity_documentsarrayAn array of documents that uniquely identify the user, such as a license number, social security number, and so on.
itemsobjectThe authority-issued identification document. Document types include a driver's license, social security number, employee ID number, and so on.
typerequiredstring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION"The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.
valuerequiredstring^[A-Za-z0-9]+$The identifier value, such as license number, social security number, and so on.
partial_valuerequiredbooleanfalseIndicates whether the value is a partial value. Specify this value when the identifier type supports a partial value, such as four SSN digits instead of the full nine values. Depending on the context, this parameter can be ignored.
issuer_country_coderequiredstring^[A-Z]([A-Z]|\d)$The two-character ISO-3166-1 country code for the country that issued the document.
account_owner_relationshipsarrayAn array of familial relationships that are attached to a seller.
itemsobjectThe familial relationship of the seller account owner.
namerequiredobjectThe name of the familial relation.
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.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
relationrequiredstring"MOTHER"The type of familial relationship.
country_code_of_nationalityrequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The nationality of the familial relation.