Retrieve a Document

GET

https://withpersona.com/api/v1/documents/:document-id

GET

/api/v1/documents/:document-id

1 curl https://withpersona.com/api/v1/documents/document-id \
2      -H "Authorization: <apiKey>"

Try it

200Retrieved

1 {
2   "data": {
3     "type": "document/generic",
4     "id": "doc_JT2Bc2g6rEAVsaZjXs3d6oYq",
5     "attributes": {
6       "kind": "proof_of_employment",
7       "status": "ready",
8       "created-at": "2020-04-07T02:33:41.000Z",
9       "processed-at": "2020-04-07T05:50:53.000Z",
10       "files": [
11         {
12           "filename": "multipage_example.pdf",
13           "url": "https://withpersona.com/api/v1/files/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBdUUyIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--7b006f97a2438d58fc9aec7baa121592f823e678/multipage_example.pdf"
14         }
15       ]
16     },
17     "relationships": {
18       "inquiry": {
19         "data": {
20           "type": "inquiry",
21           "id": "inq_GC7xwqnhgNHwomz5yT3geLrT"
22         }
23       }
24     }
25   }
26 }

Retrieve the details of a Document.

Path parameters

document-idstringRequired

Response

200

dataobject or null

Retrieve a Document

Path parameters

Headers

Response

Errors