Expire an Inquiry

POST

https://withpersona.com/api/v1/inquiries/:inquiry-id/expire

POST

/api/v1/inquiries/:inquiry-id/expire

1 curl -X POST https://withpersona.com/api/v1/inquiries/inquiry-id/expire \
2      -H "Authorization: <apiKey>"

Try it

200Successful

1 {
2   "data": {
3     "type": "inquiry",
4     "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
5     "attributes": {
6       "status": "expired",
7       "subject": {},
8       "reference-id": {},
9       "created-at": "2019-11-15T05:27:24.000Z",
10       "completed-at": {},
11       "expired-at": "2019-11-15T05:28:02.000Z"
12     },
13     "relationships": {
14       "account": {
15         "data": {
16           "type": "account",
17           "id": "act_n2uq9eKMboaCQzu9ALWYcVdN"
18         }
19       },
20       "template": {
21         "data": {
22           "type": "template",
23           "id": "tmpl_DyLDeD3ftjxuMstYTvgwPX5f"
24         }
25       },
26       "reports": {
27         "data": []
28       },
29       "verifications": {
30         "data": [
31           {
32             "type": "verification/database",
33             "id": "ver_uHDiwtcx3htjajvEaeMjPQcE"
34           }
35         ]
36       }
37     }
38   }
39 }

Expires an inquiry and all sessions on the inquiry. Cancels any pending verifications on the inquiry. The inquiry can still be resumed after expiry.

Path parameters

inquiry-idstringRequired

Response

200

dataobject or null

Path parameters

Headers

Response