> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# persona-identity
> Persona Identity - Inquiries, sessions, accounts, and templates
**Server path:** `/persona-identity` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [`persona_identity_accounts_add_tag`](#persona_identity_accounts_add_tag) | Add tag to an Account |
| [`persona_identity_accounts_list_all_relations`](#persona_identity_accounts_list_all_relations) | Get all relations for an Account |
| [`persona_identity_accounts_remove_tag`](#persona_identity_accounts_remove_tag) | Remove tag from an Account |
| [`persona_identity_accounts_set_all_tags`](#persona_identity_accounts_set_all_tags) | Set tags on an Account |
| [`persona_identity_approve_an_inquiry`](#persona_identity_approve_an_inquiry) | Approve an Inquiry |
| [`persona_identity_consolidate_into_an_account`](#persona_identity_consolidate_into_an_account) | Consolidate Accounts |
| [`persona_identity_create_an_account`](#persona_identity_create_an_account) | Create an Account |
| [`persona_identity_create_an_inquiry`](#persona_identity_create_an_inquiry) | Create an Inquiry |
| [`persona_identity_create_an_inquiry_session`](#persona_identity_create_an_inquiry_session) | Create an Inquiry Session |
| [`persona_identity_decline_an_inquiry`](#persona_identity_decline_an_inquiry) | Decline an Inquiry |
| [`persona_identity_expire_an_inquiry`](#persona_identity_expire_an_inquiry) | Expire an Inquiry |
| [`persona_identity_expire_an_inquiry_session`](#persona_identity_expire_an_inquiry_session) | Expire an Inquiry Session |
| [`persona_identity_expire_inquiry_sessions`](#persona_identity_expire_inquiry_sessions) | Expire Inquiry Sessions |
| [`persona_identity_generate_a_one_time_link`](#persona_identity_generate_a_one_time_link) | Generate a one-time link for an Inquiry |
| [`persona_identity_generate_a_one_time_link_for_an_inquiry_session`](#persona_identity_generate_a_one_time_link_for_an_inquiry_session) | Generate a one-time link for Inquiry Session |
| [`persona_identity_inquiries_add_tag`](#persona_identity_inquiries_add_tag) | Add tag to an Inquiry |
| [`persona_identity_inquiries_perform_simulate_actions`](#persona_identity_inquiries_perform_simulate_actions) | Perform Simulate Actions |
| [`persona_identity_inquiries_remove_tag`](#persona_identity_inquiries_remove_tag) | Remove tag from an Inquiry |
| [`persona_identity_inquiries_set_all_tags`](#persona_identity_inquiries_set_all_tags) | Set tags on an Inquiry |
| [`persona_identity_list_all_accounts`](#persona_identity_list_all_accounts) | List all Accounts |
| [`persona_identity_list_all_inquiries`](#persona_identity_list_all_inquiries) | List all Inquiries |
| [`persona_identity_list_all_inquiry_sessions`](#persona_identity_list_all_inquiry_sessions) | List all Inquiry Sessions |
| [`persona_identity_list_all_inquiry_templates`](#persona_identity_list_all_inquiry_templates) | List all Inquiry Templates |
| [`persona_identity_mark_an_inquiry_for_review`](#persona_identity_mark_an_inquiry_for_review) | Mark an Inquiry for manual review |
| [`persona_identity_print_an_inquiry_pdf`](#persona_identity_print_an_inquiry_pdf) | Print Inquiry PDF |
| [`persona_identity_redact_an_account`](#persona_identity_redact_an_account) | Redact an Account |
| [`persona_identity_redact_an_inquiry`](#persona_identity_redact_an_inquiry) | Redact an Inquiry |
| [`persona_identity_resume_an_inquiry`](#persona_identity_resume_an_inquiry) | Resume an Inquiry |
| [`persona_identity_retrieve_an_account`](#persona_identity_retrieve_an_account) | Retrieve an Account |
| [`persona_identity_retrieve_an_inquiry`](#persona_identity_retrieve_an_inquiry) | Retrieve an Inquiry |
| [`persona_identity_retrieve_an_inquiry_session`](#persona_identity_retrieve_an_inquiry_session) | Retrieve an Inquiry Session |
| [`persona_identity_retrieve_an_inquiry_template`](#persona_identity_retrieve_an_inquiry_template) | Retrieve an Inquiry Template |
| [`persona_identity_run_account_action`](#persona_identity_run_account_action) | Run an account action |
| [`persona_identity_search_accounts`](#persona_identity_search_accounts) | Search Accounts |
| [`persona_identity_update_an_account`](#persona_identity_update_an_account) | Update an Account |
| [`persona_identity_update_an_inquiry`](#persona_identity_update_an_inquiry) | Update an Inquiry |
***
## persona\_identity\_accounts\_add\_tag
Add tag to an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to add to the Account."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Account."
}
}
}
},
"required": [
"PCID",
"account-id",
"meta"
]
}
```
***
## persona\_identity\_accounts\_list\_all\_relations
Get all relations for an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
| `filter` | object | Yes | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"key": {
"type": "string",
"description": "Filter relations by relation key."
},
"created-at-start": {
"type": "string",
"description": "Filter relations by creation date."
},
"created-at-end": {
"type": "string",
"description": "Filter relations by creation date."
}
},
"required": [
"key"
]
}
},
"required": [
"PCID",
"account-id",
"filter"
]
}
```
***
## persona\_identity\_accounts\_remove\_tag
Remove tag from an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to remove from the Account."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to remove from the Account."
}
}
}
},
"required": [
"PCID",
"account-id",
"meta"
]
}
```
***
## persona\_identity\_accounts\_set\_all\_tags
Set tags on an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Name of the tags to set on the Account."
},
"tag-id": {
"type": "array",
"items": {
"type": "string"
},
"description": "ID of the tags to set on the Account."
}
}
}
},
"required": [
"PCID",
"account-id",
"meta"
]
}
```
***
## persona\_identity\_approve\_an\_inquiry
Approve an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"comment": {
"type": "string",
"description": "Unstructured comment for auditing purposes"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_consolidate\_into\_an\_account
Consolidate Accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | Destination Account ID |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "Destination Account ID"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"source-account-ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of Account IDs that need to be consolidated into the destination Account."
}
},
"required": [
"source-account-ids"
]
}
},
"required": [
"PCID",
"account-id",
"meta"
]
}
```
***
## persona\_identity\_create\_an\_account
Create an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `data` | object | No | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"description": "The attributes value"
}
}
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"upsert-by": {
"type": "string",
"description": "The field name to use for upserting the account. This field must be unique across all accounts for the given account type."
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_create\_an\_inquiry
Create an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `data` | object | Yes | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"attributes"
]
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"auto-create-account": {
"type": "boolean",
"description": "If true, automatically create an Account for the user if one does not exist. Default is true."
},
"auto-create-account-type-id": {
"type": "string",
"description": "If `auto-create-account` is true, the type ID to use for the Account. If not provided, the default type ID for the organization will be used. If `auto-create-account-reference-id` is present and corresponds to an existing Account, `auto-create-account-type-id` will be ignored. Will error if passed when `auto-create-account` is false."
},
"auto-create-account-reference-id": {
"type": "string",
"description": "If `auto-create-account` is true, this Inquiry will be attached to the Account with this reference ID, or a new Account will be created with this reference ID if one does not exist. Will error if passed when `auto-create-account` is false."
},
"auto-create-inquiry-session": {
"type": "boolean",
"description": "If true, automatically create an Inquiry Session token for the Inquiry."
},
"auto-create-one-time-link": {
"type": "boolean",
"description": "If true, automatically create a One-Time Link URL for the Inquiry."
},
"expiration-after-create-interval-seconds": {
"type": "integer",
"description": "Time interval from inquiry creation after which an Inquiry expires and the flow can no longer be accessed. Overrides value set at the template level."
},
"expiration-after-start-interval-seconds": {
"type": "integer",
"description": "Time interval from inquiry start after which an Inquiry expires and the flow can no longer be accessed. Overrides value set at the template level."
},
"expiration-after-resume-interval-seconds": {
"type": "integer",
"description": "Time interval from inquiry start after which an Inquiry expires and the flow can no longer be accessed. Overrides value set at the template level."
},
"one-time-link-expiration-seconds": {
"type": "integer",
"description": "Time interval after which Device Handoff one time links expire. Overrides value set at the template level."
}
}
}
},
"required": [
"PCID",
"data"
]
}
```
***
## persona\_identity\_create\_an\_inquiry\_session
Create an Inquiry Session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `data` | object | No | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_decline\_an\_inquiry
Decline an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"comment": {
"type": "string",
"description": "Unstructured comment for auditing purposes"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_expire\_an\_inquiry
Expire an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_expire\_an\_inquiry\_session
Expire an Inquiry Session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-session-id` | string | Yes | — | The inquiry-session-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-session-id": {
"type": "string",
"description": "The inquiry-session-id value"
}
},
"required": [
"PCID",
"inquiry-session-id"
]
}
```
***
## persona\_identity\_expire\_inquiry\_sessions
Expire Inquiry Sessions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"inquiry-ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The inquiry-ids value"
}
},
"required": [
"inquiry-ids"
]
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_generate\_a\_one\_time\_link
Generate a one-time link for an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | Inquiry ID (starts with "inq\_") |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "Inquiry ID (starts with \"inq_\")"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"expires-in-seconds": {
"type": "integer",
"description": "Number of seconds from now to expire the key (must be greater than 0). If not provided, the one-time link expiration setting from the inquiry template version will apply. Default expiry is 24 hours."
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_generate\_a\_one\_time\_link\_for\_an\_inquiry\_session
Generate a one-time link for Inquiry Session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-session-id` | string | Yes | — | The inquiry-session-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-session-id": {
"type": "string",
"description": "The inquiry-session-id value"
}
},
"required": [
"PCID",
"inquiry-session-id"
]
}
```
***
## persona\_identity\_inquiries\_add\_tag
Add tag to an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "The tag-name value"
},
"tag-id": {
"type": "string",
"description": "The tag-id value"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_inquiries\_perform\_simulate\_actions
Perform Simulate Actions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"simulate-actions": {
"type": "array",
"items": {
"type": "object"
},
"description": "The simulate-actions value"
}
},
"required": [
"simulate-actions"
]
}
},
"required": [
"PCID",
"inquiry-id",
"meta"
]
}
```
***
## persona\_identity\_inquiries\_remove\_tag
Remove tag from an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "The tag-name value"
},
"tag-id": {
"type": "string",
"description": "The tag-id value"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_inquiries\_set\_all\_tags
Set tags on an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tag-name value"
},
"tag-id": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tag-id value"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_list\_all\_accounts
List all Accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | 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. |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "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."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"reference-id": {
"type": "string",
"description": "Filter accounts by reference ID. Can be a single reference ID or an array of reference IDs."
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_list\_all\_inquiries
List all Inquiries
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | 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. |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "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."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"inquiry-id": {
"type": "string",
"description": "Comma separated list of inquiry IDs (starting with `inq_`) to filter inquiries by"
},
"account-id": {
"type": "string",
"description": "Comma separated list of account IDs (starting with `act_`) to filter inquiries by"
},
"note": {
"type": "string",
"description": "Filter inquiries by note. Must be the only filter."
},
"reference-id": {
"type": "string",
"description": "Filter inquiries by reference ID"
},
"inquiry-template-id": {
"type": "string",
"description": "Comma separated list of inquiry template IDs (starting with `itmpl_`) to filter inquiries by"
},
"template-id": {
"type": "string",
"description": "Comma separated list of legacy template IDs (starting with `tmpl_`) to filter inquiries by"
},
"status": {
"type": "string",
"description": "Comma separated list of statuses to filter inquiries by"
},
"created-at-start": {
"type": "string",
"description": "Filter inquiries by creation date, equal to or later than"
},
"created-at-end": {
"type": "string",
"description": "Filter inquiries by creation date, earlier than or equal to"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_list\_all\_inquiry\_sessions
List all Inquiry Sessions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"inquiry-id": {
"type": "string",
"description": "Filter inquiry sessions by inquiry ID"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_list\_all\_inquiry\_templates
List all Inquiry Templates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_mark\_an\_inquiry\_for\_review
Mark an Inquiry for manual review
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_print\_an\_inquiry\_pdf
Print Inquiry PDF
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_redact\_an\_account
Redact an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
}
},
"required": [
"PCID",
"account-id"
]
}
```
***
## persona\_identity\_redact\_an\_inquiry
Redact an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_resume\_an\_inquiry
Resume an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_retrieve\_an\_account
Retrieve an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
}
},
"required": [
"PCID",
"account-id"
]
}
```
***
## persona\_identity\_retrieve\_an\_inquiry
Retrieve an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```
***
## persona\_identity\_retrieve\_an\_inquiry\_session
Retrieve an Inquiry Session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-session-id` | string | Yes | — | Inquiry Session ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-session-id": {
"type": "string",
"description": "Inquiry Session ID"
}
},
"required": [
"PCID",
"inquiry-session-id"
]
}
```
***
## persona\_identity\_retrieve\_an\_inquiry\_template
Retrieve an Inquiry Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-template-id` | string | Yes | — | Inquiry Template ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-template-id": {
"type": "string",
"description": "Inquiry Template ID"
}
},
"required": [
"PCID",
"inquiry-template-id"
]
}
```
***
## persona\_identity\_run\_account\_action
Run an account action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------ |
| `account-id` | string | Yes | — | The ID of the account to run the action on |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account-id": {
"type": "string",
"description": "The ID of the account to run the action on"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"account-action-id": {
"type": "string",
"description": "The ID of the account action to run"
},
"parameters": {
"type": "object",
"description": "Parameters required by the account action"
}
},
"required": [
"account-action-id"
]
}
},
"required": [
"PCID",
"account-id",
"data"
]
}
```
***
## persona\_identity\_search\_accounts
Search Accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `fields` | object | No | — | 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. |
| `page` | object | No | — | Pagination parameters |
| `query` | object | No | — | Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Pass as a JSON object with boolean logic (AND/OR/NOT) and comparison predicates. |
| `sort` | object | No | — | Sort configuration for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"fields": {
"type": "object",
"description": "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."
},
"page": {
"type": "object",
"description": "Pagination parameters",
"properties": {
"after": {
"type": "string",
"description": "Cursor for forward pagination"
},
"before": {
"type": "string",
"description": "Cursor for backward pagination"
},
"size": {
"type": "integer",
"description": "Number of results to return per page"
}
}
},
"query": {
"type": "object",
"description": "Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Pass as a JSON object with boolean logic (AND/OR/NOT) and comparison predicates."
},
"sort": {
"type": "object",
"description": "Sort configuration for results",
"properties": {
"attribute": {
"type": "string",
"description": "The attribute name to sort by"
},
"direction": {
"type": "string",
"description": "Sort direction. Possible values: asc (ascending), desc (descending)."
}
},
"required": [
"attribute",
"direction"
]
}
},
"required": [
"PCID"
]
}
```
***
## persona\_identity\_update\_an\_account
Update an Account
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `account-id` | string | Yes | — | The account-id value |
| `data` | object | No | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"account-id": {
"type": "string",
"description": "The account-id value"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"description": "The attributes value"
}
}
}
},
"required": [
"PCID",
"account-id"
]
}
```
***
## persona\_identity\_update\_an\_inquiry
Update an Inquiry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | 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. |
| `fields` | object | No | — | 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. |
| `inquiry-id` | string | Yes | — | The inquiry-id value |
| `data` | object | No | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "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."
},
"fields": {
"type": "object",
"description": "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."
},
"inquiry-id": {
"type": "string",
"description": "The inquiry-id value"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID",
"inquiry-id"
]
}
```