Retrieve an Inquiry

GET

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

GET

/api/v1/inquiries/:inquiry-id

1 curl https://api.withpersona.com/api/v1/inquiries/inquiry-id \
2      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
4     "attributes": {
5       "status": "pending",
6       "reference-id": "abc-123",
7       "note": "A helpful note",
8       "behaviors": {
9         "api-version-less-than-minimum-count": 0,
10         "autofill-cancels": 0,
11         "autofill-starts": 0,
12         "behavior-threat-level": "low",
13         "bot-score": 70,
14         "completion-time": 40.172463903,
15         "devtools-open": false,
16         "debugger-attached": false,
17         "distraction-events": 0,
18         "hesitation-baseline": 29677,
19         "hesitation-count": 3,
20         "hesitation-percentage": 96.88310813087575,
21         "hesitation-time": 28752,
22         "mobile-sdk-version-less-than-minimum-count": 0,
23         "request-spoof-attempts": 0,
24         "shortcut-copies": 0,
25         "shortcut-pastes": 0,
26         "user-agent-spoof-attempts": 0
27       },
28       "tags": [],
29       "creator": "creator@withpersona.com",
30       "reviewer-comment": "This is a comment for this inquiry!",
31       "created-at": "2023-03-29T19:06:45.000Z",
32       "updated-at": "2023-03-30T19:07:01.000Z",
33       "started-at": "2023-03-30T19:07:01.000Z",
34       "expires-at": "2023-03-31T19:07:01.000Z",
35       "completed-at": "2023-03-28T18:35:10.000Z",
36       "failed-at": "2023-03-28T18:35:10.000Z",
37       "marked-for-review-at": "2023-03-28T18:35:10.000Z",
38       "decisioned-at": "2023-03-28T18:35:10.000Z",
39       "expired-at": "2023-03-28T18:35:10.000Z",
40       "redacted-at": "2023-03-28T18:35:10.000Z",
41       "previous-step-name": "start",
42       "next-step-name": "verification_document",
43       "fields": {
44         "name-first": {
45           "type": "string",
46           "value": "Jane"
47         },
48         "name-middle": {
49           "type": "string",
50           "value": "Marie"
51         },
52         "name-last": {
53           "type": "string",
54           "value": "Doe"
55         },
56         "address-street-1": {
57           "type": "string",
58           "value": "123 Main St"
59         },
60         "address-street-2": {
61           "type": "string"
62         },
63         "address-city": {
64           "type": "string",
65           "value": "San Francisco"
66         },
67         "address-subdivision": {
68           "type": "string",
69           "value": "California"
70         },
71         "address-postal-code": {
72           "type": "string",
73           "value": "94111"
74         },
75         "address-country-code": {
76           "type": "string",
77           "value": "US"
78         },
79         "birthdate": {
80           "type": "date",
81           "value": "1995-09-08"
82         },
83         "email-address": {
84           "type": "string",
85           "value": "jane@doe.com"
86         },
87         "phone-number": {
88           "type": "string"
89         },
90         "identification-number": {
91           "type": "string"
92         }
93       },
94       "birthdate": "1995-09-08",
95       "name-first": "Jane",
96       "name-middle": "Marie",
97       "name-last": "Doe",
98       "email-address": "jane@doe.com",
99       "address-street-1": "123 Main St",
100       "address-city": "San Francisco",
101       "address-subdivision": "California",
102       "address-postal-code": "94111",
103       "address-subdivision-abbr": "CA",
104       "address-postal-code-abbr": "94111"
105     },
106     "relationships": {
107       "account": {
108         "data": {
109           "id": "act_n2uq9eKMboaCQzu9ALWYcVdN",
110           "type": "account"
111         }
112       },
113       "documents": {
114         "data": []
115       },
116       "template": {
117         "data": {}
118       },
119       "inquiry-template": {
120         "data": {
121           "id": "itmpl_p8ANAJy9iqadm2buF2xcVgqH",
122           "type": "inquiry-template"
123         }
124       },
125       "inquiry-template-version": {
126         "data": {
127           "id": "itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo",
128           "type": "inquiry-template-version"
129         }
130       },
131       "reports": {
132         "data": []
133       },
134       "reviewer": {
135         "data": {}
136       },
137       "selfies": {
138         "data": []
139       },
140       "sessions": {
141         "data": []
142       },
143       "verifications": {
144         "data": [
145           {
146             "id": "ver_uHDiwtcx3htjajvEaeMjPQcE",
147             "type": "verification/database"
148           }
149         ]
150       }
151     },
152     "type": "inquiry"
153   },
154   "included": [
155     {
156       "type": "inquiry-session",
157       "attributes": {
158         "status": "expired",
159         "created-at": "2023-07-25T04:15:20.000Z",
160         "started-at": "2023-07-25T05:14:50.000Z",
161         "expired-at": "2023-07-26T05:14:50.000Z",
162         "ip-address": "127.0.0.1",
163         "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
164         "os-name": "Mac",
165         "os-full-version": "10.15.7",
166         "device-type": "desktop",
167         "browser-name": "Chrome",
168         "browser-full-version": "115.0.0.0",
169         "is-proxy": false,
170         "is-tor": false,
171         "is-datacenter": false,
172         "is-vpn": false,
173         "threat-level": "low",
174         "country-code": "US",
175         "country-name": "United States",
176         "region-code": "CA",
177         "region-name": "California",
178         "latitude": 37.7688,
179         "longitude": -122.262
180       },
181       "id": "iqse_ABC123",
182       "relationships": {
183         "inquiry": {
184           "data": {
185             "type": "inquiry",
186             "id": "inq_ABC123"
187           }
188         }
189       }
190     },
191     {
192       "type": "inquiry-template",
193       "attributes": {
194         "name": "Twilio Desktop",
195         "status": "active"
196       },
197       "id": "itmpl_ABC123",
198       "relationships": {
199         "latest-published-version": {
200           "data": {
201             "type": "inquiry-template-version",
202             "id": "itmplv_ABC123"
203           }
204         }
205       }
206     }
207   ]
208 }

Retrieves the details of an existing Inquiry.

In the Embedded Flow, the inquiry-id is the first parameter of the onStart callback. In the Hosted Flow, the inquiry-id is a query parameter in the onComplete callback.

Template information will be found in data.relationships.inquiry-template if the inquiry is a Dynamic Flow inquiry, and in data.relationships.template if the inquiry is a Legacy 2.0 inquiry. For more information, see Dynamic Flow vs. Legacy Templates.

Retrieves the details of an existing Inquiry. In the [Embedded Flow](https://docs.withpersona.com/embedded-flow), the `inquiry-id` is the first parameter of the onStart callback. In the [Hosted Flow](https://docs.withpersona.com/hosted-flow), the `inquiry-id` is a query parameter in the onComplete callback. Template information will be found in `data.relationships.inquiry-template` if the inquiry is a Dynamic Flow inquiry, and in `data.relationships.template` if the inquiry is a Legacy 2.0 inquiry. For more information, see [Dynamic Flow vs. Legacy Templates](https://docs.withpersona.com/inquiry-templates#dynamic-flow-vs-legacy-templates).

Authentication

AuthorizationBearer

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

Path parameters

inquiry-idstringRequired

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

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 for more details.

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.

Response

This endpoint returns an Inquiry object and (optionally) its related objects in included.

dataobject

An Inquiry object

includedlist of objects

Included by default:

Reports
Verifications
Inquiry Sessions
Documents
Inquiry Template

Anything else must be explicitly requested with the include query parameter.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors