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
    • OpenAPI Specification
    • Cases
    • Documents
    • Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API ReferenceInquiries

Update an Inquiry

PATCH
https://api.withpersona.com/api/v1/inquiries/:inquiry-id
PATCH
/api/v1/inquiries/:inquiry-id
1curl -X PATCH https://api.withpersona.com/api/v1/inquiries/inquiry-id \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it
1{
2  "data": {
3    "type": "inquiry",
4    "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6",
5    "attributes": {
6      "status": "pending",
7      "reference-id": "abc-123",
8      "note": null,
9      "behaviors": {
10        "api-version-less-than-minimum-count": 0,
11        "autofill-cancels": 0,
12        "autofill-starts": 0,
13        "behavior-threat-level": "low",
14        "bot-score": 70,
15        "completion-time": 40.172463903,
16        "devtools-open": false,
17        "debugger-attached": false,
18        "distraction-events": 0,
19        "hesitation-baseline": 29677,
20        "hesitation-count": 3,
21        "hesitation-percentage": 96.88310813087575,
22        "hesitation-time": 28752,
23        "mobile-sdk-version-less-than-minimum-count": 0,
24        "request-spoof-attempts": 0,
25        "shortcut-copies": 0,
26        "shortcut-pastes": 0,
27        "user-agent-spoof-attempts": 0
28      },
29      "tags": [],
30      "creator": "creator@withpersona.com",
31      "reviewer-comment": null,
32      "created-at": "2023-03-29T19:06:45.000Z",
33      "updated-at": "2023-03-29T20:08:47.000Z",
34      "started-at": "2023-03-30T19:07:01.000Z",
35      "expires-at": "2023-03-31T19:07:01.000Z",
36      "completed-at": null,
37      "failed-at": null,
38      "marked-for-review-at": null,
39      "decisioned-at": null,
40      "expired-at": null,
41      "redacted-at": null,
42      "previous-step-name": "start",
43      "next-step-name": "verification_document",
44      "fields": {
45        "name-first": {
46          "type": "string",
47          "value": "Jane"
48        },
49        "name-middle": {
50          "type": "string",
51          "value": "Marie"
52        },
53        "name-last": {
54          "type": "string",
55          "value": "Doe"
56        },
57        "address-street-1": {
58          "type": "string",
59          "value": "123 Main St"
60        },
61        "address-street-2": {
62          "type": "string"
63        },
64        "address-city": {
65          "type": "string",
66          "value": "San Francisco"
67        },
68        "address-subdivision": {
69          "type": "string",
70          "value": "California"
71        },
72        "address-postal-code": {
73          "type": "string",
74          "value": "94111"
75        },
76        "address-country-code": {
77          "type": "string",
78          "value": "US"
79        },
80        "birthdate": {
81          "type": "date",
82          "value": "1995-09-08"
83        },
84        "email-address": {
85          "type": "string",
86          "value": "jane@doe.com"
87        },
88        "phone-number": {
89          "type": "string"
90        },
91        "identification-number": {
92          "type": "string"
93        }
94      }
95    },
96    "relationships": {
97      "account": {
98        "data": {
99          "id": "act_n2uq9eKMboaCQzu9ALWYcVdN",
100          "type": "account"
101        }
102      },
103      "documents": {
104        "data": []
105      },
106      "template": {
107        "data": {}
108      },
109      "inquiry-template": {
110        "data": {
111          "id": "itmpl_p8ANAJy9iqadm2buF2xcVgqH",
112          "type": "inquiry-template"
113        }
114      },
115      "inquiry-template-version": {
116        "data": {
117          "id": "itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo",
118          "type": "inquiry-template-version"
119        }
120      },
121      "reports": {
122        "data": []
123      },
124      "transaction": {},
125      "reviewer": {
126        "data": {}
127      },
128      "selfies": {
129        "data": []
130      },
131      "sessions": {
132        "data": []
133      },
134      "verifications": {
135        "data": [
136          {
137            "id": "ver_uHDiwtcx3htjajvEaeMjPQcE",
138            "type": "verification/database"
139          }
140        ]
141      }
142    }
143  }
144}
Updates an existing Inquiry. Note that if you use webhooks, updates to inquiries that are not in progress can result in data getting out of sync. For example, updating a completed Inquiry will not cause your Inquiry completed webhook to retrigger. Inquiries represent a snapshot of data collected from an individual, so we generally do not recommend updating an Inquiry's data after the Inquiry has been finalized.
Was this page helpful?
Previous

Add tag to an Inquiry

Next
Built with
Add tag to an Inquiry
Updates an existing Inquiry. Note that if you use webhooks, updates to inquiries that are not in progress can result in data getting out of sync. For example, updating a completed Inquiry will not cause your Inquiry completed webhook to retrigger. Inquiries represent a snapshot of data collected from an individual, so we generally do not recommend updating an Inquiry's data after the Inquiry has been finalized.

Authentication

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

Path Parameters

inquiry-idstringRequired

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

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](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](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Request

This endpoint expects an object.
dataobjectOptional

Response

This endpoint returns an Inquiry object and (optionally) its related objects in `included`.
dataobject
An Inquiry object
includedlist of objects or null

Objects that may be returned if specified via the include query parameter in the request.

Errors

Ensures the request is idempotent.

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

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.

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

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.