Retrieve an Inquiry

GET

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

GET

/api/v1/inquiries/:inquiry-id

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

Try it

1 {
2   "data": {
3     "type": "inquiry",
4     "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
5     "attributes": {
6       "status": "completed",
7       "subject": {},
8       "reference-id": {},
9       "created-at": "2019-11-15T05:27:24.000Z",
10       "completed-at": "2019-11-15T05:28:02.000Z",
11       "expired-at": {}
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/basic",
33             "id": "ver_uHDiwtcx3htjajvEaeMjPQcE"
34           }
35         ]
36       },
37       "sessions": {
38         "data": [
39           {
40             "type": "session",
41             "id": "iqse_ov4ftVuCYm8U7rNkZADFpiBg"
42           }
43         ]
44       }
45     }
46   },
47   "included": [
48     {
49       "type": "verification/database",
50       "id": "ver_uHDiwtcx3htjajvEaeMjPQcE",
51       "attributes": {
52         "status": "passed",
53         "created-at": "2019-11-15T05:27:59.000Z",
54         "completed-at": "2019-11-15T05:28:02.000Z",
55         "country-code": "US",
56         "name-first": "Rickilus",
57         "name-middle": {},
58         "name-last": "Smith",
59         "address-street-1": "1234 St",
60         "address-street-2": {},
61         "address-city": "San Francisco",
62         "address-subdivision": "California",
63         "address-postal-code": "94000",
64         "birthdate": "1990-01-01"
65       }
66     },
67     {
68       "type": "inquiry-session",
69       "id": "iqse_ueCQP8wmydueLgbsgSVCzt3J",
70       "attributes": {
71         "status": "active",
72         "created-at": "2019-11-15T05:27:59.000Z",
73         "ip-address": "2603:9000:8507:1f2e:d23:b50d:a31e:ce30",
74         "browser-name": "Mobile Safari",
75         "browser-full-version": "13.0.4",
76         "os-name": "iOS",
77         "os-full-version": 13.3,
78         "device-name": "iPhone",
79         "device-type": "smartphone"
80       },
81       "relationships": {
82         "inquiry": {
83           "data": {
84             "type": "inquiry",
85             "id": "inq_rfWJxnYSa725XAQswNwpLubP"
86           }
87         }
88       }
89     }
90   ]
91 }

Retrieves the details of an inquiry that has previously been created.

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.

Path parameters

inquiry-idstringRequired

Response

200

dataobject or null

includedlist of objects or null

Retrieve an Inquiry

Path parameters

Headers

Response

Errors