Update a Generic Document

PATCH

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

PATCH

/api/v1/document/generics/:document-id

1 curl -X PATCH https://withpersona.com/api/v1/document/generics/document-id \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "data": {}
6 }'

Try it

200Updated

1 {
2   "data": {
3     "type": "document/generic",
4     "id": "doc_8HfuATwEZbXT532wv6pzWMTN",
5     "attributes": {
6       "kind": "proof_of_address",
7       "status": "initiated",
8       "created-at": "2020-04-18T15:43:25.000Z",
9       "processed-at": {},
10       "files": [
11         {
12           "filename": "multipage_example.pdf",
13           "url": "https://withpersona.com/api/v1/files/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBdHc4IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c4482780e1fa5c7bc0a26fc73b1dd76c44b98ad8/multipage_example.pdf"
14         }
15       ]
16     },
17     "relationships": {
18       "inquiry": {
19         "data": {
20           "type": "inquiry",
21           "id": "inq_jdRz9RHNRzkjxUqZApHwX1ZU"
22         }
23       }
24     }
25   }
26 }

Updates an existing generic document. Can only update initiated documents.

Path parameters

document-idstringRequired

Request

This endpoint expects an object.

dataobjectRequired

Response

200

dataobject or null

Update a Generic Document

Path parameters

Headers

Request

Response

Errors