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

Archive a Government ID Number List Item

DELETE
https://withpersona.com/api/v1/list-item/government-id-numbers/:list-item-id
DELETE
/api/v1/list-item/government-id-numbers/:list-item-id
1curl -X DELETE https://withpersona.com/api/v1/list-item/government-id-numbers/list-item-id \
2     -H "Authorization: <apiKey>"
Try it
1{
2  "data": {
3    "type": "list-item/government-id-number",
4    "id": "ligin_soqGRWaUXZct3pCRbjRaXFqz",
5    "attributes": {
6      "status": "archived",
7      "archived-at": "2020-09-18T19:07:53.000Z",
8      "updated-at": "2020-09-18T18:07:53.000Z",
9      "created-at": "2020-09-18T18:07:53.000Z",
10      "match-count": 0,
11      "id-class": "dl",
12      "id-number": "F4K3NUM"
13    },
14    "relationships": {
15      "creator": {
16        "data": {}
17      }
18    }
19  }
20}
Archived items are not matched against new inquiries.
Was this page helpful?
Previous

Archive an IP Address List Item

Next
Build with
Archive an IP Address List Item
Archived items are not matched against new inquiries.

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

list-item-idstringRequired
ID of list item to archive.

Headers

key-inflectionstringOptional
Determines casing for the API response
idempotence-keystringOptional
API Key authentication via header
ID of list item to archive.
Determines casing for the API response
Ensures the request is idempotent.

Response

200
dataobject or null

Errors