On this page
No Headings
The customer's business details.
objectphone_contactsarrayAn array of phone contacts for the business.
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.
business_addressobjectThe address of the business.
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.
business_typestringThe type of business.
itemsstring"INDIVIDUAL", "PROPRIETORSHIP", "PARTNERSHIP", "CORPORATION", "NONPROFIT", "GOVERNMENT", "GENERAL_PARTNERSHIP", "LIMITED_PARTNERSHIP", "LIMITED_LIABILITY_PARTNERSHIP", "PRIVATE_CORPORATION", "PUBLIC_CORPORATION", "PROPRIETORSHIP_CRAFTSMAN", "PUBLIC_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "PRIVATE_PARTNERSHIP", "PROPRIETARY_COMPANY", "PUBLIC_COMPANY", "ASSOCIATION", "REGISTERED_COOPERATIVE", "OTHER_CORPORATE_BODY", "ANY_OTHER_BUSINESS_ENTITY", "ONLY_BUY_OR_SEND_MONEY"The business type.
business_subtypestring"ASSO_TYPE_INCORPORATED", "ASSO_TYPE_NON_INCORPORATED", "GOVT_TYPE_ENTITY", "GOVT_TYPE_EMANATION", "GOVT_TYPE_ESTD_COMM", "GOVT_TYPE_ESTD_FC", "GOVT_TYPE_ESTD_ST_TR"^[0-9A-Z_]+$Sub classification of the business type.
categorystring^\d+$The customer's business category code. PayPal uses the industry standard seller category codes.
sub_categorystring^\d+$The customer's business subcategory code. PayPal uses the industry standard seller category codes.
merchant_category_codestring^\d+$The customer's business seller category code. PayPal uses the industry standard seller category codes.
purpose_codeThe account's purpose code.
itemsstring"P0104", "P0301", "P0801", "P0802", "P0803", "P0805", "P0806", "P0902", "P1004", "P1005", "P1006", "P1007", "P1008", "P1009"The purpose code. Required only for India. For more information, see the Reserve Bank Of India web site. Value is:
P0104. Cross border delivery of goods and services.P0301. Business related travel purchase.P0801. Hardware consulting.P0802. Software consulting.P0803. Data processing consulting.P0805. Freelance journalism.P0806. Other information services.P0902. Licensing revenues.P1004. Legal.P1005. Accounting and tax.P1006. Business and management consultancy.P1007. Advertising and market research.P1008. Research and development.P1009. Architectural services.namesarrayAn array of business names.
itemsobjectA name for the business. For example, the legal name or the stock-trading name.
typerequiredstring"LEGAL", "DOING_BUSINESS_AS", "STOCK_TRADING_NAME"The legal category of the business.
namerequiredstringThe business name.
business_descriptionstringThe business goals description. For example, a mission statement.
event_datesarrayAn array of event dates for the business.
itemsobjectThe date for an event type. Typically captured during onboarding.
event_typerequiredstring"BIRTH", "ESTABLISHED", "INCORPORATION", "OPERATION"The event type for an onboarding entity.
event_daterequiredstringdate-timeThe date portion of the date and time when the event occurred, in Internet date and time format. For accuracy, if you do not know the exact time zone, use the UTC time zone.
website_urlsarrayAn array of website URLs for the business.
itemsstringuriThe URL for the business website.
annual_sales_volume_rangeobjectThe range for the total annual sales volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
average_monthly_volume_rangeobjectThe range for the average monthly volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
identity_documentsarrayAn array of identity documents that uniquely identify the user. For example, 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.
email_contactsarrayAn array of contact email addresses for the company.
itemsobjectThe email address. Includes the role of the email address.
email_addressrequiredstringppaas_common_email_address_v2^.+@[^"\-].+$The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
rolerequiredstring"CUSTOMER_SERVICE"The role of the email address.
country_of_incorporationstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The country code of the country where the business was incorporated.
beneficial_ownersobjectList of beneficial owners part of the entity. They can be either a Person or a business entity.
individual_beneficial_ownersarrayIndividual beneficial owners.
itemsobjectThe individual owner 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 citizenship country code of the person
percentage_of_ownershipstringThe percentage of shares this person owns in the company.
business_beneficial_ownersarrayBusiness beneficial owners.
itemsobjectThe individual owner of the account.
namesarrayAn array of business names.
itemsobjectA name for the business. For example, the legal name or the stock-trading name.
typerequiredstring"LEGAL", "DOING_BUSINESS_AS", "STOCK_TRADING_NAME"The legal category of the business.
namerequiredstringThe business name.
phone_contactsarrayAn array of phone contacts for the business.
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.
business_addressobjectThe address of the business.
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.
business_typestringThe type of business.
itemsstring"INDIVIDUAL", "PROPRIETORSHIP", "PARTNERSHIP", "CORPORATION", "NONPROFIT", "GOVERNMENT", "GENERAL_PARTNERSHIP", "LIMITED_PARTNERSHIP", "LIMITED_LIABILITY_PARTNERSHIP", "PRIVATE_CORPORATION", "PUBLIC_CORPORATION", "PROPRIETORSHIP_CRAFTSMAN", "PUBLIC_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "PRIVATE_PARTNERSHIP", "PROPRIETARY_COMPANY", "PUBLIC_COMPANY", "ASSOCIATION", "REGISTERED_COOPERATIVE", "OTHER_CORPORATE_BODY", "ANY_OTHER_BUSINESS_ENTITY", "ONLY_BUY_OR_SEND_MONEY"The business type.
business_subtypestring"ASSO_TYPE_INCORPORATED", "ASSO_TYPE_NON_INCORPORATED", "GOVT_TYPE_ENTITY", "GOVT_TYPE_EMANATION", "GOVT_TYPE_ESTD_COMM", "GOVT_TYPE_ESTD_FC", "GOVT_TYPE_ESTD_ST_TR"^[0-9A-Z_]+$The sub classification of business type.
categorystring^\d+$The customer's business category code. PayPal uses the industry standard seller category codes.
sub_categorystring^\d+$The customer's business subcategory code. PayPal uses the industry standard seller category codes.
merchant_category_codestring^\d+$The customer's business seller category code. PayPal uses the industry standard seller category codes.
purpose_codeThe account's purpose code.
itemsstring"P0104", "P0301", "P0801", "P0802", "P0803", "P0805", "P0806", "P0902", "P1004", "P1005", "P1006", "P1007", "P1008", "P1009"The purpose code. Required only for India. For more information, see the Reserve Bank Of India web site. Value is:
P0104. Cross border delivery of goods and services.P0301. Business related travel purchase.P0801. Hardware consulting.P0802. Software consulting.P0803. Data processing consulting.P0805. Freelance journalism.P0806. Other information services.P0902. Licensing revenues.P1004. Legal.P1005. Accounting and tax.P1006. Business and management consultancy.P1007. Advertising and market research.P1008. Research and development.P1009. Architectural services.website_urlsarrayAn array of website URLs for the business.
itemsstringuriThe URL for the business website.
annual_sales_volume_rangeobjectThe range for the total annual sales volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
average_monthly_volume_rangeobjectThe range for the average monthly volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
maximum_amountobjectThe maximum inclusive amount for the range.
valuerequiredstringThe amount, up to N digits after the decimal separator. For currencies that do not support decimals, see currency codes.
percentage_of_ownershipstringThe percentage of shares this person owns in the company.
office_bearersarrayList of office bearers as part of the business entity.
itemsobjectDetails of the person party.
The office bearers 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 citizenship country code of the person
rolestring"CEO", "CHAIRMAN", "DIRECTOR", "SECRETARY", "TREASURER", "TRUSTEE"^[0-9A-Z_]+$The role of the person in the company.