On this page
No Headings
The customer's referral data that partners share with PayPal.
objectindividual_ownersarrayList of owners in the account. There should be only one primary account owner which is mentioned in their role_type.
itemsobjectDetails 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.
typestring"PRIMARY"^[0-9A-Z_]+$The actual role of this user on the account, PRIMARY/SECONDARY.
business_entityobjectBusiness entity of the account.
business_typeobjectInformation related to the business like the nature of business, started date etc.
typestring"ANY_OTHER_BUSINESS_ENTITY", "ASSOCIATION", "CORPORATION", "GENERAL_PARTNERSHIP", "GOVERNMENT", "INDIVIDUAL", "LIMITED_LIABILITY_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "NONPROFIT", "ONLY_BUY_OR_SEND_MONEY", "OTHER_CORPORATE_BODY", "PARTNERSHIP", "PRIVATE_PARTNERSHIP", "PROPRIETORSHIP", "PROPRIETORSHIP_CRAFTSMAN", "PROPRIETORY_COMPANY", "PRIVATE_CORPORATION", "PUBLIC_COMPANY", "PUBLIC_CORPORATION", "PUBLIC_PARTNERSHIP", "REGISTERED_COOPERATIVE"^[0-9A-Z_]+$Type of business entity like corporation, sole prop, governmental.
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 the business type.
business_industryobjectInformation related to the business like the nature of business, started date etc.
categoryrequiredstring^\d+$The customer's business category code. PayPal uses industry standard seller category codes.
mcc_coderequiredstring^\d+$The customer's business seller category code. PayPal uses industry standard seller category codes.
subcategoryrequiredstring^\d+$The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.
business_incorporationobjectBusiness incorporation information.
incorporation_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The incorporation country code.
incorporation_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$date of incorporation
namesarrayName of the business.
itemsobjectThe business name of the party.
Name of the business provided.
business_namestringRequired. The business name of the party.
typerequiredstring"DOING_BUSINESS_AS", "LEGAL_NAME"^[0-9A-Z_]+$The type of business name. For example, trading name.
emailsarrayEmail addresses of the business.
itemsobjectAn email address at which the person or business can be contacted.
typerequiredstring"CUSTOMER_SERVICE"^[0-9A-Z_]+$The role of the email address.
emailrequiredstringppaas_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.
websitestringuriWebsite of the business.
addressesarrayList of addresses associated with the business entity.
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"WORK"^[0-9A-Z_]+$The address type under which this is classified. For example, shipping or dropoff.
phonesarrayList of phone number associated with the business.
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"CUSTOMER_SERVICE", "BUSINESS"^[0-9A-Z_]+$The type of phone number provided. For example, home, work, or mobile.
documentsarrayBusiness Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
itemsobjectThe document object.
The documents associated with the business.
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", "BUSINESS_REGISTRATION"^[0-9A-Z_]+$The actual type of the document.
beneficial_ownersobjectList of beneficial owners part of the entity. They can be either a Person or a business entity.
individual_beneficial_ownersarrayIndividual beneficial owners.
itemsobjectDetails 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.
business_beneficial_ownersarrayBusiness beneficial owners.
itemsobjectThe business beneficial owner of the account.
business_typeobjectInformation related to the business like the nature of business, started date etc.
typestring"ANY_OTHER_BUSINESS_ENTITY", "ASSOCIATION", "CORPORATION", "GENERAL_PARTNERSHIP", "GOVERNMENT", "INDIVIDUAL", "LIMITED_LIABILITY_PARTNERSHIP", "LIMITED_LIABILITY_PROPRIETORS", "LIMITED_LIABILITY_PRIVATE_CORPORATION", "LIMITED_PARTNERSHIP", "LIMITED_PARTNERSHIP_PRIVATE_CORPORATION", "NONPROFIT", "ONLY_BUY_OR_SEND_MONEY", "OTHER_CORPORATE_BODY", "PARTNERSHIP", "PRIVATE_PARTNERSHIP", "PROPRIETORSHIP", "PROPRIETORSHIP_CRAFTSMAN", "PROPRIETORY_COMPANY", "PRIVATE_CORPORATION", "PUBLIC_COMPANY", "PUBLIC_CORPORATION", "PUBLIC_PARTNERSHIP", "REGISTERED_COOPERATIVE"^[0-9A-Z_]+$Type of business entity like corporation, sole prop, governmental.
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 the business type.
business_industryobjectInformation related to the business like the nature of business, started date etc.
categoryrequiredstring^\d+$The customer's business category code. PayPal uses industry standard seller category codes.
mcc_coderequiredstring^\d+$The customer's business seller category code. PayPal uses industry standard seller category codes.
subcategoryrequiredstring^\d+$The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.
business_incorporationobjectBusiness incorporation information.
incorporation_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The incorporation country code.
incorporation_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$date of incorporation
namesarrayName of the business.
itemsobjectThe business name of the party.
Name of the business provided.
business_namestringRequired. The business name of the party.
typerequiredstring"DOING_BUSINESS_AS", "LEGAL_NAME"^[0-9A-Z_]+$The type of business name. For example, trading name.
emailsarrayEmail addresses of the business.
itemsobjectAn email address at which the person or business can be contacted.
typerequiredstring"CUSTOMER_SERVICE"^[0-9A-Z_]+$The role of the email address.
emailrequiredstringppaas_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.
websitestringuriWebsite of the business.
addressesarrayList of addresses associated with the business entity.
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"WORK"^[0-9A-Z_]+$The address type under which this is classified. For example, shipping or dropoff.
phonesarrayList of phone number associated with the business.
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"CUSTOMER_SERVICE", "BUSINESS"^[0-9A-Z_]+$The type of phone number provided. For example, home, work, or mobile.
documentsarrayBusiness Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
itemsobjectThe document object.
The documents associated with the business.
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", "BUSINESS_REGISTRATION"^[0-9A-Z_]+$The actual type of the document.
percentage_of_ownershipstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage of shares this person owns in the company.
office_bearersannual_sales_volume_rangeobjectThe range for the total annual sales volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.maximum_amountobjectThe maximum inclusive amount for the range.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.average_monthly_volume_rangeobjectThe range for the average monthly volume of the business.
minimum_amountobjectThe minimum inclusive amount for the range.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.maximum_amountobjectThe maximum inclusive amount for the range.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.purpose_codeThe account's purpose code.
itemsstring"P0104", "P0301", "P0801", "P0802", "P0803", "P0805", "P0806", "P0902", "P1004", "P1005", "P1006", "P1007", "P1008", "P1009"^[a-zA-Z0-9]([a-zA-Z0-9_ ])+$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.business_descriptionstringThe business goals description. For example, a mission statement.
emailstringppaas_common_email_address_v2^.+@[^"\-].+$Email address of the customer used to create the account.
preferred_language_codestringppaas_common_language_v3^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$The preferred locale code to use in the onboarding flow for the customer.
tracking_idstringThe partner's unique identifier for this customer in their system which can be used to track user in PayPal.
partner_config_overrideobjectThe configuration property that the partner intends to override for this onboarding request.
return_urlstringuriThe URL to which to redirect the customer upon completion of the onboarding process.
return_url_descriptionstring^.+$The description of the return URL.
show_add_credit_cardbooleanIndicates whether to show an add credit card page.
financial_instrumentsobjectArray of financial instruments attached to the customer's account.
banksarrayAn array of banks attached to this managed account.
itemsobjectThe bank account information.
nick_namestring^[0-9A-Za-z_-]+$The user-provided short name for the user's bank account.
account_numberrequiredstring\d+The bank account number.
account_typerequiredstring"CHECKING", "SAVINGS"^[0-9A-Z_]+$The type of bank account.
currency_codestringppaas_common_currency_code_v2The primary currency code of the bank account.
identifiersarrayAn array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:
itemsobjectThe bank account ID. An ID with ROUTING_NUMBER_1 is required.
typestring"BANK_CODE", "BI_CODE", "BRANCH_CODE", "ROUTING_NUMBER_1", "ROUTING_NUMBER_2", "ROUTING_NUMBER_3", "SWIFT_CODE", "BRANCH_CODE", "INTERMEDIARY_SWIFT_CODE", "BBAN", "BBAN_ENCRYPTED", "BBAN_HMAC", "AGGREGATOR_YODLEE"^[0-9A-Z_-]+$The bank account ID type.
valuestring^[A-Za-z0-9-_.+/ =]+The value of account identifier.
branch_locationobjectThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
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.
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.
mandateobjectMandate for this bank account.
acceptedrequiredbooleanWhether mandate was accepted or not.
operationsarrayAn array of operations to perform for the customer while they share their data.
itemsobjectThe required operation to share data.
operationrequiredstring"API_INTEGRATION", "BANK_ADDITION", "BILLING_AGREEMENT", "CONTEXTUAL_MARKETING_CONSENT", "OFFLINE_ONBOARDING", "SALESFORCE_REFERRAL"^[0-9A-Z_-]+$The operation to enable for the customer. To enable the collection of the API permissions that you require to integrate with the customer, specify API_INTEGRATION. BANK_ADDITION is supported only for the US.
api_integration_preferenceobjectThe integration details for the partner and customer relationship. Required if operation is API_INTEGRATION.
classic_api_integrationobjectThe integration details for PayPal CLASSIC endpoints.
rest_api_integrationobjectThe integration details for PayPal REST endpoints.
integration_methodstring"BRAINTREE", "PAYPAL", "SDK"^[0-9A-Z_-]+$"PAYPAL"The REST-credential integration method.
integration_channelstring"DEFERRED_ONBOARDING"^[A-Z0-9_]+$The rest api integration channel.
integration_typerequiredstring"FIRST_PARTY", "THIRD_PARTY"^[0-9A-Z_-]+$The type of REST-endpoint integration. To integrate with Braintree v.zero for PayPal REST endpoints, specify third_party_details.
first_party_detailsobjectThe integration details for PayPal first party REST endpoints.
featuresrequiredarrayAn array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.
itemsstring"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"^[0-9A-Z_-]+$The REST endpoint.
seller_noncerequiredstring^[a-zA-Z0-9-_:]+$S256 - The code verifier must be high-entropy cryptographic random string with a byte length of 43-128 range.
third_party_detailsobjectThe integration details for PayPal REST endpoints.
featuresarrayAn array of features that partner can access, or use, in PayPal on behalf of the seller. The seller grants permission for these features to the partner.
itemsstring"PAYOUTS", "PAYMENT", "REFUND", "FUTURE_PAYMENT", "DIRECT_PAYMENT", "PARTNER_FEE", "DELAY_FUNDS_DISBURSEMENT", "READ_SELLER_DISPUTE", "UPDATE_SELLER_DISPUTE", "ADVANCED_TRANSACTIONS_SEARCH", "SWEEP_FUNDS_EXTERNAL_SINK", "ACCESS_MERCHANT_INFORMATION", "TRACKING_SHIPMENT_READWRITE", "INVOICE_READ_WRITE", "DISPUTE_READ_BUYER", "UPDATE_CUSTOMER_DISPUTES", "VAULT", "BILLING_AGREEMENT", "WITHDRAWALS", "LINKED_FINANCIAL_INSTRUMENTS", "USER_PROFILE", "TRANSACTION_RISK_DATA", "PAYPAL_BALANCE", "EXCHANGE_CURRENCY", "SCREEN_CONTENT", "SCREEN_CONTENT_DECISIONS", "MEDIA_INVALIDATE_CACHE_READWRITE", "MEDIA_DIGITALASSETS_READWRITE", "MEDIA_DIGITALASSETS_DELETE", "COMMERCE_ADMIN"^[0-9A-Z_-]+$The REST endpoint.
signup_modestring"VERIFY_WITH_PAYPAL"Signup Mode to be used for sellers for third party integration.
organizationstring^.*$The organization to which the account will belong in the partner’s hierarchy, as a path.
offline_onboarding_preferenceobjectThe preference details for offline onboarding without UI.
billing_agreementobjectThe details of the billing agreement between the partner and a seller.
descriptionstring^.+$The billing agreement description.
billing_experience_preferenceobjectThe preference that customizes the billing experience of the customer.
experience_idstring^[a-zA-Z0-9-]+$The ID of the payment web experience profile.
billing_context_setbooleanIndicates whether the partner has already displayed the billing context to the seller.
merchant_custom_datastring^[a-zA-Z0-9-]+$The custom data for the billing agreement.
approval_urlstringuriThe URL to which to redirect seller to accept the billing agreement.
ec_tokenstring^[0-9A-Z_-]+$The billing agreement token for the agreement.
productsarrayAn array of PayPal products to which the partner wants to onboard the customer.
itemsstring"ALIPAY", "BANCONTACT", "BLIK", "EPS", "PPCP", "EXPRESS_CHECKOUT", "PAYMENT_METHODS", "ADVANCED_VAULTING", "IDEAL", "MB_WAY", "MULTIBANCO", "PAYPAL_COMMERCE_PLATFORM_BUSINESS", "PPPLUS", "PRZELEWY24", "SATISPAY", "TRUSTLY", "WECHAT_PAY", "WEBSITE_PAYMENT_PRO", "ZETTLE", "PAYPAL_COMMERCE_PLATFORM_BUSINESS", "HYPERWALLET_PAYOUTS", "CRYPTO_PYMTS"^[0-9A-Z_-]+$The PayPal product for which the customer is onboarded.
capabilitiesarrayAn array of capabilities which the partner wants to enable for the selected products. Supported only when products are specified.
itemsstring"PAYPAL_WALLET_VAULTING_ADVANCED", "PAY_UPON_INVOICE", "APPLE_PAY", "GOOGLE_PAY"^[A-Z0-9_]+$Optional capabilities of the selected PayPal product for which the customer is being onboarded.
outside_process_dependenciesarrayAn array of dependent processes.
itemslegal_consentsarrayAn array of all consents that the partner has received from this seller. If SHARE_DATA_CONSENT is not granted, PayPal does not store customer data.
itemsobjectThe customer-provided consent.
typerequiredstring"SHARE_DATA_CONSENT"^[0-9A-Z_-]+$The type of consent. SHARE_DATA_CONSENT gives consent to you to share your customer's data with PayPal.
grantedrequiredbooleanIndicates whether the customer agreed to share this type of data. To give consent, specify true. To withhold consent, specify false.
payout_attributesobjectPayout specific attributes.
marketplacebooleanIf true, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.
kyc_requiredbooleanIf true, specifies that the Kyc is required for the merchant.
country_transfer_method_currency_selectionarrayRequested country, transfer method and currency.
itemsobjectRequested country, transfer method and currency.
countrystringppaas_common_country_code_v2^([A-Z]{2}|C2)$Country.
transfer_methodsarrayRequested transfer method and currency for a country.
itemsobjectRequested transfer method and currency for a country.
transfer_method_typestring"BANK_ACCOUNT", "PAYPAL", "VENMO", "WIRE_ACCOUNT"^[0-9A-Z_-]+$Transfer Method type.
currenciesarrayRequested Currencies for a Transfer Method.
itemsstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
legal_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$Legal Country Code.