On this page
No Headings
Business Party related Document data collected from the customer.. For example SSN, ITIN, Business registration number that were collected from the user.
arrayitemsobjectThe document object.
The documents associated with the business.
idstring^[0-9A-Z]+$The encrypted identifier for the document.
labelsarrayThe document labels. A document could be classfied to multiple categories. For example, a bill document can be classfified as BILL DOCUMENT and UTILITY DOCUMENT.
itemsstringA document label.
namestring^[0-9A-Za-z_-]+$The file name.
identification_numberstring^[a-zA-Z0-9-]+$The number for the document. It is the ID number if the document is ID CARD, the passport number if the document is PASSPORT, etc.
issue_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The issue date of the document.
expiry_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The expire data of the document.
issuing_country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The country code of the document.
filesarrayThe files contained in the document. For example, a document could be represented by a front page file and a back page file, etc.
itemsobjectThe file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
idstringThe ID of the referenced file.
reference_urlstringuriThe reference URL for the file.
create_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the file was created, in Internet date and time format.
sizestring^[0-9]+$The size of the file, in bytes.
linksarrayThe HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
typestring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "BUSINESS_REGISTRATION"^[0-9A-Z_]+$The actual type of the document.