/persona-verification | Type: Application | PCID required: Yes
Tools
persona_verification_print_a_verification_as_pdf
Print Verification 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. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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"
]
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_redact_a_verification
Redact a Verification 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. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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"
]
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_database_standard_verification
Retrieve a Database Standard Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_database_verification
Retrieve a Database Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_document
Retrieve a Document 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. |
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 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 for more details. |
document-id | string | Yes | — | The document-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"document-id": {
"type": "string",
"description": "The document-id value"
}
},
"required": [
"PCID",
"document-id"
]
}
persona_verification_retrieve_a_document_verification
Retrieve a Document Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_email_address_verification
Retrieve an Email Address Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_generic_document
Retrieve a Generic Document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
document-id | string | Yes | — | The document-id value |
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. |
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 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 for more details. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"document-id": {
"type": "string",
"description": "The document-id value"
},
"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."
}
},
"required": [
"PCID",
"document-id"
]
}
persona_verification_retrieve_a_government_id_document
Retrieve a Government Id Document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
document-id | string | Yes | — | The document-id value |
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. |
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 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 for more details. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"document-id": {
"type": "string",
"description": "The document-id value"
},
"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."
}
},
"required": [
"PCID",
"document-id"
]
}
persona_verification_retrieve_a_government_id_nfc_verification
Retrieve a Government ID NFC Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_government_id_verification
Retrieve a Government ID Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_phone_carrier_database_verification
Retrieve a Phone Carrier Database Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_phone_number_verification
Retrieve a Phone Number Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_selfie_verification
Retrieve a Selfie Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_serpro_database_verification
Retrieve a Serpro Database Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_tin_database_verification
Retrieve a TIN Database Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_a_verification
Retrieve a Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | The verification-id value |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "The verification-id value"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_an_aamva_verification
Retrieve an AAMVA Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}
persona_verification_retrieve_an_ecbsv_database_verification
Retrieve an eCBSV Database Verification 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. |
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 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 for more details. |
verification-id | string | Yes | — | ID of Verification to retrieve |
Show inputSchema
Show inputSchema
{
"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."
},
"verification-id": {
"type": "string",
"description": "ID of Verification to retrieve"
}
},
"required": [
"PCID",
"verification-id"
]
}