Content documents sample requests and responses
DOCS
Last updated: Aug 15th, 7:01am
Document Upload
Upload a document sample
1{2 "description": "Create a document from the uploaded file. Document identifier conforms to the standard pattern of {domain_id}-{assigned_app_id}-{uuid}. Documents migrated from DMS 1.0 have a slightly different format for document id.",3 "title": "Create document entity for the given binary using business intent.",4 "runnable": true,5 "operationId": "document.create",6 "request": {7 "method": "POST",8 "path": "v2/content/documents",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRvd25sb2FkX3RheF9yZXBvcnRpbmciLCJ1cGxvYWRfdGF4X3JlcG9ydGluZyJdLCJleHAiOjE2MDYyNjQ0MTU0ODIsImlhdCI6MTYwNjI2Mjk3NTQ4MiwianRpIjoxNjA2MjYyOTc1NDgyfQ.na_lNgMav_lGDqwEz5aF7wKO-2nxIiN-tXaLAoZqttuI1CEXhU6q8TCAUT3p3I-egtVrX1brv3HZc9xQUCqmvPYYj0t1T1p9n8jGdtBgKyqQB5IzpSplXWRI37_9Vg5ubPemkT9nTpLVxoBDA2ZHoyizn3eOQ0eliqIUZe7Jy7Y",11 "Content-Type": "multipart/mixed; boundary=----WebKitFormBoundary4WCYSRVoLsVGgBQl",12 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"13 },14 "formData": {15 "inputFile": "@inputFile.pdf"16 },17 "body": {18 "account_numbers": [19 "12345678901234567"20 ],21 "external_id": "1234567",22 "business_intent": "TAX_REPORTING",23 "document_class": "IRS_1099K"24 }25 },26 "response": {27 "status": "201 Created",28 "headers": {29 "Content-Type": "application/json",30 "Content-length": "430592",31 "Correlation-Id": "dab83c13fe192"32 },33 "body": {34 "id": "CMP-044-150b07a2-16d0-4a64-ba17-afa7efd7f592",35 "source": "doccentralapiserv",36 "create_time": "2021-07-07T17:58:35.781Z",37 "update_time": "2021-07-07T17:58:35.781Z",38 "metadata": {39 "account_numbers": [40 "12345678901234567"41 ],42 "business_intent": "TAX_REPORTING",43 "document_type": "IRS_1099K",44 "external_id": "1234567"45 },46 "files": [47 {48 "file_id": 1,49 "size_in_bytes": 65,50 "mime_type": "application/pdf;charset=UTF-8",51 "filename": "file1.pdf",52 "create_time": "2021-07-07T17:58:35.781Z",53 "update_time": "2021-07-07T17:58:35.781Z",54 "links": [55 {56 "href": "/v2/content/documents/CMP-044-150b07a2-16d0-4a64-ba17-afa7efd7f592/files/1",57 "rel": "self"58 },59 {60 "href": "/v2/content/documents/CMP-044-150b07a2-16d0-4a64-ba17-afa7efd7f592/files/1/download",61 "rel": "download"62 },63 {64 "href": "/v2/content/documents/CMP-044-150b07a2-16d0-4a64-ba17-afa7efd7f592/files/1?fields=extract.coordinates",65 "rel": "fetch-coordinates"66 }67 ]68 }69 ],70 "links": [71 {72 "href": "/v2/content/documents/CMP-044-150b07a2-16d0-4a64-ba17-afa7efd7f592",73 "rel": "self"74 }75 ]76 }77 }78}
Upload a document with tenant header sample
1{2 "description": "Create a document from the uploaded file with both PayPal-Tenant-Context and X-PayPal-Security-Context. tenant_name read only value in response object will be set as per https://ppaas/docs/standards/http-methods-headers-status#http-custom-headers where PayPal-Tenant-Context overrides value in SC.",3 "title": "Create document entity for the given binary.",4 "runnable": true,5 "operationId": "document.create",6 "request": {7 "method": "POST",8 "path": "v2/content/documents",9 "headers": {10 "PayPal-Tenant-Context": "{\"tenant_name\":\"PayPal\",\"tenant_id\":\"68953aff-f3bf-4613-be1e-d4a9590192df\"}",11 "X-PayPal-Security-Context": "{\"version\":\"1.2\",\"actor\":{\"client_id\":\"AeEPwxDEJ6WoO-7nlJE9An3s3TONEywR5fx5A5QI7j8vi83W_hDcEItvFd7N\",\"id\":\"245285\",\"auth_claims\":[\"CLIENT_ID_SECRET\"],\"auth_state\":\"IDENTIFIED\",\"account_number\":\"1539671732305563784\",\"encrypted_account_number\":\"SZEKQNBKSSQ8L\",\"party_id\":\"1539671732305563784\",\"user_type\":\"API_CALLER\",\"tenant_context\":{\"tenant_name\":\"Venmo\",\"tenant_id\":\"68953aff-f3bf-4613-be1e-d4a9590192df\"}},\"auth_token\":\"A005k-uhHJpWeigFugez8NvL1HiCn-SkjzGvaKOiIL3xY1k\",\"auth_token_type\":\"ACCESS_TOKEN\",\"global_session_id\":\"I3c0ddbad-538e-4062-848e-8d3407c4e216\",\"last_validated\":1.462667249E9,\"scopes\":[\"https://uri.paypal.com/services/identity/proxyclient\",\"openid\"],\"client_id\":\"AeEPwxDEJ6WoO-7nlJE9An3s3TONEywR5fx5A5QI7j8vi83W_hDcEItvFd7N\",\"claims\":{\"actor_payer_id\":\"SZEKQNBKSSQ8L\"},\"edge_authorization\":{\"policy_decision\":\"PERMIT\"},\"subjects\":[]}",12 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",13 "Content-Type": "multipart/mixed; boundary=----WebKitFormBoundary4WCYSRVoLsVGgBQl",14 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"15 },16 "formData": {17 "inputFile": "@license.jpeg"18 },19 "body": {20 "account_numbers": [21 "12345678901234567"22 ],23 "country_code": "US",24 "cases": [25 "PP-AD-12345",26 "PP-BD-56789"27 ],28 "contains_pii": true,29 "document_class": "PROOF_OF_IDENTITY"30 }31 },32 "response": {33 "status": "201 Created",34 "headers": {35 "Content-Type": "application/json",36 "Content-length": "430592",37 "Correlation-Id": "dab83c13fe192"38 },39 "body": {40 "id": "CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",41 "create_time": "2018-04-12T23:20:50.52Z",42 "update_time": "2019-04-12T10:00:00.00Z",43 "source": "csknowledgebasenodeweb",44 "tenant_name": "PayPal",45 "metadata": {46 "account_numbers": [47 "12345678901234567"48 ],49 "country_code": "US",50 "cases": [51 "PP-AD-12345",52 "PP-BD-56789"53 ],54 "contains_pii": true,55 "document_class": "PROOF_OF_IDENTITY"56 },57 "files": [58 {59 "file_id": 1,60 "size_in_bytes": 167363,61 "mime_type": "image/jpeg",62 "filename": "license.jpeg",63 "create_time": "2018-04-12T23:20:50.52Z",64 "update_time": "2019-04-12T10:00:00.00Z",65 "links": [66 {67 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",68 "rel": "self"69 },70 {71 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",72 "rel": "download"73 }74 ]75 }76 ],77 "links": [78 {79 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",80 "rel": "self"81 }82 ]83 }84 }85}
Document Search
Search documents sample
1{2 "description": "Search document by metadata filters. Only specific metadata filters are searchable.",3 "title": "Search document by metadata filters.",4 "runnable": true,5 "operationId": "documents.search",6 "request": {7 "method": "GET",8 "path": "v2/content/documents?metadata.account_numbers=12345678901234567&page=2&page_size=2&total_required=true",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"12 }13 },14 "response": {15 "status": "200 OK",16 "headers": {17 "Content-Type": "application/json",18 "Content-length": "45437",19 "Correlation-Id": "dab83c13fe192"20 },21 "body": {22 "documents": [23 {24 "id": "CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",25 "create_time": "2018-04-12T23:20:50.52Z",26 "update_time": "2019-04-12T10:00:00.00Z",27 "source": "csknowledgebasenodeweb",28 "metadata": {29 "account_numbers": [30 "12345678901234567"31 ],32 "country_code": "US",33 "cases": [34 "PP-AD-12345",35 "PP-BD-56789"36 ],37 "contains_pii": true,38 "document_class": "PROOF_OF_IDENTITY"39 },40 "files": [41 {42 "file_id": 1,43 "size_in_bytes": 167363,44 "mime_type": "image/jpeg",45 "filename": "doc.jpeg",46 "create_time": "2018-04-12T23:20:50.52Z",47 "update_time": "2019-04-12T10:00:00.00Z",48 "links": [49 {50 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",51 "rel": "self"52 },53 {54 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",55 "rel": "download"56 }57 ]58 }59 ],60 "links": [61 {62 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",63 "rel": "self"64 }65 ]66 },67 {68 "id": "CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4c",69 "create_time": "2018-04-13T23:20:50.52Z",70 "update_time": "2019-04-13T10:00:00.00Z",71 "source": "csknowledgebasenodeweb",72 "metadata": {73 "account_numbers": [74 "12345678901234567"75 ],76 "country_code": "US",77 "cases": [78 "PP-AD-7868"79 ],80 "contains_pii": true,81 "document_class": "PROOF_OF_ADDRESS"82 },83 "files": [84 {85 "file_id": 1,86 "size_in_bytes": 678543,87 "mime_type": "image/jpeg",88 "filename": "doc.jpeg",89 "create_time": "2018-04-12T23:20:50.52Z",90 "update_time": "2019-04-12T10:00:00.00Z",91 "links": [92 {93 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4c/files/1",94 "rel": "self"95 },96 {97 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4c/files/1/download",98 "rel": "download"99 }100 ]101 }102 ],103 "links": [104 {105 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4c",106 "rel": "self"107 }108 ]109 }110 ],111 "total_items": 10,112 "total_pages": 5,113 "links": [114 {115 "href": "/v2/content/documents?page_size=2&metadata.account_numbers=12345678901234567&total_required=true&page=2",116 "rel": "self"117 },118 {119 "href": "/v2/content/documents?page_size=2&metadata.account_numbers=12345678901234567&total_required=true&page=1",120 "rel": "first"121 },122 {123 "href": "/v2/content/documents?page_size=2&metadata.account_numbers=12345678901234567&total_required=true&page=1",124 "rel": "prev"125 },126 {127 "href": "/v2/content/documents?page_size=2&metadata.account_numbers=12345678901234567&total_required=true&page=3",128 "rel": "next"129 },130 {131 "href": "/v2/content/documents?page_size=2&metadata.account_numbers=12345678901234567&total_required=true&page=5",132 "rel": "last"133 }134 ]135 }136 }137}
Document Get
Get document sample
1{2 "description": "Get document object (document and file metadata) by document identifier. Document identifier conforms to the standard pattern of {domain_id}-{assigned_app_id}-{uuid}. Documents migrated from DMS 1.0 have a slightly different format for document id.",3 "title": "Get document by identifier.",4 "runnable": true,5 "operationId": "document.get",6 "request": {7 "method": "GET",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"12 }13 },14 "response": {15 "status": "200 OK",16 "headers": {17 "Content-Type": "application/json",18 "Content-length": "45437",19 "Correlation-Id": "dab83c13fe192"20 },21 "body": {22 "id": "CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",23 "create_time": "2018-04-12T23:20:50.52Z",24 "update_time": "2019-04-12T10:00:00.00Z",25 "source": "csknowledgebasenodeweb",26 "metadata": {27 "account_numbers": [28 "12345678901234567"29 ],30 "country_code": "US",31 "cases": [32 "PP-AD-12345",33 "PP-BD-56789"34 ],35 "contains_pii": true,36 "document_class": "PROOF_OF_IDENTITY"37 },38 "files": [39 {40 "file_id": 1,41 "size_in_bytes": 167363,42 "mime_type": "image/jpeg",43 "filename": "doc.jpeg",44 "create_time": "2018-04-12T23:20:50.52Z",45 "update_time": "2019-04-12T10:00:00.00Z",46 "links": [47 {48 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",49 "rel": "self"50 },51 {52 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",53 "rel": "download"54 }55 ]56 }57 ],58 "links": [59 {60 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",61 "rel": "self"62 }63 ]64 }65 }66}
Document Update
Patch document sample
1{2 "description": "Update document metadata for the fields defined for the calling component.",3 "title": "Update document metadata.",4 "runnable": true,5 "operationId": "document.metadata.update",6 "request": {7 "method": "PATCH",8 "headers": {9 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",10 "Content-Type": "application/json",11 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"12 },13 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",14 "body": [15 {16 "op": "add",17 "path": "/metadata/document_type",18 "value": "DRIVERS_LICENSE"19 },20 {21 "op": "add",22 "path": "/metadata/cases",23 "value": "PP-CS-12345"24 },25 {26 "op": "replace",27 "path": "/metadata/account_numbers",28 "value": "1234567890"29 },30 {31 "op": "replace",32 "path": "/metadata/cases/1",33 "value": "PP-CS-67890"34 },35 {36 "op": "replace",37 "path": "/metadata/cases",38 "value": [39 "PP-CS-12345",40 "PP-CS-67890"41 ]42 },43 {44 "op": "remove",45 "path": "/metadata/contains_pii"46 },47 {48 "op": "remove",49 "path": "/metadata/cases/0"50 },51 {52 "op": "remove",53 "path": "/metadata/cases",54 "value": "PP-CS-67890"55 },56 {57 "op": "add",58 "path": "/metadata/classification",59 "value": {60 "create_time": "2022-10-14T14:15:34.740Z",61 "model": {62 "name": "classification",63 "version": "v1.0.0"64 },65 "detected_document_classes": [66 "PROOF_OF_IDENTITY"67 ],68 "detected_types": {69 "document_type": "PASSPORT",70 "percentage_confidence": "38.28",71 "alternate_values": [72 {73 "document_type": "Others",74 "percentage_confidence": "29.09"75 }76 ]77 }78 }79 },80 {81 "op": "replace",82 "path": "/metadata/classification",83 "value": {84 "create_time": "2022-10-15T14:15:34.740Z",85 "model": {86 "name": "classification",87 "version": "v2.0.0"88 },89 "detected_document_classes": [90 "PROOF_OF_ADDRESS"91 ],92 "detected_types": {93 "document_type": "PHONE_BILL",94 "percentage_confidence": "40.00",95 "alternate_values": [96 {97 "document_type": "Others",98 "percentage_confidence": "29.09"99 }100 ]101 }102 }103 },104 {105 "op": "remove",106 "path": "/metadata/classification"107 }108 ]109 },110 "response": {111 "status": "204 No Content",112 "headers": {113 "Content-Type": "application/json",114 "Correlation-Id": "dab83c13fe192"115 }116 }117}
Document Delete
Delete document sample
1{2 "description": "Delete document object (document, file metadata and the actual file) by document identifier.",3 "title": "Delete document by identifier.",4 "runnable": true,5 "operationId": "document.delete",6 "request": {7 "method": "DELETE",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8"11 }12 },13 "response": {14 "status": "204 No Content",15 "headers": {16 "Correlation-Id": "dab83c13fe192"17 }18 }19}
Document Files Get
Get files sample
1{2 "description": "Get the file collection associated with the document by the document id.",3 "title": "Get Files Collection for Document.",4 "runnable": true,5 "operationId": "documents.get.files",6 "request": {7 "method": "GET",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"12 }13 },14 "response": {15 "status": "200 OK",16 "headers": {17 "Content-Type": "application/json"18 },19 "body": {20 "files": [21 {22 "file_id": 1,23 "size_in_bytes": 167363,24 "mime_type": "image/jpeg",25 "filename": "doc.jpeg",26 "create_time": "2018-04-12T23:20:50.52Z",27 "update_time": "2019-04-12T10:00:00.00Z",28 "links": [29 {30 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",31 "rel": "self"32 },33 {34 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",35 "rel": "download"36 }37 ]38 }39 ]40 }41 }42}
Document File Get
Get file sample
1{2 "description": "Get file associated with the document.",3 "title": "Get file associated to the document by the document id and file reference.",4 "runnable": true,5 "operationId": "documents.get.files.file",6 "request": {7 "method": "GET",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"12 }13 },14 "response": {15 "status": "200 OK",16 "headers": {17 "Content-Type": "application/json"18 },19 "body": {20 "file_id": 1,21 "size_in_bytes": 167363,22 "mime_type": "image/jpeg",23 "filename": "doc.jpeg",24 "create_time": "2018-04-12T23:20:50.52Z",25 "update_time": "2019-04-12T10:00:00.00Z",26 "links": [27 {28 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",29 "rel": "self"30 },31 {32 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",33 "rel": "download"34 }35 ]36 }37 }38}
Document File Download
Download sample
1{2 "description": "Download the file binary data associated to the document by the document id and file reference.",3 "title": "Get File Content.",4 "runnable": true,5 "operationId": "documents.get.files.file.download",6 "request": {7 "method": "GET",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Accept": "application/pdf",12 "Authorization": "Bearer A101.OLQiCxMmoVwigKQQDu3CYlamZ1KTKQmhrbAZK85RIy4IiWh9d_up_Nliuq_lfZdU.P3gvkY3PO28akjKYaDorm12QdfK"13 }14 },15 "response": {16 "status": "200 OK",17 "headers": {18 "Content-Type": "application/pdf",19 "Content-length": "45437",20 "Correlation-Id": "dab83c13fe192",21 "Content-Disposition": "inline; filename=sample_file.pdf"22 },23 "body": "<<binary>>"24 }25}
Document Capture
Extract sample
1{2 "description": "Initiate document capture process to extract raw text and fields associated with the file.",3 "title": "Initiate Document Capture Process.",4 "runnable": true,5 "operationId": "documents.files.file.extract",6 "request": {7 "method": "POST",8 "path": "v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/extract",9 "headers": {10 "PayPal-Application-Context": "eyJ4NXQjUzI1NiI6Im94T0ZQU1RtVHRXcFdOYWlRb1U5Tmltc25VWjM4dXRpcUJHbFUzN3VKalEiLCJ4NXQiOiI5QUxfZWNBYU12RlFzV1RQOEswNlAwVEFkRXMiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkb2NjZW50cmFsYXBpc2VydiIsInNlY3VyaXR5X3pvbmUiOiJIUloiLCJ0ZW5hbnRfbmFtZSI6InBheXBhbCIsImFwcGxpY2F0aW9uX3R5cGUiOiJyYXB0b3IiLCJpc3MiOiJrZXltYWtlcmFwaV9wYXlwYWwiLCJ2ZXJzaW9uIjoiVEVTVCIsInNvZnRfZXhwaXJ5Ijp0cnVlLCJhdWQiOiJkb2NjZW50cmFsYXBpc2VydiIsImFwcGxpY2F0aW9uX25hbWUiOiJkb2NjZW50cmFsYXBpc2VydiIsInBlcm1pc3Npb25zIjpbImRlbGV0ZSIsInJlYWRfd3JpdGUiLCJyZWFkX3dyaXRlX2FsbCJdLCJleHAiOjE1NjAxMjA3MjkzNDMsImlhdCI6MTU2MDExOTI4OTM0MywianRpIjoxNTYwMTE5Mjg5MzQzfQ.rGnHcbdTcwLttCL6HKD8E6ojCrELZ-RN02SuHKmHoNNDBSwkOiuhLowLgl_HdQdA8SryrJw_31KTMCLFh807Gll_jR_InroHycrMz2ioVWCyjlh1smDfAjSX0udSDSpIsngTQS505yjNQu_lA_MM6utiGXBm3InzyuJCXUTsWO8",11 "Prefer": "respond-async"12 }13 },14 "response": {15 "status": "202 Accepted",16 "headers": {17 "Content-Type": "application/json"18 },19 "body": {20 "file_id": 1,21 "size_in_bytes": 167363,22 "mime_type": "image/jpeg",23 "filename": "doc.jpeg",24 "create_time": "2018-04-12T23:20:50.52Z",25 "update_time": "2019-04-12T10:00:00.00Z",26 "links": [27 {28 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1",29 "rel": "self"30 },31 {32 "href": "/v2/content/documents/CSO-020-0260e518-062d-45cc-8e4a-da9324c17f4b/files/1/download",33 "rel": "download"34 }35 ]36 }37 }38}