For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsAPI ReferenceChangelog
OverviewInquiriesTransactionsAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Response Body
    • Idempotence
    • Pagination
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • OpenAPI Specification
    • Cases
    • Connect
    • Documents
    • Inquiries
      • GETList all Inquiries
      • POSTCreate an Inquiry
      • GETRetrieve an Inquiry
      • DELRedact an Inquiry
      • PATCHUpdate an Inquiry
      • POSTAdd tag to an Inquiry
      • POSTApprove an Inquiry
      • POSTDecline an Inquiry
      • POSTMark an Inquiry for manual review
      • POSTExpire an Inquiry
      • POSTGenerate a one-time link for an Inquiry
      • GETPrint Inquiry PDF
      • POSTRemove tag from an Inquiry
      • POSTResume an Inquiry
      • POSTSet tags on an Inquiry
      • POSTPerform Simulate Actions
      • PATCHSet Simulated Data
      • POSTSearch Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API ReferenceInquiries

List all Inquiries

GET
https://api.withpersona.com/api/v1/inquiries
GET
/api/v1/inquiries
$curl https://api.withpersona.com/api/v1/inquiries \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
5      "attributes": {
6        "status": "pending",
7        "reference-id": "abc-123",
8        "note": "A helpful note",
9        "behaviors": {},
10        "tags": [],
11        "creator": "creator@withpersona.com",
12        "reviewer-comment": "This is a comment for this inquiry!",
13        "created-at": "2023-03-29T19:06:45.000Z",
14        "updated-at": "2023-03-30T19:07:01.000Z",
15        "started-at": "2023-03-30T19:07:01.000Z",
16        "expires-at": "2023-03-31T19:07:01.000Z",
17        "completed-at": "2023-03-28T18:35:10.000Z",
18        "failed-at": "2023-03-28T18:35:10.000Z",
19        "marked-for-review-at": "2023-03-28T18:35:10.000Z",
20        "decisioned-at": "2023-03-28T18:35:10.000Z",
21        "expired-at": "2023-03-28T18:35:10.000Z",
22        "redacted-at": "2023-03-28T18:35:10.000Z",
23        "previous-step-name": "start",
24        "next-step-name": "verification_document",
25        "fields": {
26          "name-first": {
27            "type": "string",
28            "value": "Jane"
29          },
30          "name-middle": {
31            "type": "string",
32            "value": "Marie"
33          },
34          "name-last": {
35            "type": "string",
36            "value": "Doe"
37          },
38          "address-street-1": {
39            "type": "string",
40            "value": "123 Main St"
41          },
42          "address-street-2": {
43            "type": "string"
44          },
45          "address-city": {
46            "type": "string",
47            "value": "San Francisco"
48          },
49          "address-subdivision": {
50            "type": "string",
51            "value": "California"
52          },
53          "address-postal-code": {
54            "type": "string",
55            "value": "94111"
56          },
57          "address-country-code": {
58            "type": "string",
59            "value": "US"
60          },
61          "birthdate": {
62            "type": "date",
63            "value": "1995-09-08"
64          },
65          "email-address": {
66            "type": "string",
67            "value": "jane@doe.com"
68          },
69          "phone-number": {
70            "type": "string"
71          },
72          "identification-number": {
73            "type": "string"
74          }
75        },
76        "birthdate": "1995-09-08",
77        "name-first": "Jane",
78        "name-middle": "Marie",
79        "name-last": "Doe",
80        "email-address": "jane@doe.com",
81        "address-street-1": "123 Main St",
82        "address-city": "San Francisco",
83        "address-subdivision": "California",
84        "address-postal-code": "94111",
85        "address-subdivision-abbr": "CA",
86        "address-postal-code-abbr": "94111",
87        "reviewer": "reviewer@example.com",
88        "reviewer-type": "user"
89      },
90      "relationships": {
91        "account": {
92          "data": {
93            "id": "act_n2uq9eKMboaCQzu9ALWYcVdN",
94            "type": "account"
95          }
96        },
97        "documents": {
98          "data": []
99        },
100        "template": {
101          "data": {}
102        },
103        "inquiry-template": {
104          "data": {
105            "id": "itmpl_p8ANAJy9iqadm2buF2xcVgqH",
106            "type": "inquiry-template"
107          }
108        },
109        "inquiry-template-version": {
110          "data": {
111            "id": "itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo",
112            "type": "inquiry-template-version"
113          }
114        },
115        "reports": {
116          "data": []
117        },
118        "selfies": {
119          "data": []
120        },
121        "sessions": {
122          "data": []
123        },
124        "verifications": {
125          "data": [
126            {
127              "id": "ver_uHDiwtcx3htjajvEaeMjPQcE",
128              "type": "verification/database"
129            }
130          ]
131        }
132      },
133      "type": "inquiry"
134    }
135  ],
136  "links": {
137    "prev": "/api/v1/inquiries?page%5Bafter%5D=inq_ABC123",
138    "next": "/api/v1/inquiries?page%5Bafter%5D=inq_ByBdXDqUrguLAHjGZMuDZLCx"
139  }
140}
Returns a list of your organization's inquiries. Note that this endpoint aggregates inquiries across all inquiry template(s). See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.
Was this page helpful?
Previous

Create an Inquiry

Next
Built with

Returns a list of your organization’s inquiries.

Note that this endpoint aggregates inquiries across all inquiry template(s). See Pagination for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent.
Persona-VersionenumOptional
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).

Query parameters

pageobjectOptional
fieldsmap from strings to stringsOptional
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.
filterobjectOptional

Response

This endpoint returns a collection of Inquiry objects.
datalist of objects
An array of Inquiries
linksobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error

Server API version. More info on versioning can be found here.

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.