Use the Partner Referrals API to add PayPal seller accounts to PayPal Complete Payments Platform for Marketplaces and Platforms.
Important: This endpoint is available to approved partners only. Fill out this form to get approved and a PayPal representative will reach out to you shortly.For more information about partner integrations and onboarding sellers, see PayPal Complete Payments Platform for Marketplaces and Platforms.
Creates a partner referral that is shared by the partner or API caller. The partner referral is used to onboard the seller, and contains the seller's personal, business, financial and operations.
Array of objects (Individual_owner) [ 0 .. 2 ] items List of owners in the account. There should be only one primary account owner which is mentioned in their role_type. | |||||||||||||||||||
object (Business_entity) Business entity of the account. | |||||||||||||||||||
tracking_id | string [ 1 .. 127 ] characters The partner's unique identifier for this customer in their system which can be used to track user in PayPal. | ||||||||||||||||||
required | Array of objects (operation) [ 1 .. 5 ] items An array of operations to perform for the customer while they share their data. | ||||||||||||||||||
products | Array of strings (product_name) [ 1 .. 5 ] items An array of PayPal products to which the partner wants to onboard the customer.
| ||||||||||||||||||
capabilities | Array of strings (capability_name) [ 1 .. 5 ] items An array of capabilities which the partner wants to enable for the selected products. Supported only when products are specified.
| ||||||||||||||||||
outside_process_dependencies | Array of any [ 1 .. 5 ] items An array of dependent processes. | ||||||||||||||||||
required | Array of objects (legal_consent) [ 1 .. 5 ] items An array of all consents that the partner has received from this seller. If | ||||||||||||||||||
string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^.+@[^"\-].+$ Email address of the customer used to create the account. | |||||||||||||||||||
preferred_language_code | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))... The preferred locale code to use in the onboarding flow for the customer. | ||||||||||||||||||
object (partner_configuration_override) The configuration property that the partner intends to override for this onboarding request. | |||||||||||||||||||
object (Financial instrument.) Array of financial instruments attached to the customer's account. | |||||||||||||||||||
object (Payout Attributes) Payout specific attributes. | |||||||||||||||||||
property name* additional property | any |
A successful request returns the HTTP 201 Created
status code and a JSON response body that contains a HATEOAS link to show the referral data and an action_url
to which you redirect the customer in a browser to complete the signup process. The partner_referral_id
token is appended to the URL.
{- "email": "accountemail@example.com",
- "tracking_id": "testenterprices123122",
- "partner_config_override": {
- "return_url_description": "the url to return the merchant after the paypal onboarding process.",
- "show_add_credit_card": true
}, - "operations": [
- {
- "operation": "API_INTEGRATION",
- "api_integration_preference": {
- "rest_api_integration": {
- "integration_method": "PAYPAL",
- "integration_type": "THIRD_PARTY",
- "third_party_details": {
- "features": [
- "PAYMENT",
- "REFUND",
- "PARTNER_FEE"
]
}
}
}
}
], - "products": [
- "PAYMENT_METHODS"
], - "capabilities": [
- "APPLE_PAY"
], - "legal_consents": [
- {
- "type": "SHARE_DATA_CONSENT",
- "granted": true
}
]
}
{- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "action_url",
- "method": "GET"
}
]
}
Shows details by ID for referral data that was shared by the partner or API caller.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows referral data.
curl -v -X GET https://api-m.sandbox.paypal.com/v2/customer/partner-referrals/ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0= \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'
{- "partner_referral_id": "ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0=",
- "submitter_payer_id": "RFYUH2QQDGUQU",
- "referral_data": {
- "individual_owners": [
- {
- "names": [
- {
- "prefix": "Mr.",
- "given_name": "John",
- "surname": "Doe",
- "middle_name": "Middle",
- "suffix": "Jr.",
- "full_name": "John Middle Doe Jr.",
- "type": "LEGAL"
}
], - "citizenship": "US",
- "addresses": [
- {
- "address_line_1": "One Washington Square",
- "address_line_2": "Apt 123",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95112",
- "country_code": "US",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "1",
- "national_number": "6692468839",
- "extension_number": "1234",
- "type": "MOBILE"
}
], - "birth_details": {
- "date_of_birth": "1955-12-29"
}, - "type": "PRIMARY"
}
], - "business_entity": {
- "business_type": {
- "type": "INDIVIDUAL",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "1004",
- "mcc_code": "8931",
- "subcategory": "2025"
}, - "business_incorporation": {
- "incorporation_country_code": "US",
- "incorporation_date": "1986-12-29"
}, - "names": [
- {
- "business_name": "Test Enterprise",
- "type": "LEGAL_NAME"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "customerservice@example.com"
}
], - "addresses": [
- {
- "address_line_1": "One Washington Square",
- "address_line_2": "Apt 123",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95112",
- "country_code": "US",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "1",
- "national_number": "6692478833",
- "extension_number": "1234",
- "type": "CUSTOMER_SERVICE"
}
], - "beneficial_owners": {
- "individual_beneficial_owners": [
- {
- "names": [
- {
- "prefix": "Mr.",
- "given_name": "John",
- "surname": "Doe",
- "middle_name": "Middle",
- "suffix": "Jr.",
- "full_name": "John Middle Doe Jr.",
- "type": "LEGAL"
}
], - "citizenship": "US",
- "addresses": [
- {
- "address_line_1": "One Washington Square",
- "address_line_2": "Apt 123",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95112",
- "country_code": "US",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "1",
- "national_number": "6692468839",
- "extension_number": "1234",
- "type": "MOBILE"
}
], - "birth_details": {
- "date_of_birth": "1955-12-29"
}, - "percentage_of_ownership": "50"
}
], - "business_beneficial_owners": [
- {
- "business_type": {
- "type": "INDIVIDUAL",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "1004",
- "mcc_code": "8931",
- "subcategory": "2025"
}, - "business_incorporation": {
- "incorporation_country_code": "US",
- "incorporation_date": "1986-12-29"
}, - "names": [
- {
- "business_name": "Test Enterprise",
- "type": "LEGAL_NAME"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "customerservice@example.com"
}
], - "addresses": [
- {
- "address_line_1": "One Washington Square",
- "address_line_2": "Apt 123",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95112",
- "country_code": "US",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "1",
- "national_number": "6692478833",
- "extension_number": "1234",
- "type": "CUSTOMER_SERVICE"
}
], - "percentage_of_ownership": "50"
}
]
}, - "office_bearers": [
- {
- "names": [
- {
- "prefix": "Mr.",
- "given_name": "John",
- "surname": "Doe",
- "middle_name": "Middle",
- "suffix": "Jr.",
- "full_name": "John Middle Doe Jr.",
- "type": "LEGAL"
}
], - "citizenship": "US",
- "addresses": [
- {
- "address_line_1": "One Washington Square",
- "address_line_2": "Apt 123",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95112",
- "country_code": "US",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "1",
- "national_number": "6692468839",
- "extension_number": "1234",
- "type": "MOBILE"
}
], - "birth_details": {
- "date_of_birth": "1955-12-29"
}, - "role": "DIRECTOR"
}
], - "annual_sales_volume_range": {
- "minimum_amount": {
- "currency_code": "USD",
- "value": "10000"
}, - "maximum_amount": {
- "currency_code": "USD",
- "value": "50000"
}
}, - "average_monthly_volume_range": {
- "minimum_amount": {
- "currency_code": "USD",
- "value": "1000"
}, - "maximum_amount": {
- "currency_code": "USD",
- "value": "50000"
}
}, - "purpose_code": "P0104"
}, - "email": "accountemail@example.com",
- "preferred_language_code": "en-US",
- "tracking_id": "testenterprices123122",
- "partner_config_override": {
- "return_url_description": "the url to return the merchant after the paypal onboarding process.",
- "show_add_credit_card": true
}, - "operations": [
- {
- "operation": "API_INTEGRATION",
- "api_integration_preference": {
- "classic_api_integration": {
- "integration_type": "THIRD_PARTY",
- "third_party_details": {
- "permissions": [
- "EXPRESS_CHECKOUT",
- "REFUND",
- "DIRECT_PAYMENT",
- "AUTH_CAPTURE",
- "BUTTON_MANAGER",
- "ACCOUNT_BALANCE",
- "TRANSACTION_DETAILS"
]
}, - "first_party_details": "CERTIFICATE"
}, - "rest_api_integration": {
- "integration_method": "PAYPAL",
- "integration_type": "THIRD_PARTY",
- "third_party_details": {
- "features": [
- "PAYMENT",
- "REFUND",
- "PARTNER_FEE"
]
}
}
}, - "billing_agreement": {
- "description": "Billing Agreement Description Field",
- "billing_experience_preference": {
- "experience_id": "string",
- "billing_context_set": true
}, - "merchant_custom_data": "PatnerMERCHANT23124",
- "approval_url": "wttps://www.paypal.com/agreements/approve?ba_token=BA-67944913LE886121E",
- "ec_token": "EC-1S970363DB536864M"
}
}
], - "products": [
- "EXPRESS_CHECKOUT"
], - "legal_consents": [
- {
- "type": "SHARE_DATA_CONSENT",
- "granted": true
}
], - "payout_attributes": {
- "marketplace": true,
- "kyc_required": true,
- "country_transfer_method_currency_selection": [
- {
- "country": "US",
- "transfer_methods": [
- {
- "transfer_method_type": "BANK_ACCOUNT",
- "currencies": [
- "USD, CAD"
]
}, - {
- "transfer_method_type": "PAYPAL"
}
]
}, - {
- "country": "CA",
- "transfer_methods": [
- {
- "transfer_method_type": "WIRE",
- "currencies": [
- "USD, CAD"
]
}, - {
- "transfer_method_type": "VENMO"
}
]
}
]
}
}, - "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "action_url",
- "method": "GET"
}
]
}
Common account object to hold the account related details of the customer.
Array of objects (Individual_owner) [ 0 .. 2 ] items List of owners in the account. There should be only one primary account owner which is mentioned in their role_type. | |
object (Business_entity) Business entity of the account. |
{- "individual_owners": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "type": "PRIMARY"
}
], - "business_entity": {
- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "office_bearers": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "role": "CEO"
}
], - "purpose_code": [
- "P0104"
], - "business_description": "string",
- "beneficial_owners": {
- "individual_beneficial_owners": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "percentage_of_ownership": "string"
}
], - "business_beneficial_owners": [
- {
- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "percentage_of_ownership": "string"
}
]
}, - "annual_sales_volume_range": {
- "minimum_amount": {
- "currency_code": "str",
- "value": "string"
}, - "maximum_amount": {
- "currency_code": "str",
- "value": "string"
}
}, - "average_monthly_volume_range": {
- "minimum_amount": {
- "currency_code": "str",
- "value": "string"
}, - "maximum_amount": {
- "currency_code": "str",
- "value": "string"
}
}
}
}
The bank account information.
nick_name | string [ 1 .. 50 ] characters ^[0-9A-Za-z_-]+$ The user-provided short name for the user's bank account. | ||||||
account_number required | string [ 1 .. 50 ] characters \d+ The bank account number. | ||||||
account_type required | string [ 1 .. 50 ] characters ^[0-9A-Z_]+$ The type of bank account.
| ||||||
Array of objects (Bank Account Identifier) [ 0 .. 20 ] items An array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:
| |||||||
currency_code | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The primary currency code of the bank account. | ||||||
object (Portable Postal Address (Medium-Grained)) The branch location, if applicable. | |||||||
object (Mandate) Mandate for this bank account. |
{- "nick_name": "string",
- "account_number": "string",
- "account_type": "CHECKING",
- "identifiers": [
- {
- "type": "BANK_CODE",
- "value": "string"
}
], - "currency_code": "str",
- "branch_location": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "mandate": {
- "accepted": true
}
}
The bank account ID. An ID with ROUTING_NUMBER_1
is required.
type | string [ 1 .. 125 ] characters ^[0-9A-Z_-]+$ The bank account ID type.
| ||||||||||||||||||||||||||
value | string [ 1 .. 125 ] characters ^[A-Za-z0-9-_.+/ =]+ The value of account identifier. |
{- "type": "BANK_CODE",
- "value": "string"
}
Beneficial owners of the entity.
Array of objects (Individual_beneficial_owner) [ 0 .. 5 ] items Individual beneficial owners. | |
Array of objects (Business_beneficial_owner) [ 0 .. 5 ] items Business beneficial owners. |
{- "individual_beneficial_owners": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "percentage_of_ownership": "string"
}
], - "business_beneficial_owners": [
- {
- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "percentage_of_ownership": "string"
}
]
}
The details of the billing agreement between the partner and a seller.
description | string [ 1 .. 125 ] characters ^.+$ The billing agreement description. |
object (billing_experience_preference) The preference that customizes the billing experience of the customer. | |
merchant_custom_data | string [ 1 .. 125 ] characters ^[a-zA-Z0-9-]+$ The custom data for the billing agreement. |
approval_url | string <uri> [ 1 .. 125 ] characters The URL to which to redirect seller to accept the billing agreement. |
ec_token | string [ 1 .. 50 ] characters ^[0-9A-Z_-]+$ The billing agreement token for the agreement. |
{- "description": "string",
- "billing_experience_preference": {
- "experience_id": "string",
- "billing_context_set": true
}, - "merchant_custom_data": "string",
- "ec_token": "string"
}
The preference that customizes the billing experience of the customer.
experience_id | string [ 1 .. 20 ] characters ^[a-zA-Z0-9-]+$ The ID of the payment web experience profile. |
billing_context_set | boolean Indicates whether the partner has already displayed the billing context to the seller. |
{- "experience_id": "string",
- "billing_context_set": true
}
Date of birth data provided by the user
date_of_birth required | string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... date of birth, fomrat Internet date and time format. |
{- "date_of_birth": "stringstri"
}
Array of objects (Business name) [ 0 .. 5 ] items Name of the business. | |
Array of objects (Email of a person orbusiness) [ 0 .. 5 ] items Email addresses of the business. | |
website | string <uri> [ 1 .. 50 ] characters Website of the business. |
Array of objects (Business_address_detail) [ 0 .. 5 ] items List of addresses associated with the business entity. | |
Array of objects (Phone details) [ 0 .. 5 ] items List of phone number associated with the business. | |
Array of objects (Business document) [ 0 .. 20 ] items Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user. | |
object (Business type information) Information related to the business like the nature of business, started date etc. | |
object (Business industry) Information related to the business like the nature of business, started date etc. | |
object (Business_incorporation) Information related to the business like the nature of business, started date etc. |
{- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}
}
Address type under which the provided address is tagged
Address type under which the provided address is tagged
Value: | Description |
---|---|
WORK | The address of the business. |
"WORK"
The documents associated with the business.
identification_number | string [ 1 .. 100 ] characters ^[a-zA-Z0-9-]+$ The number for the document. It is the ID number if the document is | ||||||||||||||||||||
issuing_country_code | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is | ||||||||||||||||||||
type | string (Document type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The actual type of the document.
|
{- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
The category, subcategory and MCC code of the business.
category required | string [ 1 .. 20 ] characters ^\d+$ The customer's business category code. PayPal uses industry standard seller category codes. |
mcc_code required | string [ 1 .. 20 ] characters ^\d+$ The customer's business seller category code. PayPal uses industry standard seller category codes. |
subcategory required | string [ 1 .. 20 ] characters ^\d+$ The customer's business subcategory code. PayPal uses industry standard seller subcategory codes. |
{- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}
Name of the business provided.
business_name | string <= 300 characters Required. The business name of the party. | ||||||
type required | string (The business name type.) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The type of business name. For example, trading name.
|
{- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
The business name of the party.
business_name | string <= 300 characters Required. The business name of the party. |
{- "business_name": "string"
}
The business types classified
The business types classified
Enum: | Description |
---|---|
ANY_OTHER_BUSINESS_ENTITY | The any other business entity. |
ASSOCIATION | The association. |
CORPORATION | The corporation. |
GENERAL_PARTNERSHIP | The general partnership. |
GOVERNMENT | The government. |
INDIVIDUAL | The individual. |
LIMITED_LIABILITY_PARTNERSHIP | The limited liability partnership. |
LIMITED_LIABILITY_PROPRIETORS | The limited liability proprietors. |
LIMITED_LIABILITY_PRIVATE_CORPORATION | The limited liability private corporation. |
LIMITED_PARTNERSHIP | The limited partnership. |
LIMITED_PARTNERSHIP_PRIVATE_CORPORATION | The limited partnership private corporation. |
NONPROFIT | The nonprofit. |
ONLY_BUY_OR_SEND_MONEY | The only buy and send money. |
OTHER_CORPORATE_BODY | The other corporate body. |
PARTNERSHIP | The partnership. |
PRIVATE_PARTNERSHIP | The private partnership. |
PROPRIETORSHIP | The proprietorship. |
PROPRIETORSHIP_CRAFTSMAN | The proprietorship craftsman. |
PROPRIETORY_COMPANY | The proprietory company. |
PRIVATE_CORPORATION | The private corporation. |
PUBLIC_COMPANY | The public company. |
PUBLIC_CORPORATION | The public corporation. |
PUBLIC_PARTNERSHIP | The public partnership. |
REGISTERED_COOPERATIVE | Registered Co-operative. |
"ANY_OTHER_BUSINESS_ENTITY"
The type and subtype of the business.
type | string (Business type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Type of business entity like corporation, sole prop, governmental.
| ||||||||||||||||||||||||||||||||||||||||||||||||||
subtype | string (The business sub type.) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The sub classification of the business type.
|
{- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}
A simple postal address with coarse-grained fields.
address_line_1 | string <= 300 characters The first line of the address. For example, number or street. For example, | ||||
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. | ||||
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than | ||||
admin_area_1 | string <= 300 characters 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,
| ||||
postal_code | string <= 60 characters The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. | ||||
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is | ||||
type required | string (Business address type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The address type under which this is classified. For example, shipping or dropoff.
|
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
The business beneficial owner of the account.
Array of objects (Business name) [ 0 .. 5 ] items Name of the business. | |
Array of objects (Email of a person orbusiness) [ 0 .. 5 ] items Email addresses of the business. | |
website | string <uri> [ 1 .. 50 ] characters Website of the business. |
Array of objects (Business_address_detail) [ 0 .. 5 ] items List of addresses associated with the business entity. | |
Array of objects (Phone details) [ 0 .. 5 ] items List of phone number associated with the business. | |
object (Business type information) Information related to the business like the nature of business, started date etc. | |
object (Business industry) Information related to the business like the nature of business, started date etc. | |
object (Business_incorporation) Information related to the business like the nature of business, started date etc. | |
percentage_of_ownership | string <ppaas_common_percentage_v2> (percentage) ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The percentage of shares this person owns in the company. |
{- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "percentage_of_ownership": "string"
}
The business entity of the account.
Array of objects (Business name) [ 0 .. 5 ] items Name of the business. | |||||||||||||||||||||||||||||||
Array of objects (Email of a person orbusiness) [ 0 .. 5 ] items Email addresses of the business. | |||||||||||||||||||||||||||||||
website | string <uri> [ 1 .. 50 ] characters Website of the business. | ||||||||||||||||||||||||||||||
Array of objects (Business_address_detail) [ 0 .. 5 ] items List of addresses associated with the business entity. | |||||||||||||||||||||||||||||||
Array of objects (Phone details) [ 0 .. 5 ] items List of phone number associated with the business. | |||||||||||||||||||||||||||||||
Array of objects (Business document) [ 0 .. 20 ] items Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user. | |||||||||||||||||||||||||||||||
object (Business type information) Information related to the business like the nature of business, started date etc. | |||||||||||||||||||||||||||||||
object (Business industry) Information related to the business like the nature of business, started date etc. | |||||||||||||||||||||||||||||||
object (Business_incorporation) Information related to the business like the nature of business, started date etc. | |||||||||||||||||||||||||||||||
Array of objects (Office Bearers) [ 0 .. 5 ] items List of Directors present as part of the business entity. | |||||||||||||||||||||||||||||||
purpose_code | Array of strings (purpose_code) The account's purpose code.
| ||||||||||||||||||||||||||||||
business_description | string [ 1 .. 256 ] characters The business goals description. For example, a mission statement. | ||||||||||||||||||||||||||||||
object (Beneficial_owners) List of beneficial owners part of the entity. They can be either a Person or a business entity. | |||||||||||||||||||||||||||||||
object (currency_range) The range for the total annual sales volume of the business. | |||||||||||||||||||||||||||||||
object (currency_range) The range for the average monthly volume of the business. |
{- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "office_bearers": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "documents": [
- {
- "identification_number": "string",
- "issuing_country_code": "string",
- "type": "SOCIAL_SECURITY_NUMBER"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "role": "CEO"
}
], - "purpose_code": [
- "P0104"
], - "business_description": "string",
- "beneficial_owners": {
- "individual_beneficial_owners": [
- {
- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "percentage_of_ownership": "string"
}
], - "business_beneficial_owners": [
- {
- "names": [
- {
- "business_name": "string",
- "type": "DOING_BUSINESS_AS"
}
], - "emails": [
- {
- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "WORK"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "CUSTOMER_SERVICE"
}
], - "business_type": {
- "type": "ANY_OTHER_BUSINESS_ENTITY",
- "subtype": "ASSO_TYPE_INCORPORATED"
}, - "business_industry": {
- "category": "string",
- "mcc_code": "string",
- "subcategory": "string"
}, - "business_incorporation": {
- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}, - "percentage_of_ownership": "string"
}
]
}, - "annual_sales_volume_range": {
- "minimum_amount": {
- "currency_code": "str",
- "value": "string"
}, - "maximum_amount": {
- "currency_code": "str",
- "value": "string"
}
}, - "average_monthly_volume_range": {
- "minimum_amount": {
- "currency_code": "str",
- "value": "string"
}, - "maximum_amount": {
- "currency_code": "str",
- "value": "string"
}
}
}
Business incorporation information.
incorporation_country_code | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The incorporation country code. |
incorporation_date | string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... date of incorporation |
{- "incorporation_country_code": "st",
- "incorporation_date": "stringstri"
}
Optional capabilities of the selected PayPal product for which the customer is being onboarded.
Optional capabilities of the selected PayPal product for which the customer is being onboarded.
Enum: | Description |
---|---|
PAYPAL_WALLET_VAULTING_ADVANCED | Enables capability to save payment methods. Supported only when ADVANCED_VAULTING is requested and EXPRESS_CHECKOUT or PPCP is also requested. |
PAY_UPON_INVOICE | Enables Pay Upon Invoice (PUI) which is a deferred payment method that allows a buyer to buy now and pay later. Supported only when PAYMENT_METHODS is requested. |
APPLE_PAY | Enables Apple Pay capability. Supported only when PAYMENT_METHODS is requested. |
GOOGLE_PAY | Enables Google Pay capability. Supported only when PAYMENT_METHODS is requested. |
"PAYPAL_WALLET_VAULTING_ADVANCED"
The integration details for PayPal CLASSIC endpoints.
The integration details for PayPal CLASSIC endpoints.
{ }
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The shared referral data.
Array of objects (Links) [ 2 .. 10 ] items An array of request-related HATEOAS links. |
{- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}, - {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The currency range, from the minimum inclusive amount to the maximum inclusive amount.
object (Money) The minimum inclusive amount for the range. | |
object (Money) The maximum inclusive amount for the range. |
{- "minimum_amount": {
- "currency_code": "str",
- "value": "string"
}, - "maximum_amount": {
- "currency_code": "str",
- "value": "string"
}
}
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
"stringstri"
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The document object.
id | string [ 1 .. 20 ] characters ^[0-9A-Z]+$ The encrypted identifier for the document. |
labels | Array of strings [ 1 .. 50 ] items The document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as |
name | string [ 1 .. 100 ] characters ^[0-9A-Za-z_-]+$ The file name. |
identification_number | string [ 1 .. 100 ] characters ^[a-zA-Z0-9-]+$ The number for the document. It is the ID number if the document is |
Array of objects (File Reference) [ 1 .. 50 ] items The files contained in the document. For example, a document could be represented by a front page file and a back page file, etc. | |
Array of objects (Link Description) [ 1 .. 10 ] items The HATEOAS links. | |
issue_date | string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard |
expiry_date | string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard |
issuing_country_code | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "id": "string",
- "labels": [
- "string"
], - "name": "string",
- "identification_number": "string",
- "files": [
- {
- "id": "string",
- "content_type": "string",
- "size": "string",
- "create_time": "string"
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "issue_date": "string",
- "expiry_date": "string",
- "issuing_country_code": "string"
}
The type of documents.
The type of documents.
Enum: | Description |
---|---|
SOCIAL_SECURITY_NUMBER | A social security number. |
EMPLOYMENT_IDENTIFICATION_NUMBER | The employee identification number. |
TAX_IDENTIFICATION_NUMBER | A tax identification number. |
PASSPORT_NUMBER | The passport number. |
PENSION_FUND_ID | A pension fund ID. |
MEDICAL_INSURANCE_ID | The medical insurance ID. |
CNPJ | The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil. |
CPF | A Brazilian individual's taxpayer registry identification number. |
PAN | The permanent account number issued by the Indian Income Tax Department. |
"SOCIAL_SECURITY_NUMBER"
The type of documents.
The type of documents.
Enum: | Description |
---|---|
SOCIAL_SECURITY_NUMBER | A social security number. |
EMPLOYMENT_IDENTIFICATION_NUMBER | The employee identification number. |
TAX_IDENTIFICATION_NUMBER | The tax identification number. |
PASSPORT_NUMBER | A passport number. |
PENSION_FUND_ID | A pension fund ID. |
MEDICAL_INSURANCE_ID | A medical insurance ID. |
CNPJ | The identification number issued to Brazilian companies by the Department of Federal Revenue of Brazil. |
CPF | A Brazilian individual's taxpayer registry identification number. |
PAN | The Permanent account number issued by the Indian Income Tax Department. |
"SOCIAL_SECURITY_NUMBER"
An email address at which the person or business can be contacted.
type required | string [ 1 .. 50 ] characters ^[0-9A-Z_]+$ The role of the email address.
| ||||
email required | string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^.+@[^"\-].+$ The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the |
{- "type": "CUSTOMER_SERVICE",
- "email": "string"
}
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.
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.
"string"
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.
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.
"string"
The error details.
name required | string The human-readable, unique name of the error. |
message required | string The message that describes the error. |
debug_id required | string The PayPal internal ID. Used for correlation purposes. |
information_link | string The information link, or URI, that shows detailed information about this error for the developer. |
Array of objects (Error Details) An array of additional details about the error. | |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "name": "string",
- "message": "string",
- "debug_id": "string",
- "information_link": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
The file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
id | string [ 1 .. 255 ] characters The ID of the referenced file. |
reference_url | string <uri> [ 1 .. 2000 ] characters The reference URL for the file. |
content_type | |
size | string^[0-9]+$ The size of the file, in bytes. |
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. |
{- "id": "string",
- "content_type": "string",
- "size": "string",
- "create_time": "string"
}
Financial instruments attached to this account.
Array of objects (Bank Account) [ 0 .. 5 ] items An array of banks attached to this managed account. |
{- "banks": [
- {
- "nick_name": "string",
- "account_number": "string",
- "account_type": "CHECKING",
- "identifiers": [
- {
- "type": "BANK_CODE",
- "value": "string"
}
], - "currency_code": "str",
- "branch_location": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "mandate": {
- "accepted": true
}
}
]
}
Role of the person party played in the account.
Role of the person party played in the account.
Value: | Description |
---|---|
PRIMARY | Primary account holder. |
"PRIMARY"
The individual owner of the account.
Array of objects (Person name) [ 0 .. 5 ] items The name of the person. | |
Array of objects (Person address detail) [ 0 .. 5 ] items The list of addresses associated with the person. | |
Array of objects (Phone details) [ 0 .. 5 ] items The list of phone numbers associated with the person. | |
citizenship | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The citizenship country code of the person. |
object (Birth details) The person's birth details. | |
percentage_of_ownership | string <ppaas_common_percentage_v2> (percentage) ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The percentage of shares this person owns in the company. |
{- "names": [
- {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string",
- "type": "LEGAL"
}
], - "addresses": [
- {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st",
- "type": "HOME"
}
], - "phones": [
- {
- "country_code": "str",
- "national_number": "string",
- "extension_number": "string",
- "type": "FAX"
}
], - "citizenship": "st",
- "birth_details": {
- "date_of_birth": "stringstri"
}, - "percentage_of_ownership": "string"
}
The individual owner of the account.
Array of objects (Person name) [ 0 .. 5 ] items The name of the person. | |
Array of objects (Person address detail) [ 0 .. 5 ] items The list of addresses associated with the person. | |
Array of objects (Phone details) [ 0 .. 5 ] items The list of phone numbers associated with the person. | |
Array of objects (Person document) [ 0 .. 20 ] items 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 API calls. | |
citizenship | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The citizenship country code of the person. |
object (Birth details) The person's birth details. | |
type |