Help CenterOpenAPI SpecStatus
DocumentationAPI ReferenceChangelogIntegration Guides
DocumentationAPI ReferenceChangelogIntegration Guides
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Idempotence
    • Pagination
    • Serialization
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • POSTResume an Inquiry
    • GETRetrieve a Verification
    • POSTApprove an Inquiry
    • GETRetrieve a Report
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • POSTDecline an Inquiry
    • GETList all Accounts
    • POSTCreate an Account
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETDownload a File
    • GETList all API Logs
    • GETRetrieve an API Log
    • POSTCreate a Generic Document
    • POSTSubmit a Generic Document
    • POSTCreate a Phone Number Verification
    • GETList all Events
    • PATCHUpdate a Generic Document
    • GETRetrieve a Document
    • POSTCreate a Database Verification
    • POSTCreate a Government ID Verification
    • POSTCreate a Document Verification
    • GETRetrieve an Event
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • POSTImport Accounts
    • POSTConsolidate Accounts
    • GETRetrieve an Importer
    • POSTImport Government ID Number Lists
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport IP Address Lists
    • POSTImport Name Lists
    • POSTImport Phone Number Lists
    • POSTCreate a Government ID Document
    • POSTSubmit a Government ID Verification
    • POSTSubmit a Government ID Document
    • PATCHUpdate a Government ID Document
    • GETRetrieve a List
    • DELArchive a List
    • GETList all Lists
    • POSTCreate a Browser Fingerprint List
    • PATCHUpdate a Government ID Verification
    • POSTCreate a Country List
    • POSTCreate an Email Address List
    • POSTCreate a Geolocation List
    • POSTCreate a Government ID Number List
    • POSTCreate an IP Address List
    • POSTCreate a Name List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a County List Item
    • POSTCreate a Phone Number List
    • POSTCreate an Email Address List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Name List Item
    • POSTCreate a Phone Number List Item
    • POSTCreate a Government ID Number List Item
    • POSTCreate a Geolocation List Item
    • DELArchive a Browser Fingerprint List Item
    • DELArchive a Country List Item
    • DELArchive an Email Address List Item
    • DELArchive a Geolocation List Item
    • DELArchive a Name List Item
    • DELArchive a Phone Number List Item
    • DELArchive a Government ID Number List Item
    • DELArchive an IP Address List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETRetrieve Case
    • GETList all Cases
    • POSTAdd a tag
    • POSTSubmit a Selfie Verification
    • POSTRemove a tag
    • POSTSet all tags
    • POSTRemove a tag
    • POSTCreate a Selfie Verification
    • POSTAdd a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

Update a Government ID Document

PATCH
https://withpersona.com/api/v1/document/government-ids/:document-id
PATCH
/api/v1/document/government-ids/:document-id
1curl -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
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.
Was this page helpful?
Previous

Retrieve a List

Next
Build with
Retrieve a List

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

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

document-idstringRequired

Headers

Key-InflectionstringOptional
Determines casing for the API response
Idempotency-KeystringOptional
Ensures the request is idempotent

Request

This endpoint expects an object.
dataobjectRequired

Response

200
dataobject or null

Errors