Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Account

Common account object to hold the account related details of the customer.

individual_ownersobject<individual_owner>[]Optional

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

Items0 <= length <= 2

individual_owner properties

8 properties

idstringOptional

The encrypted party ID.

Match^[0-9A-Z]+$Length1 <= length <= 20

namesobject<person_name>[]Optional

The name of the person.

Items0 <= length <= 5

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Length0 <= length <= 140

surnamestringOptional

When 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.

Length0 <= length <= 140

middle_namestringOptional

When 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.

Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Length0 <= length <= 300

typeenum<person_name_type>Required

The type of name. Currently supported values are: `LEGAL`.

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

Allowed values

"LEGAL"

citizenshipstring<country_code>Optional

The citizenship country code of the person.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

addressesobject<person_address_detail>[]Optional

The list of addresses associated with the person.

Items0 <= length <= 5

person_address_detail properties

11 properties

address_line_1stringOptional

The 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.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The 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.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The 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:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

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

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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`.

address_details properties

6 properties

street_numberstringOptional

The street number.

Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Length0 <= length <= 100

building_namestringOptional

A 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.

Length0 <= length <= 100

sub_buildingstringOptional

The 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.

Length0 <= length <= 100

typeenum<person_address_type>Required

The address type under which this is classified.

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

Allowed values

"HOME"

phonesobject<person_phone_detail>[]Optional

The list of phone numbers associated with the person.

Items0 <= length <= 5

person_phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

typeenum<phone_type>Required

The type of phone number provided. For example, home, work, or mobile.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

birth_detailsobject<birth_details>Optional

The person's birth details.

birth_details properties

1 property

date_of_birthstring<date_no_time>Required

date of birth, fomrat [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

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

idstringOptional

The encrypted identifier for the document.

Match^[0-9A-Z]+$Length1 <= length <= 20

labelsarray<labels>Optional

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as `BILL DOCUMENT` and `UTILITY DOCUMENT`.

Items1 <= length <= 50

namestringOptional

The file name.

Match^[0-9A-Za-z_-]+$Length1 <= length <= 100

identification_numberstringOptional

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.

Match^[a-zA-Z0-9-]+$Length1 <= length <= 100

issue_datestring<date_no_time>Optional

The issue date of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

expiry_datestring<date_no_time>Optional

The expire data of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

issuing_country_codestring<country_code>Optional

The country code of the document.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

create_timestring<date_time>Optional

The date and time when the file was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

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"

typeenum<individual_owner_type>Optional

The actual role of this user on the account, PRIMARY/SECONDARY.

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

Allowed values

"PRIMARY"

business_entityobject<business_entity>Optional

Business entity of the account.

business_entity properties

15 properties

business_typeobject<business_type_info>Optional

Information related to the business like the nature of business, started date etc.

business_type_info properties

2 properties

typeenum<business_type>Optional

Type of business entity like corporation, sole prop, governmental.

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

Allowed values

"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"

subtypeenum<business_sub_type>Optional

The sub classification of the business type.

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

Allowed values

"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"

business_industryobject<business_industry>Optional

Information related to the business like the nature of business, started date etc.

business_industry properties

3 properties

categorystringRequired

The customer's business category code. PayPal uses industry standard seller category codes.

Match^\d+$Length1 <= length <= 20

mcc_codestringRequired

The customer's business seller category code. PayPal uses industry standard seller category codes.

Match^\d+$Length1 <= length <= 20

subcategorystringRequired

The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.

Match^\d+$Length1 <= length <= 20

business_incorporationobject<Business_incorporation>Optional

Business incorporation information.

Business_incorporation properties

2 properties

incorporation_country_codestring<country_code>Optional

The incorporation country code.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

incorporation_datestring<date_no_time>Optional

date of incorporation

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

namesobject<business_name_detail>[]Optional

Name of the business.

Items0 <= length <= 5

business_name_detail properties

2 properties

business_namestringOptional

Required. The business name of the party.

Length0 <= length <= 300

typeenum<business_name_type>Required

The type of business name. For example, trading name.

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

Allowed values

"DOING_BUSINESS_AS"
"LEGAL_NAME"

emailsobject<email>[]Optional

Email addresses of the business.

Items0 <= length <= 5

email properties

2 properties

typeenumRequired

The role of the email address.

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

Allowed values

"CUSTOMER_SERVICE"

emailstring<email_address>Required

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.

Match^.+@[^"\-].+$Formatppaas_common_email_address_v2Length3 <= length <= 254

websitestringOptional

Website of the business.

FormaturiLength1 <= length <= 50

addressesobject<business_address_detail>[]Optional

List of addresses associated with the business entity.

Items0 <= length <= 5

business_address_detail properties

11 properties

address_line_1stringOptional

The 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.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The 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.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The 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:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

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

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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`.

address_details properties

6 properties

street_numberstringOptional

The street number.

Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Length0 <= length <= 100

building_namestringOptional

A 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.

Length0 <= length <= 100

sub_buildingstringOptional

The 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.

Length0 <= length <= 100

typeenum<business_address_type>Required

The address type under which this is classified. For example, shipping or dropoff.

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

Allowed values

"WORK"

phonesobject<business_phone_detail>[]Optional

List of phone number associated with the business.

Items0 <= length <= 5

business_phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

typeenum<business_phone_type>Required

The type of phone number provided. For example, home, work, or mobile.

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

Allowed values

"CUSTOMER_SERVICE"
"BUSINESS"

documentsobject<business_document>[]Optional

Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

Items0 <= length <= 20

business_document properties

10 properties

idstringOptional

The encrypted identifier for the document.

Match^[0-9A-Z]+$Length1 <= length <= 20

labelsarray<labels>Optional

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as `BILL DOCUMENT` and `UTILITY DOCUMENT`.

Items1 <= length <= 50

namestringOptional

The file name.

Match^[0-9A-Za-z_-]+$Length1 <= length <= 100

identification_numberstringOptional

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.

Match^[a-zA-Z0-9-]+$Length1 <= length <= 100

issue_datestring<date_no_time>Optional

The issue date of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

expiry_datestring<date_no_time>Optional

The expire data of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

issuing_country_codestring<country_code>Optional

The country code of the document.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

create_timestring<date_time>Optional

The date and time when the file was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

typeenum<business_document_type>Optional

The actual type of the document.

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"
"BUSINESS_REGISTRATION"

beneficial_ownersobject<beneficial_owners>Optional

List of beneficial owners part of the entity. They can be either a Person or a business entity.

beneficial_owners properties

2 properties

individual_beneficial_ownersobject<individual_beneficial_owner>[]Optional

Individual beneficial owners.

Items0 <= length <= 5

individual_beneficial_owner properties

8 properties

idstringOptional

The encrypted party ID.

Match^[0-9A-Z]+$Length1 <= length <= 20

namesobject<person_name>[]Optional

The name of the person.

Items0 <= length <= 5

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Length0 <= length <= 140

surnamestringOptional

When 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.

Length0 <= length <= 140

middle_namestringOptional

When 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.

Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Length0 <= length <= 300

typeenum<person_name_type>Required

The type of name. Currently supported values are: `LEGAL`.

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

Allowed values

"LEGAL"

citizenshipstring<country_code>Optional

The citizenship country code of the person.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

addressesobject<person_address_detail>[]Optional

The list of addresses associated with the person.

Items0 <= length <= 5

person_address_detail properties

11 properties

address_line_1stringOptional

The 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.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The 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.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The 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:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

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

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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`.

address_details properties

6 properties

street_numberstringOptional

The street number.

Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Length0 <= length <= 100

building_namestringOptional

A 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.

Length0 <= length <= 100

sub_buildingstringOptional

The 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.

Length0 <= length <= 100

typeenum<person_address_type>Required

The address type under which this is classified.

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

Allowed values

"HOME"

phonesobject<person_phone_detail>[]Optional

The list of phone numbers associated with the person.

Items0 <= length <= 5

person_phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

typeenum<phone_type>Required

The type of phone number provided. For example, home, work, or mobile.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

birth_detailsobject<birth_details>Optional

The person's birth details.

birth_details properties

1 property

date_of_birthstring<date_no_time>Required

date of birth, fomrat [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

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

idstringOptional

The encrypted identifier for the document.

Match^[0-9A-Z]+$Length1 <= length <= 20

labelsarray<labels>Optional

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as `BILL DOCUMENT` and `UTILITY DOCUMENT`.

Items1 <= length <= 50

namestringOptional

The file name.

Match^[0-9A-Za-z_-]+$Length1 <= length <= 100

identification_numberstringOptional

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.

Match^[a-zA-Z0-9-]+$Length1 <= length <= 100

issue_datestring<date_no_time>Optional

The issue date of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

expiry_datestring<date_no_time>Optional

The expire data of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

issuing_country_codestring<country_code>Optional

The country code of the document.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

create_timestring<date_time>Optional

The date and time when the file was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

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"

percentage_of_ownershipstring<percentage>Optional

The percentage of shares this person owns in the company.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Formatppaas_common_percentage_v2

business_beneficial_ownersobject<business_beneficial_owner>[]Optional

Business beneficial owners.

Items0 <= length <= 5

business_beneficial_owner properties

10 properties

business_typeobject<business_type_info>Optional

Information related to the business like the nature of business, started date etc.

business_type_info properties

2 properties

typeenum<business_type>Optional

Type of business entity like corporation, sole prop, governmental.

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

Allowed values

"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"

subtypeenum<business_sub_type>Optional

The sub classification of the business type.

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

Allowed values

"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"

business_industryobject<business_industry>Optional

Information related to the business like the nature of business, started date etc.

business_industry properties

3 properties

categorystringRequired

The customer's business category code. PayPal uses industry standard seller category codes.

Match^\d+$Length1 <= length <= 20

mcc_codestringRequired

The customer's business seller category code. PayPal uses industry standard seller category codes.

Match^\d+$Length1 <= length <= 20

subcategorystringRequired

The customer's business subcategory code. PayPal uses industry standard seller subcategory codes.

Match^\d+$Length1 <= length <= 20

business_incorporationobject<Business_incorporation>Optional

Business incorporation information.

Business_incorporation properties

2 properties

incorporation_country_codestring<country_code>Optional

The incorporation country code.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

incorporation_datestring<date_no_time>Optional

date of incorporation

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

namesobject<business_name_detail>[]Optional

Name of the business.

Items0 <= length <= 5

business_name_detail properties

2 properties

business_namestringOptional

Required. The business name of the party.

Length0 <= length <= 300

typeenum<business_name_type>Required

The type of business name. For example, trading name.

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

Allowed values

"DOING_BUSINESS_AS"
"LEGAL_NAME"

emailsobject<email>[]Optional

Email addresses of the business.

Items0 <= length <= 5

email properties

2 properties

typeenumRequired

The role of the email address.

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

Allowed values

"CUSTOMER_SERVICE"

emailstring<email_address>Required

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.

Match^.+@[^"\-].+$Formatppaas_common_email_address_v2Length3 <= length <= 254

websitestringOptional

Website of the business.

FormaturiLength1 <= length <= 50

addressesobject<business_address_detail>[]Optional

List of addresses associated with the business entity.

Items0 <= length <= 5

business_address_detail properties

11 properties

address_line_1stringOptional

The 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.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The 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.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The 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:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

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

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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`.

address_details properties

6 properties

street_numberstringOptional

The street number.

Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Length0 <= length <= 100

building_namestringOptional

A 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.

Length0 <= length <= 100

sub_buildingstringOptional

The 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.

Length0 <= length <= 100

typeenum<business_address_type>Required

The address type under which this is classified. For example, shipping or dropoff.

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

Allowed values

"WORK"

phonesobject<business_phone_detail>[]Optional

List of phone number associated with the business.

Items0 <= length <= 5

business_phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

typeenum<business_phone_type>Required

The type of phone number provided. For example, home, work, or mobile.

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

Allowed values

"CUSTOMER_SERVICE"
"BUSINESS"

documentsobject<business_document>[]Optional

Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.

Items0 <= length <= 20

business_document properties

10 properties

idstringOptional

The encrypted identifier for the document.

Match^[0-9A-Z]+$Length1 <= length <= 20

labelsarray<labels>Optional

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as `BILL DOCUMENT` and `UTILITY DOCUMENT`.

Items1 <= length <= 50

namestringOptional

The file name.

Match^[0-9A-Za-z_-]+$Length1 <= length <= 100

identification_numberstringOptional

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.

Match^[a-zA-Z0-9-]+$Length1 <= length <= 100

issue_datestring<date_no_time>Optional

The issue date of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

expiry_datestring<date_no_time>Optional

The expire data of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

issuing_country_codestring<country_code>Optional

The country code of the document.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

create_timestring<date_time>Optional

The date and time when the file was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

typeenum<business_document_type>Optional

The actual type of the document.

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"
"BUSINESS_REGISTRATION"

percentage_of_ownershipstring<percentage>Optional

The percentage of shares this person owns in the company.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Formatppaas_common_percentage_v2

office_bearersobject<office_bearer>[]Optional

List of Directors present as part of the business entity.

Items0 <= length <= 5

office_bearer properties

8 properties

idstringOptional

The encrypted party ID.

Match^[0-9A-Z]+$Length1 <= length <= 20

namesobject<person_name>[]Optional

The name of the person.

Items0 <= length <= 5

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Length0 <= length <= 140

surnamestringOptional

When 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.

Length0 <= length <= 140

middle_namestringOptional

When 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.

Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Length0 <= length <= 300

typeenum<person_name_type>Required

The type of name. Currently supported values are: `LEGAL`.

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

Allowed values

"LEGAL"

citizenshipstring<country_code>Optional

The citizenship country code of the person.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

addressesobject<person_address_detail>[]Optional

The list of addresses associated with the person.

Items0 <= length <= 5

person_address_detail properties

11 properties

address_line_1stringOptional

The 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.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The 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.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The 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:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

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

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/docs/api/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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`.

address_details properties

6 properties

street_numberstringOptional

The street number.

Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Length0 <= length <= 100

building_namestringOptional

A 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.

Length0 <= length <= 100

sub_buildingstringOptional

The 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.

Length0 <= length <= 100

typeenum<person_address_type>Required

The address type under which this is classified.

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

Allowed values

"HOME"

phonesobject<person_phone_detail>[]Optional

The list of phone numbers associated with the person.

Items0 <= length <= 5

person_phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

typeenum<phone_type>Required

The type of phone number provided. For example, home, work, or mobile.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

birth_detailsobject<birth_details>Optional

The person's birth details.

birth_details properties

1 property

date_of_birthstring<date_no_time>Required

date of birth, fomrat [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

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

idstringOptional

The encrypted identifier for the document.

Match^[0-9A-Z]+$Length1 <= length <= 20

labelsarray<labels>Optional

The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as `BILL DOCUMENT` and `UTILITY DOCUMENT`.

Items1 <= length <= 50

namestringOptional

The file name.

Match^[0-9A-Za-z_-]+$Length1 <= length <= 100

identification_numberstringOptional

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.

Match^[a-zA-Z0-9-]+$Length1 <= length <= 100

issue_datestring<date_no_time>Optional

The issue date of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

expiry_datestring<date_no_time>Optional

The expire data of the document.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

issuing_country_codestring<country_code>Optional

The country code of the document.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

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

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

create_timestring<date_time>Optional

The date and time when the file was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[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})$Formatppaas_date_time_v3Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$

linksobject<link_description>[]Optional

The HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

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"

roleenum<office_bearer_role>Optional

The role of the office bearer in the company.

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

Allowed values

"CEO"
"CHAIRMAN"
"DIRECTOR"
"SECRETARY"
"TREASURER"
"TRUSTEE"

annual_sales_volume_rangeobject<currency_range>Optional

The range for the total annual sales volume of the business.

currency_range properties

2 properties

minimum_amountobject<money>Optional

The minimum inclusive amount for the range.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

maximum_amountobject<money>Optional

The maximum inclusive amount for the range.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

average_monthly_volume_rangeobject<currency_range>Optional

The range for the average monthly volume of the business.

currency_range properties

2 properties

minimum_amountobject<money>Optional

The minimum inclusive amount for the range.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

maximum_amountobject<money>Optional

The maximum inclusive amount for the range.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

purpose_codeOptional

The account's purpose code.

business_descriptionstringOptional

The business goals description. For example, a mission statement.

Length1 <= length <= 256

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

Account

individual_owner properties

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

business_entity properties

business_type_info properties

business_industry properties

Business_incorporation properties

business_name_detail properties

email properties

business_address_detail properties

address_details properties

business_phone_detail properties

business_document properties

file_reference properties

link_description properties

beneficial_owners properties

individual_beneficial_owner properties

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

business_beneficial_owner properties

business_type_info properties

business_industry properties

Business_incorporation properties

business_name_detail properties

email properties

business_address_detail properties

address_details properties

business_phone_detail properties

business_document properties

file_reference properties

link_description properties

office_bearer properties

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

currency_range properties

money properties

money properties

currency_range properties

money properties

money properties

Back to top

On this page