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
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • POSTResume an Inquiry
    • GETRetrieve a Verification
    • POSTApprove an Inquiry
    • GETRetrieve a Report
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • POSTDecline an Inquiry
    • GETList all Accounts
    • POSTCreate an Account
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETDownload a File
    • GETList all API Logs
    • GETRetrieve an API Log
    • POSTCreate a Generic Document
    • POSTSubmit a Generic Document
    • POSTCreate a Phone Number Verification
    • GETList all Events
    • PATCHUpdate a Generic Document
    • GETRetrieve a Document
    • POSTCreate a Database Verification
    • POSTCreate a Government ID Verification
    • POSTCreate a Document Verification
    • GETRetrieve an Event
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • POSTImport Accounts
    • POSTConsolidate Accounts
    • GETRetrieve an Importer
    • POSTImport Government ID Number Lists
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport IP Address Lists
    • POSTImport Name Lists
    • POSTImport Phone Number Lists
    • POSTCreate a Government ID Document
    • POSTSubmit a Government ID Verification
    • POSTSubmit a Government ID Document
    • PATCHUpdate a Government ID Document
    • GETRetrieve a List
    • DELArchive a List
    • GETList all Lists
    • POSTCreate a Browser Fingerprint List
    • PATCHUpdate a Government ID Verification
    • POSTCreate a Country List
    • POSTCreate an Email Address List
    • POSTCreate a Geolocation List
    • POSTCreate a Government ID Number List
    • POSTCreate an IP Address List
    • POSTCreate a Name List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a County List Item
    • POSTCreate a Phone Number List
    • POSTCreate an Email Address List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Name List Item
    • POSTCreate a Phone Number List Item
    • POSTCreate a Government ID Number List Item
    • POSTCreate a Geolocation List Item
    • DELArchive a Browser Fingerprint List Item
    • DELArchive a Country List Item
    • DELArchive an Email Address List Item
    • DELArchive a Geolocation List Item
    • DELArchive a Name List Item
    • DELArchive a Phone Number List Item
    • DELArchive a Government ID Number List Item
    • DELArchive an IP Address List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETRetrieve Case
    • GETList all Cases
    • POSTAdd a tag
    • POSTSubmit a Selfie Verification
    • POSTRemove a tag
    • POSTSet all tags
    • POSTRemove a tag
    • POSTCreate a Selfie Verification
    • POSTAdd a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

GET
https://withpersona.com/api/v1/inquiries/:inquiry-id
GET
/api/v1/inquiries/:inquiry-id
1curl 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}
Was this page helpful?
Previous

Redact an Inquiry

Next
Build with
Retrieves the details of an inquiry that has previously been created. In the [Embedded Flow](doc:embedded-flow), the `inquiry-id` is the first parameter of the onStart callback. In the [Hosted Flow](doc:hosted-flow), the `inquiry-id` is a query parameter in the onComplete callback.
Retrieve an Inquiry

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.

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

inquiry-idstringRequired

Headers

Key-InflectionstringOptional
Determines casing for the API response

Response

200
dataobject or null
includedlist of objects or null

Errors