Content documents reference

DOCS

Last updated: Aug 15th, 8:03am

Resources

Document (/documents)

The Document object represents a document within the Document Management System. The Document object and its sub-resources include 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 a 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 a document and its descriptors such as filename, file type, and number of bytes.

Use cases

Document Upload

Creates a new Document object, file sub-resource, and associated file data.

HTTP Method: POST Resource Path: /v2/content/documents/
Sample Request URI: POST https://sandbox.qa.paypal.com:17220/v2/content/documents/

Sample request & response	Description
Upload a document sample	This sample creates a document within the Document Management System. The Swagger 2.0 support for multipart requests is poor, so the sample represents the request as having a `body` and `formData`. In actuality, the JSON data and file data are separate parts of the request body.
Upload a document with tenant header sample	This sample shows how to use the tenant headers to associate a tenant with a document at the time of document creation.

HTTP code	Error Name	Message	Details
`201`	N/A	N/A	Resource successfully created with a POST operation.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`422`	`UNPROCESSABLE_ENTITY`	The requested action could not be performed, semantically incorrect, or failed business validation.	Errors such as a file type and file name extension mismatch or file size too large can result in this response status.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Search

Search for documents using metadata field values.

HTTP Method: GET Resource Path: /v2/content/documents/
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents?metadata.cases=PP-AD-12345&update_time_after=2020-08-01T16:07:00.830Z&total_required=true&page=2&page_size=10

Sample request & response	Description
Search documents sample	Search a document using metadata filters. Only specific metadata filters are searchable.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	Document search successfully completed.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`422`	`UNPROCESSABLE_ENTITY`	The requested action could not be performed, semantically incorrect, or failed business validation.	Requested search criteria are not supported.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Get

Retrieve a Document resource by ID.

HTTP Method: GET Resource Path: /v2/content/documents/{id}
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b

Sample request & response	Description
Sample request & response	Get a Document object, including the document and its file metadata, using the document ID.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	Document successfully retrieved.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Authorization failed due to insufficient permissions.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the ID provided.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Update

Update a document's metadata fields.

HTTP Method: PATCH Resource Path: /v2/content/documents/{id}
Sample Request URI: PATCH https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b

Sample request & response	Description
Patch document sample	This sample shows how to update a document's metadata by adding, replacing, and removing fields.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	Document successfully updated.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the ID provided.
`422`	`UNPROCESSABLE_ENTITY`	The requested action could not be performed, semantically incorrect, or failed business validation.	Value not allowed for given operation or the field is read-only.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Delete

Permanently delete a document.

HTTP Method: DELETE Resource Path: /v2/content/documents/{id}
Sample Request URI: DELETE https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b

Sample request & response	Description
Delete document sample	Delete document object, including the document object, the file metadata, and the actual file, using the document ID.

HTTP code	Error Name	Message	Details
`204`	N/A	N/A	Document successfully deleted or is not present.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Initiate Upload

Upload a document from the local Document Management System to a remote geography Document Management System.

HTTP Method: POST Resource Path: /documents/{id}/initiate-upload
Sample Request URI: POST https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/initiate-upload

Sample request & response	Description
Initiate upload sample	Request to initiate the cross-geo document upload workflow.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	Cross-geo document upload successfully initiated.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the id provided.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Files Get

Retrieves the list FileReference sub-resources for a document.

HTTP Method: GET Resource Path: /v2/content/documents/{id}/files
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/files

Sample request & response	Description
Get files sample	Get the file collection associated with the document using the document ID.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	File references successfully retrieved.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the id provided.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document File Get

Retrieves the specified FileReference sub-resources for a document.

HTTP Method: GET Resource Path: /v2/content/documents/{id}/files/{file_id}
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1

Sample request & response	Description
Get file sample	Get the file associated with a document using the document ID and file reference.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	File references successfully retrieved.
`403`	`NOT_AUTHORIZED`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the id provided.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document File Download

Downloads the file data associated with a document and its specified file sub-resource.

HTTP Method: GET Resource Path: /v2/content/documents/{id}/files/{file_id}/download
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download

Sample request & response	Description
Download sample	Download the file binary data associated with a document using the document ID and file reference. The server attempts to honor the request `Accept` header by fetching the matching file type rendition if present.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	File references successfully retrieved.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the document id provided or there is no file reference associated with the provided file id.
`406`	`MEDIA_TYPE_NOT_ACCEPTABLE`	The server does not implement the media type that would be acceptable to the client.	The server cannot provide the Mime Type specified by the request `Accept` header.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Document Capture

Start the Document Capture process.

HTTP Method: POST Resource Path: /v2/content/documents/{id}/files/{file_id}/extract
Sample Request URI: POST https://sandbox.qa.paypal.com:17220/v2/content/documents/v2/content/documents/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/extract

Sample request & response	Description
Extract sample	Initiate document capture process to extract raw text and fields associated with the file.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	File references successfully retrieved.
`202`	N/A	N/A	The document capture process is successfully initiated for this file.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`404`	`RESOURCE_NOT_FOUND`	The specified resource does not exist.	There is no document associated with the document id provided or there is no file reference associated with the provided file id.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Upload Document Snapshots

Persists a full representation of a Document Management System document to the system. Access to this operation is limited, and use cases usually involve cross-geo movement of data. The operation attempts to use the document ID provided in the request body, but it is not guaranteed.

HTTP Method: POST Resource Path: /upload-document-snapshots
Sample Request URI: POST https://sandbox.qa.paypal.com:17220/v2/content/upload-document-snapshots

Sample request & response	Description
Upload snapshots sample	Document snapshots are uploaded and persisted in the target Document Management system.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	The document has already been successfully uploaded.
`201`	N/A	N/A	The document was uploaded successfully.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.

Download Document Thumbnail

Retrieve the Document thumbnail of a specific document version using the document's ID.

HTTP Method: GET Resource Path: /{id}/files/{fileId}/download-thumbnail
Sample Request URI: GET https://sandbox.qa.paypal.com:17220/v2/content/DIS-010-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download-thumbnail

Sample request & response	Description
Download thumbnail sample	Get the thumbnail binary data associated with a document using the document ID and file reference.

HTTP code	Error Name	Message	Details
`200`	N/A	N/A	Thumbnail reference successfully retrieved.
`400`	`INVALID_REQUEST`	Request is not well-formed, syntactically incorrect, or violates schema.	One or more validation errors have occurred.
`403`	`NOT_AUTHORIZED`	Authorization failed due to insufficient permissions.	Check your credentials, such as the application context and security context.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred.	Resend the request at another time. If this error continues, contact the API development team.