Update a Government ID Document

PATCH

https://withpersona.com/api/v1/document/government-ids/:document-id

PATCH

/api/v1/document/government-ids/:document-id

1 curl -X PATCH https://withpersona.com/api/v1/document/government-ids/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/government-id",
4     "id": "doc_FxCzxBkkF8V1AtxmY19zhVAz",
5     "attributes": {
6       "status": "initiated",
7       "created-at": "2020-09-13T02:34:57.000Z",
8       "processed-at": {},
9       "front-photo": {},
10       "back-photo": {},
11       "selfie-photo": {},
12       "id-class": {},
13       "name-middle": {},
14       "name-last": {},
15       "birthdate": {},
16       "address-street-1": {},
17       "address-street-2": {},
18       "address-city": {},
19       "address-subdivision": {},
20       "address-postal-code": {},
21       "endorsements": {},
22       "restrictions": {},
23       "vehicle-class": {}
24     },
25     "relationships": {
26       "inquiry": {
27         "data": {
28           "type": "inquiry",
29           "id": "inq_Dj1JxEG9K153GbvFYGScCRlL"
30         }
31       }
32     }
33   }
34 }

Updates an existing government ID document. Can only update initiated documents.

Path parameters

document-idstringRequired

Request

This endpoint expects an object.

dataobjectRequired

Response

200

dataobject or null

Update a Government ID Document

Path parameters

Headers

Request

Response

Errors