GetAdvancedPersonalData API Operation

Important: The Adaptive Platform API is not available for new integrations. PayPal provides this documentation to support existing integrations. If you're starting an integration, we recommend our latest solutions.

Shows sensitive personal data for an account holder.

GetAdvancedPersonalDataRequest Message

GetAdvancedPersonalDataRequest Fields

Field, Description
Field	Description
`attributeList`	`tns:PersonalAttributeList` (Required) The list of personal attributes requested for the account.
`requestEnvelope`	`common:requestEnvelope` (Required) Information common to each API operation, such as the language in which an error message is returned.

PersonalAttributeList Fields

Field, Description
Field	Description
`PersonalAttribute`	The attributes whose value you are requesting. You specify one or more of the following URIs: `http://axschema.org/birthDate` — Date of birth `http://axschema.org/contact/postalCode/home` — Postcode `http://schema.openid.net/contact/street1` — Street1 `http://schema.openid.net/contact/street2` — Street2 `http://axschema.org/contact/city/home` — City `http://axschema.org/contact/state/home` — State `http://axschema.org/contact/phone/default` — Phone

RequestEnvelope Fields

Field, Description
Field	Description
`detailLevel`	`common:DetailLevelCode` (Optional) Level of detail required by the client application for components. Value is: `ReturnAll` — This value provides the maximum level of detail (default).
`errorLanguage`	`xs:string` (Required) RFC 3066 language in which error messages are returned; by default it is `en_US`, which is the only language currently supported.

GetAdvancedPersonalDataResponse Message

GetAdvancedPersonalData Response Fields

Field, Description
Field	Description
`responseEnvelope`	`common:ResponseEnvelope` Common response information, including a timestamp and the response acknowledgment status.

PersonalDataListFields

Field, Description
Field	Description
`personalData`	`tns:PersonalData` The list of name-value pairs of personal data in the response.

PersonalData Fields

Field, Description
Field	Description
`personalDataKey`	`tns:PersonalAttribute` The attributes whose values you are requesting. You specify one or more of the following URIs: `http://axschema.org/namePerson/first` — First name `http://axschema.org/namePerson/last` — Last name `http://axschema.org/contact/email` — Email `http://schema.openid.net/contact/fullname` — Full name `http://axschema.org/company/name` — Business name `http://axschema.org/contact/country/home` — Country `https://www.paypal.com/webapps/auth/schema/payerID` — Payer ID
`personalDataValue`	`xs:String` The value associated with the key.

ResponseEnvelope Fields

Field, Description
Field	Description
`ack`	`common:AckCode` Acknowledgment code. Value is: `Success` — The operation completed successfully. `Failure` — The operation failed. `Warning` — Warning. `SuccessWithWarning` — The operation completed successfully; however, there is a warning message. `FailureWithWarning` — The operation failed with a warning message.
`build`	Build number; it is used only by Merchant Technical Support.
`correlationId`	Correlation ID; it is used only by Merchant Technical Support. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues.
`timestamp`	Date on which the response was sent. The time is currently not supported. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues.

PPFault Message

The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs.

FaultMessage Fields

Field, Description
Field	Description
`error`	`common:ErrorData` Detailed error information.
`responseEnvelope`	`common:ResponseEnvelope` Common response information, including a timestamp and the response acknowledgment status.

ErrorData Fields

Field, Description
Field	Description
`category`	`common:ErrorCategory` The location where the error occurred. Value is: `System` — The system encountered errors; try again `Application` — The application encountered errors; try again `Request` — The request was incorrect
`domain`	The domain to which this service belongs.
`errorId`	A number that uniquely identifies a particular error.
`exceptionID`	This field is not used.
`message`	A description of the error.
`parameter`	`common:ErrorParameter` Represents contextual information about the error.
`severity`	`common:ErrorSeverity` The severity of the error encountered. Value is: `Error` — Processing of the request was interrupted `Warning` — Processing of the request was completed
`subdomain`	This field is not used.

ResponseEnvelope Fields

Field, Description
Field	Description
`ack`	`common:AckCode` Acknowledgment code. Value is: `Success` — The operation completed successfully. `Failure` — The operation failed. `Warning` — Warning. `SuccessWithWarning` — The operation completed successfully; however, there is a warning message. `FailureWithWarning` — The operation failed with a warning message.
`build`	Build number; it is used only by Merchant Technical Support.
`correlationId`	Correlation ID; it is used only by Merchant Technical Support. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues.
`timestamp`	Date on which the response was sent. The time is currently not supported. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues.

GetAdvancedPersonalData Errors

Code, Message, Additional Information
Code	Message	Additional Information
580022	Invalid Access Token

Shows sensitive personal data for an account holder.