Content documents

Overview

The Content Documents API is the primary RESTful interface for the Document Management System (DMS).

DMS is the system of record for documents acquired and processed by PayPal and its subsidiaries. The system complies with the information security and data governance guidelines for handling sensitive data. It offers additional features such as document viewing, document editing, optical character recognition, and file type conversion.

The Documents API contains CRUD-like operations for the lifecycle management of documents within the DMS. The operations manage the primary resource of "Document" and its sub-resources. The Document resource object encapsulates the following:

• The origin or intake channel of the document, the purpose for document collection, and association with a PayPal account if applicable.
• Additional information or metadata about the document, including document type such as License, PAN, and Passport, and class or category such as Proof of Identity (POI), and Proof of Address (POA).
• The file data associated with the document and its descriptors such as filename, file type, and number of bytes.

Eligibiilty

• US - United States
• CN - China

Supported access channels

This API supports the following access channels: INTERNAL LIMITED_RELEASE.

Setup

Clients are requested to go through the formal DMS on-boarding process to use the Documents API. During the onboarding process it will be determined whether the use case calls for a new DMS bucket to be created or if an existing bucket is appropriate. A list of the existing named buckets can be found here.

Internal consumption - stage environments

Clients don't need to wait for the onboarding process to complete to start using many of the API operations from the managed stage environment. Testing can begin using the existing DMS buckets: the basic API usage doesn't vary much from one integration to another. You need a valid Application Context request header ifor all internal API calls. The DMS team can provide a test Application Context token. After the onboarding process is complete, the DMS team will tell you which Application Context permissions to request for a given integration.

Internal consumption - live and sandbox environments

Please specify if you intend to use this API in the Sandbox environment during the onboarding process. Before attempting to consume the Documents API in the Live or Sandbox environments, ensure that the client is properly fetching an Application Context token from the keymaker service, rather than using a test token, and test the Documents API integration against sandbox.qa.paypal.com. If all looks good, promote the Application Context to Sandbox/Live.

External consumption - live and sandbox Environments

Please specify if you intend to use this API in the Sandbox environment during the onboarding process. To consume this API in the live or sandbox environment, you need to get your application credentials and then obtain an OAuth token.

Supported environments

Combine one of the following host names with a resource path from one of the following use cases to create the request URI:

• Live: https://api-m.paypal.com:13756
• Sandbox: https://api-m.sandbox.paypal.com:14645
• Managed Stage: https://sandbox.qa.paypal.com:17220, https://msgeo.qa.paypal.com:17220