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
    • POSTResume an Inquiry
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • GETRetrieve a Report
    • DELRedact a Report
    • GETRetrieve a Verification
    • POSTDecline an Inquiry
    • POSTApprove an Inquiry
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • GETList all Accounts
    • POSTCreate an Account
    • GETDownload a File
    • GETList all API Logs
    • POSTCreate a Generic Document
    • GETRetrieve an API Log
    • GETRetrieve a Document
    • POSTCreate a Phone Number Verification
    • PATCHUpdate a Generic Document
    • POSTCreate a Document Verification
    • POSTSubmit a Generic Document
    • GETList all Events
    • POSTCreate a Government ID Verification
    • POSTCreate a Database Verification
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • GETRetrieve an Event
    • POSTImport Accounts
    • GETRetrieve an Importer
    • POSTConsolidate Accounts
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport Government ID Number Lists
    • POSTImport Name Lists
    • POSTImport IP Address Lists
    • POSTCreate a Government ID Document
    • POSTImport Phone Number Lists
    • PATCHUpdate a Government ID Document
    • POSTSubmit a Government ID Document
    • POSTSubmit a Government ID Verification
    • PATCHUpdate a Government ID Verification
    • GETList all Lists
    • GETRetrieve a List
    • DELArchive a List
    • POSTCreate a Browser Fingerprint List
    • POSTCreate a Geolocation List
    • POSTCreate an Email Address List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a Country List
    • POSTCreate an IP Address List
    • POSTCreate a Phone Number List
    • POSTCreate a Government ID Number List
    • POSTCreate a Name List
    • POSTCreate a Country List Item
    • POSTCreate an Email Address List Item
    • POSTCreate a Phone Number List Item
    • DELArchive a Browser Fingerprint List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Geolocation List Item
    • POSTCreate a Government ID Number List Item
    • DELArchive an IP Address List Item
    • DELArchive a Government ID Number List Item
    • DELArchive a Name List Item
    • DELArchive an Email Address List Item
    • DELArchive a Country List Item
    • DELArchive a Geolocation List Item
    • POSTCreate a Name List Item
    • DELArchive a Phone Number List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETList all Cases
    • POSTCreate a Case
    • POSTCreate a Selfie Verification
    • POSTSubmit a Selfie Verification
    • GETRetrieve Case
    • PATCHUpdate a Case
    • POSTRemove a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTRemove a tag
    • GETPrint Inquiry PDF
    • GETPrint Verification PDF
    • GETPrint Report PDF
    • POSTReport a Government ID Verification
    • POSTBusiness Lookup Report
    • POSTAdd Persona objects
    • POSTAssign a Case
    • POSTCreate a Face List Item
    • POSTCreate a Face List
    • DELArchive a Face List Item
    • POSTImport Face Lists
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
    • GETList all User Audit Logs
    • GETRetrieve an User Audit Log
    • POSTSet status for a case
    • GETRetrieve a Government Id Verification
    • GETRetrieve a Selfie Verification
    • POSTSubmit a Database Verification
    • GETRetrieve a Database Verification
    • POSTCreate a Phone Carrier Database Verification
    • POSTSubmit a Phone Carrier Database Verification
    • GETRetrieve a Phone Carrier Database Verification
    • POSTCreate a Serpro Database Verification
    • POSTSubmit a Serpro Database Verification
    • GETRetrieve a Serpro Database Verification
    • POSTCreate a TIN Database Verification
    • POSTSubmit a TIN Database Verification
    • GETRetrieve a TIN Database Verification
    • POSTConfirm a Phone Number Verification
    • GETRetrieve a Phone Number Verification
    • POSTSend an SMS
    • POSTCreate a Workflow Run
    • POSTCreate an Email Address Verification
    • POSTSend an email
    • POSTConfirm an Email Address Verification
    • GETRetrieve a Email Address Verification
    • GETList all API keys
    • POSTCreate an API key
    • POSTExpire an API key
    • GETRetrieve an API key
    • PATCHUpdate an API key
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

POST
https://withpersona.com/api/v1/api-keys/:api-key-id/expire
POST
/api/v1/api-keys/:api-key-id/expire
1import requests
2
3url = "https://withpersona.com/api/v1/api-keys/api-key-id/expire"
4
5payload = {}
6headers = {
7 "Authorization": "<apiKey>",
8 "Content-Type": "application/json"
9}
10
11response = requests.post(url, json=payload, headers=headers)
12
13print(response.json())
Try it
1{
2 "data": {
3 "type": "api-key",
4 "id": "api_eENJtyj61qWGLWCd2X7vHyAf",
5 "attributes": {
6 "name": {},
7 "note": {},
8 "value": {},
9 "api-version": "2021-07-05",
10 "api-key-inflection": "kebab",
11 "permissions": [
12 "account.read",
13 "account.write",
14 "api_log.read",
15 "..."
16 ],
17 "api-attributes-allowlist": [
18 "address_*",
19 "allowed_users",
20 "..."
21 ],
22 "ip-address-allowlist": [
23 "*"
24 ],
25 "last-used-at": "2022-08-17T23:44:00.000Z",
26 "expires-at": "2022-08-17T23:45:00.000Z",
27 "created-at": "2022-08-17T23:18:13.000Z"
28 }
29 }
30}
Was this page helpful?
Previous

Retrieve an API key

Next
Built with
Deactivate an API key within some time period
Expire an API key

Authentication

Authorizationstring
API Key authentication via header

Path parameters

api-key-idstringRequired

API key’s ID (starts with “api_”)

Request

This endpoint expects an object.
metaobjectOptional

Response

200
dataobject or null

Errors

200