openapi: 3.1.0 info: title: Persona API Reference version: '2025-12-08' license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' contact: name: Persona Support url: 'https://help.withpersona.com/' email: support@withpersona.com servers: - url: 'https://api.withpersona.com/api/v1' security: - bearerAuth: [] tags: - name: Accounts description: Interact with Persona Account objects - name: Account Types description: Interact with Persona Account Type objects - name: API Keys description: Interact with your organization's API keys - name: API Logs description: View your organization's API logs - name: Cases description: Interact with Persona Case objects - name: Case Templates description: Interact with Persona Case Template objects - name: Connect description: Interact with Persona Connect objects - name: Devices description: Interact with Persona Device objects - name: Documents description: Interact with Persona Document objects - name: Events description: Endpoints for viewing your organization's events - name: Importers description: Import external data as corresponding objects within Persona - name: Inquiries description: Interact with Persona Inquiry objects - name: Inquiry Sessions description: Interact with Persona Inquiry Session objects - name: Inquiry Templates description: Interact with Persona Inquiry Template objects - name: List Items description: Interact with Persona List Item objects - name: Lists description: Interact with Persona List objects - name: OAuth description: Share access to a Persona object with another organization - name: Rate Limits description: Interact with Rate Limits via API - name: Relay description: Interact with Persona Relay objects - name: Reports description: Interact with Persona Report objects - name: Transactions description: Interact with Persona Transaction objects - name: Transaction Types description: Interact with Persona Transaction Type objects - name: User Audit Logs description: View your organization's User Audit logs - name: Verifications description: Interact with Persona Verification objects - name: AAMVA Verifications description: Interact with AAMVA Verifications - name: eCBSV Database Verifications description: Interact with eCBSV Database Verifications - name: Phone Carrier Database Verifications description: Interact with Phone Carrier Database Verifications - name: Serpro Database Verifications description: Interact with Serpro Database Verifications - name: TIN Database Verifications description: Interact with TIN Database Verifications - name: Database Verifications description: Interact with Database Verifications - name: Database Standard Verifications description: Interact with Database Standard Verifications - name: Database Business Verifications description: Interact with Database Business Verifications - name: Document Verifications description: Interact with Document Verifications - name: Email Address Verifications description: Interact with Email Address Verifications - name: Government ID Verifications description: Interact with Government ID Verifications - name: Phone Number Verifications description: Interact with Phone Number Verifications - name: Selfie Verifications description: Interact with Selfie Verifications - name: Webhooks description: Interact with Webhooks via API - name: Workflows description: Interact with Persona Workflow objects externalDocs: description: Full API documentation on the Persona website url: 'https://docs.withpersona.com/api-reference/' paths: '/account-types/{account-type-id}': get: summary: Retrieve an Account Type tags: - Account Types x-persona-product: Accounts description: 'Retrieves the details of an existing Account Type, including its configured field schemas.' externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/account-types/retrieve-an-account-type' operationId: retrieve-an-account-type parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-type-id in: path description: ID of the Account Type to retrieve. schema: type: string required: true responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns an Account Type object. content: application/json: examples: Success: $ref: '#/components/examples/account-type' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/account-type' included: $ref: '#/components/schemas/empty-included-objects' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' /accounts: get: description: 'Returns a list of your organization''s account(s). Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-accounts externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/list-all-accounts' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: reference-id: description: Filter accounts by reference ID. Can be a single reference ID or an array of reference IDs. examples: - ref_123 - 'ref_123,ref_456' unevaluatedProperties: false type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/account-list' schema: properties: data: items: $ref: '#/components/schemas/account' type: array description: An array of Accounts links: properties: prev: type: - string - 'null' examples: - /api/v1/accounts?page%5Bafter%5D=act_ABC123 description: 'URL pointing to the previous page of data, or null if on the first page.' next: type: - string - 'null' examples: - /api/v1/accounts?page%5Bafter%5D=act_ABC123 description: 'URL pointing to the next page of data, or null if on the last page.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links description: This endpoint returns a collection of Account objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List all Accounts tags: - Accounts x-persona-product: Accounts post: description: Creates a new Account for your organization. operationId: create-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/create-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: unevaluatedProperties: false allOf: - type: object properties: account-type-id: type: string description: Account Type ID to create the account for. Starts with `acttp_`. account-status: type: string description: Name of the status to set on this Account. reference-id: description: 'Reference ID on Account, refers to an entity in your user model' type: string selfie-photo: description: Selfie photo. properties: data: description: 'Selfie photo data, must be an image. Can also be provided as an uploaded file such as with multipart/form-data requests instead of this object.' properties: data: description: Base64 encoded image type: string filename: description: Name of the image type: string additionalProperties: false type: object additionalProperties: false type: object tags: description: A list of tag names to be associated with the Account. items: type: string type: - array - 'null' country-code: description: ISO 3166-1 alpha 2 country code. examples: - US type: - string social-security-number: description: Social security number. examples: - 123-45-6789 type: - string fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Account Type. type: object additionalProperties: true birthdate: description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date examples: - '1994-04-12' type: - string name-first: description: Given or first name. examples: - Jane type: - string name-middle: description: Middle name. examples: - Marie type: - string name-last: description: Family or last name. examples: - Doe type: - string phone-number: description: Phone number. examples: - 415-555-1234 type: - string email-address: description: Email address. examples: - jane@doe.com type: - string address-street-1: description: Street name of residence address. examples: - 123 Main St type: string address-street-2: description: 'Extension of residence address, usually apartment or suite number.' examples: - Apt 1 type: string address-city: description: City of residence address. Not all international addresses use this attribute. examples: - San Francisco type: string address-subdivision: description: 'State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.' examples: - California type: string address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: string additionalProperties: false type: object meta: type: object additionalProperties: false properties: upsert-by: type: - string - 'null' description: The field name to use for upserting the account. This field must be unique across all accounts for the given account type. additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns an Account object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}': delete: description: |- Permanently deletes personally identifiable information (PII) for an Account and all associated Inquiries, Verifications and Reports. The response indicates a successful redaction of the Account. Redaction of the Account's associated child objects is done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. Note: An account is still updatable after redaction. If you want to delete data continuously, please reach out to us to help you setup a retention policy. operationId: redact-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/redact-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Redact an Account tags: - Accounts x-persona-product: Accounts get: description: Retrieves the details of an existing Account. operationId: retrieve-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/retrieve-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Account tags: - Accounts x-persona-product: Accounts patch: description: Updates an existing Account. operationId: update-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/update-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: data: properties: attributes: unevaluatedProperties: false allOf: - type: object properties: reference-id: description: 'Reference ID on Account, refers to an entity in your user model' type: string account-status: type: string description: Name of the status to set on this Account. selfie-photo: description: Selfie photo. properties: data: description: 'Selfie photo data, must be an image. Can also be provided as an uploaded file such as with multipart/form-data requests instead of this object. Null will remove the existing selfie photo from the Account.' properties: data: description: Base64 encoded image type: string filename: description: Name of the image type: string additionalProperties: false type: - object - 'null' additionalProperties: false type: object tags: description: A list of tag names to be associated with the Account. items: type: string type: - array - 'null' country-code: description: ISO 3166-1 alpha 2 country code. examples: - US type: - string social-security-number: description: Social security number. examples: - 123-45-6789 type: - string fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Account Type. type: object additionalProperties: true birthdate: description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date examples: - '1994-04-12' type: string name-first: description: Given or first name. examples: - Jane type: string name-middle: description: Middle name. examples: - Marie type: string name-last: description: Family or last name. examples: - Doe type: string phone-number: description: Phone number. examples: - 415-555-1234 type: string email-address: description: Email address. examples: - jane@doe.com type: string address-street-1: description: Street name of residence address. examples: - 123 Main St type: string address-street-2: description: 'Extension of residence address, usually apartment or suite number.' examples: - Apt 1 type: string address-city: description: City of residence address. Not all international addresses use this attribute. examples: - San Francisco type: string address-subdivision: description: 'State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.' examples: - California type: string address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: string additionalProperties: false type: object additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Update an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/add-relation': post: description: Adds a relation from an Account to a target Account or Transaction operationId: accounts-add-relation externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/add-relation' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: relation-schema-key: type: string description: Key of the relation schema to add. target-object-id: type: string description: ID of the target Account or Transaction to relate to. type: object additionalProperties: false required: - relation-schema-key - target-object-id type: object additionalProperties: false required: - meta examples: Success: $ref: '#/components/examples/set-relation' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data examples: Success: $ref: '#/components/examples/account' description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add a relation to an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/add-tag': post: description: Adds a new tag to an Account operationId: accounts-add-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/add-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: 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. type: object additionalProperties: false type: object additionalProperties: false required: - meta examples: Success: $ref: '#/components/examples/set-tag' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data examples: Success: $ref: '#/components/examples/account' description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add tag to an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/consolidate': post: description: |- Consolidates several source Accounts' information into one target Account. Any Persona resource associated with the source Account will be transferred over to the destination Account. However, the Account's attributes will **not** be transferred. After consolidation, you can update the destination Account's attributes using the [Account update endpoint](https://docs.withpersona.com/api-reference/accounts/update-an-account). This endpoint can be used to clean up duplicate Accounts. Note: A source account can only be consolidated once. Afterwards, the source account will be archived and unable to be used moving forward - any attempts to create an inquiry attached to the source account will fail. operationId: consolidate-into-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/consolidate-into-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Destination Account ID in: path name: account-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: required: - source-account-ids properties: source-account-ids: description: A list of Account IDs that need to be consolidated into the destination Account. items: type: string type: array additionalProperties: false type: object required: - meta additionalProperties: false type: object examples: Accepted: $ref: '#/components/examples/consolidate-accounts' responses: '202': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Accepted: $ref: '#/components/examples/account' schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Consolidate Accounts tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/relations': get: description: Gets relations for an Account by key operationId: accounts-list-all-relations externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/list-all-relations' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string - in: query name: filter style: deepObject explode: true required: true schema: type: object additionalProperties: false 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 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: type: array unevaluatedProperties: false description: List of relations for the Account. The type of the returned objects is determined by the key query parameter. items: unevaluatedProperties: false oneOf: - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/transaction' links: properties: prev: examples: - /api/v1/accounts/act_ABC123/relations?filter%5Bkey%5D=my_relation&page%5Bafter%5D=act_XYZ987 type: - 'null' - string description: 'URL pointing to the previous page of data, or null if on the first page.' next: examples: - /api/v1/accounts/act_ABC123/relations?filter%5Bkey%5D=my_relation&page%5Bafter%5D=act_XYZ987 type: - 'null' - string description: 'URL pointing to the next page of data, or null if on the last page.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links examples: Success: $ref: '#/components/examples/account-list' description: This endpoint returns a collection of Account relations. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Get all relations for an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/remove-relation': post: description: Removes a relation from an Account to a target Account or Transaction. operationId: accounts-remove-relation externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/remove-relation' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: relation-schema-key: type: string description: Key of the relation schema to remove. target-object-id: type: string description: ID of the target Account or Transaction to unrelate. type: object additionalProperties: false required: - relation-schema-key - target-object-id type: object additionalProperties: false required: - meta examples: Success: $ref: '#/components/examples/set-relation' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data examples: Success: $ref: '#/components/examples/account' description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove a relation from an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/remove-tag': post: description: Removes an existing tag from an Account operationId: accounts-remove-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/remove-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: 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. additionalProperties: false type: object additionalProperties: false type: object required: - meta examples: Success: $ref: '#/components/examples/set-tag' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data examples: Success: $ref: '#/components/examples/account' description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove tag from an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/set-tags': post: description: Sets all tags on an Account. Any tags that are not provided in the request will be removed. operationId: accounts-set-all-tags externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/set-all-tags' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: account-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: description: Name of the tags to set on the Account. items: type: string type: array tag-id: description: ID of the tags to set on the Account. items: type: string type: array additionalProperties: false type: object additionalProperties: false type: object required: - meta examples: Success: $ref: '#/components/examples/set-tags' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: properties: data: $ref: '#/components/schemas/account' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/accounts-included-objects' additionalProperties: false type: object required: - data examples: Success: $ref: '#/components/examples/account' description: This endpoint returns an Account object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Set tags on an Account tags: - Accounts x-persona-product: Accounts '/accounts/{account-id}/run-action': post: summary: Run an account action description: Triggers an account action for the specified account operationId: runAccountAction tags: - Accounts x-persona-product: Accounts parameters: - name: account-id in: path required: true schema: type: string pattern: '^act_[a-zA-Z0-9]{24,28}$' description: The ID of the account to run the action on requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: account-action-id: type: string description: The ID of the account action to run pattern: '^accac_[a-zA-Z0-9]{24,28}$' parameters: type: object description: Parameters required by the account action additionalProperties: true required: - account-action-id required: - data examples: Success: $ref: '#/components/examples/run-account-action' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Account action executed successfully content: application/json: schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' meta: type: object additionalProperties: false properties: workflow-run-id: type: string description: The ID of the workflow run created by this action examples: - wfr_abc123def456ghi789 required: - workflow-run-id required: - data - meta examples: Success: $ref: '#/components/examples/account-with-meta' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /accounts/search: post: description: | Search for accounts using a flexible query language. ## Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics. Use the **Search** endpoint (`POST /accounts/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter by custom fields or identifiers, or apply multiple conditions simultaneously. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /accounts`) for simple listing with basic filters like reference ID. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating an account, use the List Accounts endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `type` | Account type (e.g., `acttp_ABC123`) | | `status` | Account status (e.g., `actst_ABC123`) | | `created_at` | Account creation timestamp | | `updated_at` | Account last updated timestamp | | `identifiers.*` | Custom identifier (e.g., `identifiers.user_id`) | | `fields.*` | Custom account field (e.g., `fields.age`) | **Note:** Custom fields (`fields.*`) must be configured as searchable on the Account Type to be queryable. operationId: search-accounts externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/accounts/search-accounts' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: page style: deepObject explode: true schema: type: object additionalProperties: false properties: after: description: Cursor for forward pagination. Use the value from `links.next` in the previous response. type: string examples: - act_ABC123 before: description: Cursor for backward pagination. Use the value from `links.prev` in the previous response. type: string examples: - act_XYZ789 size: description: Number of results to return per page. type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 requestBody: content: application/json: schema: properties: query: 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). unevaluatedProperties: false oneOf: - type: object x-inheritable: true additionalProperties: false description: | Boolean AND clause - combines multiple conditions where ALL must be true. This clause is recursive: each item in the `and` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per AND: 20 properties: and: type: array items: type: object additionalProperties: true required: - and - type: object x-inheritable: true additionalProperties: false description: | Boolean OR clause - combines multiple conditions where AT LEAST ONE must be true. This clause is recursive: each item in the `or` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per OR: 20 properties: or: type: array items: type: object additionalProperties: true required: - or - type: object x-inheritable: true additionalProperties: false description: | Boolean NOT clause - negates a single condition. This clause is recursive: the `not` value can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels properties: not: type: object additionalProperties: true required: - not - type: object x-inheritable: true additionalProperties: false description: Attribute predicate properties: attribute: type: string description: 'The attribute name to filter on (e.g., ''created_at'', ''type'', ''status'', ''fields.age'')' examples: - created_at - type - status - fields.age operator: type: string description: 'Comparison operator. Possible values: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal).' value: description: Value to compare against x-inheritable: true unevaluatedProperties: false oneOf: - type: string - type: number - type: boolean required: - attribute - operator - value examples: - attribute: created_at operator: gte value: '2025-01-01' - and: - attribute: type operator: eq value: acttp_ABC123 - attribute: created_at operator: gte value: '2025-01-01' sort: description: Sort configuration for results type: object additionalProperties: false properties: attribute: type: string description: The attribute name to sort by examples: - created_at - updated_at - type - fields.age direction: type: string default: desc description: 'Sort direction. Possible values: asc (ascending), desc (descending).' required: - attribute - direction page: description: Pagination parameters type: object additionalProperties: false properties: after: description: Cursor for forward pagination type: string examples: - act_ABC123 before: description: Cursor for backward pagination type: string examples: - act_XYZ789 size: description: Number of results to return per page type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 additionalProperties: false type: object examples: Simple query: value: query: not: attribute: status operator: eq value: actst_ABC123 sort: attribute: created_at direction: asc page: size: 15 Complex boolean query: value: query: and: - attribute: type operator: eq value: acttp_ABC123 - or: - attribute: status operator: eq value: actst_ABC123 - attribute: status operator: eq value: actst_ABC456 sort: attribute: created_at direction: desc page: size: 15 Empty query (all accounts): value: page: size: 15 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/account-list-search' schema: properties: data: items: $ref: '#/components/schemas/account' type: array description: An array of Accounts matching the search criteria links: properties: prev: type: - string - 'null' examples: - /api/v1/accounts/search?page%5Bbefore%5D=act_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the previous page of data, or null if on the first page. Must be used with POST request and original request body.' next: type: - string - 'null' examples: - /api/v1/accounts/search?page%5Bafter%5D=act_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the next page of data, or null if on the last page. Must be used with POST request and original request body.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links description: This endpoint returns a collection of Account objects matching the search criteria. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Search Accounts tags: - Accounts x-persona-product: Accounts /api-keys: get: description: 'Returns a list of your organization''s API keys. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-api-keys externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-keys/list-all-api-keys' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: name: type: string description: Filter API keys by name responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-key-list' schema: type: object additionalProperties: false properties: data: items: $ref: '#/components/schemas/api-key' type: array description: An array of API Keys links: properties: next: type: - string - 'null' prev: type: - string - 'null' type: object additionalProperties: false required: - next - prev required: - data - links description: This endpoint returns a collection of API key objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all API keys tags: - API Keys x-persona-product: API Keys post: description: Creates a new API key with response defaults and permissions. operationId: create-an-api-key externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-keys/create-an-api-key' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/create-api-key-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/api-key-with-value' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/api-key-with-value' included: $ref: '#/components/schemas/empty-included-objects' required: - data description: This endpoint returns an API key object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an API key tags: - API Keys x-persona-product: API Keys '/api-keys/{api-key-id}': get: description: Retrieves the information for an existing API key. The plaintext value is only returned when creating or cloning an API key. operationId: retrieve-an-api-key externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-keys/retrieve-an-api-key' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: API key's ID (starts with "api_") in: path name: api-key-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-key' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/api-key' included: $ref: '#/components/schemas/empty-included-objects' required: - data description: This endpoint returns an API key object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an API key tags: - API Keys x-persona-product: API Keys patch: description: Updates an existing API key. operationId: update-an-api-key externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-keys/update-an-api-key' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: API key's ID (starts with "api_") in: path name: api-key-id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/update-api-key-request' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-key' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/api-key' included: $ref: '#/components/schemas/empty-included-objects' required: - data description: This endpoint returns an API key object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Update an API key tags: - API Keys x-persona-product: API Keys '/api-keys/{api-key-id}/expire': post: description: Deactivates an API key within some time period operationId: expire-an-api-key externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-keys/expire-an-api-key' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: API key's ID (starts with "api_") in: path name: api-key-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: expires-in-seconds: description: Number of seconds from now to expire the key (max of 30 days) type: integer required: - expires-in-seconds type: object additionalProperties: false type: object additionalProperties: false required: - meta examples: Success: $ref: '#/components/examples/expire-api-key' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-key' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/api-key' included: $ref: '#/components/schemas/empty-included-objects' required: - data description: This endpoint returns an API key object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Expire an API key tags: - API Keys x-persona-product: API Keys '/api-keys/{api-key-id}/clone': post: description: Creates a copy of an existing API key. All attributes except the value are copied over to the new API key. operationId: clone-api-key parameters: - in: path name: api-key-id required: true schema: type: string description: The token/ID of the API key to be cloned. - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns an API key object. content: application/json: examples: Success: $ref: '#/components/examples/api-key-with-value' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/api-key-with-value' included: $ref: '#/components/schemas/empty-included-objects' required: - data '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Clone an API key tags: - API Keys x-persona-product: API Keys /connect/connections: get: description: 'Returns a list of connect connections associated with your organization, including both outbound connections your organization created and inbound connections where your organization is the destination. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-connect-connections externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/connect/connections/list-all-connect-connections' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: status: description: Filter connections by status type: string destination-organization-id: description: Filter connections by destination organization ID — the organization authorized to access data through the connection. type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-connection-list' schema: properties: data: items: $ref: '#/components/schemas/connect-connection' type: array description: An array of Connections links: properties: prev: type: - string - 'null' examples: - /api/v1/connect/connections?page%5Bafter%5D=cxn_ABC123 description: 'URL pointing to the previous page of data, or null if on the first page.' next: type: - string - 'null' examples: - /api/v1/connect/connections?page%5Bafter%5D=cxn_ABC123 description: 'URL pointing to the next page of data, or null if on the last page.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links description: This endpoint returns a collection of Connections. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List all Connections tags: - Connect x-persona-product: Connect post: description: 'Creates a new Connection from your organization to a destination organization in the `pending` state. The destination organization must accept the connection before it transitions to `active`; share tokens cannot be redeemed through the connection until then. Connections cannot be deleted, but they can be deactivated and later reactivated to control access.' operationId: create-a-connect-connection externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/connect/connections/create-a-connect-connection' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: examples: Success: $ref: '#/components/examples/create-connection' schema: properties: data: properties: attributes: unevaluatedProperties: false allOf: - type: object properties: destination-organization-id: description: The organization ID that will be authorized to access objects through this connection type: string examples: - org_XYZ789 required: - destination-organization-id additionalProperties: false type: object additionalProperties: false type: object responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-connection' schema: properties: data: $ref: '#/components/schemas/connect-connection' type: object additionalProperties: false required: - data description: This endpoint returns a Connection. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Connection tags: - Connect x-persona-product: Connect '/connect/connections/{connection-id}': get: description: Retrieves the details of an existing Connection. operationId: retrieve-a-connect-connection externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/connect/connections/retrieve-a-connect-connection' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/fields-query-parameter' - name: connection-id in: path required: true schema: type: string description: Token of the connect connection examples: connection-id: value: connection-id responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-connection' schema: properties: data: $ref: '#/components/schemas/connect-connection' additionalProperties: false type: object required: - data description: This endpoint returns a Connection. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Connection tags: - Connect x-persona-product: Connect '/connect/connections/{connection-id}/deactivate': post: description: Deactivates a Connection. Either the source or destination organization may deactivate a connection that is currently `pending` or `active`. Deactivation prevents further access through the connection but maintains the connection record. Connections that are already `inactive` cannot be deactivated again. operationId: deactivate-a-connect-connection externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/connect/connections/deactivate-a-connect-connection' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: connection-id in: path required: true schema: type: string description: ID of the connect connection examples: connection-id: value: connection-id responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-connection-inactive' schema: properties: data: $ref: '#/components/schemas/connect-connection' additionalProperties: false type: object required: - data description: This endpoint returns a Connection. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Deactivate a Connection tags: - Connect x-persona-product: Connect '/connect/connections/{connection-id}/reactivate': post: description: 'Reactivates an inactive Connection, returning it to the `pending` state. Only the source organization can reactivate a connection. Once reactivated, the destination organization must accept the connection again before it returns to the `active` state. Only inactive connections can be reactivated.' operationId: reactivate-a-connect-connection externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/connect/connections/reactivate-a-connect-connection' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: connection-id in: path required: true schema: type: string description: ID of the connect connection examples: connection-id: value: connection-id responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-connection' schema: properties: data: $ref: '#/components/schemas/connect-connection' additionalProperties: false type: object required: - data description: This endpoint returns a Connection. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Reactivate a Connection tags: - Connect x-persona-product: Connect /connect/share-tokens: get: tags: - Connect summary: List all Share Tokens description: 'Returns a list of your organization''s Share Tokens. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-share-tokens externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/share-tokens/list-all-share-tokens' x-persona-product: Connect parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: connection-id: description: Filter Share Tokens by connect connection ID type: string examples: - cxn_ABC123 status: description: 'Filter Share Tokens by status. One of `created`, `pending`, `redeemed`, `expired`, or `failed`.' type: string examples: - created - pending - redeemed - expired - failed direction: description: Filter Share Tokens by direction. Defaults to returning both inbound and outbound. One of `inbound` or `outbound`. type: string examples: - inbound - outbound responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-share-token-list' schema: type: object additionalProperties: false properties: data: items: $ref: '#/components/schemas/connect-share-token' type: array description: An array of Share Tokens links: properties: next: type: - string - 'null' prev: type: - string - 'null' type: object additionalProperties: false required: - next - prev required: - data - links description: This endpoint returns a collection of Share Token resources. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' post: tags: - Connect summary: Create a Share Token description: 'Creates a new Share Token with the specified connection and source. Share Tokens can be created from Accounts, Inquiries, Transactions, or Verifications.' operationId: create-a-share-token externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/share-tokens/create-a-share-token' x-persona-product: Connect parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: examples: Success: $ref: '#/components/examples/create-share-token' schema: required: - data properties: data: required: - attributes properties: attributes: required: - connection-id - source-id properties: connection-id: type: string description: The ID of the connect connection examples: - cxn_ABC123 source-id: type: string description: The ID of the object to share. examples: - act_ABC123 - inq_DEF456 - txn_GHI789 - ver_JKL012 expires-in-seconds: type: integer description: 'The number of seconds from now until the share token expires. Must be between `60` (1 minute) and `1814400` (21 days). If omitted, defaults to 14 days.' examples: - 86400 - 3600 type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/connect-share-token' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/connect-share-token' included: $ref: '#/components/schemas/empty-included-objects' required: - data description: This endpoint returns a Share Token resource. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/connect/share-tokens/{share-token-id}': get: tags: - Connect summary: Retrieve a Share Token description: Retrieve the information for an existing Share Token. operationId: retrieve-a-share-token x-persona-product: Connect parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: share-token-id in: path required: true schema: type: string description: The ID of the Share Token - name: peek-source-data in: query required: false schema: type: boolean default: false description: | When `true`, the caller is the destination organization, and the destination organization has access to the source data peek capability, the response's `data.attributes.source-data` carries a PII-filtered source-data envelope. Defaults to `false`; omitted from list responses regardless. responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Share Token resource. content: application/json: examples: Success: $ref: '#/components/examples/connect-share-token-redeemed' Failed: $ref: '#/components/examples/connect-share-token-failed' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/connect-share-token' included: $ref: '#/components/schemas/empty-included-objects' required: - data '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/too-many-requests' '/connect/share-tokens/{share-token-id}/expire': post: tags: - Connect summary: Expire a Share Token description: 'Expires a Share Token, setting its status to expired and preventing further use.' operationId: expire-share-token x-persona-product: Connect parameters: - in: path name: share-token-id required: true schema: type: string description: The token/ID of the Share Token to be expired. - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Share Token resource. content: application/json: examples: Success: $ref: '#/components/examples/connect-share-token-expired' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/connect-share-token' included: $ref: '#/components/schemas/empty-included-objects' required: - data '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/connect/share-tokens/{share-token-id}/redeem': post: tags: - Connect summary: Redeem a Share Token description: | Initiates redemption of a Share Token in one of two modes: - **Clone:** Omit `data.attributes.destination-id` to create a new object from the source. Inquiry and Verification Share Tokens can be cloned. - **Hydrate:** Provide `data.attributes.destination-id` to import source data into an existing object. Account, Transaction, and Inquiry Share Tokens can hydrate an existing Account, Transaction, or Inquiry. Redemption is asynchronous. A successful request returns the Share Token with a `pending` status while Persona processes the import. operationId: redeem-share-token x-persona-product: Connect x-fern-examples: - name: Clone an object path-parameters: share-token-id: cnst_ABC123 request: data: attributes: {} response: body: data: type: connect/share-token id: cnst_ABC123 attributes: status: pending direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:25:00.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: clone relationships: destination: data: null connection: data: type: connect/connection id: cxn_ABC123 - name: Hydrate an object path-parameters: share-token-id: cnst_DEF456 request: data: attributes: destination-id: inq_XYZ789 response: body: data: type: connect/share-token id: cnst_DEF456 attributes: status: pending direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:25:00.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: hydrate relationships: destination: data: type: inquiry id: inq_XYZ789 connection: data: type: connect/connection id: cxn_ABC123 parameters: - in: path name: share-token-id required: true schema: type: string description: The token/ID of the Share Token to be redeemed. - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: required: false content: application/json: examples: CloneObject: x-remove-from-fern: true $ref: '#/components/examples/redeem-share-token-clone-object' HydrateObject: x-remove-from-fern: true $ref: '#/components/examples/redeem-share-token-hydrate-object' schema: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: attributes: type: object additionalProperties: false properties: destination-id: type: string description: | The ID of the existing destination object to hydrate. Omit this field, or the entire request body, to clone the source into a new destination object. example: inq_DEF456 meta: type: object additionalProperties: false properties: field-mappings: type: array description: | Optional list of field mappings to apply when hydrating an existing destination. If a source field name matches the destination field name, it is copied directly. These mappings are applied for fields not already matched by name. Field mappings are not used when cloning; omit them from clone requests. items: type: object additionalProperties: false required: - source-field-name - destination-field-name properties: source-field-name: type: string description: The name of the field in the source object. example: address_street_1 destination-field-name: type: string description: The name of the field in the destination object. example: street_address responses: '202': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Share Token redemption has been initiated and is processing. content: application/json: examples: CloneObject: x-remove-from-fern: true $ref: '#/components/examples/connect-share-token-clone-object-pending' HydrateObject: x-remove-from-fern: true $ref: '#/components/examples/connect-share-token-hydrate-object-pending' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/connect-share-token' included: $ref: '#/components/schemas/empty-included-objects' required: - data '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /api-logs: get: description: 'Returns a list of your organization''s API Logs. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-api-logs externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-logs/list-all-api-logs' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-log-list' schema: properties: data: items: $ref: '#/components/schemas/api-log' type: array description: An array of API Logs links: properties: next: examples: - /api/v1/api-logs?page%5Bafter%5D=req_19pQg1NHfYeUdpIvYZ54xmDz type: - string - 'null' prev: examples: - /api/v1/api-logs?page%5Bbefore%5D=req_1ePP8j3pyznPCEuw4TCjWWD0 type: - string - 'null' type: object additionalProperties: false required: - next - prev type: object additionalProperties: false required: - data - links description: This endpoint returns a collection of API log objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List all API Logs tags: - API Logs x-persona-product: API Logs '/api-logs/{api-log-id}': get: description: Retrieves the details of an existing API Log. operationId: retrieve-an-api-log externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/api-logs/retrieve-an-api-log' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: api-log-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/api-log' schema: properties: data: $ref: '#/components/schemas/api-log' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns an API log object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an API Log tags: - API Logs x-persona-product: API Logs '/case-templates/{case-template-id}': get: summary: Retrieve a Case Template tags: - Case Templates x-persona-product: Cases description: 'Retrieves the details of an existing Case Template, including its configured field schemas.' externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/case-templates/retrieve-a-case-template' operationId: retrieve-a-case-template parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: case-template-id in: path description: ID of the Case Template to retrieve. schema: type: string required: true responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Case Template object. content: application/json: examples: Success: $ref: '#/components/examples/case-template' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/case-template' included: $ref: '#/components/schemas/empty-included-objects' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' /cases: get: description: |- Returns a list of your organization's cases. Note that this endpoint aggregates cases across all case template(s). See [Pagination](https://docs.withpersona.com/pagination)for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. operationId: list-all-cases externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/list-all-cases' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: status: description: Filter cases by status examples: - Open type: string case-template-id: description: Filter cases by case template ID examples: - ctmpl_ABC123 type: string account-id: description: Filter cases by account ID examples: - act_ABC123 type: string reference-id: description: Filter cases by reference ID examples: - abc-123 type: string inquiry-id: description: Filter cases by inquiry ID examples: - inq_ABC123 type: string report-id: description: Filter cases by report ID examples: - rep_ABC123 type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: case id: case_KsFU1Vxv9oK3ztnwQuD7MaJo attributes: status: open name: KCAS-1 resolution: null created-at: '2021-03-24T04:59:21.764Z' updated-at: '2021-03-24T04:59:21.764Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: null creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_updater@withpersona.com updater-type: user tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_336jV1uVaaY84GAqvG91oiy9 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_eGK41TM6GjcZgdcoox7x8Hh0 reports: data: [] verifications: data: [] txns: data: [] links: prev: null next: /api/v1/cases?page%5Bafter%5D=case_19pQg1NHfYeUdpIvYZ54xmDz schema: properties: data: items: $ref: '#/components/schemas/case' type: array description: An array of Cases links: properties: next: examples: - /api/v1/cases?page%5Bafter%5D=case_19pQg1NHfYeUdpIvYZ54xmDz type: - string - 'null' prev: examples: - /api/v1/cases?page%5Bbefore%5D=case_1ePP8j3pyznPCEuw4TCjWWD0 type: - string - 'null' type: object additionalProperties: false required: - next - prev type: object additionalProperties: false required: - data - links description: This endpoint returns a collection of Case objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List all Cases tags: - Cases x-persona-product: Cases post: description: Creates a new case in your organization. operationId: create-a-case externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/create-a-case' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: description: 'Properties can include Case Template ID, creator email address, and fields configured on your Case Template.' properties: case-template-id: description: ID of the case template for this case type: string creator-email-address: description: Email of the user creating this case in the organization type: string case-queue-id: description: ID of the case queue to put this case in type: string fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Case Template. examples: - preferred-name: Albert additionalProperties: true type: object required: - case-template-id type: object additionalProperties: false type: object additionalProperties: false meta: properties: object-ids: description: 'Array of Persona object IDs that should be related to this case. The following object types are supported- accounts, documents, graph queries, inquiries, reports, report runs, sars, transactions, and, verifications.' items: type: string type: array sla-expires-in-seconds: description: Number of seconds from now when SLA expires (max of 90 days). examples: - 7200 type: - 'null' - number type: object additionalProperties: false required: - data type: object additionalProperties: false examples: Created: $ref: '#/components/examples/create-case' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: open name: MRR-3 resolution: null created-at: '2021-09-28T05:18:36.200Z' updated-at: '2021-09-28T05:18:36.200Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: '2021-09-28T07:18:36.200Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '503': $ref: '#/components/responses/service-unavailable' summary: Create a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}': delete: description: Permanently redacts a Case and its fields. Case objects must be redacted individually. **This action cannot be undone**. operationId: redact-a-case parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: case-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_KsFU1Vxv9oK3ztnwQuD7MaJo attributes: status: Approved name: KCAS-1 resolution: null created-at: '2021-03-24T04:59:21.764Z' updated-at: '2021-03-24T04:59:21.764Z' assigned-at: null resolved-at: '2021-03-25T04:59:21.764Z' redacted-at: '2021-03-26T04:59:21.764Z' sla-expires-at: '2021-03-26T06:59:21.764Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: null assigner-id: null assigner-type: null resolver-id: case_resolver@withpersona.com resolver-type: user updater-id: case_updater@withpersona.com updater-type: user tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_336jV1uVaaY84GAqvG91oiy9 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: - type: case-comment id: cscm_yd2urRmjaCWcSSxqTSHvUcsn accounts: data: - type: account id: act_RNwaSKFUDTzxUakAEuE2xmhZ inquiries: data: - type: inquiry id: inq_b6UPkf7mNC1qBtLXnfaWyUbY reports: data: [] verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Redact a Case tags: - Cases x-persona-product: Cases get: description: Retrieves the details of an existing Case. operationId: retrieve-case externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/retrieve-case' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: case-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_KsFU1Vxv9oK3ztnwQuD7MaJo attributes: status: Approved name: KCAS-1 resolution: null created-at: '2021-03-24T04:59:21.764Z' updated-at: '2021-03-24T04:59:21.764Z' assigned-at: null resolved-at: '2021-03-25T04:59:21.764Z' redacted-at: null sla-expires-at: null creator-id: case_creator@withpersona.com creator-type: user assignee-id: null assigner-id: null assigner-type: null resolver-id: case_resolver@withpersona.com resolver-type: user updater-id: case_updater@withpersona.com updater-type: user tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_336jV1uVaaY84GAqvG91oiy9 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: - type: case-comment id: cscm_yd2urRmjaCWcSSxqTSHvUcsn accounts: data: - type: account id: act_RNwaSKFUDTzxUakAEuE2xmhZ inquiries: data: - type: inquiry id: inq_b6UPkf7mNC1qBtLXnfaWyUbY reports: data: [] verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Case tags: - Cases x-persona-product: Cases patch: description: Updates the fields and add attachments on a Case that has been previously created. operationId: update-a-case parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: data: properties: attributes: properties: attachments: description: List of PDF and image files to add to this case. items: properties: data: description: base 64 encoded file type: string filename: description: Name of the file type: string type: object additionalProperties: false type: array case-queue-id: description: ID of the case queue to put this case in. Set to null to remove case from case queue. type: - string - 'null' fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Case Template. examples: - preferred-name: Albert additionalProperties: true type: object type: object additionalProperties: false type: object additionalProperties: false meta: properties: sla-expires-in-seconds: description: Number of seconds from now when SLA expires (max of 90 days). Set to null to clear SLA. examples: - 7200 - null type: - 'null' - number type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: open name: WATC-16 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: '2021-06-30T22:37:18.678Z' creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: foo@bar.com assigner-id: foo@bar.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Update a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/add-objects': post: description: 'Adds Persona objects (such as inquiries, accounts, or reports) to a Case' operationId: add-persona-objects externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/add-persona-objects' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: object-ids: description: 'Array of Persona object IDs to attach to this case. The following object types are supported- accounts, documents, graph queries, inquiries, reports, report runs, sars, transactions, and, verifications.' items: type: string type: - array - 'null' type: object additionalProperties: false type: object additionalProperties: false examples: Success: $ref: '#/components/examples/add-objects' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: resolved name: WATC-16 resolution: Escalated created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: null resolved-at: '2021-08-26T18:24:19.000Z' redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add Persona objects to a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/remove-objects': post: description: 'Removes Persona objects (such as inquiries, accounts, or reports) from a Case. This operation is idempotent — removing an object that is not attached succeeds without modifying the case.' operationId: remove-persona-objects externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/remove-persona-objects' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: object-ids: description: 'Array of Persona object IDs to detach from this case. The following object types are supported- accounts, documents, graph queries, inquiries, reports, report runs, sars, transactions, and, verifications. Detaching an object that is not currently attached is a no-op.' items: type: string type: - array - 'null' type: object additionalProperties: false type: object additionalProperties: false examples: Success: $ref: '#/components/examples/remove-objects' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: resolved name: WATC-16 resolution: Escalated created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: null resolved-at: '2021-08-26T18:24:19.000Z' redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-comments: data: [] accounts: data: [] inquiries: data: [] reports: data: [] verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove Persona objects from a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/assign': post: description: Assigns a Case to a Persona user. operationId: assign-a-case externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/assign-a-case' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: user-email-address: description: Email address of the Persona user to whom to assign this case type: string required: - user-email-address type: object additionalProperties: false required: - meta type: object additionalProperties: false examples: Success: $ref: '#/components/examples/assign-case' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: open name: WATC-16 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: foo@bar.com assigner-id: foo@bar.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Assign a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/set-status': post: description: Sets the status of a Case. operationId: set-status-for-a-case externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/set-status-for-a-case' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update status in: path name: case-id required: true schema: type: string requestBody: content: application/json: examples: Success: $ref: '#/components/examples/set-status' schema: properties: meta: properties: status: type: string description: Status to update case to required: - status type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: Approved name: WATC-16 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: foo@bar.com assigner-id: foo@bar.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Set status on a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/add-tag': post: description: Adds a new tag to a Case operationId: add-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/add-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update. in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to add to the Case. tag-id: type: string description: ID of the tag to add to the Case. type: object additionalProperties: false type: object additionalProperties: false examples: Success: $ref: '#/components/examples/set-tag' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: Open name: KYC-6 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: '2021-08-26T18:24:19.695Z' resolved-at: null redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: - FRAUD fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add tag to a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/remove-tag': post: description: Removes an existing tag from a Case operationId: remove-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/remove-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update. in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to remove from the Case. tag-id: type: string description: ID of the tag to add to the Case. type: object additionalProperties: false type: object additionalProperties: false examples: Success: $ref: '#/components/examples/set-tag' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: Open name: KYC-6 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: '2021-08-26T18:24:19.695Z' resolved-at: null redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove tag from a Case tags: - Cases x-persona-product: Cases '/cases/{case-id}/set-tags': post: description: Sets all tags on a Case. Any tags that are not provided in the request will be removed. operationId: set-tags externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/set-tags' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the case to update. in: path name: case-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: description: Names of the tags to add to the Case. items: type: string type: array tag-id: description: IDs of the tags to add to the Case. items: type: string type: array type: object additionalProperties: false type: object additionalProperties: false examples: Success: $ref: '#/components/examples/set-tags' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: case id: case_3maVhdLzdGftRZCvxfqazVL1 attributes: status: Open name: KYC-6 resolution: null created-at: '2021-06-30T20:37:18.678Z' updated-at: '2021-08-26T18:24:19.695Z' assigned-at: '2021-08-26T18:24:19.695Z' resolved-at: null redacted-at: null sla-expires-at: null creator-id: wfl_yKynZZiuPz1R5qm9JFyBnnLB creator-type: workflow-run assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: null updater-type: null tags: - FRAUD - IMPERSONATING CELEBRITY fields: {} attachments: [] relationships: case-template: data: type: case-template id: ctmpl_6HheND7s14a2o7fg33iHqhg7 case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 case-comments: data: [] accounts: data: [] inquiries: data: - type: inquiry id: inq_29Yd6kF6xWVFgemm5WTxhxvf reports: data: - type: report/watchlist id: rep_PN3xspEwWCWWRp1eGpedaSNj verifications: data: [] txns: data: [] schema: properties: data: $ref: '#/components/schemas/case' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/cases-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Case object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Set tags on a Case tags: - Cases x-persona-product: Cases /cases/search: post: description: | Search for cases using a flexible query language. ## Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics. Use the **Search** endpoint (`POST /cases/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter by custom fields, assignee, case queue, or SLA expiration, or apply multiple conditions simultaneously. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /cases`) for simple listing with basic filters like status, case template, account, inquiry, or report. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating a case, use the List Cases endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `template` | Case template (e.g., `ctmpl_ABC123`) | | `status` | Case status (e.g., `open`, `pending`, `resolved`) | | `state` | Case state | | `created_at` | Case creation timestamp | | `updated_at` | Case last updated timestamp | | `resolved_at` | Case resolution timestamp | | `sla_expires_at` | SLA expiration timestamp | | `assignee` | Assigned user (e.g., `user_ABC123`) | | `case_queue` | Case queue (e.g., `cqueue_ABC123`) | | `resolver` | Resolver user | | `fields.*` | Custom case field (e.g., `fields.priority`) | **Note:** Custom fields (`fields.*`) must be configured as searchable on the Case Template to be queryable. operationId: search-cases externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/cases/search-cases' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: page style: deepObject explode: true schema: type: object additionalProperties: false properties: after: description: Cursor for forward pagination. Use the value from `links.next` in the previous response. type: string examples: - case_ABC123 before: description: Cursor for backward pagination. Use the value from `links.prev` in the previous response. type: string examples: - case_XYZ789 size: description: Number of results to return per page. type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 requestBody: content: application/json: schema: properties: query: 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). unevaluatedProperties: false oneOf: - type: object x-inheritable: true additionalProperties: false description: | Boolean AND clause - combines multiple conditions where ALL must be true. This clause is recursive: each item in the `and` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per AND: 20 properties: and: type: array items: type: object additionalProperties: true required: - and - type: object x-inheritable: true additionalProperties: false description: | Boolean OR clause - combines multiple conditions where AT LEAST ONE must be true. This clause is recursive: each item in the `or` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per OR: 20 properties: or: type: array items: type: object additionalProperties: true required: - or - type: object x-inheritable: true additionalProperties: false description: | Boolean NOT clause - negates a single condition. This clause is recursive: the `not` value can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels properties: not: type: object additionalProperties: true required: - not - type: object x-inheritable: true additionalProperties: false description: Attribute predicate properties: attribute: type: string description: 'The attribute name to filter on (e.g., ''created_at'', ''template'', ''status'', ''fields.priority'')' examples: - created_at - template - status - fields.priority operator: type: string description: 'Comparison operator. Possible values: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal).' value: description: Value to compare against x-inheritable: true unevaluatedProperties: false oneOf: - type: string - type: number - type: boolean required: - attribute - operator - value examples: - attribute: created_at operator: gte value: '2025-01-01' - and: - attribute: template operator: eq value: ctmpl_ABC123 - attribute: created_at operator: gte value: '2025-01-01' sort: description: Sort configuration for results type: object additionalProperties: false properties: attribute: type: string description: The attribute name to sort by examples: - created_at - updated_at - resolved_at - fields.priority direction: type: string default: desc description: 'Sort direction. Possible values: asc (ascending), desc (descending).' required: - attribute - direction page: description: Pagination parameters type: object additionalProperties: false properties: after: description: Cursor for forward pagination type: string examples: - case_ABC123 before: description: Cursor for backward pagination type: string examples: - case_XYZ789 size: description: Number of results to return per page type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 additionalProperties: false type: object examples: Simple query: value: query: not: attribute: status operator: eq value: resolved sort: attribute: created_at direction: asc page: size: 15 Complex boolean query: value: query: and: - attribute: template operator: eq value: ctmpl_ABC123 - or: - attribute: status operator: eq value: open - attribute: status operator: eq value: pending sort: attribute: created_at direction: desc page: size: 15 Empty query (all cases): value: page: size: 15 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/case-list-search' schema: properties: data: items: $ref: '#/components/schemas/case' type: array description: An array of Cases matching the search criteria links: properties: prev: type: - string - 'null' examples: - /api/v1/cases/search?page%5Bbefore%5D=case_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the previous page of data, or null if on the first page. Must be used with POST request and original request body.' next: type: - string - 'null' examples: - /api/v1/cases/search?page%5Bafter%5D=case_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the next page of data, or null if on the last page. Must be used with POST request and original request body.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links description: This endpoint returns a collection of Case objects matching the search criteria. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Search Cases tags: - Cases x-persona-product: Cases /devices: get: description: 'Retrieves a list of Devices. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-devices externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/devices/list-all-devices' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - in: query name: filter required: true style: deepObject explode: true schema: type: object additionalProperties: false properties: inquiry-session-id: description: Filter devices by inquiry session ID type: string example: iqse_ABC123 required: - inquiry-session-id responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/device-list' schema: type: object additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/device' links: type: object additionalProperties: false properties: prev: type: - string - 'null' examples: - /api/v1/devices?page%5Bbefore%5D=dev_ABC123 next: type: - string - 'null' examples: - /api/v1/devices?page%5Bafter%5D=dev_ABC123 required: - prev - next required: - data - links description: This endpoint returns a collection of Device objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' '503': $ref: '#/components/responses/service-unavailable' summary: List all Devices tags: - Devices x-persona-product: Devices '/devices/{device-id}': get: description: Retrieves details of a specific Device. operationId: retrieve-a-device externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/devices/retrieve-a-device' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Device ID in: path name: device-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/device' schema: properties: data: $ref: '#/components/schemas/device' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Device object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' '503': $ref: '#/components/responses/service-unavailable' summary: Retrieve a Device tags: - Devices x-persona-product: Devices '/document/generics/{document-id}': get: description: Retrieves the details of a generic document that has been previously created. operationId: retrieve-a-generic-document externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/documents/retrieve-a-generic-document' parameters: - in: path name: document-id required: true schema: type: string - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/document-generic' schema: properties: data: $ref: '#/components/schemas/document-generic' included: $ref: '#/components/schemas/document-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Generic Document object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Generic Document tags: - Documents x-persona-product: Documents '/document/government-ids/{document-id}': get: description: Retrieves the details of a government-id document that has been previously created. operationId: retrieve-a-government-id-document externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/documents/retrieve-a-government-id-document' parameters: - in: path name: document-id required: true schema: type: string - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/document-government-id' schema: properties: data: $ref: '#/components/schemas/document-government-id' included: $ref: '#/components/schemas/document-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Government ID Document object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Government Id Document tags: - Documents x-persona-product: Documents '/documents/{document-id}': get: description: Retrieves the details of a Document. operationId: retrieve-a-document externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/documents/retrieve-a-document' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: document-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/document-generic' schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: $ref: '#/components/schemas/document-included-objects' required: - data description: This endpoint returns a Document object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Document tags: - Documents x-persona-product: Documents /events: get: description: 'Returns a list of your organization''s events. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-events externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/events/list-all-events' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: name: description: Comma separated list of event names type: string object-id: description: Comma separated list of object ids type: string id: description: Comma separated list of event ids type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: event id: evt_ABC123 attributes: name: inquiry.expired payload: data: type: inquiry id: inq_ABC123 attributes: {} created-at: '2023-09-23T17:14:01.918Z' - type: event id: evt_ABC123 attributes: name: account.tag-added payload: data: type: account id: act_ABC123 attributes: {} created-at: '2023-09-23T00:46:41.877Z' links: prev: null next: null schema: properties: data: type: array description: An array of Events items: $ref: '#/components/schemas/event' links: type: object additionalProperties: false properties: prev: type: - string - 'null' examples: - /api/v1/events?page%5Bbefore%5D=evt_ABC123 next: type: - string - 'null' examples: - /api/v1/events?page%5Bafter%5D=evt_ABC123 required: - prev - next type: object additionalProperties: false required: - data - links description: This endpoint returns a collection of Event objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Events tags: - Events x-persona-product: Events '/events/{event-id}': get: description: Retrieves the details of an existing event. operationId: retrieve-an-event externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/events/retrieve-an-event' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: event-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: event id: evt_ABC123 attributes: name: inquiry.expired payload: data: type: inquiry id: inq_ABC123 attributes: {} created-at: '2023-09-23T17:14:01.918Z' schema: properties: data: $ref: '#/components/schemas/event' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns an Event object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Event tags: - Events x-persona-product: Events /graph-queries: post: description: Create a Graph Query operationId: create-a-graph-query externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/graph/create-a-graph-query' parameters: - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: graph-query-template-id: type: string parameter-map: type: object additionalProperties: true description: Required. JSON key-value pairs of parameter name to value. Schema is defined by your Graph Query Template. examples: - example-key-1: example-value-1 example-key-2: example-value-2 variable-map: type: object additionalProperties: true deprecated: true description: |- Deprecated, use parameter-map instead. JSON key-value pairs of variable name to value. Schema is defined by your Graph Query Template. examples: - example-key-1: example-value-1 example-key-2: example-value-2 timeout-in-seconds: description: Number of seconds from now to timeout the graph query. Must be greater than 0 and less than 60. type: integer required: - graph-query-template-id type: object additionalProperties: false required: - attributes type: object additionalProperties: false meta: properties: run-sync: type: boolean description: 'If true, the query will run synchronously and results will be returned in the response. If false, the query will run asynchronously and you will have to poll for results.' default: false type: object additionalProperties: false required: - data type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' included: description: 'Optional included resources, requested via the `include` query parameter.' type: array items: $ref: '#/components/schemas/account' required: - data examples: Created: value: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: submitted params: : created-at: '2023-09-1T06:30:44.000Z' updated-at: null errored-at: null completed-at: null redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: false nodes: [] description: This endpoint returns a Graph Query object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Graph Query tags: - Graph x-persona-product: Graph '/graph-queries/{graph-query-id}': get: description: Retrieve a Graph Query operationId: retrieve-a-graph-query externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/graph/retrieve-a-graph-query' parameters: - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - in: path name: graph-query-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' included: $ref: '#/components/schemas/empty-included-objects' required: - data examples: Success: value: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: completed params: : created-at: '2023-09-1T06:30:44.000Z' updated-at: '2023-09-2T07:31:47.000Z' errored-at: null completed-at: '2023-09-4T09:33:03.000Z' redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: false nodes: [] description: This endpoint returns a Graph Query object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Graph Query tags: - Graph x-persona-product: Graph /importers: get: description: 'Returns a list of your organization''s importers. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-importers externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/list-all-importers' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: importer/account id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 - type: importer/list-item/name id: mprt_N6PqYkfSqeqiQYWoeHA3GGDo attributes: status: ready created-at: '2020-07-12T17:16:54.656Z' completed-at: '2020-07-14T17:17:23.032Z' error-count: 0 successful-count: 104 duplicate-count: 3 links: prev: null next: null schema: properties: data: type: array description: An array of Importers items: unevaluatedProperties: false $ref: '#/components/schemas/importer' links: type: object additionalProperties: false properties: prev: type: - string - 'null' examples: - /api/v1/events?page%5Bbefore%5D=mprt_ABC123 next: type: - string - 'null' examples: - /api/v1/events?page%5Bafter%5D=mprt_ABC123 required: - prev - next required: - data - links type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Importers tags: - Importers x-persona-product: Importers '/importers/{importer-id}': get: description: Retrieve the details of an existing importer. operationId: retrieve-an-importer externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/retrieve-an-importer' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: String ID of the importer to fetch in: path name: importer-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: importer/account id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: type: object additionalProperties: false required: - data properties: data: unevaluatedProperties: false $ref: '#/components/schemas/importer' included: $ref: '#/components/schemas/empty-included-objects' description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Importer tags: - Importers x-persona-product: Importers /importer/accounts: post: description: |- Bulk import accounts by uploading a CSV file. Each row should be the details for a new account. The columns we allow are: - reference_id - name_first - name_middle - name_last - birthdate - social_security_number - tags operationId: import-an-account externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-an-account' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: multipart/form-data: schema: properties: data: properties: attributes: properties: file: type: string contentMediaType: application/octet-stream required: - file type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false application/json: schema: properties: data: properties: attributes: properties: file: properties: data: description: Base64 encoded file format: binary type: string filename: description: Name of file type: string type: object additionalProperties: false required: - file type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/account id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-account' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Accounts tags: - Importers x-persona-product: Importers /importer/list-item/email-addresses: post: description: |- Bulk import email address List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - value - match_type (either 'email_address' or 'domain') A match_type of 'email_address' will need to match the entire email address of an individual, while a match_type of 'domain' will match on the email address domain of an individual (i.e. all email addresses with domain 'gmail.com'). operationId: import-email-address-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-email-address-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/email-address id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-email-address' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Email Address Lists tags: - Importers x-persona-product: Importers /importer/list-item/geolocations: post: description: |- Bulk import geolocation List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - latitude - longitude - radius_meters operationId: import-geolocation-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-geolocation-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/geolocation id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-geolocation' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Geolocation Lists tags: - Importers x-persona-product: Importers /importer/list-item/government-id-numbers: post: description: |- Bulk import government ID number List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - id_number - id_class Common values for id_class include `pp` for passport and `dl` for driver license. Please contact us or reach out to [support@withpersona.com](mailto:support@withpersona.com) if you need help getting id_class values. operationId: import-government-id-number-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-government-id-number-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/government-id-number id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-government-id-number' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Government ID Number Lists tags: - Importers x-persona-product: Importers /importer/list-item/ip-addresses: post: description: |- Bulk import IP address List Items by uploading a CSV file. Each row should be the details for a new List Item. The columns we allow are: - value Both IPv4 and IPv6 are supported. operationId: import-ip-address-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-ip-address-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/ip-address id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-ip-address' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import IP Address Lists tags: - Importers x-persona-product: Importers /importer/list-item/names: post: description: |- Bulk import name List Items by uploading a CSV file. Each row should be the details for a new list item. The columns we allow are: - name_first - name_last operationId: import-name-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-name-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/name id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-name' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Name Lists tags: - Importers x-persona-product: Importers /importer/list-item/phone-numbers: post: description: |- Bulk import phone number List Items by uploading a CSV file. Each row should be the details for a new list item. The columns we allow are: - value operationId: import-phone-number-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/importers/import-phone-number-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: $ref: '#/components/requestBodies/list-item-importer-csv-request' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: data: type: importer/list-item/phone-number id: mprt_TKqquVbHaSVYqgWhxNjuYDjQ attributes: status: pending created-at: '2020-07-12T17:16:54.656Z' completed-at: null error-count: 0 successful-count: 0 duplicate-count: 0 schema: properties: data: $ref: '#/components/schemas/importer-list-item-phone-number' required: - data type: object additionalProperties: false description: This endpoint returns an Importer object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Phone Number Lists tags: - Importers x-persona-product: Importers /inquiries: get: description: |- Returns a list of your organization's inquiries. Note that this endpoint aggregates inquiries across all inquiry template(s). See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first. operationId: list-all-inquiries externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/list-all-inquiries' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: additionalProperties: false type: object properties: inquiry-id: description: Comma separated list of inquiry IDs (starting with `inq_`) to filter inquiries by examples: - inq_ABC123 - 'inq_ABC123,inq_DEF456' unevaluatedProperties: false type: string account-id: description: Comma separated list of account IDs (starting with `act_`) to filter inquiries by examples: - act_ABC123 - 'act_ABC123,act_DEF456' unevaluatedProperties: false type: string note: description: Filter inquiries by note. Must be the only filter. examples: - A note saved on an Inquiry type: string reference-id: description: Filter inquiries by reference ID examples: - abc-123 type: string inquiry-template-id: description: Comma separated list of inquiry template IDs (starting with `itmpl_`) to filter inquiries by examples: - itmpl_ABC123 - 'itmpl_ABC123,itmpl_DEF456' unevaluatedProperties: false type: string template-id: description: Comma separated list of legacy template IDs (starting with `tmpl_`) to filter inquiries by examples: - tmpl_ABC123 - 'tmpl_ABC123,tmpl_DEF456' unevaluatedProperties: false type: string status: description: Comma separated list of statuses to filter inquiries by examples: - created - pending - completed - expired - failed - needs_review - approved - declined - 'completed,approved' unevaluatedProperties: false type: string created-at-start: description: 'Filter inquiries by creation date, equal to or later than' examples: - '2023-10-11T04:59:21.764Z' format: date-time type: string created-at-end: description: 'Filter inquiries by creation date, earlier than or equal to' examples: - '2023-10-20T04:59:21.764Z' format: date-time type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-list' schema: properties: data: items: $ref: '#/components/schemas/inquiry' type: array description: An array of Inquiries links: properties: prev: examples: - /api/v1/inquiries?page%5Bafter%5D=inq_ABC123 type: - 'null' - string description: 'URL pointing to the previous page of data, or null if on the first page.' next: examples: - /api/v1/inquiries?page%5Bafter%5D=inq_ABC123 type: - 'null' - string description: 'URL pointing to the next page of data, or null if on the last page.' required: - prev - next additionalProperties: false type: object required: - data - links additionalProperties: false type: object description: This endpoint returns a collection of Inquiry objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Inquiries tags: - Inquiries x-persona-product: Inquiries post: description: |- Creates a new inquiry with optional pre-filled attributes. See [Sessions](https://docs.withpersona.com/inquiry-sessions) for how to continue the inquiry in [Embedded Flow](https://docs.withpersona.com/embedded-flow) or [Hosted Flow](https://docs.withpersona.com/hosted-flow). operationId: create-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/create-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: template-id: description: Template ID for flow requirements (use this field if your template ID starts with `tmpl_`). *You must pass in either template-id OR inquiry-template-id OR inquiry-template-version-id* examples: - tmpl_ABC123 type: - string - 'null' inquiry-template-id: description: Template ID for flow requirements (use this field if your template ID starts with `itmpl_`). *You must pass in either template-id OR inquiry-template-id OR inquiry-template-version-id* examples: - itmpl_ABC123 type: - string - 'null' inquiry-template-version-id: description: Template Version ID for flow requirements (begins with `itmplv_`). *You must pass in either template-id OR inquiry-template-id OR inquiry-template-version-id* examples: - itmplv_ABC123 type: - string - 'null' reference-id: description: Reference ID to refer to an entity in your user model. This field is deprecated in favor of `meta.auto-create-account-reference-id`. deprecated: true examples: - abc-123 type: - string - 'null' account-id: description: Account ID to associate with this inquiry examples: - act_ABC123 type: - string - 'null' creator-email-address: description: Email of the user creating this inquiry in the organization examples: - creator@withpersona.com type: - string - 'null' theme-id: description: Theme ID for styling. Only available for Legacy 2.0 Inquiries. examples: - the_ABC123 type: - string - 'null' theme-set-id: description: BETA FEATURE -- Theme Set ID for styling. Only available for Dynamic Flow Inquiries. examples: - theset_ABC123 type: - string - 'null' redirect-uri: description: 'If using the Hosted flow, redirect to this URL after completion' examples: - 'https://yoururl.com/redirect' type: - string - 'null' note: description: Unstructured field for your custom use examples: - A note about this inquiry type: - string - 'null' fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. unevaluatedProperties: false oneOf: - type: 'null' - $ref: '#/components/schemas/inquiry-fields' tags: description: A list of tag names to be associated with the Inquiry. items: type: string type: - array - 'null' initial-step-name: description: BETA FEATURE -- Specify an alternate initial step. Only available for Dynamic Flow Inquiries. type: - string - 'null' additionalProperties: false type: object required: - attributes additionalProperties: false type: object meta: properties: auto-create-account: description: 'If true, automatically create an Account for the user if one does not exist. Default is true.' examples: - true type: boolean auto-create-account-type-id: 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. examples: - acttp_ABC123 type: string auto-create-account-reference-id: 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. examples: - my_reference_id type: string auto-create-inquiry-session: description: 'If true, automatically create an Inquiry Session token for the Inquiry.' examples: - true type: boolean auto-create-one-time-link: description: 'If true, automatically create a One-Time Link URL for the Inquiry.' examples: - true type: boolean expiration-after-create-interval-seconds: 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. examples: - 86400 type: - integer - 'null' expiration-after-start-interval-seconds: 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. examples: - 86400 type: - integer - 'null' expiration-after-resume-interval-seconds: 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. examples: - 86400 type: - integer - 'null' one-time-link-expiration-seconds: description: Time interval after which Device Handoff one time links expire. Overrides value set at the template level. examples: - 3600 type: - integer - 'null' additionalProperties: false type: object required: - data additionalProperties: false type: object examples: Created: $ref: '#/components/examples/create-inquiry' responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/inquiry-created' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' meta: properties: session-token: description: The token for the Inquiry Session. Only present when `meta.auto-create-inquiry-session` is true. type: - string - 'null' one-time-link: description: The URL for the One-Time Link. Only present when `meta.auto-create-one-time-link` is true. type: - string - 'null' one-time-link-short: description: The short URL for the One-Time Link. Only present when `meta.auto-create-one-time-link` is true. type: - string - 'null' required: - session-token - one-time-link - one-time-link-short additionalProperties: false type: object required: - data - meta additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}': delete: description: |- Permanently deletes personally identifiable information (PII) for an Inquiry and all associated Verifications, Reports, or other Persona resources. The response indicates a successful redaction of the Inquiry. Redaction of the Inquiry's associated child objects are done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. operationId: redact-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/redact-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Redact an Inquiry tags: - Inquiries x-persona-product: Inquiries get: description: |- Retrieves the details of an existing Inquiry. In the [Embedded Flow](https://docs.withpersona.com/embedded-flow), the `inquiry-id` is the first parameter of the onStart callback. In the [Hosted Flow](https://docs.withpersona.com/hosted-flow), the `inquiry-id` is a query parameter in the onComplete callback. Template information will be found in `data.relationships.inquiry-template` if the inquiry is a Dynamic Flow inquiry, and in `data.relationships.template` if the inquiry is a Legacy 2.0 inquiry. For more information, see [Dynamic Flow vs. Legacy Templates](https://docs.withpersona.com/inquiry-templates#dynamic-flow-vs-legacy-templates). operationId: retrieve-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/retrieve-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-retrieve' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Inquiry tags: - Inquiries x-persona-product: Inquiries patch: description: |- Updates an existing Inquiry. Note that if you use webhooks, updates to inquiries that are not in progress can result in data getting out of sync. For example, updating a completed Inquiry will not cause your Inquiry completed webhook to retrigger. Inquiries represent a snapshot of data collected from an individual, so we generally do not recommend updating an Inquiry's data after the Inquiry has been finalized. operationId: update-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/update-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: data: properties: attributes: properties: note: description: Unstructured field for your custom use examples: - A note about this inquiry type: - string - 'null' fields: description: JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. unevaluatedProperties: false oneOf: - type: 'null' - $ref: '#/components/schemas/inquiry-fields' tags: description: A list of tag names to be associated with the Inquiry. items: type: string type: array redirect-uri: description: 'The URI to redirect to after the inquiry flow is completed. When using Hosted Flow, the user will be redirected to this URL upon completion.' examples: - 'https://example.com/redirect' type: - string - 'null' additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Update an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/add-tag': post: description: Adds a new tag to an Inquiry. operationId: inquiries-add-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/add-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/inquiries-tag-request' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add tag to an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/approve': post: description: |- Approves an Inquiry. Note that this action will trigger any associated workflows and webhooks. Approving an inquiry will prevent further progress on the inquiry. operationId: approve-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/approve-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/inquiries-review-request' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Approve an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/decline': post: description: |- Declines an Inquiry. Note that this action will trigger any associated workflows and webhooks. Declining an inquiry will prevent further progress on the inquiry. operationId: decline-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/decline-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/inquiries-review-request' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Decline an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/mark-for-review': post: description: |- Marks an Inquiry for manual review. Inquiries that are already approved or declined cannot be marked for review. Note that this action will trigger any associated workflows and webhooks. Marking an inquiry for review will prevent further progress on the inquiry. operationId: mark-an-inquiry-for-review externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/mark-an-inquiry-for-review' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Mark an Inquiry for manual review tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/expire': post: description: |- Expires an Inquiry and all sessions on the Inquiry. Cancels any pending Verifications on the inquiry. The Inquiry can still be resumed after expiry. operationId: expire-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/expire-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Expire an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/generate-one-time-link': post: description: Creates a new inquiry session and returns `meta.one-time-link`. operationId: generate-a-one-time-link externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/generate-a-one-time-link' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Inquiry ID (starts with "inq_") in: path name: inquiry-id required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: expires-in-seconds: 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.' examples: - 3600 format: int32 type: integer additionalProperties: false type: object additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-one-time-link' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' meta: properties: one-time-link: examples: - 'https://withpersona.com/verify?code=us1-asdf' type: string one-time-link-short: examples: - 'https://perso.na/verify?code=ABC123' type: string required: - one-time-link - one-time-link-short additionalProperties: false type: object required: - data - meta additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Generate a one-time link for an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/print': get: description: Prints an Inquiry as PDF. operationId: print-an-inquiry-pdf externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/print-an-inquiry-pdf' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a PDF for the Inquiry object. content: application/pdf: schema: type: string format: binary '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/too-many-requests' summary: Print Inquiry PDF tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/remove-tag': post: description: Removes an existing tag from an Inquiry. operationId: inquiries-remove-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/remove-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/inquiries-tag-request' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove tag from an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/resume': post: description: |- Creates a session token that is returned as `meta.session-token`. If the inquiry's status is `expired`, changes the status to `pending`. The `session-token` must be included when loading the inquiry flow if the inquiry's status is `pending`. This endpoint will error if the inquiry is redacted. This endpoint first tries to reuse any existing valid unused [sessions](https://docs.withpersona.com/inquiry-sessions). If none exist, a new session is created. For more information, see [Resuming Inquiries](https://docs.withpersona.com/resuming-inquiries). operationId: resume-an-inquiry externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/resume-an-inquiry' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-resume' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' meta: properties: session-token: examples: - eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJpcXNlX1Q4UHJxcG9FaHdoVVYxd0hSZXVVOW9mcyIsImF1ZCI6InBlcnNvbmEtdmVyaWZ5IiwiaXNzIjoic3RhZ2luZy53aXRocGVyc29uYS5jb20iLCJpYXQiOjE1NzM4NTI2NjEsIm5iZiI6MTU3Mzg1MjY2MSwiZXhwIjoxNTczOTM5MDYxLCJqdGkiOiI5NWRlNjhkOS1hZjI4LTRiMzItOWIxYi03MjA4MTg3NTI3N2IiLCJzaWQiOiJpcXNlX1Q4UHJxcG9FaHdoVVYxd0hSZXVVOW9mcyJ9.LN6DEnfjP5cZoZ3w41RgyX5QVmutmjHja_bRHOmDjg0 type: string required: - session-token additionalProperties: false type: object required: - data - meta additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Resume an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/set-tags': post: description: Sets all tags on an Inquiry. Any tags that are not provided in the request will be removed. operationId: inquiries-set-all-tags externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/set-all-tags' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: content: application/json: examples: Success: $ref: '#/components/examples/set-tags' schema: properties: meta: properties: tag-name: items: type: string examples: - - apple - banana - - orange type: array tag-id: items: type: string type: array additionalProperties: false type: object additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Set tags on an Inquiry tags: - Inquiries x-persona-product: Inquiries '/inquiries/{inquiry-id}/perform-simulate-actions': post: description: Performs a series of simulated actions on a Sandbox Inquiry. operationId: inquiries-perform-simulate-actions externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/perform-simulate-actions' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: simulate-actions: items: unevaluatedProperties: false anyOf: - $ref: '#/components/schemas/inquiry-status-action' - $ref: '#/components/schemas/create-verification-action' type: object example: - type: start_inquiry - type: create_failed_verification data: verification-template-id: vtmpl_CCLT7pvBZM8z5fumdb3QvW5cSrdr - type: create_passed_verification data: verification-template-id: vtmpl_CCLT7pvBZM8z5fumdb3QvW5cSrdr - type: complete_inquiry - type: approve_inquiry type: array required: - simulate-actions additionalProperties: false type: object required: - meta additionalProperties: false type: object responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry' schema: properties: data: $ref: '#/components/schemas/inquiry' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-included-objects' required: - data additionalProperties: false type: object description: This endpoint returns an Inquiry object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Perform Simulate Actions tags: - Inquiries x-persona-product: Inquiries /inquiries/search: post: description: | Search for inquiries using a flexible query language. ## Search vs. List Endpoints The Search and List endpoints serve different purposes and have distinct performance characteristics. Use the **Search** endpoint (`POST /inquiries/search`) when you need to perform complex queries with boolean logic (AND/OR/NOT), filter on multiple statuses simultaneously, or apply multiple conditions at once. Search is optimized for flexible querying and is faster than paginating through all resources when looking for specific records. Use the **List** endpoint (`GET /inquiries`) for simple listing with basic filters like reference ID. ## Data Freshness Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation of new or updated data could be delayed during an outage. For workflows that require immediate data availability after creating or updating an inquiry, use the List Inquiries endpoint instead. ### Searchable Attributes The following attributes can be used in query predicates: | Attribute | Description | |-----------|-------------| | `status` | Inquiry status (e.g., `pending`, `completed`, `approved`, `declined`) | | `created_at` | Inquiry creation timestamp | | `updated_at` | Inquiry last updated timestamp | | `reference_id` | Reference ID associated with the inquiry's account | | `inquiry_template_id` | Inquiry template ID (e.g., `itmpl_ABC123`) | operationId: search-inquiries externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiries/search-inquiries' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: page style: deepObject explode: true schema: type: object additionalProperties: false properties: after: description: Cursor for forward pagination. Use the value from `links.next` in the previous response. type: string examples: - inq_ABC123 before: description: Cursor for backward pagination. Use the value from `links.prev` in the previous response. type: string examples: - inq_XYZ789 size: description: Number of results to return per page. type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 requestBody: content: application/json: schema: properties: query: 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). unevaluatedProperties: false oneOf: - type: object x-inheritable: true additionalProperties: false description: | Boolean AND clause - combines multiple conditions where ALL must be true. This clause is recursive: each item in the `and` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per AND: 20 properties: and: type: array items: type: object additionalProperties: true required: - and - type: object x-inheritable: true additionalProperties: false description: | Boolean OR clause - combines multiple conditions where AT LEAST ONE must be true. This clause is recursive: each item in the `or` array can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels, Maximum clauses per OR: 20 properties: or: type: array items: type: object additionalProperties: true required: - or - type: object x-inheritable: true additionalProperties: false description: | Boolean NOT clause - negates a single condition. This clause is recursive: the `not` value can be another AND, OR, NOT clause, or a leaf predicate, enabling complex nested queries. Maximum nesting depth: 2 levels properties: not: type: object additionalProperties: true required: - not - type: object x-inheritable: true additionalProperties: false description: Attribute predicate properties: attribute: type: string description: 'The attribute name to filter on (e.g., ''status'', ''created_at'', ''reference_id'', ''inquiry_template_id'')' examples: - status - created_at - updated_at - reference_id - inquiry_template_id operator: type: string description: 'Comparison operator. Possible values: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal).' value: description: Value to compare against x-inheritable: true unevaluatedProperties: false oneOf: - type: string - type: number - type: boolean required: - attribute - operator - value examples: - attribute: created_at operator: gte value: '2025-01-01' - or: - attribute: status operator: eq value: pending - attribute: status operator: eq value: completed sort: description: Sort configuration for results type: object additionalProperties: false properties: attribute: type: string description: The attribute name to sort by examples: - created_at - updated_at - status direction: type: string default: desc description: 'Sort direction. Possible values: asc (ascending), desc (descending).' required: - attribute - direction page: description: Pagination parameters type: object additionalProperties: false properties: after: description: Cursor for forward pagination type: string examples: - inq_ABC123 before: description: Cursor for backward pagination type: string examples: - inq_XYZ789 size: description: Number of results to return per page type: integer minimum: 1 maximum: 100 default: 10 examples: - 10 additionalProperties: false type: object examples: Simple query: value: query: attribute: status operator: eq value: completed sort: attribute: created_at direction: asc page: size: 15 Multi-status query: value: query: or: - attribute: status operator: eq value: pending - attribute: status operator: eq value: completed - attribute: status operator: eq value: approved sort: attribute: created_at direction: desc page: size: 15 Complex boolean query: value: query: and: - attribute: inquiry_template_id operator: eq value: itmpl_ABC123 - or: - attribute: status operator: eq value: completed - attribute: status operator: eq value: approved - attribute: created_at operator: gte value: '2025-01-01' sort: attribute: created_at direction: desc page: size: 15 Empty query (all inquiries): value: page: size: 15 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-list-search' schema: properties: data: items: $ref: '#/components/schemas/inquiry' type: array description: An array of Inquiries matching the search criteria links: properties: prev: type: - string - 'null' examples: - /api/v1/inquiries/search?page%5Bbefore%5D=inq_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the previous page of data, or null if on the first page. Must be used with POST request and original request body.' next: type: - string - 'null' examples: - /api/v1/inquiries/search?page%5Bafter%5D=inq_ABC123&page%5Bsize%5D=10 description: 'URL pointing to the next page of data, or null if on the last page. Must be used with POST request and original request body.' additionalProperties: false type: object required: - prev - next additionalProperties: false type: object required: - data - links description: This endpoint returns a collection of Inquiry objects matching the search criteria. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Search Inquiries tags: - Inquiries x-persona-product: Inquiries /inquiry-sessions: get: description: 'Retrieves a list of Inquiry Sessions. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-inquiry-sessions externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/list-all-inquiry-sessions' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: inquiry-id: description: Filter inquiry sessions by inquiry ID type: string example: inq_ABC123 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: inquiry-session id: iqse_ABC123 attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 relationships: inquiry: data: type: inquiry id: inq_ABC123 device: data: type: device id: dev_ABC123 links: prev: null next: null schema: type: object additionalProperties: false required: - data - links properties: data: type: array items: $ref: '#/components/schemas/inquiry-session' links: type: object additionalProperties: false properties: prev: type: - string - 'null' examples: - /api/v1/inquiry-sessions?page%5Bbefore%5D=iqse_ABC123 next: type: - string - 'null' examples: - /api/v1/inquiry-sessions?page%5Bafter%5D=iqse_ABC123 required: - prev - next description: This endpoint returns a collection of Inquiry Session objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Inquiry Sessions tags: - Inquiry Sessions x-persona-product: Inquiries post: description: 'Creates a new Inquiry Session. By default, we only allow up to 25 sessions per Inquiry.' operationId: create-an-inquiry-session externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/create-an-inquiry-session' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: inquiry-id: description: Inquiry ID of the session type: string required: - inquiry-id type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/inquiry-session' schema: properties: data: $ref: '#/components/schemas/inquiry-session' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-sessions-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an Inquiry Session tags: - Inquiry Sessions x-persona-product: Inquiries /inquiry-sessions/expire-all: post: description: Expires all active Inquiry Sessions for a given set of Inquiries. operationId: expire-inquiry-sessions externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/expire-inquiry-sessions' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: meta: properties: inquiry-ids: items: type: string type: array type: object additionalProperties: false required: - inquiry-ids type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: inquiry-session id: iqse_ABC123 attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 relationships: inquiry: data: type: inquiry id: inq_ABC123 device: data: type: device id: dev_ABC123 schema: type: object additionalProperties: false required: - data properties: data: type: array items: $ref: '#/components/schemas/inquiry-session' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-sessions-included-objects' description: This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Expire Inquiry Sessions tags: - Inquiry Sessions x-persona-product: Inquiries '/inquiry-sessions/{inquiry-session-id}': get: description: Retrieves details of a specific Inquiry Session. operationId: retrieve-an-inquiry-session externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/retrieve-an-inquiry-session' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Inquiry Session ID in: path name: inquiry-session-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-session' schema: properties: data: $ref: '#/components/schemas/inquiry-session' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-sessions-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Inquiry Session tags: - Inquiry Sessions x-persona-product: Inquiries '/inquiry-sessions/{inquiry-session-id}/expire': post: description: Expires a specific Inquiry Session. operationId: expire-an-inquiry-session externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/expire-an-inquiry-session' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-session-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/inquiry-session' schema: properties: data: $ref: '#/components/schemas/inquiry-session' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-sessions-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Expire an Inquiry Session tags: - Inquiry Sessions x-persona-product: Inquiries '/inquiry-sessions/{inquiry-session-id}/generate-one-time-link': post: description: Generates a one-time link for a specific Inquiry Session. operationId: generate-a-one-time-link-for-an-inquiry-session externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-sessions/generate-a-one-time-link-for-an-inquiry-session' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: inquiry-session-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: inquiry-session id: iqse_ABC123 attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 relationships: inquiry: data: type: inquiry id: inq_ABC123 device: data: type: device id: dev_ABC123 meta: one-time-link: 'https://withpersona.com/verify?code=CODE' one-time-link-short: 'https://perso.na/CODE' schema: properties: data: $ref: '#/components/schemas/inquiry-session' meta: properties: one-time-link: type: string one-time-link-short: type: string required: - one-time-link - one-time-link-short type: object additionalProperties: false included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-sessions-included-objects' required: - data - meta type: object additionalProperties: false description: This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Generate a one-time link for Inquiry Session tags: - Inquiry Sessions x-persona-product: Inquiries /inquiry-templates: get: description: |- Retrieves a list of your organization's Inquiry Templates. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. Results are returned in reverse chronological order, with the most recently created objects first. operationId: list-all-inquiry-templates externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-templates/list-all-inquiry-templates' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a collection of Inquiry Template objects. content: application/json: examples: Success: $ref: '#/components/examples/inquiry-template-list' schema: type: object additionalProperties: false required: - data - links properties: data: type: array description: An array of Inquiry Templates items: $ref: '#/components/schemas/inquiry-template' links: type: object additionalProperties: false properties: prev: type: - 'null' - string examples: - /api/v1/inquiry-templates?page%5Bafter%5D=itmpl_ABC123 next: type: - 'null' - string examples: - /api/v1/inquiry-templates?page%5Bafter%5D=itmpl_ABC123 required: - prev - next '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Inquiry Templates tags: - Inquiry Templates x-persona-product: Inquiries '/inquiry-templates/{inquiry-template-id}': get: description: |- Retrieves details of a specific Inquiry Template by ID. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. operationId: retrieve-an-inquiry-template externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-templates/retrieve-an-inquiry-template' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Inquiry Template ID in: path name: inquiry-template-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns an Inquiry Template object. content: application/json: examples: Success: $ref: '#/components/examples/inquiry-template' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/inquiry-template' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/inquiry-template-included-objects' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Inquiry Template tags: - Inquiry Templates x-persona-product: Inquiries '/inquiry-templates/{inquiry-template-id}/translations': get: description: |- Retrieves the translations for an Inquiry Template as a JSON:API resource. The export uses the latest draft version if one exists, otherwise falls back to the latest published version. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. operationId: retrieve-inquiry-template-translations externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-templates/retrieve-inquiry-template-translations' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Inquiry Template ID in: path name: inquiry-template-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns an Inquiry Template Translations object. content: application/json: schema: type: object additionalProperties: false required: - data properties: data: type: object additionalProperties: false required: - type - id - attributes properties: type: type: string const: inquiry-template-translations id: type: string description: The token of the Inquiry Template Version the translations were retrieved from. attributes: type: object additionalProperties: false required: - translations properties: translations: type: array items: type: object additionalProperties: false required: - step - step-display-name - component - attribute-name - locale-values properties: step: type: string step-display-name: type: string component: type: string attribute-name: type: string locale-values: type: array items: type: object additionalProperties: false required: - locale - value properties: locale: type: string value: type: - string - 'null' examples: Success: value: data: type: inquiry-template-translations id: itmplv_HAVumeSgCxWxhVb8tTRjaiUB attributes: translations: - step: start step-display-name: Start component: title attribute-name: text locale-values: - locale: en-US value: Getting started - locale: fr value: Commencer - locale: es-MX value: Empezar '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve Inquiry Template Translations tags: - Inquiry Templates x-persona-product: Inquiries post: description: |- Imports translations for an Inquiry Template. Supports partial updates — translation rows not included in the request body are left unchanged. If a draft version already exists, translations are applied to it. If no draft exists, a new draft is created from the latest published version before importing. The draft is never automatically published — publishing is always a manual step in the dashboard. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. operationId: import-inquiry-template-translations externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/inquiry-templates/import-inquiry-template-translations' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Inquiry Template ID in: path name: inquiry-template-id required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: false required: - data properties: data: type: object additionalProperties: false required: - attributes properties: attributes: type: object additionalProperties: false required: - translations properties: translations: type: array items: type: object additionalProperties: false required: - step - component - attribute-name - locale-values properties: step: type: string step-display-name: type: string component: type: string attribute-name: type: string locale-values: type: array items: type: object additionalProperties: false required: - locale - value properties: locale: type: string value: type: - string - 'null' examples: Import translations: value: data: attributes: translations: - step: start step-display-name: Start component: title attribute-name: text locale-values: - locale: en-US value: Getting started - locale: fr value: Commencer - locale: es-MX value: Empezar responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the updated Inquiry Template Version object. content: application/json: schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/inquiry-template-version' examples: Success: value: data: type: inquiry-template-version id: itmplv_HAVumeSgCxWxhVb8tTRjaiUB attributes: name-display: Collect Government ID status: draft enabled-locales: - en-US created-at: '2023-01-05T00:00:00.000Z' updated-at: '2023-01-05T00:00:00.000Z' published-at: null theme: {} relationships: inquiry-template: data: type: inquiry-template id: itmpl_srQQ2Ui2gvNY353u65vD61gr '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Import Inquiry Template Translations tags: - Inquiry Templates x-persona-product: Inquiries /list-item/browser-fingerprints: post: description: Create a new item in a list. operationId: create-a-browser-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-browser-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a Browser Fingerprint List. type: string value: description: Browser fingerprint to add to list. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-browser-fingerprint' schema: properties: data: $ref: '#/components/schemas/list-item-browser-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Browser Fingerprint List Item tags: - List Items x-persona-product: Lists '/list-item/browser-fingerprints/{list-item-id}': get: description: Retrieves the details of an existing browser fingerprint List Item. operationId: retrieve-a-browser-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-browser-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to retrieve. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-browser-fingerprint' schema: properties: data: $ref: '#/components/schemas/list-item-browser-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Browser Fingerprint List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-browser-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-browser-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-browser-fingerprint-archived' schema: properties: data: $ref: '#/components/schemas/list-item-browser-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Browser Fingerprint List Item tags: - List Items x-persona-product: Lists /list-item/countries: post: description: Create a new item in a list. operationId: create-a-country-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-country-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: country-code: description: Country code to add to list. type: string list-id: description: ID of the list to add this item to. List must be a Country List. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-country' schema: properties: data: $ref: '#/components/schemas/list-item-country' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Country List Item tags: - List Items x-persona-product: Lists '/list-item/countries/{list-item-id}': get: description: Retrieves the details of an existing country List Item. operationId: retrieve-a-country-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-country-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-country' schema: properties: data: $ref: '#/components/schemas/list-item-country' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Country List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-country-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-country-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-country-archived' schema: properties: data: $ref: '#/components/schemas/list-item-country' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Country List Item tags: - List Items x-persona-product: Lists /list-item/device-fingerprints: post: description: Create a new item in a list. operationId: create-a-device-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-device-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a Device Fingerprint List. type: string value: description: Device fingerprint to add to list. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-device-fingerprint' schema: properties: data: $ref: '#/components/schemas/list-item-device-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Device Fingerprint List Item tags: - List Items x-persona-product: Lists '/list-item/device-fingerprints/{list-item-id}': get: description: Retrieves the details of an existing device fingerprint List Item. operationId: retrieve-a-device-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-device-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to retrieve. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-device-fingerprint' schema: properties: data: $ref: '#/components/schemas/list-item-device-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Device Fingerprint List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-device-fingerprint-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-device-fingerprint-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-device-fingerprint-archived' schema: properties: data: $ref: '#/components/schemas/list-item-device-fingerprint' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Device Fingerprint List Item tags: - List Items x-persona-product: Lists /list-item/email-addresses: post: description: Create a new item in a list. operationId: create-an-email-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-an-email-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be an Email Address List. type: string match-type: description: Can be either `email_address` or `domain`. type: string value: description: Email address to add. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-email-address' schema: properties: data: $ref: '#/components/schemas/list-item-email-address' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an Email Address List Item tags: - List Items x-persona-product: Lists '/list-item/email-addresses/{list-item-id}': get: description: Retrieves the details of an existing email address List Item. operationId: retrieve-an-email-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-an-email-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-email-address' schema: properties: data: $ref: '#/components/schemas/list-item-email-address' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Email Address List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-an-email-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-an-email-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-email-address-archived' schema: properties: data: $ref: '#/components/schemas/list-item-email-address' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive an Email Address List Item tags: - List Items x-persona-product: Lists /list-item/fields: post: description: Create a new item in a list. operationId: create-a-field-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-field-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a Field List. type: string field-value: description: Field value to add to the list. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-field' schema: properties: data: $ref: '#/components/schemas/list-item-field' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Field List Item tags: - List Items x-persona-product: Lists '/list-item/fields/{list-item-id}': get: description: Retrieves the details of an existing field List Item. operationId: retrieve-a-field-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-field-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-field' schema: properties: data: $ref: '#/components/schemas/list-item-field' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Field List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-field-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-field-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-field-archived' schema: properties: data: $ref: '#/components/schemas/list-item-field' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Field List Item tags: - List Items x-persona-product: Lists /list-item/geolocations: post: description: Create a new item in a list. operationId: create-a-geolocation-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-geolocation-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: latitude: description: Latitude of the geolocation item (-90 to 90). format: float type: number list-id: description: ID of the list to add this item to. List must be a Geolocation List. type: string longitude: description: Longitude of geolocation item (-180 to 180). format: float type: number radius-meters: description: Radius in meters from point to be considered for match distance. format: float type: number type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-geolocation' schema: properties: data: $ref: '#/components/schemas/list-item-geolocation' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Geolocation List Item tags: - List Items x-persona-product: Lists '/list-item/geolocations/{list-item-id}': get: description: Retrieves the details of an existing geolocation List Item. operationId: retrieve-a-geolocation-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-geolocation-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-geolocation' schema: properties: data: $ref: '#/components/schemas/list-item-geolocation' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Geolocation List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-geolocation-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-geolocation-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-geolocation-archived' schema: properties: data: $ref: '#/components/schemas/list-item-geolocation' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Geolocation List Item tags: - List Items x-persona-product: Lists /list-item/government-id-numbers: post: description: Create a new item in a list. operationId: create-a-government-id-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-government-id-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: id-class: description: Common values for id-class include `'pp'` for passport and`'dl'` for driver license. type: string id-number: description: Number of the ID. type: string list-id: description: ID of the list to add this item to. List must be a Government ID Number List. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-government-id-number' schema: properties: data: $ref: '#/components/schemas/list-item-government-id-number' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Government ID Number List Item tags: - List Items x-persona-product: Lists '/list-item/government-id-numbers/{list-item-id}': get: description: Retrieves the details of an existing government ID number List Item. operationId: retrieve-a-government-id-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-government-id-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-government-id-number' schema: properties: data: $ref: '#/components/schemas/list-item-government-id-number' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Government ID Number List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-government-id-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-government-id-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-government-id-number-archived' schema: properties: data: $ref: '#/components/schemas/list-item-government-id-number' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Government ID Number List Item tags: - List Items x-persona-product: Lists /list-item/ip-addresses: post: description: Create a new item in a list. operationId: create-an-ip-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-an-ip-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be an IP Address List. type: string value: description: IP address to add. IPv4 and IPv6 are supported. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-ip-address' schema: properties: data: $ref: '#/components/schemas/list-item-ip-address' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create an IP Address List Item tags: - List Items x-persona-product: Lists '/list-item/ip-addresses/{list-item-id}': get: description: Retrieves the details of an existing IP address List Item. operationId: retrieve-an-ip-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-an-ip-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-ip-address' schema: properties: data: $ref: '#/components/schemas/list-item-ip-address' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an IP Address List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-an-ip-address-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-an-ip-address-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-ip-address-archived' schema: properties: data: $ref: '#/components/schemas/list-item-ip-address' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive an IP Address List Item tags: - List Items x-persona-product: Lists /list-item/names: post: description: Create a new item in a list. operationId: create-a-name-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-name-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a Name List. type: string name-first: description: First name of the name to add to the list. type: string name-last: description: Last name of the name to add to the list. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-name' schema: properties: data: $ref: '#/components/schemas/list-item-name' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Name List Item tags: - List Items x-persona-product: Lists '/list-item/names/{list-item-id}': get: description: Retrieves the details of an existing name List Item. operationId: retrieve-a-name-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-name-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-name' schema: properties: data: $ref: '#/components/schemas/list-item-name' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Name List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-name-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-name-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-name-archived' schema: properties: data: $ref: '#/components/schemas/list-item-name' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Name List Item tags: - List Items x-persona-product: Lists /list-item/phone-numbers: post: description: Create a new item in a list. operationId: create-a-phone-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-phone-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a Name List. type: string value: description: Phone number to add. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-phone-number' schema: properties: data: $ref: '#/components/schemas/list-item-phone-number' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Phone Number List Item tags: - List Items x-persona-product: Lists '/list-item/phone-numbers/{list-item-id}': get: description: Retrieves the details of an existing phone number List Item. operationId: retrieve-a-phone-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-phone-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-phone-number' schema: properties: data: $ref: '#/components/schemas/list-item-phone-number' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Phone Number List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-phone-number-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-phone-number-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-phone-number-archived' schema: properties: data: $ref: '#/components/schemas/list-item-phone-number' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Phone Number List Item tags: - List Items x-persona-product: Lists /list-item/strings: post: description: Create a new item in a list. operationId: create-a-string-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/create-a-string-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: list-id: description: ID of the list to add this item to. List must be a String List. type: string value: description: String value to add to the list. type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/list-item-string' schema: properties: data: $ref: '#/components/schemas/list-item-string' required: - data type: object additionalProperties: false description: This endpoint returns the created List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a String List Item tags: - List Items x-persona-product: Lists '/list-item/strings/{list-item-id}': get: description: Retrieves the details of an existing string List Item. operationId: retrieve-a-string-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/retrieve-a-string-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-string' schema: properties: data: $ref: '#/components/schemas/list-item-string' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a String List Item tags: - List Items x-persona-product: Lists delete: description: Archived items are not matched against new inquiries. operationId: archive-a-string-list-item externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/list-items/archive-a-string-list-item' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of list item to archive. in: path name: list-item-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/list-item-string-archived' schema: properties: data: $ref: '#/components/schemas/list-item-string' required: - data type: object additionalProperties: false description: This endpoint returns a List Item object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a String List Item tags: - List Items x-persona-product: Lists /list/browser-fingerprints: post: summary: Create a Browser Fingerprint List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-browser-fingerprint-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-browser-fingerprint-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-browser-fingerprints' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/browser-fingerprint id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/countries: post: summary: Create a Country List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-country-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-country-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-countries' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/country id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/email-addresses: post: summary: Create an Email Address List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-an-email-address-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-an-email-address-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-email-addresses' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/email-address id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/geolocations: post: summary: Create a Geolocation List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-geolocation-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-geolocation-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-geolocations' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/geolocation id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/government-id-numbers: post: summary: Create a Government ID Number List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-government-id-number-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-government-id-number-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-government-id-numbers' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/government-id-number id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/ip-addresses: post: summary: Create an IP Address List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-an-ip-address-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-an-ip-address-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-ip-addresses' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/ip-address id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/names: post: summary: Create a Name List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-name-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-name-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: allow-fuzzy-name-first: description: Flag to determine if the list should use fuzzy matching for first name type: boolean name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List allow-fuzzy-name-first: true responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-names' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/name id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/phone-numbers: post: summary: Create a Phone Number List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-phone-number-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-phone-number-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-phone-numbers' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/phone-number id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /list/strings: post: summary: Create a Strings List tags: - Lists x-persona-product: Lists description: Create a new list for your organization. operationId: create-a-strings-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/create-a-strings-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Name of the list type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false examples: exampleRequest: summary: Example Request value: data: attributes: name: My New List responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns the created List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/lists-strings' required: - data type: object additionalProperties: false examples: Created: value: data: type: list/string id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My New List status: active archived-at: null created-at: '2023-08-30T20:22:07.000Z' updated-at: '2023-08-30T20:22:07.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' /lists: get: summary: List all Lists tags: - Lists x-persona-product: Lists description: 'Returns a list of your organization''s lists. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-lists externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/list-all-lists' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: status: description: Filter lists by status type: string enum: - active - archived responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: type: object additionalProperties: false required: - data - links properties: data: type: array description: An array of Lists items: $ref: '#/components/schemas/list' links: additionalProperties: false type: object properties: prev: type: - 'null' - string description: 'URL pointing to the previous page of data, or null if on the first page.' next: type: - string - 'null' description: 'URL pointing to the next page of data, or null if on the last page.' required: - prev - next examples: Success: value: data: - type: list/phone-number id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My List status: active archived-at: null created-at: '2023-08-30T21:31:06.000Z' updated-at: '2023-08-30T21:31:06.000Z' relationships: list-items: data: [] links: prev: null next: /api/v1/lists?page%5Bafter%5D=lst_3DS1z7bME8vWqqxmdCDqHwLm description: This endpoint returns a collection List objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' '/lists/{list-id}': delete: summary: Archive a List tags: - Lists x-persona-product: Lists description: 'Archive an existing list. Archived lists are still retrievable, but will no longer match on inquiries.' operationId: archive-a-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/archive-a-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the list to archive in: path name: list-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/list' required: - data type: object additionalProperties: false examples: Success: value: data: type: list/phone-number id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My List status: archived archived-at: '2023-01-01T00:00:00.000Z' created-at: '2023-01-01T00:00:00.000Z' updated-at: '2023-01-01T00:00:00.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' get: summary: Retrieve a List tags: - Lists x-persona-product: Lists description: Retrieves the details of an existing list. operationId: retrieve-a-list externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/lists/retrieve-a-list' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of the list to retrieve in: path name: list-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a List object. content: application/json: schema: properties: data: $ref: '#/components/schemas/list' required: - data type: object additionalProperties: false examples: Success: value: data: type: list/phone-number id: lst_kRcKDJ4c8wF2AmAghggtYxboX attributes: name: My List status: archived archived-at: '2023-01-01T00:00:00.000Z' created-at: '2023-01-01T00:00:00.000Z' updated-at: '2023-01-01T00:00:00.000Z' relationships: list-items: data: [] '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' /oauth/authorize: post: description: 'Authorizes another Organization to access your Inquiry, Verifications, or other Persona resources.' operationId: create-authorization externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/oauth/create-authorization' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' requestBody: content: application/x-www-form-urlencoded: schema: properties: client-id: description: Organization (`org_`) to authorize type: string response-type: description: Must be set to 'code' type: string default: code scope: description: 'Space-separated list of ''permission:object'' combinations (i.e. `inquiry.read:inq_uX7kRTiBxsJ1sZqPLAsjdP9j verification.read:ver_ynYuWdrjwwjiHJ2rgHfSoHeT`' type: string type: object additionalProperties: false required: - client-id - response-type - scope responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: value: code: 8qaA6Q9GQnPjqiWB8BPed9MC6twE expires-in: 599 schema: properties: code: description: Authorization Code that is only usable by the Organization specified by the client-id examples: - 8qaA6Q9GQnPjqiWB8BPed9MC6twE type: string expires-in: description: Number of seconds until the authorization code expires. default: 0 examples: - 599 type: integer required: - code - expires-in type: object additionalProperties: false description: This endpoint returns an Authorization Code. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create Authorization tags: - OAuth x-persona-product: OAuth /oauth/token: post: description: |- Exchange a credential for an access token. Supports two grant types: - `authorization_code`: Exchange an authorization code for an access token (cross-org data sharing). - `client_credentials`: Exchange a signed JWT assertion (`private_key_jwt`) for a short-lived access token (machine-to-machine auth, RFC 7523). operationId: create-access-token externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/oauth/create-access-token' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' requestBody: content: application/x-www-form-urlencoded: schema: oneOf: - title: authorization_code description: Exchange an authorization code for an access token. properties: code: description: Authorization Code type: string grant-type: description: Must be set to 'authorization_code' type: string default: authorization_code type: object additionalProperties: false required: - code - grant-type - title: client_credentials description: 'Exchange a signed JWT assertion for a short-lived access token. The JWT must be signed with the private key corresponding to the public key registered on the OAuth client. Note: parameter names follow OAuth RFC 6749/7523 conventions (snake_case) rather than the Persona API default (kebab-case).' properties: grant_type: description: Must be set to 'client_credentials' type: string client_assertion_type: description: 'Must be ''urn:ietf:params:oauth:client-assertion-type:jwt-bearer''' type: string client_assertion: description: 'A signed JWT (RS256 or ES256) with claims: iss, sub (both set to the client_id), aud (the token endpoint URL), jti, iat, and exp (max 5 minutes from now).' type: string scope: description: Optional space-separated list of permissions to request. Must be a subset of the OAuth client's registered permissions. Defaults to all client permissions if omitted. type: string type: object additionalProperties: false required: - grant_type - client_assertion_type - client_assertion unevaluatedProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: AuthorizationCode: summary: authorization_code grant response value: access-token: persona_access_token_AbCdEfGhIjKlMnOpQrStUvWxYz01234567 token-type: bearer expires-in: 3599 scope: 'inquiry.read:inq_AbCdEfGhIjKlMnOpQrStUvWxYz01234567' Created: summary: client_credentials grant response value: access-token: oat_AbCdEfGhIjKlMnOpQrStUvWxYz01234567 token-type: Bearer expires-in: 900 scope: inquiry.read account.read schema: properties: access-token: description: Access Token that can be used wherever an API Key would be used. type: string expires-in: description: Number of seconds until the access token expires. default: 0 type: integer scope: description: 'Space-separated list of granted permissions. Format varies by grant type: for client_credentials, bare permission names (e.g. inquiry.read account.read); for authorization_code, permission:object pairs (e.g. inquiry.read:inq_xxx). Empty string when no permissions are granted.' type: string token-type: type: string enum: - bearer - Bearer required: - access-token - expires-in - scope - token-type type: object additionalProperties: false description: This endpoint returns an Access Token. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create Access Token tags: - OAuth x-persona-product: OAuth /privacy-passes: post: description: 'Issues a Privacy Pass token by blind-signing a client-provided blinded token (Blind RSA, RFC 9578). The returned blind signature is unblinded client-side to produce a Privacy Pass token that can later be redeemed anonymously (for example, when generating a Relay claim).' operationId: create-a-privacy-pass externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/relay/create-a-privacy-pass' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' requestBody: content: application/json: schema: properties: blinded-token: description: The base64url-encoded blinded token to be signed. Produced client-side by blinding a token input with the issuer public key identified by `key-id`. type: string examples: - 5rT2pX9qLkV0nW3bYc7dZ1aF8gH4jK6mN2pQ5rS8tU key-id: description: The hex-encoded identifier of the issuer signing key to use. Must match the key the `blinded-token` was blinded against. type: string examples: - a3c5f8e2d1b4079c6e5a2f8b1d3c4e5f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c additionalProperties: false type: object required: - blinded-token - key-id examples: Created: value: blinded-token: 5rT2pX9qLkV0nW3bYc7dZ1aF8gH4jK6mN2pQ5rS8tU key-id: a3c5f8e2d1b4079c6e5a2f8b1d3c4e5f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Returns the blind signature for the submitted blinded token. content: application/json: examples: Created: value: blind-sig: kR9mP2xQ7vL0nW3bYc8dZ4aF1gH6jK5mN8pQ2rS7tU schema: properties: blind-sig: description: The base64url-encoded blind signature. Unblind this client-side to produce the Privacy Pass token. examples: - kR9mP2xQ7vL0nW3bYc8dZ4aF1gH6jK5mN8pQ2rS7tU type: string additionalProperties: false type: object required: - blind-sig '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Privacy Pass tags: - Relay x-persona-product: Relay /rate-limits: get: description: Returns a list of your current rate limits. operationId: list-all-rate-limits externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/rate-limits/list-all-rate-limits' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: type: object additionalProperties: false properties: data: items: $ref: '#/components/schemas/rate-limit' type: array description: An array of Rate Limits required: - data examples: Success: value: data: - type: rate-limit/api attributes: limit: 3003 remaining: 250 seconds-to-reset: 60 description: This endpoint returns a collection of Rate Limit objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Rate Limits tags: - Rate Limits x-persona-product: Rate Limits /relays: servers: - url: 'https://api.withpersona.com/api/privacy/v1' post: description: Creates a new Relay. operationId: create-a-relay externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/relay/create-a-relay' security: [] parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/persona-version-header' requestBody: content: application/json: schema: properties: claim-type: description: |- Possible values: - live_human_presence - age_over18_germany - age_over18_united_kingdom - age_over18_verified - age_over18_france - age_over18_italy - age_over18_brazil - age_over18_australia - age_over16_australia - age_over21_verified Do not assume this is a static enumeration; Persona may add new claim types in the future without a versioned update. type: string examples: - live_human_presence encryption-key-pem: description: 'RSA public key (PEM-encoded, 2048-4096 bits). When non-null, claim payloads returned by subsequent reads will be encrypted with RSA OAEP. Pass `null` to receive unencrypted claim payloads.' type: - string - 'null' additionalProperties: false type: object required: - claim-type - encryption-key-pem examples: Created: value: claim-type: live_human_presence encryption-key-pem: null responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Returns the Relay tokens needed to redeem and read the claim. content: application/json: examples: Created: value: relay-token: relay_AbcDeFGhIjKlMnOpQrStUvWxYz1 relay-secret: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d relay-session-access-token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJyZWxzZXNzX0FiYyJ9.signature schema: properties: relay-token: description: 'Public Relay identifier. Use this token in subsequent calls to `/relays/{relay-token}/generate-claim`.' examples: - relay_AbcDeFGhIjKlMnOpQrStUvWxYz1 type: string relay-secret: description: Secret value tied to this Relay. Returned only at creation and must be passed in the `Persona-Relay-Secret` header for any read of the claim payload. examples: - 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d type: string relay-session-access-token: description: Encoded JWT used by Persona's client SDK to load the associated Inquiry Session in the end-user's browser or device. type: string additionalProperties: false type: object required: - relay-token - relay-secret - relay-session-access-token '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Relay tags: - Relay x-persona-product: Relay /relays/challenge: servers: - url: 'https://api.withpersona.com/api/privacy/v1' post: description: 'Requests a Privacy Pass challenge for a claim type. The challenge materials returned here are used to obtain a Privacy Pass token, which is then redeemable to read claims from Relays with the same claim type.' operationId: request-a-relay-challenge externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/relay/request-a-relay-challenge' security: [] parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/persona-version-header' requestBody: content: application/json: schema: properties: claim-type: description: |- Possible values: - live_human_presence - age_over18_germany - age_over18_united_kingdom - age_over18_verified - age_over18_france - age_over18_italy - age_over18_brazil - age_over18_australia - age_over16_australia - age_over21_verified Do not assume this is a static enumeration; Persona may add new claim types in the future without a versioned update. type: string examples: - live_human_presence additionalProperties: false type: object required: - claim-type examples: Success: value: claim-type: live_human_presence responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Returns the Privacy Pass challenge materials for the requested claim type. content: application/json: examples: Success: value: challenge: eyJ0b2tlbl90eXBlIjoyfQ token-key: MIIBIjANBgkqhkiG9w0B token-key-id: a3c5f8e2d1b4079c6e5a2f8b1d3c4e5f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c schema: properties: challenge: description: base64url-encoded PrivateToken challenge object (RFC 9577). Pass this to the Privacy Pass issuance flow to obtain a token. type: string examples: - eyJ0b2tlbl90eXBlIjoyfQ token-key: description: base64url-encoded DER public key used to issue the token. type: string examples: - MIIBIjANBgkqhkiG9w0B token-key-id: description: hex-encoded SHA-256 of `token-key`. type: string examples: - a3c5f8e2d1b4079c6e5a2f8b1d3c4e5f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c additionalProperties: false type: object required: - challenge - token-key - token-key-id '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Request a Relay challenge tags: - Relay x-persona-product: Relay '/relays/{relay-token}/generate-claim': servers: - url: 'https://api.withpersona.com/api/privacy/v1' post: description: Returns a relay's claim. operationId: generate-a-relay-claim externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/relay/generate-a-relay-claim' security: - privacyPassAuth: [] x-fern-examples: - code-samples: - sdk: curl code: | curl -X POST https://api.withpersona.com/api/privacy/v1/relays/:relay-token/generate-claim \ -H "Authorization: PrivateToken token=" \ -H "Persona-Relay-Secret: " parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: relay-token in: path required: true description: The public Relay token returned by `POST /relays`. schema: type: string examples: - relay_AbcDeFGhIjKlMnOpQrStUvWxYz1 - name: Persona-Relay-Secret in: header required: true description: The `relay-secret` value returned at Relay creation. Required for every read of the claim payload; an incorrect secret returns 404. schema: type: string examples: - 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: Returns the claim payload and whether the Privacy Pass token was consumed. content: application/json: examples: Success: value: claim-payload: '{"claim_type":"live_human_presence","claim_result":"passed","methodology":[]}' token-consumed: true schema: properties: claim-payload: description: |- The claim payload. If an `encryption-key-pem` was provided at Relay creation, this is a base64-encoded RSA OAEP ciphertext that must be decrypted client-side. Otherwise, this is a JSON string containing `claim_type`, `claim_result`, and an optional `methodology` array. type: string token-consumed: description: '`true` if the Privacy Pass token was consumed by this request. `false` if the underlying claim did not pass and the token was refunded to the client.' type: boolean additionalProperties: false type: object required: - claim-payload - token-consumed '400': $ref: '#/components/responses/bad-request' '401': description: No valid Privacy Pass token was presented. content: application/json: examples: Unauthorized: value: errors: - title: Privacy Pass token required details: Request a challenge to obtain a token schema: type: object additionalProperties: false required: - errors properties: errors: type: array items: type: object additionalProperties: false required: - title - details properties: title: type: string examples: - Privacy Pass token required details: type: string examples: - Request a challenge to obtain a token '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Generate a Relay claim tags: - Relay x-persona-product: Relay /reports: get: description: 'Returns a list of all your organization''s Reports. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-reports externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/list-all-reports' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: reference-id: description: Filter reports by reference ID type: string account-id: description: Filter reports by account ID type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: schema: type: object additionalProperties: false required: - data - links properties: data: type: array items: $ref: '#/components/schemas/report' links: type: object additionalProperties: false properties: prev: type: - string - 'null' next: type: - string - 'null' required: - prev - next examples: Success: value: data: - type: report/address-lookup id: rep_YcNZJLxuwEuV8jUPbykYQyXG attributes: created-at: '2019-12-19T21:42:49.000Z' completed-at: '2019-12-19T21:42:49.000Z' status: ready - type: report/adverse-media id: rep_2wM8yufwLrbMV6kUtGPBxeGS attributes: created-at: '2019-12-18T22:43:03.000Z' completed-at: '2019-12-18T22:43:03.000Z' - type: report/email-address id: rep_LatvE1PdVhfiwcJWVLj4Z25j attributes: created-at: '2019-12-13T08:34:10.000Z' completed-at: '2019-12-13T08:34:10.000Z' - type: report/phone-number id: rep_RU3JgzXaAzVV2g2NYLd7ub12 attributes: created-at: '2019-12-13T08:32:49.000Z' completed-at: '2019-12-13T08:33:29.000Z' - type: report/watchlist id: rep_6LRELcKmPcx9MxYGk6mdCPJo attributes: created-at: '2019-11-19T00:10:27.000Z' completed-at: '2019-11-19T00:10:27.000Z' links: prev: null next: /api/v1/reports?page%5Bafter%5D=rep_u2Dgz8U3CmxTVgqEH9qzezHi description: This endpoint returns a collection of Report objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Reports tags: - Reports x-persona-product: Reports post: description: Creates a new Report of any type. operationId: create-a-report externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/create-a-report' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: properties: data: unevaluatedProperties: false anyOf: - $ref: '#/components/schemas/report-address-lookup-request' - $ref: '#/components/schemas/report-adverse-media-request' - $ref: '#/components/schemas/report-business-adverse-media-request' - $ref: '#/components/schemas/report-business-lookup-request' - $ref: '#/components/schemas/report-business-watchlist-request' - $ref: '#/components/schemas/report-crypto-address-watchlist-request' - $ref: '#/components/schemas/report-email-address-request' - $ref: '#/components/schemas/report-phone-risk-request' - $ref: '#/components/schemas/report-politically-exposed-person-request' - $ref: '#/components/schemas/report-profile-request' - $ref: '#/components/schemas/report-profile-non-authoritative-request' - $ref: '#/components/schemas/report-social-media-request' - $ref: '#/components/schemas/report-synthetic-request' - $ref: '#/components/schemas/report-watchlist-request' meta: properties: auto-create-account: description: 'If true, automatically create an Account for the user if one does not exist. Default is true.' examples: - true type: boolean auto-create-account-type-id: 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.' examples: - acttp_TOKEN type: string auto-create-account-reference-id: description: 'If `auto-create-account` is true, this Report 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.' examples: - my_reference_id type: string processing-mode: type: string examples: - sync description: The processing mode for the report. request-flags: type: array items: type: string examples: - sync type: object additionalProperties: false type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/report-watchlist' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '408': $ref: '#/components/responses/request-timeout' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Report tags: - Reports x-persona-product: Reports '/reports/{report-id}': delete: description: |- Permanently deletes personally identifiable information (PII) for a Report. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. Note that this will only delete the report -- it does not delete associated accounts, inquiries, verifications, or other Persona resources. operationId: redact-a-report externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/redact-a-report' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/report-watchlist' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Redact a Report tags: - Reports x-persona-product: Reports get: description: Retrieves the details of an existing Report. operationId: retrieve-a-report externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/retrieve-a-report' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/report-watchlist' schema: properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' required: - data type: object additionalProperties: false description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Report tags: - Reports x-persona-product: Reports '/reports/{report-id}/add-tag': post: description: Adds a new tag to the Report operationId: reports-add-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/add-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to add to the Report. tag-id: type: string description: ID of the tag to add to the Report. type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Add tag to a Report tags: - Reports x-persona-product: Reports '/reports/{report-id}/dismiss': post: description: Dismisses active matches for supported report types operationId: dismiss-matches externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/dismiss-matches' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: data: properties: attributes: properties: dismiss-type: description: required in case of Adverse Media and Business Adverse Media. "entity" - refers to one of several individuals or businesses found by the report. "media" - refers to specific article about that "entity" examples: - entity - media type: string entity-id: description: required in case of Adverse Media and Business Adverse Media. refers to id of the "entity" or the "media". type: string reason: description: required type: string type: object additionalProperties: false type: object additionalProperties: false required: - data type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: 'Report Action: Dismiss Matches' tags: - Reports x-persona-product: Reports '/reports/{report-id}/history': get: description: 'Retrieves the history of an existing Report, including runs and actions. See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-report-history externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/list-report-history' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: run id: rpr_5HCmTnQMtLgRyarbyFDFNy8k run-type: scheduled scheduled-date: '2025-10-22' completed-at: '2025-10-22T05:07:10.000+00:00' matches: 30 - type: dismiss id: ract_nXmT51zEhQnwRYPCJmQ73Rq5 created-at: '2025-10-22T05:09:22.065+00:00' creator-name: John Doe - type: review id: ract_zbzaG66ZnxeRxnSrumQGU8kF created-at: '2025-10-22T04:30:03.000+00:00' creator-name: John Doe - type: pause id: ract_xxSK46C5xQ8pCqcg3wKUyX5F created-at: '2025-10-22T04:30:03.000+00:00' creator-name: John Doe - type: resume id: ract_L6JdsScaRjdzfKhESXRELyMg created-at: '2025-10-22T04:30:03.000+00:00' creator-name: John Doe links: next: /api/v1/reports/report-id/history?page%5Bafter%5D=rpr_VydFpmA58EyEYnWLprvtMNau prev: null schema: type: object additionalProperties: false required: - data - links properties: data: $ref: '#/components/schemas/report-history' links: type: - object - 'null' additionalProperties: false description: Pagination links for navigating through the history required: - prev - next properties: prev: type: - string - 'null' description: URL to the previous page of results next: type: - string - 'null' description: URL to the next page of results description: This endpoint returns a history array containing report runs and actions. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List Report history tags: - Reports x-persona-product: Reports '/reports/{report-id}/pause': post: description: Pauses continuous monitoring on a report. Requires additional permissions. operationId: report-action-pause-continuous-monitoring externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/report-action-pause-continuous-monitoring' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: 'Report Action: Pause Continuous Monitoring' tags: - Reports x-persona-product: Reports '/reports/{report-id}/print': get: description: Prints a report in PDF format. operationId: print-report-pdf externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/print-report-pdf' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a PDF of a Report object. content: application/pdf: schema: type: string format: binary '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/too-many-requests' summary: Print Report PDF tags: - Reports x-persona-product: Reports '/reports/{report-id}/remove-tag': post: description: Removes an existing tag from a Report. operationId: reports-remove-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/remove-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to remove from the Report. tag-id: type: string description: ID of the tag to remove from the Report. type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Remove tag from a Report tags: - Reports x-persona-product: Reports '/reports/{report-id}/resume': post: description: Resumes continuous monitoring on paused report. Requires additional permissions. operationId: report-action-resume-continuous-monitoring externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/report-action-resume-continuous-monitoring' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: 'Report Action: Resume Continuous Monitoring' tags: - Reports x-persona-product: Reports '/reports/{report-id}/run': post: description: 'Re-runs a continuously monitored report immediately, outside of its existing recurrence schedule.' operationId: report-action-re-run-report externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/report-action-re-run-report' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: 'Report Action: Re-run Report' tags: - Reports x-persona-product: Reports '/reports/{report-id}/set-tags': post: description: Sets all tags on a Report. Any tags that are not provided in the request will be removed. operationId: reports-set-all-tags externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/reports/set-all-tags' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: report-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: meta: properties: tag-name: items: type: string description: Name of the tag to add to the Report. type: array tag-id: items: type: string description: ID of the tag to add to the Report. type: array type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: report/watchlist id: rep_EPehAHkBaZKUxxxLEDL1gv4h attributes: status: ready created-at: '2022-01-14T23:42:01.000Z' completed-at: '2022-01-14T23:42:01.000Z' redacted-at: null report-template-version-name: v1 term: Alexander Sample matched-lists: [] relationships: inquiry: data: null account: data: null report-template: data: type: report-template/watchlist id: rptp_jfp2TAY28vijxxxCcn4WVqdX schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/report' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/reports-included-objects' description: This endpoint returns a Report object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Set tags on a Report tags: - Reports x-persona-product: Reports /transactions: post: summary: Create a Transaction tags: - Transactions x-persona-product: Transactions description: Creates a new Transaction for a specific transaction type in your organization. operationId: create-a-transaction externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/create-a-transaction' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: attributes: type: object additionalProperties: false properties: transaction-type-id: type: string description: Transaction type ID to create the transaction for. fields: description: JSON key-value pairs of field name to field value. Schema is defined by your transaction type. examples: - external-integration-id: ind_123 type: object additionalProperties: true reference-id: type: string description: 'Reference ID on Account, refers to an entity in your user model.' tags: description: A list of tag names to be associated with the Transaction. items: type: string type: - array - 'null' meta: type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Created: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' get: summary: List all Transactions tags: - Transactions x-persona-product: Transactions description: 'Returns a list of your organization''s transactions. Note that this endpoint aggregates transactions across all transaction type(s). See [Pagination](https://docs.withpersona.com/pagination) for more details about handling the response. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-transactions externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/list-all-transactions' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: reference-id: description: Filter transactions by reference ID. type: string transaction-type-id: description: Filter transactions by Transaction Type ID. type: string identifier: type: object description: Filter transactions by Identifier Key and Value additionalProperties: false properties: key: type: string value: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a collection of Transaction objects. content: application/json: examples: Success: $ref: '#/components/examples/transaction-list' schema: type: object additionalProperties: false required: - data - links properties: data: type: array items: $ref: '#/components/schemas/transaction' links: type: object additionalProperties: false properties: prev: type: - string - 'null' examples: - /api/v1/transactions?page%before%5D=txn_ABC123 next: type: - string - 'null' examples: - /api/v1/transactions?page%5Bafter%5D=txn_ABC123 required: - prev - next '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}': delete: summary: Redact a Transaction tags: - Transactions x-persona-product: Transactions description: Permanently deletes personally identifiable information (PII) for a Transaction. The response indicates a successful redaction of the Transaction. Redaction of the Transaction's associated child objects is done asynchronously and may take some time before all associated child objects are fully redacted. **This action cannot be undone**. operationId: redact-a-transaction externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/redact-a-transaction' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: value: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: null fields: front-photo: type: file value: null back-photo: type: file value: null country-code: type: string value: null selected-id-class: type: string value: null center-photo: type: file value: null selfie-compare-photo: type: file value: null tags: [] created-at: '2021-09-29T18:00:00Z' updated-at: '2021-09-29T18:00:00Z' relationships: transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' get: summary: Retrieve a Transaction tags: - Transactions x-persona-product: Transactions description: Retrieves the details of an existing Transaction. operationId: retrieve-a-transaction externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/retrieve-a-transaction' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to retrieve. schema: type: string required: true responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction-retrieve' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' included: items: properties: type: x-polymorphic: true examples: - account type: string id: examples: - act_ABC123 type: string additionalProperties: true type: object required: - type - id type: array '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' patch: summary: Update a Transaction tags: - Transactions x-persona-product: Transactions description: Updates a Transaction that has been previously created. operationId: update-a-transaction externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/update-a-transaction' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to update. schema: type: string required: true requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: attributes: type: object additionalProperties: false properties: fields: description: JSON key-value pairs of field name to field value. Schema is defined by your transaction type. examples: - external-integration-id: ind_123 type: object additionalProperties: true status: type: string reference-id: type: string description: 'Reference ID on Account, refers to an entity in your user model.' label: type: string tags: description: A list of tag names to be associated with the Transaction. items: type: string type: array responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction-with-label' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' included: type: array items: $ref: '#/components/schemas/transaction-label' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/add-relation': post: summary: Add relation to Transaction tags: - Transactions x-persona-product: Transactions description: Adds a relation between this Transaction and a target Account or Transaction using a relation schema key. No effect if the relation already exists. operationId: transactions-add-relation externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/add-relation' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to add the relation to. schema: type: string required: true requestBody: content: application/json: schema: properties: meta: properties: relation-schema-key: type: string description: Key of the relation schema to add. target-object-id: type: string description: ID of the target Account or Transaction to relate to. type: object additionalProperties: false required: - relation-schema-key - target-object-id type: object additionalProperties: false required: - meta examples: Example: value: meta: relation-schema-key: parent-of target-object-id: act_ABC123 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/add-tag': post: summary: Add tag to Transaction tags: - Transactions x-persona-product: Transactions description: Adds a tag to a Transaction. Create a new tag if the tag does not already exist. No effect if the transaction already has the tag. operationId: transactions-add-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/add-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to add tag on. schema: type: string required: true requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to add to the Transaction. tag-id: type: string description: ID of the tag to add to the Transaction. type: object additionalProperties: false type: object additionalProperties: false examples: Example: value: meta: tag-name: new tag responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/label': post: summary: Create a Transaction label tags: - Transactions x-persona-product: Transactions description: Create a new label for an existing Transaction. operationId: create-a-transaction-label externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/create-a-transaction-label' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to create a label for. schema: type: string required: true requestBody: content: application/json: schema: type: object additionalProperties: false properties: meta: type: object additionalProperties: false properties: label: type: string score: type: number format: float model-version: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction-with-label' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' included: type: array items: $ref: '#/components/schemas/transaction-label' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/remove-relation': post: summary: Remove relation from Transaction tags: - Transactions x-persona-product: Transactions description: Removes a relation between this Transaction and a target Account or Transaction. No effect if the relation does not exist. operationId: transactions-remove-relation externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/remove-relation' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to remove the relation from. schema: type: string required: true requestBody: content: application/json: schema: properties: meta: properties: relation-schema-key: type: string description: Key of the relation schema to remove. target-object-id: type: string description: ID of the target Account or Transaction to unrelate. type: object additionalProperties: false required: - relation-schema-key - target-object-id type: object additionalProperties: false required: - meta examples: Example: value: meta: relation-schema-key: parent-of target-object-id: act_ABC123 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/remove-tag': post: summary: Remove tag from a Transaction tags: - Transactions x-persona-product: Transactions description: Remove a tag from a transaction. No effect if the transaction does not have the tag. operationId: transactions-remove-tag externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/remove-tag' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to remove tag from. schema: type: string required: true requestBody: content: application/json: schema: properties: meta: properties: tag-name: type: string description: Name of the tag to add to the Transaction. tag-id: type: string description: ID of the tag to add to the Transaction. type: object additionalProperties: false type: object additionalProperties: false examples: Example: value: meta: tag-name: new tag responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/set-tags': post: summary: Sets tags on a Transaction tags: - Transactions x-persona-product: Transactions description: Set the list of tags on a transaction. Remove all tags on the transaction that don't appear on the list. Add all tags on the transaction from the list. operationId: transactions-set-tags externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/set-tags' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path description: ID of the transaction to set tags on. schema: type: string required: true requestBody: content: application/json: schema: properties: meta: properties: tag-name: items: type: string type: array description: Name of the tag to add to the Transaction. tag-id: items: type: string type: array description: ID of the tag to add to the Transaction. type: object additionalProperties: false type: object additionalProperties: false examples: Example: value: meta: tag-name: - new tag 1 - new tag 2 responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: $ref: '#/components/examples/transaction' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transactions/{transaction-id}/redact-biometrics': post: x-private: true summary: Redact Transaction biometrics tags: - Transactions x-persona-product: Transactions description: Permanently deletes biometric data for a Transaction AND all its associated objects. **This action cannot be undone**. operationId: redact-transaction-biometrics externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/transactions/redact-transaction-biometrics' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction object and (optionally) its related objects in `included`. content: application/json: examples: Success: value: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: null fields: front-photo: type: file value: null back-photo: type: file value: null country-code: type: string value: null selected-id-class: type: string value: null center-photo: type: file value: null selfie-compare-photo: type: file value: null tags: [] created-at: '2021-09-29T18:00:00Z' updated-at: '2021-09-29T18:00:00Z' relationships: transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' '/transaction-types/{transaction-type-id}': get: summary: Retrieve a Transaction Type tags: - Transaction Types x-persona-product: Transactions description: Retrieves the details of an existing Transaction Type. operationId: retrieve-a-transaction-type parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: transaction-type-id in: path description: ID of the Transaction Type to retrieve. schema: type: string required: true responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Transaction Type object. content: application/json: examples: Success: $ref: '#/components/examples/transaction-type' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/transaction-type' included: $ref: '#/components/schemas/empty-included-objects' '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' /user-audit-logs: get: description: |- Returns a list of your organization’s user audit logs for up to the most recent 6 months. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like user audit logs in Sandbox via API. Results are returned in reverse chronological order, with the most recently created objects first. operationId: list-all-user-audit-logs externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/user-audit-logs/list-all-user-audit-logs' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: user-audit-log id: ual_ABC123ABC attributes: path: /api/v1/inquiries method: GET get-params: {} post-params: {} ip-address: 127.0.0.1 user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 response-status: 200 created-at: '2023-10-03T21:31:05.163Z' impersonator-email-address: null relationships: user: data: type: user id: user_ABC123 user-session: data: type: user-session id: uses_ABC123 - type: user-audit-log id: ual_ABC123XYZ attributes: path: /api/internal/dashboard/v1/user-sessions/uses_ABC123/expire method: GET get-params: {} post-params: data: id: uses_ABC123 type: user-session ip-address: 127.0.0.1 user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 response-status: 200 created-at: '2023-10-03T21:31:05.163Z' impersonator-email-address: null relationships: user: data: type: user id: user_ABC123 user-session: data: type: user-session id: uses_ABC123 links: next: null prev: null included: - type: user id: user_ABC123 attributes: email-address: jane@doe.com name-first: Jane name-last: Doe schema: type: object additionalProperties: false required: - data - links properties: data: type: array items: $ref: '#/components/schemas/user-audit-log' links: type: object additionalProperties: false required: - prev - next properties: prev: type: - string - 'null' examples: - /api/v1/user-audit-logs?page%5Bbefore%5D=ual_ABC123 next: type: - string - 'null' examples: - /api/v1/user-audit-logs?page%5Bafter%5D=ual_ABC123 included: type: array description: Objects that will be returned by default unless otherwise specified using the `include` query parameter in the request. items: $ref: '#/components/schemas/user' description: This endpoint returns a collection of User Audit Logs objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: List all User Audit Logs tags: - User Audit Logs x-persona-product: User Audit Logs '/user-audit-logs/{user-audit-log-id}': get: description: |- Retrieves the details of an existing user audit logs for up to the most recent 6 months. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like user audit logs in Sandbox via API. operationId: retrieve-a-user-audit-log externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/user-audit-logs/retrieve-an-user-audit-log' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: user-audit-log-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: user-audit-log id: ual_ABC123 attributes: path: /api/v1/inquiries method: GET get-params: {} post-params: {} ip-address: 127.0.0.1 created-at: '2023-10-03T21:31:05.163Z' impersonator-email-address: null relationships: user: data: type: user id: user_ABC123 schema: properties: data: $ref: '#/components/schemas/user-audit-log' included: type: array description: Objects that _may_ be returned if specified via the `include` query parameter in the request. items: $ref: '#/components/schemas/user' type: object additionalProperties: false required: - data description: This endpoint returns a User Audit Log object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a User Audit Log tags: - User Audit Logs x-persona-product: User Audit Logs '/verification/aamvas/{verification-id}': get: description: Retrieve an AAMVA verification operationId: retrieve-an-aamva-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/aamva-verifications/retrieve-an-aamva-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-aamva' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-aamva' description: This endpoint returns an AAMVA Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an AAMVA Verification tags: - AAMVA Verifications x-persona-product: Verifications '/verification/database-ecbsvs/{verification-id}': get: description: Retrieve an eCBSV database verification operationId: retrieve-an-ecbsv-database-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/ecbsv-database-verifications/retrieve-an-ecbsv-database-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database-ecbsv' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database-ecbsv' description: This endpoint returns a Database eCBSV Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an eCBSV Database Verification tags: - eCBSV Database Verifications x-persona-product: Verifications '/verification/database-phone-carriers/{verification-id}': get: description: Retrieve a phone carrier database verification operationId: retrieve-a-phone-carrier-database-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications//phone-carrier-database-verifications/retrieve-a-phone-carrier-database-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database-phone-carrier' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database-phone-carrier' description: This endpoint returns a Phone Carrier Database Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Phone Carrier Database Verification tags: - Phone Carrier Database Verifications x-persona-product: Verifications '/verification/database-serpros/{verification-id}': get: description: Retrieve a Serpro database verification operationId: retrieve-a-serpro-database-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/serpro-database-verifications/retrieve-a-serpro-database-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database-serpro' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database-serpro' description: This endpoint returns a Serpro Database Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Serpro Database Verification tags: - Serpro Database Verifications x-persona-product: Verifications '/verification/database-standards/{verification-id}': get: description: Retrieve a database standard verification operationId: retrieve-a-database-standard-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/-database-standard-verifications/retrieve-a-database-standard-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database-standard' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database-standard' description: This endpoint returns a Database Standard Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Database Standard Verification tags: - Database Standard Verifications x-persona-product: Verifications '/verification/database-tins/{verification-id}': get: description: Retrieve a TIN database verification operationId: retrieve-a-tin-database-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/tin-database-verifications/retrieve-a-tin-database-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database-tin' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database-tin' description: This endpoint returns a TIN Database Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a TIN Database Verification tags: - TIN Database Verifications x-persona-product: Verifications '/verification/databases/{verification-id}': get: description: Retrieve a database verification operationId: retrieve-a-database-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/database-verifications/retrieve-a-database-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-database' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-database' description: This endpoint returns a Database Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Database Verification tags: - Database Verifications x-persona-product: Verifications '/verification/documents/{verification-id}': get: description: Retrieves the details of a specific document verification operationId: retrieve-a-document-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/document-verifications/retrieve-a-document-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-document' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-document' description: This endpoint returns a Document Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Document Verification tags: - Document Verifications x-persona-product: Verifications '/verification/email-addresses/{verification-id}': get: description: Retrieve a email address verification operationId: retrieve-a-email-address-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/email-address-verifications/retrieve-a-email-address-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-email-address' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-email-address' description: This endpoint returns an Email Address Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve an Email Address Verification tags: - Email Address Verifications x-persona-product: Verifications '/verification/government-ids/{verification-id}': get: description: Retrieve a government ID verification operationId: retrieve-a-government-id-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/government-id-verifications/retrieve-a-government-id-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-government-id-passed' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-government-id' description: This endpoint returns a Government ID Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Government ID Verification tags: - Government ID Verifications x-persona-product: Verifications '/verification/government-id-nfcs/{verification-id}': get: description: Retrieve a Government ID NFC verification operationId: retrieve-a-government-id-nfc-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/government-id-nfc-verifications/retrieve-a-government-id-nfc-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: verification/government-id-nfc id: ver_Ra6LFdoQmPFJH27gonC3cChh attributes: status: passed created-at: '2022-07-28T16:55:44.000Z' created-at-ts: 1659027344 submitted-at: '2022-07-28T20:47:06.000Z' submitted-at-ts: 1659041226 completed-at: '2022-07-28T20:47:12.000Z' completed-at-ts: 1659041232 birthdate: '1994-12-30' country-code: UT expiration-date: '2022-12-30' identification-number: L898902C3 id-class: pp name-first: ANNA MARIA name-last: SAMPLE sex: F selfie-photo: url: 'https://files.withpersona.com/...' byte-size: 1000 checks: - name: id_nfc_expired_detection status: failed reasons: - expired metadata: {} relationships: inquiry: data: null document: data: type: document/government-id-nfc id: doc_QZ8M2J1fH2o76Rq57vuVWMsE schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-government-id-nfc' description: This endpoint returns a Government ID NFC Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Government ID NFC Verification tags: - Government ID NFC Verifications x-persona-product: Verifications '/verification/phone-numbers/{verification-id}': get: description: Retrieve a phone number verification operationId: retrieve-a-phone-number-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/phone-number-verifications/retrieve-a-phone-number-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: ID of Verification to retrieve in: path name: verification-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-phone-number' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-phone-number' description: This endpoint returns a Phone Number Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Phone Number Verification tags: - Phone Number Verifications x-persona-product: Verifications '/verification/selfies/{verification-id}': get: description: Retrieve a selfie ID verification operationId: retrieve-a-selfie-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/selfie-verifications/retrieve-a-selfie-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: verification/selfie id: ver_dCvHHPUHxvb5j2iYKfjwafBU attributes: status: passed created-at: '2022-07-28T21:54:23.000Z' created-at-ts: 1659045263 submitted-at: '2022-07-28T21:54:29.000Z' submitted-at-ts: 1659045269 completed-at: '2022-07-28T21:54:33.000Z' completed-at-ts: 1659045273 country-code: null selfie-similarity-score-left: 100 selfie-similarity-score-right: 100 checks: - name: selfie_id_comparison status: not_applicable reasons: - no_government_id metadata: {} - name: selfie_pose_detection status: passed reasons: [] metadata: {} - name: selfie_multiple_faces_detection status: passed reasons: [] metadata: {} - name: selfie_pose_repeat_detection status: passed reasons: [] metadata: {} - name: selfie_account_comparison status: not_applicable reasons: - no_account_selfie_present metadata: {} - name: selfie_suspicious_entity_detection status: passed reasons: [] metadata: {} - name: selfie_liveness_detection status: passed reasons: [] metadata: {} - name: selfie_glasses_detection status: passed reasons: [] metadata: {} - name: selfie_glare_detection status: failed reasons: - too_much_glare metadata: {} - name: selfie_public_figure_detection status: passed reasons: [] metadata: {} - name: selfie_age_comparison status: not_applicable reasons: - no_reference_birthdate metadata: {} - name: selfie_face_covering_detection status: passed reasons: [] metadata: {} capture-method: photo document-similarity-score: null left-photo-url: 'https://files.withpersona.com/...' center-photo-url: 'https://files.withpersona.com/...' right-photo-url: 'https://files.withpersona.com/...' photo-urls: - page: left_photo url: 'https://files.withpersona.com/...' byte-size: 316802 video-url: 'https://files.withpersona.com/...' center-photo-face-coordinates: top-left: - 0.2 - 0.5 top-right: - 0.5 - 0.5 bottom-left: - 0.2 - 0.7 bottom-right: - 0.5 - 0.7 relationships: inquiry: data: null schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification-selfie' description: This endpoint returns a Selfie Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Selfie Verification tags: - Selfie Verifications x-persona-product: Verifications '/verifications/{verification-id}': get: description: Retrieves the details of an existing Verification. operationId: retrieve-a-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/retrieve-a-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-retrieve' BusinessWebsite: $ref: '#/components/examples/verification-business-website' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/verification-included-objects' description: This endpoint returns a Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Verification tags: - Verifications x-persona-product: Verifications delete: description: Permanently deletes personally identifiable information (PII) for a Verification. **This action cannot be undone**. This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy. operationId: redact-a-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/redact-a-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: verification/government-id id: ver_7f6w4qu7KK7gjjtgp7nAixHd attributes: status: passed created-at: '2019-11-15T21:24:24.000Z' completed-at: null country-code: null tags: [] entity-confidence-score: null entity-confidence-reasons: [] front-photo-url: null back-photo-url: null selfie-photo-url: null id-class: null capture-method: null name-first: null name-middle: null name-last: null birthdate: null address-street-1: null address-street-2: null address-city: null address-subdivision: null address-postal-code: null issuing-authority: null issue-date: null expiration-date: null sex: null height: null endorsements: null restrictions: null vehicle-class: null identification-number: null checks: [] relationships: inquiry: data: null schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification' description: This endpoint returns a Verification object and (optionally) its related objects in `included`. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Redact a Verification tags: - Verifications x-persona-product: Verifications '/verifications/{verification-id}/print': get: description: Prints a verification in PDF format. operationId: print-a-verification-as-pdf externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/print-a-verification-as-pdf' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a PDF of a Verification object. content: application/pdf: schema: type: string format: binary '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Print Verification PDF tags: - Verifications x-persona-product: Verifications '/verifications/{verification-id}/investigation-lock': post: description: 'Locks a Verification from redaction while it is under investigation. While locked, redaction requests for the Verification will be rejected.' operationId: investigation-lock-a-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/investigation-lock-a-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-retrieve' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/verification-included-objects' description: This endpoint returns a Verification object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Investigation Lock a Verification tags: - Verifications x-persona-product: Verifications '/verifications/{verification-id}/investigation-unlock': post: description: Unlocks a Verification that was previously locked from redaction during an investigation. operationId: investigation-unlock-a-verification externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/verifications/investigation-unlock-a-verification' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: verification-id in: path required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/verification-retrieve' schema: type: object additionalProperties: false required: - data properties: data: $ref: '#/components/schemas/verification' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/verification-included-objects' description: This endpoint returns a Verification object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Investigation Unlock a Verification tags: - Verifications x-persona-product: Verifications /webhooks: get: description: 'Returns a list of your environment''s webhooks. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-webhooks externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/list-all-webhooks' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: webhook id: wbh_ABC123 attributes: status: disabled url: 'https://withpersona.com' api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 created-at: '2023-08-17T23:18:13.000Z' - type: webhook id: wbh_ABC123 attributes: status: disabled url: 'https://withpersona.com' api-version: '2023-01-05' api-key-inflection: camel api-attributes-blocklist: - /data/attributes/fields/*-number file-access-token-expires-in: 600 enabled-events: - '*' payload-filter: {} created-at: '2023-09-18T23:18:13.000Z' links: prev: null next: null schema: properties: data: items: $ref: '#/components/schemas/webhook' type: array description: An array of Webhooks links: properties: next: type: - string - 'null' prev: type: - string - 'null' type: object additionalProperties: false required: - next - prev type: object additionalProperties: false required: - data - links description: This endpoint returns a collection of Webhook objects. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Webhooks tags: - Webhooks x-persona-product: Webhooks post: description: Creates a new webhook with response defaults. operationId: create-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/create-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' requestBody: content: application/json: examples: Created: $ref: '#/components/examples/create-webhook' schema: properties: data: properties: attributes: $ref: '#/components/schemas/webhook-request-attributes' required: - name - url - enabled-events required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false responses: '201': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Created: $ref: '#/components/examples/webhook-created' schema: properties: data: $ref: '#/components/schemas/webhook-with-secret' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Webhook tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}': get: description: 'Retrieves the details of an existing webhook, including its secret.' operationId: retrieve-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/retrieve-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-created' schema: properties: data: $ref: '#/components/schemas/webhook-with-secret' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Webhook tags: - Webhooks x-persona-product: Webhooks patch: description: Updates an existing Webhook. operationId: update-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/update-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string requestBody: content: application/json: examples: Success: $ref: '#/components/examples/create-webhook' schema: properties: data: properties: attributes: $ref: '#/components/schemas/webhook-request-attributes' type: object additionalProperties: false type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-disabled' schema: properties: data: $ref: '#/components/schemas/webhook' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Update a Webhook tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}/archive': post: description: Archives a webhook. operationId: archive-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/archive-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-archived' schema: properties: data: $ref: '#/components/schemas/webhook' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Archive a Webhook tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}/enable': post: description: Enables a webhook. operationId: enable-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/enable-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-enabled' schema: properties: data: $ref: '#/components/schemas/webhook' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Enable a Webhook tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}/disable': post: description: Disables a webhook. operationId: disable-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/disable-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-disabled' schema: properties: data: $ref: '#/components/schemas/webhook' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Disable a Webhook tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}/rotate-secret': post: description: Rotates a webhook's secret. operationId: rotate-a-webhook-secret externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/rotate-a-webhook-secret' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Webhook's ID (starts with "wbh_") in: path name: webhook-id required: true schema: type: string requestBody: content: application/json: examples: Success: $ref: '#/components/examples/rotate-webhook-secret' schema: type: object additionalProperties: false properties: meta: type: object additionalProperties: false properties: expires-in-seconds: description: Seconds until currently active webhook expires example: 7200 type: integer responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: $ref: '#/components/examples/webhook-created' schema: properties: data: $ref: '#/components/schemas/webhook-with-secret' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Webhook object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Rotate a Webhook's secret tags: - Webhooks x-persona-product: Webhooks '/webhooks/{webhook-id}/clone': post: description: Creates a copy of an existing webhook. All attributes except the secret are copied over to the new webhook. operationId: clone-a-webhook externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/webhooks/clone-a-webhook' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: The ID of the Webhook to clone (starts with "wbh_") in: path name: webhook-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' description: This endpoint returns a Webhook object.. content: application/json: examples: Success: $ref: '#/components/examples/webhook-cloned' schema: properties: data: $ref: '#/components/schemas/webhook-with-secret' included: $ref: '#/components/schemas/empty-included-objects' type: object additionalProperties: false required: - data '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Clone a Webhook tags: - Webhooks x-persona-product: Webhooks '/workflows/{workflow-id}/trigger': post: description: |- Creates a new Workflow Run. Note: The payload is arbitrary and defined by the Workflow version trigger schema. operationId: create-a-workflow-run externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/workflow-runs/create-a-workflow-run' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - name: workflow-id in: path required: true schema: type: string requestBody: content: application/json: schema: properties: data: properties: attributes: properties: fields: description: JSON key-value pairs of field name to field value. Schema is defined by the trigger payload schema on your Workflow Version. examples: - preferred-name: Albert example-field: 123 additionalProperties: true type: object required: - fields additionalProperties: false type: object required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: workflow-run id: wfr_3JqAR9ddLRVZLK5z4yD8oeHB attributes: status: in_progress created-at: '2022-08-08T18:55:44.910Z' completed-at: null relationships: workflow-version: data: type: workflow-version id: wfv_DkWeGvK9wojQnubF8ABHzJRQ workflow: data: type: workflow id: wfl_3VghhbvDc7UuUNT8uZrqZjsk creator: data: null schema: properties: data: $ref: '#/components/schemas/workflow-run' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/workflow-run-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Workflow object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/unprocessable-entity' '429': $ref: '#/components/responses/too-many-requests' summary: Create a Workflow Run tags: - Workflows x-persona-product: Workflows '/workflow-runs/{workflow-run-id}': get: description: Retrieves the details of an existing workflow run. operationId: retrieve-a-workflow-run externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/workflow-runs/retrieve-a-workflow-run' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/include-query-parameter' - $ref: '#/components/parameters/fields-query-parameter' - description: Workflow Run's ID (starts with "wfr_") in: path name: workflow-run-id required: true schema: type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: type: workflow-run id: wfr_3JqAR9ddLRVZLK5z4yD8oeHB attributes: status: in_progress created-at: '2022-08-08T18:55:44.910Z' completed-at: null relationships: workflow-version: data: type: workflow-version id: wfv_DkWeGvK9wojQnubF8ABHzJRQ workflow: data: type: workflow id: wfl_3VghhbvDc7UuUNT8uZrqZjsk creator: data: null schema: properties: data: $ref: '#/components/schemas/workflow-run' included: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. $ref: '#/components/schemas/workflow-run-included-objects' type: object additionalProperties: false required: - data description: This endpoint returns a Workflow Run object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not-found' '429': $ref: '#/components/responses/too-many-requests' summary: Retrieve a Workflow Run tags: - Workflows x-persona-product: Workflows /workflow-runs: get: description: 'Returns a list of your environment''s workflow runs. Results are returned in reverse chronological order, with the most recently created objects first.' operationId: list-all-workflow-runs externalDocs: description: Full documentation for this API on the Persona website. url: 'https://docs.withpersona.com/api-reference/workflow-runs/list-all-workflow-runs' parameters: - $ref: '#/components/parameters/key-inflection-header' - $ref: '#/components/parameters/idempotency-key-header' - $ref: '#/components/parameters/persona-version-header' - $ref: '#/components/parameters/pagination-query-params' - $ref: '#/components/parameters/fields-query-parameter' - in: query name: filter style: deepObject explode: true schema: type: object additionalProperties: false properties: status: description: Filter workflow runs by workflow id type: string responses: '200': headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Success: value: data: - type: workflow-run id: wfr_3JqAR9ddLRVZLK5z4yD8oeHB attributes: status: in_progress created-at: '2022-08-08T18:55:44.910Z' completed-at: null relationships: workflow-version: data: type: workflow-version id: wfv_DkWeGvK9wojQnubF8ABHzJRQ workflow: data: type: workflow id: wfl_3VghhbvDc7UuUNT8uZrqZjsk creator: data: null - type: workflow-run id: wfr_3JqAR9ddLRVZLK5z4yD8oeHB attributes: status: in_progress created-at: '2022-08-08T18:55:44.910Z' completed-at: null relationships: workflow-version: data: type: workflow-version id: wfv_DkWeGvK9wojQnubF8ABHzJRQ workflow: data: type: workflow id: wfl_3VghhbvDc7UuUNT8uZrqZjsk creator: data: null links: prev: null next: null schema: properties: data: items: $ref: '#/components/schemas/workflow-run' type: array description: An array of Workflow Runs links: properties: next: type: - string - 'null' prev: type: - string - 'null' type: object additionalProperties: false required: - next - prev type: object additionalProperties: false required: - data - links description: This endpoint returns a Workflow Run object. '400': $ref: '#/components/responses/bad-request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too-many-requests' summary: List all Workflow Runs tags: - Workflows x-persona-product: Workflows webhooks: account.created: post: operationId: webhook-account-created summary: Account created description: 'Webhook for the `account.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-created-webhook-body' responses: '200': $ref: '#/components/responses/success' account.redacted: post: operationId: webhook-account-redacted summary: Account redacted description: 'Webhook for the `account.redacted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.redacted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-redacted-webhook-body' responses: '200': $ref: '#/components/responses/success' account.archived: post: operationId: webhook-account-archived summary: Account archived description: 'Webhook for the `account.archived` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.archived payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-archived-webhook-body' responses: '200': $ref: '#/components/responses/success' account.restored: post: operationId: webhook-account-restored summary: Account restored description: 'Webhook for the `account.restored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.restored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-restored-webhook-body' responses: '200': $ref: '#/components/responses/success' account.consolidated: post: operationId: webhook-account-consolidated summary: Account consolidated description: 'Webhook for the `account.consolidated` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.consolidated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-consolidated-webhook-body' responses: '200': $ref: '#/components/responses/success' account.consolidated-with: post: operationId: webhook-account-consolidated-with summary: Account consolidated with description: 'Webhook for the `account.consolidated-with` event. This event fires on the primary Account that receives data when another Account is consolidated into it. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.consolidated-with payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-consolidated-with-webhook-body' responses: '200': $ref: '#/components/responses/success' account.tag-added: post: operationId: webhook-account-tag-added summary: Account tag added description: 'Webhook for the `account.tag-added` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.tag-added payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-tag-added-webhook-body' responses: '200': $ref: '#/components/responses/success' account.tag-removed: post: operationId: webhook-account-tag-removed summary: Account tag removed description: 'Webhook for the `account.tag-removed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.tag-removed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-tag-removed-webhook-body' responses: '200': $ref: '#/components/responses/success' account.added-relation: post: operationId: webhook-account-added-relation summary: Account added relation description: 'Webhook for the `account.added-relation` event. Fires when a relationship is added between this Account and another object (an Account or a Transaction). The related object is identified by the `context`. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.added-relation payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' context: type: object additionalProperties: false description: Identifies the relationship that was added and the related object. properties: relation-schema-key: type: string description: The key of the relationship schema connecting this Account to the related object. examples: - business target-account-id: type: - string - 'null' description: 'Token of the related Account when the related object is an Account, otherwise `null`. Starts with `act_`.' examples: - act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: type: - string - 'null' description: 'Token of the related Transaction when the related object is a Transaction, otherwise `null`. Starts with `txn_`.' examples: - null - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-added-relation-webhook-body' responses: '200': $ref: '#/components/responses/success' account.removed-relation: post: operationId: webhook-account-removed-relation summary: Account removed relation description: 'Webhook for the `account.removed-relation` event. Fires when a relationship is removed between this Account and another object (an Account or a Transaction). The related object is identified by the `context`. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.removed-relation payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' context: type: object additionalProperties: false description: Identifies the relationship that was removed and the related object. properties: relation-schema-key: type: string description: The key of the relationship schema that connected this Account to the related object. examples: - business target-account-id: type: - string - 'null' description: 'Token of the related Account when the related object is an Account, otherwise `null`. Starts with `act_`.' examples: - act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: type: - string - 'null' description: 'Token of the related Transaction when the related object is a Transaction, otherwise `null`. Starts with `txn_`.' examples: - null - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-removed-relation-webhook-body' responses: '200': $ref: '#/components/responses/success' account.status-updated: post: operationId: webhook-account-status-updated summary: Account status updated description: 'Webhook for the `account.status-updated` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.status-updated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-status-updated-webhook-body' responses: '200': $ref: '#/components/responses/success' account.updated-fields: post: operationId: webhook-account-updated-fields summary: Account updated fields description: 'Webhook for the `account.updated-fields` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.updated-fields payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-updated-fields-webhook-body' responses: '200': $ref: '#/components/responses/success' account.updated-tags: post: operationId: webhook-account-updated-tags summary: Account updated tags description: 'Webhook for the `account.updated-tags` event. The `context` identifies the tags added and removed by the update. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Account events x-persona-product: Accounts parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: account.updated-tags context: type: object additionalProperties: false description: Identifies the tag names added to and removed from the Account. properties: added-tags: type: array description: Names of tags added by this update. Empty if none were added. items: type: string examples: - - manual-review removed-tags: type: array description: Names of tags removed by this update. Empty if none were removed. items: type: string examples: - - new-customer payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/account' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/accounts-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/account-updated-tags-webhook-body' responses: '200': $ref: '#/components/responses/success' case.assigned: post: operationId: webhook-case-assigned summary: Case assigned description: 'Webhook for the `case.assigned` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.assigned payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-assigned-webhook-body' responses: '200': $ref: '#/components/responses/success' case.created: post: operationId: webhook-case-created summary: Case created description: 'Webhook for the `case.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-created-webhook-body' responses: '200': $ref: '#/components/responses/success' case.exported: post: operationId: webhook-case-exported summary: Case exported description: 'Webhook for the `case.exported` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.exported payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-exported-webhook-body' responses: '200': $ref: '#/components/responses/success' case.queue-updated: post: operationId: webhook-case-queue-updated summary: Case queue updated description: 'Webhook for the `case.queue-updated` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.queue-updated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-queue-updated-webhook-body' responses: '200': $ref: '#/components/responses/success' case.redacted: post: operationId: webhook-case-redacted summary: Case redacted description: 'Webhook for the `case.redacted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.redacted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-redacted-webhook-body' responses: '200': $ref: '#/components/responses/success' case.reopened: post: operationId: webhook-case-reopened summary: Case reopened description: 'Webhook for the `case.reopened` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.reopened payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-reopened-webhook-body' responses: '200': $ref: '#/components/responses/success' case.resolved: post: operationId: webhook-case-resolved summary: Case resolved description: 'Webhook for the `case.resolved` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.resolved payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-resolved-webhook-body' responses: '200': $ref: '#/components/responses/success' case.sla-expired: post: operationId: webhook-case-sla-expired summary: Case SLA expired description: 'Webhook for the `case.sla-expired` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.sla-expired payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-sla-expired-webhook-body' responses: '200': $ref: '#/components/responses/success' case.status-updated: post: operationId: webhook-case-status-updated summary: Case status updated description: 'Webhook for the `case.status-updated` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.status-updated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-status-updated-webhook-body' responses: '200': $ref: '#/components/responses/success' case.updated-fields: post: operationId: webhook-case-updated-fields summary: Case updated fields description: 'Webhook for the `case.updated-fields` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.updated-fields payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-updated-fields-webhook-body' responses: '200': $ref: '#/components/responses/success' case.updated-tags: post: operationId: webhook-case-updated-tags summary: Case updated tags description: 'Webhook for the `case.updated-tags` event. The `context` identifies the tags added and removed by the update. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Case events x-persona-product: Cases parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: case.updated-tags context: type: object additionalProperties: false description: Identifies the tag names added to and removed from the Case. properties: added-tags: type: array description: Names of tags added by this update. Empty if none were added. items: type: string examples: - - escalated removed-tags: type: array description: Names of tags removed by this update. Empty if none were removed. items: type: string examples: - - standard-priority payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/case' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/cases-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/case-updated-tags-webhook-body' responses: '200': $ref: '#/components/responses/success' document.created: post: operationId: webhook-document-created summary: Document created description: 'Webhook for the `document.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/document-created-webhook-body' responses: '200': $ref: '#/components/responses/success' document.submitted: post: operationId: webhook-document-submitted summary: Document submitted description: 'Webhook for the `document.submitted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.submitted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/document-submitted-webhook-body' responses: '200': $ref: '#/components/responses/success' document.processed: post: operationId: webhook-document-processed summary: Document processed description: 'Webhook for the `document.processed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.processed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Generic Document: $ref: '#/components/examples/document-processed-webhook-body' Government ID: $ref: '#/components/examples/document-processed-government-id-webhook-body' responses: '200': $ref: '#/components/responses/success' document.errored: post: operationId: webhook-document-errored summary: Document errored description: 'Webhook for the `document.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/document-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' document.extracted: post: operationId: webhook-document-extracted summary: Document extracted description: 'Webhook for the `document.extracted` event. This event fires only for government ID documents when extraction completes without verification enabled. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.extracted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/document-extracted-government-id-webhook-body' responses: '200': $ref: '#/components/responses/success' document.pending: post: operationId: webhook-document-pending summary: Document pending description: 'Webhook for the `document.pending` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Document events x-persona-product: Documents parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: document.pending payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/document' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/document-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/document-pending-webhook-body' responses: '200': $ref: '#/components/responses/success' graph-query.cancelled: post: operationId: webhook-graph-query-cancelled summary: Graph Query cancelled description: 'Webhook for the `graph-query.cancelled` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Graph query events x-persona-product: Graph parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: graph-query.cancelled payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/graph-query-cancelled-webhook-body' responses: '200': $ref: '#/components/responses/success' graph-query.completed: post: operationId: webhook-graph-query-completed summary: Graph Query completed description: 'Webhook for the `graph-query.completed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Graph query events x-persona-product: Graph parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: graph-query.completed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/graph-query-completed-webhook-body' responses: '200': $ref: '#/components/responses/success' graph-query.errored: post: operationId: webhook-graph-query-errored summary: Graph Query errored description: 'Webhook for the `graph-query.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Graph query events x-persona-product: Graph parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: graph-query.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/graph-query-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' graph-query.reran: post: operationId: webhook-graph-query-reran summary: Graph Query reran description: 'Webhook for the `graph-query.reran` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Graph query events x-persona-product: Graph parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: graph-query.reran payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/graph-query-reran-webhook-body' responses: '200': $ref: '#/components/responses/success' graph-query.timed-out: post: operationId: webhook-graph-query-timed-out summary: Graph Query timed out description: 'Webhook for the `graph-query.timed-out` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Graph query events x-persona-product: Graph parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: graph-query.timed-out payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/graph-query' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/graph-query-timed-out-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.created: post: operationId: webhook-inquiry-created summary: Inquiry created description: 'Webhook for the `inquiry.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-created-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.started: post: operationId: webhook-inquiry-started summary: Inquiry started description: 'Webhook for the `inquiry.started` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.started payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-started-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.expired: post: operationId: webhook-inquiry-expired summary: Inquiry expired description: 'Webhook for the `inquiry.expired` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.expired payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-expired-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.completed: post: operationId: webhook-inquiry-completed summary: Inquiry completed description: 'Webhook for the `inquiry.completed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.completed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-completed-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.failed: post: operationId: webhook-inquiry-failed summary: Inquiry failed description: 'Webhook for the `inquiry.failed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.failed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-failed-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.marked-for-review: post: operationId: webhook-inquiry-marked-for-review summary: Inquiry marked for review description: 'Webhook for the `inquiry.marked-for-review` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.marked-for-review payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-marked-for-review-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.approved: post: operationId: webhook-inquiry-approved summary: Inquiry approved description: 'Webhook for the `inquiry.approved` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.approved payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-approved-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.declined: post: operationId: webhook-inquiry-declined summary: Inquiry declined description: 'Webhook for the `inquiry.declined` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.declined payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-declined-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.transitioned: post: operationId: webhook-inquiry-transitioned summary: Inquiry transitioned description: 'Webhook for the `inquiry.transitioned` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.transitioned payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-transitioned-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.redacted: post: operationId: webhook-inquiry-redacted summary: Inquiry redacted description: |- Webhook for the `inquiry.redacted` event. An Inquiry can be redacted directly (via the dashboard or API) or as part of cascading redaction triggered by an Account redaction or an automated retention policy. A redacted Inquiry preserves its **current** `status` — which may be any value, including `created`, `pending`, or `needs_review` for inquiries redacted before finalization, in addition to the terminal states (`approved`, `declined`, `completed`, `failed`, `expired`). Operational timestamps (`created-at`, `started-at`, `decisioned-at`, etc.) are preserved. The distinguishing signal is `redacted-at`, which is non-null on this event. **Do not detect redaction from `status`** — there is no `redacted` enum value. On the redacted payload, PII attributes are nulled out regardless of the redaction path: the deprecated top-level identity attributes (`name-first`, `name-middle`, `name-last`, `address-*`, `birthdate`, `email-address`, `phone-number`, `identification-number`, `social-security-number`) and the corresponding entries inside `fields`, plus `note`. `tags` is emptied via cascading on inquiry tags. `reference-id` is `null` **only when the parent Account is also redacted** (the cascading case). On a direct Inquiry redaction that leaves the parent Account intact, `reference-id` can remain populated. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.redacted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-redacted-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.reusable-persona-created: post: operationId: webhook-inquiry-reusable-persona-created summary: Inquiry reusable-persona created description: |- Webhook for the `inquiry.reusable-persona-created` event. Fired when a reusable persona is first created from an Inquiry — i.e., the first time an end user's verified identity from this Inquiry becomes available for reuse on subsequent verifications. The payload `data` is the Inquiry the reusable persona was created from, typically in its terminal `approved` (or `completed`) status. For more info see [Reusable Personas](https://docs.withpersona.com/reusable-personas) and [Webhooks Overview](https://docs.withpersona.com/webhooks). tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.reusable-persona-created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-reusable-persona-created-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.reusable-persona-used: post: operationId: webhook-inquiry-reusable-persona-used summary: Inquiry reusable-persona used description: |- Webhook for the `inquiry.reusable-persona-used` event. Fired when an Inquiry is verified by reusing a previously-established reusable persona rather than performing a fresh verification. The payload `data` is the new Inquiry that used the reusable persona, in its terminal status. For more info see [Reusable Personas](https://docs.withpersona.com/reusable-personas) and [Webhooks Overview](https://docs.withpersona.com/webhooks). tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.reusable-persona-used payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-reusable-persona-used-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry.updated-tags: post: operationId: webhook-inquiry-updated-tags summary: Inquiry tags updated description: 'Webhook for the `inquiry.updated-tags` event. Fired when one or more tags are added to or removed from an Inquiry. The `context` identifies the tags added and removed by the update. The delivered payload contains the Inquiry''s full attributes — including the current `tags` array reflecting the post-update state. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry.updated-tags context: type: object additionalProperties: false description: Identifies the tag names added to and removed from the Inquiry. properties: added-tags: type: array description: Names of tags added by this update. Empty if none were added. items: type: string examples: - - manual_review_complete removed-tags: type: array description: Names of tags removed by this update. Empty if none were removed. items: type: string examples: - - pending_review payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry' included: description: 'Objects referenced in `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, `included` will be empty.' $ref: '#/components/schemas/inquiry-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-updated-tags-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry-session.started: post: operationId: webhook-inquiry-session-started summary: Inquiry session started description: 'Webhook for the `inquiry-session.started` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry session events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry-session.started payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry-session' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/inquiry-sessions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-session-started-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry-session.expired: post: operationId: webhook-inquiry-session-expired summary: Inquiry session expired description: 'Webhook for the `inquiry-session.expired` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry session events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry-session.expired payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry-session' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/inquiry-sessions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-session-expired-webhook-body' responses: '200': $ref: '#/components/responses/success' inquiry-session.canceled: post: operationId: webhook-inquiry-session-canceled summary: Inquiry session canceled description: 'Webhook for the `inquiry-session.canceled` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Inquiry session events x-persona-product: Inquiries parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: inquiry-session.canceled payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/inquiry-session' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/inquiry-sessions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/inquiry-session-canceled-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.canceled: post: operationId: webhook-importer-pipeline-run-canceled summary: Importer pipeline run canceled description: 'Webhook for the `importer-pipeline-run.canceled` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.canceled payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-canceled-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.completed: post: operationId: webhook-importer-pipeline-run-completed summary: Importer pipeline run completed description: 'Webhook for the `importer-pipeline-run.completed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.completed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-completed-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.errored: post: operationId: webhook-importer-pipeline-run-errored summary: Importer pipeline run errored description: 'Webhook for the `importer-pipeline-run.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.paused: post: operationId: webhook-importer-pipeline-run-paused summary: Importer pipeline run paused description: 'Webhook for the `importer-pipeline-run.paused` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.paused payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-paused-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.resumed: post: operationId: webhook-importer-pipeline-run-resumed summary: Importer pipeline run resumed description: 'Webhook for the `importer-pipeline-run.resumed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.resumed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-resumed-webhook-body' responses: '200': $ref: '#/components/responses/success' importer-pipeline-run.started: post: operationId: webhook-importer-pipeline-run-started summary: Importer pipeline run started description: 'Webhook for the `importer-pipeline-run.started` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Importer pipeline run events x-persona-product: Importers parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: importer-pipeline-run.started payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/importer-pipeline-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/importer-pipeline-runs-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/importer-pipeline-run-started-webhook-body' responses: '200': $ref: '#/components/responses/success' report/address-lookup.ready: post: operationId: webhook-report-address-lookup-ready summary: Address lookup report ready description: |- Webhook for the `report/address-lookup.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an address lookup report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/address-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/address-lookup.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-address-lookup-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/address-lookup.errored: post: operationId: webhook-report-address-lookup-errored summary: Address lookup report errored description: |- Webhook for the `report/address-lookup.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an address lookup report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/address-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/address-lookup.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-address-lookup-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/address-lookup.submitted: post: operationId: webhook-report-address-lookup-submitted summary: Address lookup report submitted description: |- Webhook for the `report/address-lookup.submitted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an address lookup report has been submitted to its upstream data source and is awaiting results (`status` is `submitted`). A `ready` or `errored` event follows once processing completes. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/address-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/address-lookup.submitted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-address-lookup-submitted-webhook-body' responses: '200': $ref: '#/components/responses/success' report/adverse-media.ready: post: operationId: webhook-report-adverse-media-ready summary: Adverse media report ready description: |- Webhook for the `report/adverse-media.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an adverse media report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/adverse-media.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-adverse-media-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/adverse-media.errored: post: operationId: webhook-report-adverse-media-errored summary: Adverse media report errored description: |- Webhook for the `report/adverse-media.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an adverse media report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/adverse-media.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-adverse-media-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/adverse-media.matched: post: operationId: webhook-report-adverse-media-matched summary: Adverse media report matched description: |- Webhook for the `report/adverse-media.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an adverse media report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/adverse-media.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-adverse-media-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/adverse-media.dismissed: post: operationId: webhook-report-adverse-media-dismissed summary: Adverse media report match dismissed description: |- Webhook for the `report/adverse-media.dismissed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a previously surfaced match on an adverse media report is dismissed by a reviewer. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/adverse-media.dismissed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-adverse-media-dismissed-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-adverse-media.ready: post: operationId: webhook-report-business-adverse-media-ready summary: Business adverse media report ready description: |- Webhook for the `report/business-adverse-media.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business adverse media report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-adverse-media.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-adverse-media-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-adverse-media.errored: post: operationId: webhook-report-business-adverse-media-errored summary: Business adverse media report errored description: |- Webhook for the `report/business-adverse-media.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business adverse media report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-adverse-media.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-adverse-media-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-adverse-media.matched: post: operationId: webhook-report-business-adverse-media-matched summary: Business adverse media report matched description: |- Webhook for the `report/business-adverse-media.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business adverse media report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-adverse-media.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-adverse-media-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-adverse-media.dismissed: post: operationId: webhook-report-business-adverse-media-dismissed summary: Business adverse media report match dismissed description: |- Webhook for the `report/business-adverse-media.dismissed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a previously surfaced match on a business adverse media report is dismissed by a reviewer. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-adverse-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-adverse-media.dismissed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-adverse-media-dismissed-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-associated-persons.ready: post: operationId: webhook-report-business-associated-persons-ready summary: Business associated persons report ready description: |- Webhook for the `report/business-associated-persons.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business associated persons report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-associated-persons`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-associated-persons.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-associated-persons-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-associated-persons.errored: post: operationId: webhook-report-business-associated-persons-errored summary: Business associated persons report errored description: |- Webhook for the `report/business-associated-persons.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business associated persons report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-associated-persons`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-associated-persons.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-associated-persons-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-lookup.ready: post: operationId: webhook-report-business-lookup-ready summary: Business lookup report ready description: |- Webhook for the `report/business-lookup.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business lookup report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-lookup.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-lookup-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-lookup.errored: post: operationId: webhook-report-business-lookup-errored summary: Business lookup report errored description: |- Webhook for the `report/business-lookup.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business lookup report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-lookup.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-lookup-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-registrations-lookup.ready: post: operationId: webhook-report-business-registrations-lookup-ready summary: Business registrations lookup report ready description: |- Webhook for the `report/business-registrations-lookup.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business registrations lookup report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-registrations-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-registrations-lookup.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-registrations-lookup-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-registrations-lookup.errored: post: operationId: webhook-report-business-registrations-lookup-errored summary: Business registrations lookup report errored description: |- Webhook for the `report/business-registrations-lookup.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business registrations lookup report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-registrations-lookup`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-registrations-lookup.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-registrations-lookup-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-watchlist.ready: post: operationId: webhook-report-business-watchlist-ready summary: Business watchlist report ready description: |- Webhook for the `report/business-watchlist.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business watchlist report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-watchlist.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-watchlist-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-watchlist.errored: post: operationId: webhook-report-business-watchlist-errored summary: Business watchlist report errored description: |- Webhook for the `report/business-watchlist.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business watchlist report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-watchlist.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-watchlist-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-watchlist.matched: post: operationId: webhook-report-business-watchlist-matched summary: Business watchlist report matched description: |- Webhook for the `report/business-watchlist.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a business watchlist report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-watchlist.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-watchlist-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/business-watchlist.dismissed: post: operationId: webhook-report-business-watchlist-dismissed summary: Business watchlist report match dismissed description: |- Webhook for the `report/business-watchlist.dismissed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a previously surfaced match on a business watchlist report is dismissed by a reviewer. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/business-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/business-watchlist.dismissed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-business-watchlist-dismissed-webhook-body' responses: '200': $ref: '#/components/responses/success' report/crypto-address-watchlist.ready: post: operationId: webhook-report-crypto-address-watchlist-ready summary: Crypto address watchlist report ready description: |- Webhook for the `report/crypto-address-watchlist.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a crypto address watchlist report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/crypto-address-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/crypto-address-watchlist.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-crypto-address-watchlist-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/crypto-address-watchlist.errored: post: operationId: webhook-report-crypto-address-watchlist-errored summary: Crypto address watchlist report errored description: |- Webhook for the `report/crypto-address-watchlist.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a crypto address watchlist report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/crypto-address-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/crypto-address-watchlist.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-crypto-address-watchlist-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/crypto-address-watchlist.matched: post: operationId: webhook-report-crypto-address-watchlist-matched summary: Crypto address watchlist report matched description: |- Webhook for the `report/crypto-address-watchlist.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a crypto address watchlist report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/crypto-address-watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/crypto-address-watchlist.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-crypto-address-watchlist-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/email-address.ready: post: operationId: webhook-report-email-address-ready summary: Email address report ready description: |- Webhook for the `report/email-address.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an email address report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/email-address`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/email-address.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-email-address-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/email-address.errored: post: operationId: webhook-report-email-address-errored summary: Email address report errored description: |- Webhook for the `report/email-address.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when an email address report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/email-address`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/email-address.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-email-address-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/phone-number.ready: post: operationId: webhook-report-phone-number-ready summary: Phone number report ready description: |- Webhook for the `report/phone-number.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a phone number report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/phone-number`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/phone-number.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-phone-number-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/phone-number.errored: post: operationId: webhook-report-phone-number-errored summary: Phone number report errored description: |- Webhook for the `report/phone-number.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a phone number report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/phone-number`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/phone-number.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-phone-number-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/politically-exposed-person.ready: post: operationId: webhook-report-politically-exposed-person-ready summary: Politically exposed person (PEP) report ready description: |- Webhook for the `report/politically-exposed-person.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a politically exposed person (PEP) report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/politically-exposed-person`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/politically-exposed-person.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-politically-exposed-person-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/politically-exposed-person.errored: post: operationId: webhook-report-politically-exposed-person-errored summary: Politically exposed person (PEP) report errored description: |- Webhook for the `report/politically-exposed-person.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a politically exposed person (PEP) report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/politically-exposed-person`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/politically-exposed-person.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-politically-exposed-person-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/politically-exposed-person.matched: post: operationId: webhook-report-politically-exposed-person-matched summary: Politically exposed person (PEP) report matched description: |- Webhook for the `report/politically-exposed-person.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a politically exposed person (PEP) report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/politically-exposed-person`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/politically-exposed-person.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-politically-exposed-person-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/politically-exposed-person.dismissed: post: operationId: webhook-report-politically-exposed-person-dismissed summary: Politically exposed person (PEP) report match dismissed description: |- Webhook for the `report/politically-exposed-person.dismissed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a previously surfaced match on a politically exposed person (PEP) report is dismissed by a reviewer. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/politically-exposed-person`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/politically-exposed-person.dismissed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-politically-exposed-person-dismissed-webhook-body' responses: '200': $ref: '#/components/responses/success' report/profile.ready: post: operationId: webhook-report-profile-ready summary: Profile report ready description: |- Webhook for the `report/profile.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a profile report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/profile`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/profile.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-profile-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/profile.errored: post: operationId: webhook-report-profile-errored summary: Profile report errored description: |- Webhook for the `report/profile.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a profile report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/profile`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/profile.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-profile-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/profile-non-authoritative.ready: post: operationId: webhook-report-profile-non-authoritative-ready summary: Profile (non-authoritative) report ready description: |- Webhook for the `report/profile-non-authoritative.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a profile (non-authoritative) report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/profile-non-authoritative`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/profile-non-authoritative.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-profile-non-authoritative-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/profile-non-authoritative.errored: post: operationId: webhook-report-profile-non-authoritative-errored summary: Profile (non-authoritative) report errored description: |- Webhook for the `report/profile-non-authoritative.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a profile (non-authoritative) report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/profile-non-authoritative`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/profile-non-authoritative.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-profile-non-authoritative-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/sentilink-scores.ready: post: operationId: webhook-report-sentilink-scores-ready summary: SentiLink scores report ready description: |- Webhook for the `report/sentilink-scores.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a sentiLink scores report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/integration/sentilink-scores`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/sentilink-scores.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-sentilink-scores-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/sentilink-scores.errored: post: operationId: webhook-report-sentilink-scores-errored summary: SentiLink scores report errored description: |- Webhook for the `report/sentilink-scores.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a sentiLink scores report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/integration/sentilink-scores`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/sentilink-scores.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-sentilink-scores-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/social-media.ready: post: operationId: webhook-report-social-media-ready summary: Social media report ready description: |- Webhook for the `report/social-media.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a social media report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/social-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/social-media.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-social-media-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/social-media.errored: post: operationId: webhook-report-social-media-errored summary: Social media report errored description: |- Webhook for the `report/social-media.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a social media report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/social-media`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/social-media.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-social-media-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/synthetic.ready: post: operationId: webhook-report-synthetic-ready summary: Synthetic report ready description: |- Webhook for the `report/synthetic.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a synthetic report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/synthetic`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/synthetic.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-synthetic-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/synthetic.errored: post: operationId: webhook-report-synthetic-errored summary: Synthetic report errored description: |- Webhook for the `report/synthetic.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a synthetic report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/synthetic`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/synthetic.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-synthetic-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/watchlist.ready: post: operationId: webhook-report-watchlist-ready summary: Watchlist report ready description: |- Webhook for the `report/watchlist.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a watchlist report finishes processing and its results are available (`status` is `ready`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/watchlist.ready payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-watchlist-ready-webhook-body' responses: '200': $ref: '#/components/responses/success' report/watchlist.errored: post: operationId: webhook-report-watchlist-errored summary: Watchlist report errored description: |- Webhook for the `report/watchlist.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a watchlist report fails to complete processing (`status` is `errored`). The payload is the polymorphic report object. Inspect `payload.data.type` (`report/watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/watchlist.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-watchlist-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' report/watchlist.matched: post: operationId: webhook-report-watchlist-matched summary: Watchlist report matched description: |- Webhook for the `report/watchlist.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a watchlist report surfaces one or more matches (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/watchlist.matched payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-watchlist-matched-webhook-body' responses: '200': $ref: '#/components/responses/success' report/watchlist.dismissed: post: operationId: webhook-report-watchlist-dismissed summary: Watchlist report match dismissed description: |- Webhook for the `report/watchlist.dismissed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a previously surfaced match on a watchlist report is dismissed by a reviewer. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/watchlist`) to identify the report, and `payload.data.attributes` for its inputs and results. tags: - Report events x-persona-product: Reports parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: report/watchlist.dismissed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/report' included: description: 'Objects referenced by `payload.data.relationships` are included here when related-object inclusion is enabled for the webhook. When inclusion is off (the default), the `included` key is omitted entirely (it is not returned as an empty array).' $ref: '#/components/schemas/reports-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/report-watchlist-dismissed-webhook-body' responses: '200': $ref: '#/components/responses/success' selfie.created: post: operationId: webhook-selfie-created summary: Selfie created description: 'Webhook for the `selfie.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Selfie events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: selfie.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/selfie' included: description: 'Objects referenced in `payload.data.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, the `included` key is omitted.' $ref: '#/components/schemas/selfie-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/selfie-created-webhook-body' responses: '200': $ref: '#/components/responses/success' selfie.submitted: post: operationId: webhook-selfie-submitted summary: Selfie submitted description: 'Webhook for the `selfie.submitted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Selfie events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: selfie.submitted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/selfie' included: description: 'Objects referenced in `payload.data.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, the `included` key is omitted.' $ref: '#/components/schemas/selfie-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/selfie-submitted-webhook-body' responses: '200': $ref: '#/components/responses/success' selfie.processed: post: operationId: webhook-selfie-processed summary: Selfie processed description: 'Webhook for the `selfie.processed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Selfie events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: selfie.processed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/selfie' included: description: 'Objects referenced in `payload.data.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, the `included` key is omitted.' $ref: '#/components/schemas/selfie-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/selfie-processed-webhook-body' responses: '200': $ref: '#/components/responses/success' selfie.errored: post: operationId: webhook-selfie-errored summary: Selfie errored description: 'Webhook for the `selfie.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Selfie events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: selfie.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/selfie' included: description: 'Objects referenced in `payload.data.relationships` may be provided in `included` when related-object inclusion is enabled for this webhook subscription. When inclusion is not enabled, the `included` key is omitted.' $ref: '#/components/schemas/selfie-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/selfie-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.created: post: operationId: webhook-transaction-created summary: Transaction created description: 'Webhook for the `transaction.created` event. Fires when a Transaction is created. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-created-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.status-updated: post: operationId: webhook-transaction-status-updated summary: Transaction status updated description: 'Webhook for the `transaction.status-updated` event. Fires when a Transaction''s status changes. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.status-updated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-status-updated-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.updated-fields: post: operationId: webhook-transaction-updated-fields summary: Transaction updated fields description: 'Webhook for the `transaction.updated-fields` event. Fires when one or more of a Transaction''s fields are updated. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.updated-fields payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-updated-fields-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.labeled: post: operationId: webhook-transaction-labeled summary: Transaction labeled description: 'Webhook for the `transaction.labeled` event. Fires when a label is applied to a Transaction. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.labeled payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-labeled-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.redacted: post: operationId: webhook-transaction-redacted summary: Transaction redacted description: 'Webhook for the `transaction.redacted` event. Fires when a Transaction''s personally identifiable information (PII) is redacted. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.redacted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-redacted-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.added-relation: post: operationId: webhook-transaction-added-relation summary: Transaction added relation description: 'Webhook for the `transaction.added-relation` event. Fires when a relationship is added between this Transaction and another object (an Account or a Transaction). The related object is identified by the `context`. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.added-relation payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' context: type: object additionalProperties: false description: Identifies the relationship that was added and the related object. properties: relation-schema-key: type: string description: The key of the relationship schema connecting this Transaction to the related object. examples: - txn_account target-account-id: type: - string - 'null' description: 'Token of the related Account when the related object is an Account, otherwise `null`. Starts with `act_`.' examples: - act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: type: - string - 'null' description: 'Token of the related Transaction when the related object is a Transaction, otherwise `null`. Starts with `txn_`.' examples: - null - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-added-relation-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.removed-relation: post: operationId: webhook-transaction-removed-relation summary: Transaction removed relation description: 'Webhook for the `transaction.removed-relation` event. Fires when a relationship is removed between this Transaction and another object (an Account or a Transaction). The related object is identified by the `context`. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.removed-relation payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' context: type: object additionalProperties: false description: Identifies the relationship that was removed and the related object. properties: relation-schema-key: type: string description: The key of the relationship schema that connected this Transaction to the related object. examples: - txn_account target-account-id: type: - string - 'null' description: 'Token of the related Account when the related object is an Account, otherwise `null`. Starts with `act_`.' examples: - act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: type: - string - 'null' description: 'Token of the related Transaction when the related object is a Transaction, otherwise `null`. Starts with `txn_`.' examples: - null - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-removed-relation-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction.sentinel-session-processed: post: operationId: webhook-transaction-sentinel-session-processed summary: Transaction sentinel session processed description: 'Webhook for the `transaction.sentinel-session-processed` event. Fires when a Sentinel session finishes processing for a Transaction. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction.sentinel-session-processed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/transactions-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-sentinel-session-processed-webhook-body' responses: '200': $ref: '#/components/responses/success' transaction-type.deleted-field: post: operationId: webhook-transaction-type-deleted-field summary: Transaction type deleted field description: 'Webhook for the `transaction-type.deleted-field` event. Fires when a field is deleted from a Transaction Type. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Transaction type events x-persona-product: Transactions parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: transaction-type.deleted-field payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/transaction-type' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/transaction-type-deleted-field-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.canceled: post: operationId: webhook-verification-canceled summary: Verification canceled description: |- Webhook for the `verification.canceled` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.canceled payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-canceled-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.created: post: operationId: webhook-verification-created summary: Verification created description: |- Webhook for the `verification.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-created-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.escalated: post: operationId: webhook-verification-escalated summary: Verification escalated description: |- Webhook for the `verification.escalated` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.escalated payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-escalated-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.failed: post: operationId: webhook-verification-failed summary: Verification failed description: |- Webhook for the `verification.failed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.failed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-failed-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.passed: post: operationId: webhook-verification-passed summary: Verification passed description: |- Webhook for the `verification.passed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.passed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-passed-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.requires-retry: post: operationId: webhook-verification-requires-retry summary: Verification requires retry description: |- Webhook for the `verification.requires-retry` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.requires-retry payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-requires-retry-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.skipped: post: operationId: webhook-verification-skipped summary: Verification skipped description: |- Webhook for the `verification.skipped` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.skipped payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-skipped-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.submitted: post: operationId: webhook-verification-submitted summary: Verification submitted description: |- Webhook for the `verification.submitted` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.submitted payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-submitted-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.tentatively-failed: post: operationId: webhook-verification-tentatively-failed summary: Verification tentatively failed description: |- Webhook for the `verification.tentatively-failed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.tentatively-failed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-tentatively-failed-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.tentatively-passed: post: operationId: webhook-verification-tentatively-passed summary: Verification tentatively passed description: |- Webhook for the `verification.tentatively-passed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification events.** Verifications are internal building blocks of an inquiry — to learn the outcome of an end user's flow, listen to `inquiry.approved`, `inquiry.marked-for-review`, and `inquiry.declined`, and inspect the inquiry's `tags` (which surface fraudulent activity and risk signals). Subscribe to verification events only when you have a specific need to react to per-verification state transitions. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.tentatively-passed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-tentatively-passed-webhook-body' responses: '200': $ref: '#/components/responses/success' verification.updated-tags: post: operationId: webhook-verification-updated-tags summary: Verification tags updated description: |- Webhook for the `verification.updated-tags` event, which fires when tags are added to or removed from a Verification. The `context` identifies the tags added and removed by the update. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). **Most integrations don't need verification tag events.** Verifications are internal building blocks of an inquiry — for tag changes that summarize risk or fraud signals across the end user's flow, listen to `inquiry.updated-tags` and inspect the inquiry's `tags`. Subscribe to `verification.updated-tags` only when you have a specific need to react to tag changes on individual verifications. tags: - Verification events x-persona-product: Verifications parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: verification.updated-tags context: type: object additionalProperties: false description: Identifies the tag names added to and removed from the Verification. properties: added-tags: type: array description: Names of tags added by this update. Empty if none were added. items: type: string examples: - - manual_review_complete removed-tags: type: array description: Names of tags removed by this update. Empty if none were removed. items: type: string examples: - - flagged_for_followup payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/verification' included: description: 'Objects referenced by `data.attributes.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook. By default, `included` is empty.' $ref: '#/components/schemas/verification-included-objects' - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/verification-updated-tags-webhook-body' responses: '200': $ref: '#/components/responses/success' workflow-run.created: post: operationId: webhook-workflow-run-created summary: Workflow run created description: 'Webhook for the `workflow-run.created` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Workflow run events x-persona-product: Workflows parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: workflow-run.created payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/workflow-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/workflow-run-included-objects' context: type: object description: 'Additional context for the event. Always `{}` for `workflow-run.created`.' additionalProperties: true - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/workflow-run-created-webhook-body' responses: '200': $ref: '#/components/responses/success' workflow-run.errored: post: operationId: webhook-workflow-run-errored summary: Workflow run errored description: 'Webhook for the `workflow-run.errored` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Workflow run events x-persona-product: Workflows parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: workflow-run.errored payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/workflow-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/workflow-run-included-objects' context: type: object description: 'Additional context for the event. Always `{}` for `workflow-run.errored`.' additionalProperties: true - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/workflow-run-errored-webhook-body' responses: '200': $ref: '#/components/responses/success' workflow-run.resumed: post: operationId: webhook-workflow-run-resumed summary: Workflow run resumed description: 'Webhook for the `workflow-run.resumed` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).' tags: - Workflow run events x-persona-product: Workflows parameters: - $ref: '#/components/parameters/persona-signature-header' - $ref: '#/components/parameters/persona-webhook-attempts-made' - $ref: '#/components/parameters/persona-webhook-attempts-left' - $ref: '#/components/parameters/persona-webhook-first-attempted-at' requestBody: content: application/json: schema: type: object additionalProperties: false properties: data: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/webhook-body-shared-data' - type: object properties: attributes: unevaluatedProperties: false allOf: - type: object properties: name: type: string const: workflow-run.resumed payload: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/workflow-run' included: description: All objects that are present in `data.attributes.relationships` will be provided in `included`. $ref: '#/components/schemas/workflow-run-included-objects' context: type: object description: 'Additional context for the event. Always `{}` for `workflow-run.resumed`.' additionalProperties: true - $ref: '#/components/schemas/webhook-body-shared-attributes' examples: Example Body: $ref: '#/components/examples/workflow-run-resumed-webhook-body' responses: '200': $ref: '#/components/responses/success' components: securitySchemes: bearerAuth: type: http scheme: bearer x-bearer-format: bearer privacyPassAuth: type: apiKey in: header name: Authorization x-fern-header: name: privacyPassToken prefix: PrivateToken token= description: 'Privacy Pass token per RFC 9577. Provide as `Authorization: PrivateToken token=`.' parameters: key-inflection-header: name: Key-Inflection in: header description: Determines casing for the API response. schema: type: string enum: - camel - kebab - snake idempotency-key-header: name: Idempotency-Key in: header description: Ensures the request is idempotent. schema: type: string persona-version-header: name: Persona-Version in: header schema: $ref: '#/components/schemas/api-version' include-query-parameter: in: query name: include 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.' schema: type: string fields-query-parameter: in: query name: fields style: deepObject explode: true 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.' schema: type: object additionalProperties: type: string pagination-query-params: in: query name: page style: deepObject explode: true schema: type: object additionalProperties: false properties: after: description: Object ID for pagination cursor type: string examples: - obj_ABC123 before: description: Object ID for pagination cursor examples: - obj_ABC123 type: string size: description: Limit on the number of objects returned examples: - 5 type: number persona-signature-header: name: Persona-Signature in: header description: 'Header. An HMAC that you should use to check that requests are authentic. Compare this value with your own digest, computed from the request body and your webhook secret. For more info see [Webhook Best Practices](https://docs.withpersona.com/webhooks-best-practices).' schema: type: string examples: - 't=1709686052,v1=n3ulUDfqGSkzarlvyeg2oZe3qx3sQjbSno5s7Icx4dy8CbTPqu8xvQ5ZyEJy' persona-webhook-attempts-made: name: Persona-Webhook-Attempts-Made in: header description: 'The number of times that Persona has attempted to deliver this webhook. This value is incremented each time Persona attempts to deliver the webhook, regardless of whether the delivery was successful.' schema: type: integer examples: - 2 persona-webhook-attempts-left: name: Persona-Webhook-Attempts-Left in: header description: The number of times that Persona will attempt to deliver this webhook. This value is decremented each time Persona attempts to deliver the webhook. schema: type: integer examples: - 6 persona-webhook-first-attempted-at: name: Persona-Webhook-First-Attempted-At in: header description: The time at which Persona first attempted to deliver this webhook. This value is a Unix timestamp in seconds. schema: type: integer examples: - 1527811200 schemas: api-version: type: string description: 'Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).' examples: - '2025-12-08' 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' field-schema-default-config: x-inheritable: true type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time examples: - '2023-06-29T23:54:35.293Z' deactivated-at: type: - string - 'null' format: date-time examples: - '2023-06-29T23:54:35.293Z' source-key-path: description: 'When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas.' type: - string - 'null' redaction-policy: type: string default: none description: |- Whether the field's value may be redacted on request. Possible values: - `none` — value is redactable - `never` — value is never redacted Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. write-policy: type: string default: none description: |- Whether the field's value may be overwritten after it is first set. Possible values: - `none` — value may be overwritten on subsequent writes - `write_once` — subsequent writes are rejected once a value is set Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. field-schema: discriminator: propertyName: type mapping: array: '#/components/schemas/field-schema-array' boolean: '#/components/schemas/field-schema-boolean' choices: '#/components/schemas/field-schema-choices' date: '#/components/schemas/field-schema-date' datetime: '#/components/schemas/field-schema-datetime' email-address: '#/components/schemas/field-schema-email-address' file: '#/components/schemas/field-schema-file' hash: '#/components/schemas/field-schema-hash' integer: '#/components/schemas/field-schema-integer' json: '#/components/schemas/field-schema-json' multi-choices: '#/components/schemas/field-schema-multi-choices' number: '#/components/schemas/field-schema-number' string: '#/components/schemas/field-schema-string' relation-schema: '#/components/schemas/field-schema-relation' anyOf: - $ref: '#/components/schemas/field-schema-array' - $ref: '#/components/schemas/field-schema-boolean' - $ref: '#/components/schemas/field-schema-choices' - $ref: '#/components/schemas/field-schema-date' - $ref: '#/components/schemas/field-schema-datetime' - $ref: '#/components/schemas/field-schema-email-address' - $ref: '#/components/schemas/field-schema-file' - $ref: '#/components/schemas/field-schema-hash' - $ref: '#/components/schemas/field-schema-integer' - $ref: '#/components/schemas/field-schema-json' - $ref: '#/components/schemas/field-schema-multi-choices' - $ref: '#/components/schemas/field-schema-number' - $ref: '#/components/schemas/field-schema-string' - $ref: '#/components/schemas/field-schema-relation' field-schema-array: type: object additionalProperties: false properties: type: type: string const: array key: type: string label: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: item-schema: $ref: '#/components/schemas/field-schema' field-schema-boolean: type: object additionalProperties: false properties: type: type: string const: boolean key: type: string label: type: - string - 'null' default-value: type: - boolean - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: {} field-schema-choices: type: object additionalProperties: false properties: type: type: string const: choices key: type: string label: type: - string - 'null' default-value: description: 'Must be one of the values in `config.options`, or null.' type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: allow-empty: type: boolean default: false options: type: array items: type: string option-labels: description: 'Display labels for each value in `options`, in the same order.' type: array items: type: string field-schema-date: type: object additionalProperties: false properties: type: type: string const: date key: type: string label: type: - string - 'null' default-value: type: - string - 'null' format: date examples: - '2023-06-29' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: min-date: type: - string - 'null' format: date examples: - '2023-06-29' max-date: type: - string - 'null' format: date examples: - '2023-06-29' field-schema-datetime: type: object additionalProperties: false properties: type: type: string const: datetime key: type: string label: type: - string - 'null' default-value: type: - string - 'null' format: date-time examples: - '2023-06-29T23:54:35.293Z' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: {} field-schema-email-address: type: object additionalProperties: false properties: type: type: string const: email-address key: type: string label: type: - string - 'null' default-value: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: {} field-schema-file: type: object additionalProperties: false properties: type: type: string const: file key: type: string label: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: max-file-size-bytes: type: integer default: 10000000 min-file-size-bytes: type: integer default: 1 supported-mime-types: type: array items: type: string default: - image/jpg image/jpeg image/png image/heic image/heif image/tif image/tiff image/gif image/svg+xml application/pdf text/plain text/csv video/mp4 video/webm video/quicktime page-count-limit-enabled: description: Whether the document page-count limits are enforced. type: boolean default: false page-count-min: description: Minimum allowed page count when `page-count-limit-enabled` is true. type: - integer - 'null' page-count-max: description: Maximum allowed page count when `page-count-limit-enabled` is true. type: - integer - 'null' field-schema-hash: type: object additionalProperties: false properties: type: type: string const: hash key: type: string label: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: ignore-unknown-keys: type: boolean default: false item-schemas: type: array items: $ref: '#/components/schemas/field-schema' field-schema-integer: type: object additionalProperties: false properties: type: type: string const: integer key: type: string label: type: - string - 'null' default-value: type: - integer - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: min: type: number max: type: number field-schema-json: type: object additionalProperties: false properties: type: type: string const: json key: type: string label: type: - string - 'null' default-value: description: |- JSON-typed fields don't expose a default-value through this API (the stored value is a free-form JSON document; the default is `null`). type: 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: json-schema: description: |- A JSON Schema document (Draft 7 syntax) describing the shape of values stored in this field. Synthesized server-side by some verification types (e.g. `government-id` writes a map of national identification numbers); the schema is informational and may evolve without a versioned update. type: object additionalProperties: true field-schema-multi-choices: type: object additionalProperties: false properties: type: type: string const: multi-choices key: type: string label: type: - string - 'null' default-value: description: Each entry must be one of the values in `config.options`. type: - array - 'null' items: type: string config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: allow-empty: type: boolean default: false options: type: array items: type: string option-labels: description: 'Display labels for each value in `options`, in the same order.' type: array items: type: string field-schema-number: type: object additionalProperties: false properties: type: type: string const: number key: type: string label: type: - string - 'null' default-value: type: - number - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: min: type: number max: type: number field-schema-string: type: object additionalProperties: false properties: type: type: string const: string key: type: string label: type: - string - 'null' default-value: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: max-char-length: type: integer default: 255 maximum: 1024 sanitize: type: array items: type: string default: [] description: |- Possible values: - html Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. field-schema-relation: type: object additionalProperties: false properties: type: type: string const: relation-schema key: type: string label: type: - string - 'null' config: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/field-schema-default-config' - type: object properties: target: description: 'Customer-facing identifier for the specific Relation subtype this field points to — `document-generic`, `document-government-id`, `document-government-id-nfc`, `document-mdoc`, `document-qr-code`, or `selfie`. Use this on a future write API to specify which relation kind to create.' type: string account-type: type: object additionalProperties: false description: An Account Type object properties: type: const: account-type type: string id: examples: - acttp_7X5W5w9GMtQntE6oPtKnj44c type: string attributes: additionalProperties: false type: object properties: name: examples: - User type: string created-at: type: string format: date-time examples: - '2022-11-09T00:22:59.828Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-02-15T23:15:06.034Z' field-schemas: type: array items: unevaluatedProperties: false $ref: '#/components/schemas/field-schema' relationships: type: object additionalProperties: false properties: account-statuses: type: object additionalProperties: false properties: data: type: array items: type: object additionalProperties: false properties: type: type: string const: account-status id: type: string examples: - actst_ya9zKuezKLTfrc4WMB3vqVx4xTVP default-account-status: type: object additionalProperties: false properties: data: type: - object - 'null' additionalProperties: false properties: type: type: string const: account-status id: type: string examples: - actst_ya9zKuezKLTfrc4WMB3vqVx4xTVP empty-included-objects: type: array description: Excluded from the response by default. Will be an empty array when the `include` query parameter in the request was explicitly set to empty. file: type: - 'null' - object properties: filename: examples: - filename.pdf - id.png - abc123.JPEG type: string url: examples: - 'https://files.withpersona.com/abc123.JPEG?access_token=ACCESS_TOKEN' type: string byte-size: examples: - 124917 type: integer account: type: object additionalProperties: false description: |- An Account object. Note that `fields` is **not** key inflected. properties: type: type: string const: account id: type: string examples: - act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: properties: reference-id: type: - string - 'null' examples: - abc-123 account-type-name: type: - string examples: - User created-at: format: date-time examples: - '2020-04-12T05:08:51.000Z' type: string updated-at: format: date-time examples: - '2020-04-13T00:23:57.000Z' type: string redacted-at: format: date-time examples: - '2020-04-14T00:22:43.000Z' type: - string - 'null' fields: type: object description: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Account Type for this Account. Keys in `fields` are **not** key inflected. properties: name: type: object additionalProperties: false properties: type: type: string examples: - hash value: type: object additionalProperties: false properties: first: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - Jane middle: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - Marie last: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - Doe address: type: object additionalProperties: false properties: type: type: string examples: - hash value: type: object additionalProperties: false properties: street_1: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - 123 Main St street_2: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - Apt 1 subdivision: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - California city: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - San Francisco postal_code: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - '94111' country_code: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - US identification_numbers: type: object additionalProperties: false properties: type: type: string examples: - array value: type: array items: type: object additionalProperties: false properties: type: type: string examples: - hash value: type: object additionalProperties: false properties: identification_class: type: object additionalProperties: false properties: type: type: string examples: - string value: type: string examples: - visa - cct identification_number: type: object additionalProperties: false properties: type: type: string examples: - string value: type: string examples: - '12345678' - AB-12345678 issuing_country: type: object additionalProperties: false properties: type: type: string examples: - string value: type: string examples: - US - UK hashed_identification_number: type: object description: 'A SHA-256 hash of the identification number, keyed on organization, country code, identification class, and issuing subdivision. Stable across re-verifications of the same document for the same organization. Null when the identification number has not been hashed.' additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2 birthdate: type: object additionalProperties: false properties: type: type: string examples: - date value: type: - string - 'null' examples: - '1994-04-12' phone_number: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - 415-555-1234 email_address: type: object additionalProperties: false properties: type: type: string examples: - string value: type: - string - 'null' examples: - jane@doe.com selfie_photo: type: object additionalProperties: false properties: type: const: file type: string value: $ref: '#/components/schemas/file' additionalProperties: true tags: type: array account-status: type: string examples: - active type: object additionalProperties: false relationships: type: object additionalProperties: false properties: account-type: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: id: examples: - acttp_7X5W5w9GMtQntE6oPtKnj44c type: string type: const: account-type type: string accounts-included-objects: type: array items: discriminator: propertyName: type mapping: account-type: '#/components/schemas/account-type' oneOf: - $ref: '#/components/schemas/account-type' transaction: type: object additionalProperties: false properties: id: type: string description: Unique identifier for this Transaction. Starts with `txn_`. examples: - txn_ABC123 type: type: string const: transaction attributes: type: object additionalProperties: false properties: status: type: string examples: - approved - created - declined - needs review reference-id: type: - string - 'null' examples: - abc-123 fields: description: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Transaction Type for this Transaction. Keys in `fields` are **not** key inflected. type: object additionalProperties: true tags: type: array items: type: string created-at: type: string format: date-time examples: - '2023-05-26T16:49:33.860Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-05-26T16:49:43.965Z' relationships: type: object additionalProperties: false properties: reviewer: type: object additionalProperties: false description: The entity that reviewed the transaction properties: data: type: - object - 'null' properties: type: x-polymorphic: true type: string examples: - workflow-run - workflow-step - user id: type: string examples: - wfr_ABC123 - wfs_ABC123 - user_ABC123 transaction-label: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: transaction-label id: description: Unique identifier for this Transaction Label. Starts with `txnl_`. type: string examples: - txnl_ABC123 transaction-type: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string const: transaction-type id: description: Unique identifier for this Transaction Type. Starts with `txntp_`. type: string examples: - txntp_ABC123 related-objects: type: object additionalProperties: false description: Objects involved in this Transaction's related Workflow runs. Will include a maximum of 100 related objects. properties: data: type: array items: type: object additionalProperties: false properties: type: x-polymorphic: true type: string examples: - account - inquiry - verification/government-id id: type: string description: Unique identifier for this object. examples: - act_ABC123 - inq_ABC123 - ver_ABC123 api-key-shared-attributes: x-inheritable: true type: object properties: name: type: string examples: - API Key 123 note: type: - string - 'null' api-version: $ref: '#/components/schemas/api-version' api-key-inflection: type: string examples: - kebab api-attributes-blocklist: type: array items: type: - string - 'null' examples: - - address-* - name-last - /data/attributes/fields/*-number permissions: type: array items: type: string examples: - - account.read - inquiry.write ip-address-allowlist: type: array items: type: string examples: - - '*' - - 192.158.1.38 - 123.456.7.89 file-access-token-expires-in: type: integer format: int32 examples: - 21600 last-used-at: type: - string - 'null' examples: - '2023-09-21T18:29:40.000Z' expires-at: type: - string - 'null' examples: - '2023-09-21T18:29:40.000Z' created-at: type: string format: date-time examples: - '2023-09-21T18:29:40.000Z' api-key: type: object additionalProperties: false description: An API Key resource properties: type: const: api-key type: string id: examples: - api_ABC123 type: string attributes: unevaluatedProperties: false $ref: '#/components/schemas/api-key-shared-attributes' api-key-with-value: type: object additionalProperties: false description: An API Key resource properties: type: const: api-key type: string id: examples: - api_ABC123 type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/api-key-shared-attributes' - type: object properties: value: type: string description: The API Key value. This should be treated with the utmost security. examples: - persona_production_abcdefg connect-connection: type: object additionalProperties: false description: |- A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects. properties: type: type: string const: connect/connection id: type: string examples: - cxn_ABC123 attributes: additionalProperties: false properties: status: type: string description: 'The current status of the connection. One of `pending`, `active`, or `inactive`.' examples: - pending - active - inactive destination-organization-id: type: string examples: - org_XYZ789 description: The organization authorized to access objects through this connection. source-organization-id: type: string examples: - org_ABC123 description: The organization that created and owns this connection. created-at: format: date-time examples: - '2018-06-01T00:00:00.000Z' type: string description: The date and time when this connection was created updated-at: format: date-time examples: - '2018-06-01T00:00:00.000Z' type: string description: The date and time when this connection was last updated type: object relationships: type: object additionalProperties: false properties: creator: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: id: examples: - user_ABC123 - api_ABC123 type: string type: x-polymorphic: true type: string examples: - user - api-key description: The type of the creator entity required: - id - type required: - data source-data-base: x-inheritable: true type: object properties: type: type: string x-polymorphic: true description: Discriminator for the source-object type. Subtypes constrain this to a specific value via `const`. id: type: string description: The underlying source object's token. peekable-attributes: type: object additionalProperties: true description: | Bag of source-object attributes exposed to the destination organization per the source organization's PII-share configuration. Each scalar entry (e.g. `status`, `country-code`, `id-class`) is a `{visibility, value}` wrapper; see `source-data-peekable-attribute.yaml`. Inquiry, Account, and Txn subtypes additionally expose a nested `fields` sub-bucket containing standard and custom user-space fields (e.g. `name-first`, `birthdate`, org-defined fields); verification subtypes do not. The source object's `status` (when applicable to the subtype) appears here as a peekable attribute, not as a top-level scalar. Entries stripped entirely by the configuration are omitted from the bag. The concrete shape — including which subtypes expose `fields` — is declared per-subtype. required: - type - id - peekable-attributes source-data-peekable-attribute: type: object description: | Wrapper for a single peekable attribute. `visibility` discriminates between two cases: - `full`: the source organization's PII-share configuration exposes the attribute's value; `value` holds the raw value (any JSON type). - `presence`: the source organization exposes only the attribute's presence; `value` is a boolean indicating whether the underlying field has a non-null value on the source. Integrators should branch on `visibility` first, then read `value` accordingly. unevaluatedProperties: false oneOf: - type: object additionalProperties: false properties: visibility: type: string const: full value: description: Raw attribute value as exposed by the source organization. Any JSON type. additionalProperties: true required: - visibility - value - type: object additionalProperties: false properties: visibility: type: string const: presence value: type: boolean description: True if the underlying field on the source has a non-null value; false if it is null. required: - visibility - value source-data-verification-database: title: Database Verification Source Data description: | PII-filtered snapshot of a Database verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows — see `Verification::Database` in the share-token PII filter for the current allowlist. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/database id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-verification-phone-number: title: Phone Number Verification Source Data description: | PII-filtered snapshot of a Phone Number verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows — see `Verification::PhoneNumber` in the share-token PII filter for the current allowlist. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/phone-number id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-verification-email-address: title: Email Address Verification Source Data description: | PII-filtered snapshot of an Email Address verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows — see `Verification::EmailAddress` in the share-token PII filter for the current allowlist. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/email-address id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-verification-government-id: title: Government ID Verification Source Data description: | PII-filtered snapshot of a Government ID verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/government-id id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-verification-selfie: title: Selfie Verification Source Data description: | PII-filtered snapshot of a Selfie verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/selfie id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-verification-document: title: Document Verification Source Data description: | PII-filtered snapshot of a Document verification. The `peekable-attributes` bag carries whichever PII-filtered scalar attributes the source organization's configuration allows. Verification subtypes do not expose a nested `fields` sub-bucket. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/verification/document id: type: string examples: - ver_ABC123 peekable-attributes: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-account: title: Account Source Data description: | PII-filtered snapshot of an Account source object. Carries the account's filtered scalar attributes under `peekable-attributes`, and the account's standard and custom user-space fields under `peekable-attributes.fields`. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/account id: type: string examples: - act_ABC123 peekable-attributes: type: object properties: fields: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' description: | Nested bag of standard and custom user-space fields (e.g. `name-first`, `name-last`, org-defined fields). Each entry is a `{visibility, value}` wrapper. The set of keys varies by the account type and by the source organization's PII-share configuration; clients should handle unknown keys defensively. additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data-related-object: type: object discriminator: propertyName: type mapping: connect/source-data/verification/database: '#/components/schemas/source-data-verification-database' connect/source-data/verification/phone-number: '#/components/schemas/source-data-verification-phone-number' connect/source-data/verification/email-address: '#/components/schemas/source-data-verification-email-address' connect/source-data/verification/government-id: '#/components/schemas/source-data-verification-government-id' connect/source-data/verification/selfie: '#/components/schemas/source-data-verification-selfie' connect/source-data/verification/document: '#/components/schemas/source-data-verification-document' connect/source-data/account: '#/components/schemas/source-data-account' oneOf: - $ref: '#/components/schemas/source-data-verification-database' - $ref: '#/components/schemas/source-data-verification-phone-number' - $ref: '#/components/schemas/source-data-verification-email-address' - $ref: '#/components/schemas/source-data-verification-government-id' - $ref: '#/components/schemas/source-data-verification-selfie' - $ref: '#/components/schemas/source-data-verification-document' - $ref: '#/components/schemas/source-data-account' source-data-inquiry: title: Inquiry Source Data description: | PII-filtered snapshot of an Inquiry source object. Carries the inquiry's filtered scalar attributes under `peekable-attributes`, the inquiry's standard and custom user-space fields under `peekable-attributes.fields`, and filtered snapshots of related source objects (verifications, accounts, etc.) inline under `related-objects`. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/inquiry id: type: string examples: - inq_ABC123 peekable-attributes: type: object properties: fields: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' description: | Nested bag of standard and custom user-space fields (e.g. `name-first`, `birthdate`, org-defined fields). Each entry is a `{visibility, value}` wrapper. The set of keys varies by the inquiry template and by the source organization's PII-share configuration; clients should handle unknown keys defensively. additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' related-objects: type: array description: | Filtered snapshots of source objects related to this inquiry (e.g. attached verifications, the linked account). Each entry is itself a source-data envelope discriminated by its specific subtype. items: $ref: '#/components/schemas/source-data-related-object' source-data-txn: title: Txn Source Data description: | PII-filtered snapshot of a Txn source object. Carries the txn's filtered scalar attributes under `peekable-attributes`, and the txn's standard and custom user-space fields under `peekable-attributes.fields`. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data-base' - type: object properties: type: type: string const: connect/source-data/txn id: type: string examples: - txn_ABC123 peekable-attributes: type: object properties: fields: type: object additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' description: | Nested bag of standard and custom user-space fields (e.g. `amount`, org-defined fields). Each entry is a `{visibility, value}` wrapper. The set of keys varies by the txn type and by the source organization's PII-share configuration; clients should handle unknown keys defensively. additionalProperties: $ref: '#/components/schemas/source-data-peekable-attribute' source-data: type: object description: A PII-filtered snapshot of a Share Token's source object. `type` discriminates the underlying source-object type and dispatches to the matching per-subclass schema; see each subschema for shape details. discriminator: propertyName: type mapping: connect/source-data/inquiry: '#/components/schemas/source-data-inquiry' connect/source-data/verification/database: '#/components/schemas/source-data-verification-database' connect/source-data/verification/phone-number: '#/components/schemas/source-data-verification-phone-number' connect/source-data/verification/email-address: '#/components/schemas/source-data-verification-email-address' connect/source-data/account: '#/components/schemas/source-data-account' connect/source-data/txn: '#/components/schemas/source-data-txn' oneOf: - $ref: '#/components/schemas/source-data-inquiry' - $ref: '#/components/schemas/source-data-verification-database' - $ref: '#/components/schemas/source-data-verification-phone-number' - $ref: '#/components/schemas/source-data-verification-email-address' - $ref: '#/components/schemas/source-data-account' - $ref: '#/components/schemas/source-data-txn' connect-share-token: type: object additionalProperties: false description: A Share Token resource. The specific attributes and relationships included may vary based on the requesting organization's context. properties: type: const: connect/share-token type: string id: examples: - cnst_ABC123 type: string attributes: type: object additionalProperties: false properties: status: type: string description: 'The status of the share token. One of `created`, `pending`, `redeemed`, `expired`, or `failed`.' examples: - created - pending - redeemed - expired - failed direction: type: string description: Whether this share token is outbound (your organization is the source) or inbound (your organization is the destination). One of `outbound` or `inbound`. examples: - outbound - inbound created-at: type: string format: date-time description: When this share token was created examples: - '2023-09-21T18:29:40.000Z' updated-at: type: string format: date-time description: When this share token was last updated examples: - '2023-09-21T18:29:40.000Z' pending-at: type: - string - 'null' format: date-time description: When this share token started processing examples: - '2023-09-21T18:35:20.000Z' - null redeemed-at: type: - string - 'null' format: date-time description: When this share token was redeemed examples: - '2023-09-21T18:30:15.000Z' - null expires-at: type: - string - 'null' format: date-time description: When this share token expires examples: - '2023-09-22T18:29:40.000Z' - null failed-at: type: - string - 'null' format: date-time description: When this share token failed examples: - '2023-09-21T18:35:20.000Z' - null failure-reason: type: - string - 'null' description: 'The reason the share token failed, if applicable. One of `source_not_found`, `source_redacted`, `import_failed`, or `unrecoverable_error`.' examples: - source_not_found - null redeem-mode: type: - string - 'null' description: | How this Share Token was redeemed. Set to `hydrate` when `destination-id` is provided or `clone` when `destination-id` is omitted. Null until redemption is initiated. examples: - clone - hydrate - null source-data: description: | PII-filtered snapshot of the share token's source object. Present only when `peek-source-data=true` was passed on the show endpoint, the caller is the destination organization, and the destination organization has access to the source data peek capability. Omitted from list responses. unevaluatedProperties: false allOf: - $ref: '#/components/schemas/source-data' relationships: type: object additionalProperties: false properties: connection: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string const: connect/connection id: type: string examples: - cxn_ABC123 creator: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string x-polymorphic: true examples: - user - api-key id: type: string examples: - user_ABC123 - api_DEF456 source: type: object additionalProperties: false description: The object from which the shared data originated. properties: data: type: object additionalProperties: false properties: type: type: string x-polymorphic: true examples: - account - inquiry - txn - verification id: type: string examples: - act_ABC123 - inq_DEF456 - txn_GHI789 destination: type: object additionalProperties: false description: | The destination object associated with redemption. For hydration, this is the object specified by `destination-id`. For cloning, no destination is set until Persona creates the destination object. properties: data: type: - object - 'null' additionalProperties: false properties: type: type: string x-polymorphic: true examples: - account - inquiry - txn - verification/database id: type: string examples: - act_ABC123 - inq_DEF456 - txn_GHI789 api-log: type: object additionalProperties: false description: An API Log object properties: type: type: string const: api-log id: type: string examples: - req_prM3gdSL6ciwGjSjj4aXgKJT attributes: type: object additionalProperties: false properties: request: type: object additionalProperties: false properties: method: type: string examples: - GET path: type: string examples: - /api/v1/api-keys headers: type: object additionalProperties: false properties: Accept: type: string examples: - application/json Authorization: type: string description: A sanitized version of the request's Authorization header. examples: - '****-****-************' Host: type: string examples: - withpersona.com Persona-Version: type: string examples: - '2023-01-05, 2023-01-05' User-Agent: type: string examples: - 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36' get-params: type: object description: The GET params of the request. Schema depends on the API called. additionalProperties: true post-params: type: object description: The POST params of the request. Schema depends on the API called. additionalProperties: true ip-address: type: string examples: - 44.203.11.87 response: type: object additionalProperties: false properties: status: type: integer format: int32 examples: - 200 headers: type: object additionalProperties: false properties: Persona-Host: type: string examples: - us-central1 persona-web-web-77b874ff88-rrdk9 53e23b240 Cache-Control: type: string examples: - 'no-cache, no-store, max-age=0, must-revalidate' Pragma: type: string examples: - no-cache Expires: type: string examples: - 'Fri, 01 Jan 1990 00:00:00 GMT' RateLimit-Limit: type: integer format: int32 examples: - 300 RateLimit-Remaining: type: integer format: int32 examples: - 299 RateLimit-Reset: type: integer format: int32 examples: - 60 Quota-Limit: type: integer format: int32 examples: - 1000 Quota-Remaining: type: integer format: int32 examples: - 998 Quota-Reset: type: integer format: int32 examples: - 31 Request-Id: type: string examples: - req_prM3gdSL6ciwGjSjj4aXgKJT Content-Type: type: string examples: - application/json; charset=utf-8 Vary: type: string examples: - Accept created-at: type: string format: date-time examples: - '2023-09-26T06:31:43.909+00:00' redacted-at: type: - string - 'null' format: date-time examples: - '2026-05-28T18:34:17.000Z' case-template: type: object additionalProperties: false description: A Case Template object properties: type: type: string const: case-template id: type: string description: Unique identifier for the Case Template examples: - ctmpl_yd2urRmjaCWcSSxqTSHvUcsn attributes: type: object additionalProperties: false properties: status: description: |- Possible values: - active - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. examples: - active type: string name: type: string resolutions: type: array items: type: string examples: - - Approved - Declined created-at: type: string format: date-time description: The time the template was created examples: - '2021-03-25T07:04:16.667Z' updated-at: type: - string - 'null' format: date-time description: The time the template was last updated examples: - '2021-03-25T07:04:16.667Z' archived-at: type: - string - 'null' format: date-time description: The time the template was archived examples: - '2021-03-25T07:04:16.667Z' field-schemas: type: array items: unevaluatedProperties: false $ref: '#/components/schemas/field-schema' case: type: object additionalProperties: false description: A Case object properties: type: const: case type: string id: examples: - case_gqe7rH38FvxtzhGBQmDBsjkB type: string attributes: type: object additionalProperties: false properties: status: examples: - Open - Pending - Approved - Declined type: string name: examples: - MRR-3 type: string resolution: type: - string - 'null' created-at: examples: - '2021-09-28T05:18:36.200Z' type: string updated-at: examples: - '2021-09-28T05:18:36.200Z' type: - string - 'null' assigned-at: examples: - '2021-09-28T05:18:36.200Z' type: - string - 'null' resolved-at: examples: - '2021-09-28T05:18:36.200Z' type: - string - 'null' redacted-at: examples: - '2021-09-28T05:18:36.200Z' type: - string - 'null' sla-expires-at: examples: - '2021-09-28T07:18:36.200Z' type: - string - 'null' creator-id: examples: - case_creator@withpersona.com type: - string - 'null' creator-type: description: |- Possible values: - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' assignee-id: examples: - case_assignee@withpersona.com type: - string - 'null' assigner-id: examples: - case_assigner@withpersona.com - cap_jE2jrmjCsPQiAq6r4uBiMiMBJZEo - wfr_vKcf7zTQ4fg1RN3hRUUbTnURcVKp type: - string - 'null' assigner-type: description: |- Possible values: - case-assignment-policy - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' resolver-id: examples: - case_resolver@withpersona.com type: - string - 'null' resolver-type: description: |- Possible values: - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' updater-id: examples: - case_updater@withpersona.com type: - string - 'null' updater-type: description: |- Possible values: - case-assignment-policy - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' tags: examples: - - apple - banana - orange type: array fields: description: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Case template for this Case. Keys in `fields` are **not** key inflected. examples: - external-integration-id: ind_123 type: object additionalProperties: true attachments: type: array items: type: object additionalProperties: false properties: filename: examples: - filename.pdf - id.png - abc123.JPEG type: string url: examples: - 'https://files.withpersona.com/abc123.JPEG?access_token=ACCESS_TOKEN' type: string byte-size: examples: - 124917 type: integer relationships: properties: accounts: type: object additionalProperties: false properties: data: items: type: object additionalProperties: false properties: id: examples: - act_9e3yoAUApTRMjgNoPAC7TNtz type: string type: const: account type: string type: array case-comments: type: object additionalProperties: false properties: data: items: type: object additionalProperties: false properties: id: type: string type: const: case-comment type: string type: array case-template: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: id: examples: - ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC type: string type: const: case-template type: string case-queue: type: object additionalProperties: false properties: data: type: - object - 'null' additionalProperties: false properties: id: examples: - cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 type: string type: const: case-queue type: string inquiries: type: object additionalProperties: false properties: data: items: type: object additionalProperties: false properties: id: examples: - inq_KHK4MJCE4QvfocWB2intQ3YE type: string type: const: inquiry type: string type: array reports: properties: data: items: type: object additionalProperties: false properties: id: examples: - rep_7anCsX1R1We3BqRKfsJXsMaw type: string type: x-polymorphic: true examples: - report/watchlist type: string type: array type: object additionalProperties: false verifications: properties: data: items: type: object additionalProperties: false properties: id: examples: - ver_tVJF12ggSgzquQUkxtSVwssA type: string type: x-polymorphic: true examples: - verification/document type: string type: array type: object additionalProperties: false txns: properties: data: items: type: object additionalProperties: false properties: id: examples: - txn_0GKUnDBJi6RJpZhmKdYsM5me type: string type: const: transaction type: string type: array type: object additionalProperties: false type: object additionalProperties: false case-comment: type: object additionalProperties: false description: Comment on a Case object properties: type: type: string const: case-comment id: type: string description: Unique identifier for the Case Comment examples: - cscm_yd2urRmjaCWcSSxqTSHvUcsn attributes: type: object additionalProperties: false properties: message: type: string description: The comment message examples: - This is a case comment created-at: type: string format: date-time description: The time the comment was created examples: - '2021-03-25T07:04:16.667Z' updated-at: type: string format: date-time description: The time the comment was last updated examples: - '2021-03-25T07:04:16.667Z' commenter-id: type: string description: The ID of the user who made the comment examples: - admin@example.com commenter-type: type: string description: The type of the commenter examples: - user case-queue: type: object additionalProperties: false description: A Case Queue object properties: type: type: string const: case-queue id: type: string description: Unique identifier for the Case Queue examples: - cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: type: object additionalProperties: false properties: status: description: |- Possible values: - active - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. examples: - active type: string name: type: string created-at: type: string format: date-time description: The time the queue was created examples: - '2021-03-25T07:04:16.667Z' updated-at: type: - string - 'null' format: date-time description: The time the queue was last updated examples: - '2021-03-25T07:04:16.667Z' archived-at: type: - string - 'null' format: date-time description: The time the queue was archived examples: - '2021-03-25T07:04:16.667Z' inquiry: type: object additionalProperties: false description: An Inquiry object properties: type: const: inquiry type: string id: examples: - inq_5FrMN7NAGgFdGGysCDd7DaBW type: string attributes: properties: status: description: |- The status of the Inquiry Possible values: - created - pending - completed - expired - failed - needs_review - approved - declined Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string reference-id: examples: - ABC-123 type: - string - 'null' note: examples: - A helpful note type: - string - 'null' behaviors: description: |- Risk signals surfaced to enterprise customers. Specific keys are not enumerated in the public spec and may be added or removed over time. Contact your Persona account team for more information. additionalProperties: true type: - object - 'null' tags: type: array items: type: - string - 'null' creator: examples: - jane@doe.com type: string reviewer-comment: examples: - This is a comment for this inquiry! type: - string - 'null' created-at: examples: - '2023-03-28T18:34:32.000Z' type: string format: date-time updated-at: examples: - '2023-03-28T18:34:32.000Z' type: string format: date-time started-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time expires-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time completed-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time failed-at: description: Set when an Inquiry transitions to `failed`. Not typically set on `declined` Inquiries — those carry `completed-at` from the transition that preceded the decision. examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time marked-for-review-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time decisioned-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time expired-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time redacted-at: examples: - '2023-03-28T18:35:10.000Z' type: - string - 'null' format: date-time previous-step-name: examples: - verification_government_id - start type: - string - 'null' next-step-name: examples: - retry_verification_government_id type: - string - 'null' fields: description: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Inquiry template for this Inquiry. Keys in `fields` are **not** key inflected. properties: name-first: properties: type: examples: - string type: string value: examples: - Jane type: - string - 'null' additionalProperties: false type: object name-middle: properties: type: examples: - string type: string value: examples: - Marie type: - string - 'null' additionalProperties: false type: object name-last: properties: type: examples: - string type: string value: examples: - Doe type: - string - 'null' additionalProperties: false type: object address-street-1: properties: type: examples: - string type: string value: examples: - 123 Main St type: - string - 'null' additionalProperties: false type: object address-street-2: properties: type: examples: - string type: string value: examples: - Apt type: - string - 'null' additionalProperties: false type: object address-city: description: City of residence address. Not all international addresses use this attribute. properties: type: examples: - string type: string value: examples: - San Francisco type: - string - 'null' additionalProperties: false type: object address-subdivision: description: 'State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.' properties: type: examples: - string type: string value: examples: - California type: - string - 'null' additionalProperties: false type: object address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. properties: type: examples: - string type: string value: examples: - '94111' type: - string - 'null' additionalProperties: false type: object address-country-code: description: ISO 3166-1 alpha 2 country code. properties: type: examples: - string type: string value: examples: - US type: - string - 'null' additionalProperties: false type: object birthdate: properties: type: examples: - date type: string value: description: Date of birth in YYYY-MM-DD format examples: - '1991-10-07' type: - string - 'null' additionalProperties: false type: object email-address: properties: type: examples: - string type: string value: examples: - test@emailaddress.com type: - string - 'null' additionalProperties: false type: object phone-number: properties: type: examples: - string type: string value: examples: - 111-222-3333 type: - string - 'null' additionalProperties: false type: object identification-number: properties: type: examples: - string type: string value: examples: - YL123456 type: - string - 'null' additionalProperties: false type: object additionalProperties: true type: object required: - status - reference-id - note - behaviors - tags - creator - reviewer-comment - created-at - updated-at - started-at - expires-at - completed-at - failed-at - marked-for-review-at - decisioned-at - expired-at - redacted-at - previous-step-name - next-step-name - fields additionalProperties: false type: object relationships: additionalProperties: false type: object properties: account: properties: data: properties: id: examples: - act_ABC123 type: string type: const: account type: string type: - object - 'null' additionalProperties: false type: object documents: properties: data: items: properties: id: examples: - doc_ABC123 type: string type: x-polymorphic: true examples: - document/government-id type: string additionalProperties: false type: object type: array additionalProperties: false type: object template: description: Only present for Legacy 2.0 inquiries properties: data: properties: id: examples: - tmpl_ABC123 type: string type: const: template type: string type: - object - 'null' additionalProperties: false type: object inquiry-template: description: Only present for Dynamic Flow inquiries properties: data: properties: id: examples: - itmpl_ABC123 type: string type: const: inquiry-template type: string type: - object - 'null' additionalProperties: false type: object inquiry-template-version: description: Only present for Dynamic Flow inquiries properties: data: properties: id: examples: - itmplv_ABC123 type: string type: const: inquiry-template-version type: string type: - object - 'null' additionalProperties: false type: object reports: properties: data: items: properties: id: examples: - rep_ABC123 type: string type: x-polymorphic: true examples: - report/address-lookup - report/watchlist type: string additionalProperties: false type: object type: array additionalProperties: false type: object transaction: properties: data: properties: id: examples: - txn_ABC123 type: string type: const: transaction type: string type: - object - 'null' additionalProperties: false type: object reviewer: description: |- Actor that decisioned the Inquiry. `data` is `null` while the Inquiry has not been decisioned. Once decisioned, `data.type` and `data.id` identify the reviewer: - `user` + `user_*` — a dashboard user reviewed and decisioned the Inquiry. - `workflow` + `wfl_*` — Workflows 1.0 auto-decisioned the Inquiry. - `workflow-run` + `wfr_*` — Workflows 2.0 auto-decisioned the Inquiry (the dominant case in automation-heavy organizations). properties: data: properties: id: examples: - wfr_M7vXNqRpL3kBzW4tYcHdJgFs type: string type: x-polymorphic: true examples: - user - workflow - workflow-run type: string description: 'One of `user`, `workflow`, or `workflow-run`.' type: - object - 'null' additionalProperties: false type: object selfies: properties: data: items: properties: id: examples: - self_ABC123 type: string type: x-polymorphic: true examples: - selfie/profile-and-center - selfie/center-only - selfie/configurable-poses type: string additionalProperties: false type: object type: array additionalProperties: false type: object sessions: properties: data: items: properties: id: examples: - iqse_ABC123 type: string type: const: inquiry-session type: string additionalProperties: false type: object type: array additionalProperties: false type: object verifications: properties: data: items: properties: id: examples: - ver_ABC123 type: string type: x-polymorphic: true examples: - verification/government-id type: string additionalProperties: false type: object type: array additionalProperties: false type: object required: - type - id - attributes - relationships report-shared-attributes: x-inheritable: true type: object properties: status: type: string description: |- The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. created-at: type: string description: The time the report was created in ISO 8601 format example: '2020-04-12T05:08:51.000Z' completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format example: '2020-04-13T00:23:57.000Z' redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format example: null report-template-version-name: type: string description: The name of the report template version used for this report example: v1 has-match: type: boolean description: Whether or not the report matched is-continuous: type: boolean description: Whether or not this report has been run more than once is-recurring: type: boolean description: Whether or not this report is scheduled to run in the future tags: type: array description: Tags on the report items: type: string example: tag1 report-shared-relationships: type: object additionalProperties: false description: Other Persona objects related to the report properties: inquiry: type: object additionalProperties: false description: The inquiry linked to the report properties: data: type: - object - 'null' additionalProperties: false properties: id: example: inq_KHK4MJCE4QvfocWB2intQ3YE type: string type: const: inquiry type: string account: type: object additionalProperties: false description: The account linked to the report properties: data: type: - object - 'null' additionalProperties: false properties: id: example: act_9e3yoAUApTRMjgNoPAC7TNtz type: string type: const: account type: string transaction: type: object additionalProperties: false description: The transaction linked to the report properties: data: type: - object - 'null' additionalProperties: false properties: id: example: txn_9e3yoAUApTRMjgNoPAC7TNtz type: string type: const: transaction type: string report-template: type: object additionalProperties: false description: The report template used to create this report properties: data: type: object additionalProperties: false properties: id: example: rptp_tQumELV14h7Vh9Qqm8Ytm5K1 type: string type: x-polymorphic: true example: report-template/watchlist type: string report-address-lookup: title: Address Lookup Report description: An Address Lookup Report type: object additionalProperties: false properties: type: type: string const: report/address-lookup id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: addressee: description: The name of an individual at this location. type: - string - 'null' example: Joe Doe address-street-1: description: 'Address line 1 (e.g., street, PO Box, or company name).' type: - string - 'null' example: 1 Infinite Loop address-street-2: description: 'Address line 2 (e.g., apartment, suite, unit, or building).' type: - string - 'null' address-city: description: City type: - string - 'null' example: Cupertino address-subdivision: description: 'Subnational division of a country, such as a state or province.' type: - string - 'null' example: California address-postal-code: description: ZIP or postal code. type: - string - 'null' example: '95014' resolved-addressee: type: - string - 'null' resolved-address-street-1: type: - string - 'null' example: 1 Infinite Loop resolved-address-street-2: type: - string - 'null' resolved-address-city: type: - string - 'null' example: Cupertino resolved-address-subdivision: type: - string - 'null' example: CA resolved-address-postal-code: type: - string - 'null' example: '95014' metadata-record-type: type: - string - 'null' example: S metadata-zip-type: type: - string - 'null' example: Standard metadata-county-fips: type: - string - 'null' example: '06085' metadata-county-name: type: - string - 'null' example: Santa Clara metadata-carrier-route: type: - string - 'null' example: C067 metadata-carrier-route-type: type: - string - 'null' example: CityRoute metadata-congressional-district: type: - string - 'null' example: '17' metadata-building-default-indicator: type: - string - 'null' metadata-residential-delivery-indicator: type: - string - 'null' example: Commercial metadata-latitude: type: - number - 'null' example: 37.3331 metadata-longitude: type: - number - 'null' example: -122.02889 metadata-precision: type: - string - 'null' example: Zip9 metadata-time-zone: type: - string - 'null' example: Pacific metadata-utc-offset: type: - integer - 'null' example: -8 metadata-obeys-daylight-savings: type: - boolean - 'null' example: true analysis-dpv-match-code: type: - string - 'null' example: 'Y' analysis-dpv-match-code-decoded: type: - string - 'null' example: Confirmed analysis-dpv-footnotes: type: - array - 'null' items: type: string example: AA analysis-dpv-footnotes-decoded: type: - array - 'null' items: type: string example: 'Street name, city, state, and ZIP are all valid.' analysis-dpv-cmra: type: - string - 'null' example: 'N' analysis-dpv-vacant: type: - string - 'null' example: 'N' analysis-active: type: - string - 'null' example: 'Y' analysis-footnotes: type: - array - 'null' items: type: string analysis-footnotes-decoded: type: - array - 'null' items: type: string analysis-lacs-link-code: type: - string - 'null' analysis-lacs-link-code-decoded: type: - string - 'null' analysis-lacs-link-indicator: type: - string - 'null' analysis-lacs-link-indicator-decoded: type: - string - 'null' analysis-suite-link-match: type: - string - 'null' metadata-ews-match: type: - string - 'null' error-message: type: - string - 'null' relationships: $ref: '#/components/schemas/report-shared-relationships' report-adverse-media: title: Adverse Media Report description: An Adverse Media Report type: object additionalProperties: false properties: type: type: string const: report/adverse-media id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: name-first: type: - string - 'null' description: The input first name of the search individual example: Joe name-middle: type: - string - 'null' description: The input middle name of the search individual example: 'N' name-last: type: - string - 'null' description: The input last name of the search individual example: Doe term: type: string description: The input combined term used for searching (first + middle + last name) example: Joe N Doe birthdate-year: type: - integer - 'null' example: 1992 birthdate: type: - string - 'null' pattern: '^\d{4}-\d{2}-\d{2}$' description: The input DOB in YYYY-MM-DD format example: '1991-10-07' country-code: type: - string - 'null' description: The input search country in alpha2 format example: US related-sources: description: The sources that matched for the search type: array items: type: object additionalProperties: false properties: akas: type: array items: type: - string - 'null' example: Joey Doey birthdates: type: array items: type: - string - 'null' match-types: type: array items: type: string example: name_exact media: type: array items: type: object additionalProperties: false properties: date: type: - string - 'null' format: date example: '2022-11-12' snippet: type: string description: Snippet from matched article example: Joe Doe was ordered to jail on Friday after a judge revoked his bail for alleged witness tampering. url: type: string description: URL of matched article example: 'https://www.example.com/' title: type: string description: Title of matched article example: Joe Doe ordered to jail name: type: string example: Joe Doe sources: type: array items: type: object additionalProperties: false properties: country-codes: type: array items: type: string example: FR name: type: string example: Adverse Media types: type: array items: type: string example: adverse-media-v2-other-minor entity-id: type: string example: FV933QHOUDG73V8 ignore-list-media: type: object additionalProperties: true ignore-list-entity: type: array items: type: object additionalProperties: true relationships: $ref: '#/components/schemas/report-shared-relationships' report-business-adverse-media: title: Business Adverse Media Report description: A report detailing adverse media findings for a business entity. type: object additionalProperties: false properties: type: type: string const: report/business-adverse-media id: type: string description: A unique identifier for the report. examples: - rep_9XxZsPaNcroBKmJNHBlYDLOp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: term: type: string description: 'The search term for the adverse media report, typically the name of the business.' example: Acme Corporation related-sources: description: The sources that matched for the search type: array items: type: object additionalProperties: false properties: akas: type: array items: type: string example: Joey Doey birthdates: type: array items: type: - string - 'null' match_types: type: array items: type: string example: name_exact media: type: array items: type: object additionalProperties: false properties: date: type: string format: date example: '2022-11-12' snippet: type: string description: Snippet from matched article example: Joe Doe was ordered to jail on Friday after a judge revoked his bail for alleged witness tampering. url: type: string description: URL of matched article example: 'https://www.example.com/' title: type: string description: Title of matched article example: Joe Doe ordered to jail name: type: string example: Joe Doe sources: type: array items: type: object additionalProperties: false properties: country_codes: type: array items: type: string example: FR name: type: string example: Adverse Media token: type: string types: type: array items: type: string example: adverse-media-v2-other-minor id: type: string example: FV933QHOUDG73V8 query: type: object additionalProperties: false properties: business-name: type: string description: The name of the business being queried. examples: - Acme Corporation address-street: type: string description: The street address of the business being queried. examples: - 123 Elm Street address-city: type: string description: The city in which the business is located. examples: - Anytown address-state: type: string description: Subnational division of a country (such as a state or province) where the business is located. examples: - CA address-country: type: string description: The country in which the business is located. examples: - US incorporation-date: type: string format: date description: The date the business was incorporated. examples: - '2001-04-15' result: type: object additionalProperties: false properties: adverse-media: type: array description: A list of adverse media articles related to the business. items: type: object additionalProperties: false properties: title: type: string description: The title of the media article. examples: - Acme Corporation Accused of Environmental Violations url: type: string format: uri description: The URL to the full media article. examples: - 'https://news.example.com/business/acme-environmental-violations' date: type: string format: date description: The publication date of the media article. examples: - '2023-03-01' relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes report-business-associated-persons: title: Business Associated Persons Report description: A report containing information about the Associated Persons of a business entity type: object additionalProperties: false properties: type: type: string const: report/business-associated-persons id: type: string description: A unique identifier for the report. examples: - rep_9XxZsPaNcroBKmJNHBlYDLOp attributes: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: address-country-code: type: string description: The country code used for the search required: - address-country-code associated-persons: type: array description: List of persons associated with the business items: type: object additionalProperties: false properties: names: type: array description: Names associated with the person items: type: object additionalProperties: false properties: value: type: string description: The person's name required: - value positions: type: array description: Positions held by the person items: type: object additionalProperties: false properties: value: type: string description: The position title required: - value required: - names - positions ownership-information: type: object additionalProperties: false description: Ownership information for the business properties: owners: type: array description: List of owners. Empty when no ownership data is available. items: type: object additionalProperties: false properties: type: type: - string - 'null' description: 'Whether the owner is a person or a business. One of `person` or `business`, or null when the source does not specify.' name: type: - string - 'null' description: The owner's name birthdate: type: - string - 'null' description: 'ISO 8601 partial date (YYYY-MM-DD, YYYY-MM, or YYYY), depending on the precision the source provided' address: type: - object - 'null' additionalProperties: false properties: street-1: type: - string - 'null' street-2: type: - string - 'null' city: type: - string - 'null' subdivision: type: - string - 'null' postal-code: type: - string - 'null' country-code: type: - string - 'null' roles: type: array description: The owner's roles in the business items: type: object additionalProperties: false properties: description: type: - string - 'null' description: Human-readable description of the role data: type: - object - 'null' additionalProperties: true description: Source-specific structured details about the role required: - type - name - birthdate - address - roles required: - owners required: - query - associated-persons - ownership-information relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes report-business-registrations-lookup: title: Business Registrations Lookup Report description: A report containing business registration information from official sources type: object additionalProperties: false properties: type: type: string const: report/business-registrations-lookup id: type: string description: A unique identifier for the report. examples: - rep_9XxZsPaNcroBKmJNHBlYDLOp attributes: type: object unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: address-country-code: type: string description: The country code used for the search required: - address-country-code result: type: object additionalProperties: false properties: business-name: type: string description: The name of the business legal-entity-type: type: string description: The type of legal entity formation-country: type: string description: The country where the business was formed formation-subdivision: type: string description: The subdivision where the business was formed formation-date: type: string description: The date the business was formed format: date registry-records: type: array description: List of business registration records items: type: object additionalProperties: false properties: type: type: string description: The type of registry record example: us_secretary_of_state issue-date: type: string format: date description: Date the registration was issued issuing-authority: type: string description: Authority that issued the registration file-number: type: string description: Official registration number registered-name: type: string description: Official registered business name registration-type: type: string description: 'Type of registration (e.g. domestic, foreign)' status: type: object additionalProperties: false properties: raw: type: string description: Status on the registry record standardized: type: string description: Normalized status value registration-state: type: string description: State/subdivision where business is registered addresses: type: array items: type: object additionalProperties: false properties: type: type: string description: Type of address street-1: type: string description: Street address street-2: type: string description: Street address city: type: string description: City subdivision: type: string description: State/province/region postal-code: type: string description: Postal code country-code: type: string description: Country code required: - query - result relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes report-business-lookup: title: Business Lookup Report description: A Business Lookup Report type: object additionalProperties: false properties: type: type: string const: report/business-lookup id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: business-name: type: string example: Coffee Shop phone-number: type: - string - 'null' example: '+11234567890' website: type: - string - 'null' example: 'https://website.com' ein: type: - string - 'null' address-street-1: type: string example: 123 Funky St address-street-2: type: - string - 'null' address-city: type: string example: Funkyville address-subdivision: type: string description: Subnational division of a country such as a US state. example: CA address-postal-code: type: string example: '12345' address-country-code: type: - string - 'null' example: US incorporation-state: type: - string - 'null' example: CA associated-people: type: array items: type: object additionalProperties: false properties: name-first: type: - string - 'null' example: John name-last: type: - string - 'null' example: Doe name-full: type: - string - 'null' example: John Doe titles: type: array items: type: - string - 'null' example: CEO result: type: - object - 'null' properties: name: type: string example: 'Coffee Shop, LLC DBA Coffee Shop' aliases: type: array items: type: string example: COFFEE SHOP description: type: - string - 'null' legal-status: type: - string - 'null' example: unknown legal-entity-type: type: string example: LLC date-of-incorporation: type: - object - 'null' properties: granularity: type: string example: year day: type: - string - 'null' month: type: - string - 'null' year: type: - string - 'null' example: '2013' industry-classifications: type: array items: type: object additionalProperties: false properties: code: type: string example: '789456' title: type: string example: Snack and Nonalcoholic Beverage Bars type: type: string example: NAICS_2017 identifiers: type: array items: type: object additionalProperties: false properties: state: type: string example: CA country: type: string example: US issue-date: type: string format: date example: '2013-05-12' file-number: type: string example: '454894615645' type: type: string example: us_state_registration_number addresses: type: array items: type: object additionalProperties: false properties: street-1: type: string example: 123 FUNKY STREET street-2: type: - string - 'null' city: type: string example: SAN FRANCISCO subdivision: type: string example: CA postal-code: type: string example: '94000' delivery-point-barcode: type: - string - 'null' primary-number: type: - string - 'null' street-name: type: - string - 'null' latitude: type: - string - 'null' longitude: type: - string - 'null' precision: type: - string - 'null' type: type: string example: registered_agent_address status: type: string example: active addresses: type: array items: type: object additionalProperties: false properties: street-1: type: string example: 123 Funky St street-2: type: - string - 'null' city: type: string example: Funkyville subdivision: type: string example: CA postal-code: type: string example: 12345-1234 websites: type: array items: type: string example: 'https://website.com/' phone-numbers: type: array items: type: string example: '+11234567890' agents: type: array items: type: object additionalProperties: false properties: name-full: type: string example: JOHN DOE officers: type: array items: type: object additionalProperties: false properties: name-full: type: string example: JOHN DOE name-first: type: - string - 'null' example: JOHN name-last: type: - string - 'null' example: DOE titles: type: array items: type: string example: CONTACT NAME headcount: type: - string - 'null' sources: type: array items: type: object additionalProperties: false properties: name: type: string example: RESTAURANT INSPECTIONS match-status-strength: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-business-name: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-address: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-address-street: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-address-city: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-address-postal-code: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-address-subdivision: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-phone-number: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-ein: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-associated-person: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. match-status-website: type: - string - 'null' description: |- Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. relationships: $ref: '#/components/schemas/report-shared-relationships' report-business-watchlist: title: Business Watchlist Report description: A Business Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/business-watchlist id: type: string description: The ID of the report examples: - rep_8YZjQaNjXpZLKrJNHBkYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: matched-lists: type: array description: A list of slugs identifying the lists on which matches were found. items: type: string sanction-list: type: array description: Detailed information about matches found on sanction lists. items: type: object additionalProperties: false properties: name: type: string description: The name of the sanction list. url: type: string format: uri description: A URL with more information about the list. fitness-probity-list: type: array description: Detailed information about matches found on fitness and probity lists. items: type: object additionalProperties: false properties: name: type: string description: The name of the fitness and probity list. url: type: string format: uri description: A URL with more information about the list. warning-list: type: array description: Detailed information about matches found on warning lists. items: type: object additionalProperties: false properties: name: type: string description: The name of the warning list. url: type: string format: uri description: A URL with more information about the list. relationships: $ref: '#/components/schemas/report-shared-relationships' report-crypto-address-watchlist: title: Crypto Address Watchlist Report description: A Crypto Address Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/crypto-address-watchlist id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: crypto-address: type: string example: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 result: type: - array - 'null' items: type: object additionalProperties: false properties: name: type: string example: US - OFAC - Specially Designated Nationals and Blocked Persons (SDN) url: type: string example: 'https://home.treasury.gov/policy-issues/financial-sanctions/specially-designated-nationals-and-blocked-persons-list-sdn-human-readable-lists' list-type: type: string example: sanction slug: type: string example: us-ofac-specially-designated-nationals-and-blocked-persons flag-code: type: string example: US entities: type: array items: type: object additionalProperties: false properties: name: type: string example: 'ANDREYEV, Anton Nikolaeyvich' alias-type: type: string example: primary_name birthdates: type: array items: type: object additionalProperties: false properties: day: type: string pattern: '^\d{2}$' example: '03' year: type: string pattern: '^\d{4}$' example: '1985' month: type: string pattern: '^\d{2}$' example: '03' granularity: type: string example: day crypto-addresses: type: array items: type: object additionalProperties: false properties: type: type: string example: XBT address: type: string example: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 relationships: $ref: '#/components/schemas/report-shared-relationships' report-email-address: title: Email Address Report description: An Email Address Report type: object additionalProperties: false properties: type: type: string const: report/email-address id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: email-address: type: string description: The input email address of the search example: example@domain.com email-reputation: type: - string - 'null' description: |- The reputation of the email provided Possible values: - high - medium - low Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. email-reference-count: type: - integer - 'null' description: The number of sources used to determine the reputation (Deprecated) example: 4 email-domain-reputation: type: - string - 'null' deprecated: true description: |- The reputation of the email domain provided (Deprecated) Possible values: - high - medium - low Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. email-first-seen-days: type: - integer - 'null' description: How many days it has ben since the email was first seen in attack (Deprecated) example: 71 email-last-seen-days: type: - integer - 'null' description: How many days it has been since the email was last seen (Deprecated) format: integer example: 250 email-estimated-age-days: type: - integer - 'null' description: The estimated age of the email in days example: 410 email-domain-age-days: type: - integer - 'null' description: The estimated age of the domain in days example: 410 email-credentials-leaked: type: - boolean - 'null' description: Whether the email has ever been detected to have been leaked (Deprecated) example: true email-credentials-leaked-recent: type: - boolean - 'null' description: Whether the email has been recently detected as leaked example: true email-data-breached: type: - boolean - 'null' description: Whether the email was involved in a data breach (Deprecated) example: true email-malicious-activity-detected: type: - boolean - 'null' description: Whether the email has ever been detected for suspected malicious activity (Deprecated) example: true email-malicious-activity-detected-recent: type: - boolean - 'null' description: Whether the email has recently been detected for suspected malicious activity example: true email-is-blocklisted: type: - boolean - 'null' description: Whether the email appears on blocklists (Deprecated) example: true email-is-spam: type: - boolean - 'null' description: Whether the email is spam or a spam trap example: true email-is-free-provider: type: - boolean - 'null' description: Whether the email was made with a free provider (Deprecated) example: true email-is-disposable: type: - boolean - 'null' description: Whether the email is one that is disposable or temporary example: true email-is-deliverable: type: - boolean - 'null' description: Whether the email is deliverable example: true email-is-valid-mx: type: - boolean - 'null' description: Whether the domain has a valid MX record example: true email-is-spoofable: type: - boolean - 'null' description: Whether the email can be spoofed. (E.G. not a strict SPF policy or DMARC not enforced. Deprecated) example: true email-is-spf-strict: type: - boolean - 'null' description: Whether there is a sufficiently strict SPF record (Deprecated) example: true email-is-dmarc-enforced: type: - boolean - 'null' description: Whether DMARC is configured correctly and enforced (Deprecated) example: true age-estimated-13-plus: type: - boolean - 'null' description: Whether email address user is 13 or older example: true age-estimated-16-plus: type: - boolean - 'null' description: Whether email address user is 16 or older example: true age-estimated-18-plus: type: - boolean - 'null' description: Whether email address user is 18 or older example: true email-is-suspicious: type: - boolean - 'null' description: Whether the email is suspicious or risky example: true email-domain-exists: type: - boolean - 'null' description: Whether the domain of the email exists example: true email-domain: type: string description: The domain of the email example: gmail.com relationships: $ref: '#/components/schemas/report-shared-relationships' report-phone-risk: title: Phone Risk Report description: A Phone Risk Report type: object additionalProperties: false properties: type: type: string const: report/phone-number id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: phone-number: type: string description: The input phone number of the search example: '+14169671111' phone-type: type: - string - 'null' description: |- Possible values: - FIXED_LINE - MOBILE - PREPAID - TOLL_FREE - VOIP - PAGER - PAYPHONE - INVALID - RESTRICTED_PREMIUM - PERSONAL - VOICEMAIL - OTHER Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. phone-carrier: type: - string - 'null' example: Rogers Communications Canada Inc. phone-city: type: - string - 'null' description: City associated with the phone number location. example: Toronto phone-subdivision: type: - string - 'null' description: State or region associated with the phone number location. example: 'ON' phone-country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code associated with the phone number location. example: CA phone-risk-level: type: - string - 'null' description: Assessment of the phone number's risk (low - high) example: medium-low phone-risk-recommendation: type: - string - 'null' description: |- Possible values: - block - allow - flag Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. phone-risk-score: type: - integer - 'null' description: Risk score out of 1000 format: integer example: 250 phone-risk-sim-swap: type: - string - 'null' description: |- The risk of a fraudulent SIM swap Possible values: - very-low - low - medium - high - N/A Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. relationships: $ref: '#/components/schemas/report-shared-relationships' report-politically-exposed-person: title: Politically Exposed Person Report description: A Politically Exposed Person Report type: object additionalProperties: false properties: type: type: string const: report/politically-exposed-person id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: name-first: type: - string - 'null' description: The input first name of the search individual example: Joe name-middle: type: - string - 'null' description: The input middle name of the search individual example: 'N' name-last: type: - string - 'null' description: The input last name of the search individual example: Doe term: type: string description: The input combined term used for searching (first + middle + last name). Either the name or the term fields are required. example: Joe N Doe birthdate: type: string description: The input DOB in YYYY-MM-DD format example: '1991-10-07' country-code: type: - string - 'null' description: The input search country in alpha2 format example: US result: type: - array - 'null' items: type: object additionalProperties: false properties: entity-id: type: string example: MV9IPWV13KYS0A9 name: type: string example: Joe Doe birthdates: type: array items: type: string format: date example: '1942-11-20' death-dates: type: array items: type: - string - 'null' locations: type: array items: type: - string - 'null' country: type: string example: United States sex: type: - string - 'null' topics: type: array items: type: string example: PEP description: The applicable categories of the PEP. positions: type: array items: type: object additionalProperties: false properties: pep-class: type: string example: pep-class-1 source-key: type: string example: united-states-head-of-state name: type: string example: President of the United States topics: type: array items: type: string example: Head of government or state description: The applicable categories of the position. start-date: type: - string description: The start date of the position. example: '2021-01-20' end-date: type: - string - 'null' description: The end date of the position. example: '2025-01-20' associates: type: array items: type: object additionalProperties: false properties: name: type: string description: The name of the associate. relationship: type: string description: The relationship of the associate to the individual. topics: type: array items: type: string example: Close associate description: The applicable categories of the associate. affiliations: type: array items: type: object additionalProperties: false properties: source-key: type: string example: north-atlantic-treaty-organisation name: type: string example: North Atlantic Treaty Organization Member Countries Representation related-urls: type: array items: type: object additionalProperties: false properties: source-key: type: string example: internal-data-source name: type: string example: 'https://www.example.org/' images: type: array items: type: - string - 'null' sources: type: object description: A map of the sources that matched by entity additionalProperties: type: object additionalProperties: false properties: url: type: string format: uri description: The URL of the source. name: type: string description: The name of the source. flag-code: type: string description: The flag code of the source country. match-types: type: array items: type: string example: aka-exact pep-type: type: - string - 'null' ignore-list: type: array items: type: object additionalProperties: false properties: ignored-at: type: string format: date-time description: The datetime when the entry was ignored. run-history-completed-at: type: string format: date-time description: The datetime when the run history was completed. match: type: object additionalProperties: false properties: entity-id: type: string description: The entity ID of the match. name: type: string description: The name of the match. birthdates: type: array items: type: string format: date description: The birthdates associated with the match. death-dates: type: array items: type: string format: date description: 'The death dates associated with the match, if applicable.' locations: type: array items: type: string description: The locations associated with the match. country: type: string description: The country associated with the match. sex: type: string description: The sex of the individual in the match. positions: type: array items: type: object additionalProperties: false properties: pep-class: type: string description: The PEP class of the position. source-key: type: string description: The source key of the position. name: type: string description: The name of the position. topics: type: array items: type: string description: The applicable categories of the position. start-date: type: - string - 'null' description: The start date of the position. end-date: type: - string - 'null' description: The end date of the position. associates: type: array items: type: object additionalProperties: false properties: name: type: string description: The name of the associate. relationship: type: string description: The relationship of the associate to the individual. affiliations: type: array items: type: object additionalProperties: false properties: source-key: type: string description: The source key of the affiliation. name: type: string description: The name of the affiliation. related-urls: type: array items: type: object additionalProperties: false properties: source-key: type: string description: The source key for the URL. name: type: string format: uri description: The URL related to the match. images: type: array items: type: string format: uri description: The URLs of images associated with the match. sources: type: object additionalProperties: false properties: url: type: string format: uri description: The URL of the source. name: type: string description: The name of the source. flag-code: type: string description: The flag code of the source country. match-types: type: array items: type: string description: The types of matches found. pep-type: type: string description: The type of politically exposed person. user: type: string description: The user who added the entry to the ignore list. ignore-reason: type: string description: The reason why the entry was added to the ignore list. is-internal: type: boolean description: Indicates if the ignore list entry is internal. relationships: $ref: '#/components/schemas/report-shared-relationships' report-profile: title: Profile Report description: A Profile Report type: object additionalProperties: false properties: type: type: string const: report/profile id: type: string description: The ID of the report examples: - rep_XYZ1234567890ABCDEF attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: name-first: type: - string - 'null' description: Given or first name. examples: - John name-last: type: - string - 'null' description: Family or last name. examples: - Doe birthdate: type: - string - 'null' description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date examples: - '1980-04-12' social-security-number: type: - string - 'null' description: Full social security number. examples: - 123-45-6789 social-security-number-last-4: type: - string - 'null' description: Last 4 digits of social security number. examples: - '6789' address-street-1: type: - string - 'null' description: Primary street address. examples: - 123 Main St address-street-2: type: - string - 'null' description: Secondary street address (if any). examples: - Apt 4 address-city: type: - string - 'null' description: City of residence. examples: - Metropolis address-subdivision: type: - string - 'null' description: State or subdivision of residence. examples: - New York address-subdivision-abbr: type: - string - 'null' description: State or subdivision abbreviation. examples: - NY address-postal-code: type: - string - 'null' description: ZIP or postal code. examples: - '12345' address-postal-code-abbr: type: - string - 'null' description: ZIP or postal code abbreviation (if applicable). phone-number: type: - string - 'null' description: Phone number. examples: - 555-1234 identity-records: type: array description: 'Detailed identity records which passed matching logic, if available.' items: type: object additionalProperties: false properties: names: type: array items: type: object additionalProperties: false properties: name-full: type: string name-first: type: string name-middle: type: string name-last: type: string birthdates: type: array items: type: string addresses: type: array items: type: object additionalProperties: false properties: country-code: type: string street-1: type: string street-2: type: string city: type: string postal-code: type: string longitude: type: number latitude: type: number subdivision: type: string date-first-seen: type: string date-last-seen: type: string social-security-numbers: type: array items: type: string phone-numbers: type: array items: type: string email-addresses: type: array items: type: string deceased: type: boolean deceased-date: type: string drivers-licenses: type: array items: type: object additionalProperties: false properties: number: type: string state: type: string omitted-identity-records: type: array description: 'Detailed identity records which did not pass matching logic, if available.' items: type: object additionalProperties: false properties: names: type: array items: type: object additionalProperties: false properties: name-full: type: string name-first: type: string name-middle: type: string name-last: type: string birthdates: type: array items: type: string addresses: type: array items: type: object additionalProperties: false properties: country-code: type: string street-1: type: string street-2: type: string city: type: string postal-code: type: string longitude: type: number latitude: type: number subdivision: type: string date-first-seen: type: string date-last-seen: type: string social-security-numbers: type: array items: type: string phone-numbers: type: array items: type: string email-addresses: type: array items: type: string deceased: type: boolean deceased-date: type: string drivers-licenses: type: array items: type: object additionalProperties: false properties: number: type: string state: type: string relationships: $ref: '#/components/schemas/report-shared-relationships' report-profile-non-authoritative: title: Profile Non-Authoritative Report description: A Profile Non-Authoritative Report type: object additionalProperties: false properties: type: type: string const: report/profile-non-authoritative id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: - object - 'null' additionalProperties: false properties: name-first: type: - string - 'null' description: The input first name of the search individual example: Joe name-middle: type: - string - 'null' description: The input middle name of the search individual example: 'N' name-last: type: - string - 'null' description: The input last name of the search individual example: Doe address-city: type: - string - 'null' description: The locality of the search individual example: San Francisco address-subdivision: type: - string - 'null' description: The subdivision of the search individual example: CA address-postal-code: type: - string - 'null' description: The postal code of the search individual example: '94016' address-street-1: type: - string - 'null' description: The street address of the search individual example: 455 Fake St address-street-2: type: - string - 'null' description: The address line 2 of the search individual example: Apartment 12 address-country-code: type: - string - 'null' description: The country code of the search individual example: US email-address: type: - string - 'null' description: The email address of the search individual example: address@domain.com phone-number: type: - string - 'null' description: The phone number of the search individual birthdate: type: - string - 'null' description: Date of birth in YYYY-MM-DD format example: '1991-10-07' result: type: - object - 'null' additionalProperties: false properties: name: type: - string - 'null' example: Norman Osborn birthdate: type: - string - 'null' description: Date of birth in YYYY-MM-DD format example: '1991-10-07' emails: type: - array - 'null' items: type: object additionalProperties: false properties: address: type: - string - 'null' example: address@domain.com type: type: - string - 'null' example: professional phone-numbers: type: - array - 'null' items: type: - string location: type: - object - 'null' additionalProperties: false properties: locality: type: - string - 'null' example: san francisco region: type: - string - 'null' example: california country: type: - string - 'null' example: united states continent: type: - string - 'null' example: north america street-address: type: - string - 'null' example: 1234 Funky St address-line-2: type: - string - 'null' example: suite 1670 postal-code: type: - string - 'null' example: '94105' education: type: - array - 'null' items: type: object additionalProperties: false properties: start-date: type: - string - 'null' example: '2017' end-date: type: - string - 'null' example: '2021' school-name: type: - string - 'null' example: 'university of california, berkeley' school-type: type: - string - 'null' example: college experience: type: - array - 'null' items: type: object additionalProperties: false properties: end-date: type: - string - 'null' example: '2021' start-date: type: - string - 'null' example: '2017' company-name: type: - string - 'null' example: persona title-name: type: - string - 'null' example: software engineer social-media-profiles: type: - array - 'null' items: type: object additionalProperties: false properties: network: type: string example: linkedin url: type: - string - 'null' example: linkedin.com/in/person-a username: type: - string - 'null' example: persona relationships: $ref: '#/components/schemas/report-shared-relationships' report-sentilink-scores: title: SentiLink Scores Report description: A SentiLink Scores Report type: object additionalProperties: false properties: type: type: string const: report/integration/sentilink-scores id: type: string description: The ID of the report examples: - rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: query: type: object additionalProperties: false properties: birthdate: description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date examples: - '1994-04-12' type: string name-first: description: Given or first name. examples: - Jane type: string name-last: description: Family or last name. examples: - Doe type: string address-street-1: description: Street name of residence address. examples: - 123 Main St type: string address-city: description: City of residence address. Not all international addresses use this attribute. examples: - San Francisco type: string address-subdivision: description: 'State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.' examples: - California type: string address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: string address-country-code: description: Country code of residence address. examples: - US type: - string - 'null' social-security-number: description: Social security number type: string pattern: '^\d{3}-\d{2}-\d{4}$' examples: - 123-45-6789 user-id: description: Reference ID of applicant type: string examples: - USER-123 phone-number: description: Phone number. examples: - 415-555-1234 type: - string - 'null' email-address: description: Email address. examples: - jane@doe.com type: - string - 'null' result: type: object additionalProperties: false properties: application-id: type: string customer-id: type: string environment: type: string notes: type: - string - 'null' scores: type: array items: type: object additionalProperties: false properties: name: type: string examples: - sentilink_abuse_score score: type: integer format: int32 version: type: string examples: - 1.5.3 reason-codes: type: array items: type: string status: type: string examples: - passed transaction-id: type: string relationships: $ref: '#/components/schemas/report-shared-relationships' report-social-media: title: Social Media Report description: A Social Media Report type: object additionalProperties: false properties: type: type: string const: report/social-media id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: name-first: type: - string - 'null' example: Norman name-last: type: - string - 'null' example: Mannor birthdate: type: string description: Date of birth in YYYY-MM-DD format example: '1991-10-07' phone-number: type: - string - 'null' example: '+14169671111' email-address: type: - string - 'null' example: address@domain.com address-city: type: - string - 'null' example: Funkyville address-subdivision: type: - string - 'null' description: Sub-national subdivision such as a US state or a Canadian province example: Wisconsin linkedin-url: type: - string - 'null' example: linkdin.com/in/thisisausername linkedin-username: type: - string - 'null' example: thisisausername linkedin-id: type: - string - 'null' example: '123456789' facebook-url: type: - string - 'null' example: facebook.com/user.name.7 facebook-username: type: - string - 'null' example: user.name.7 facebook-id: type: - string - 'null' example: '748945123159485' twitter-url: type: - string - 'null' example: twitter.com/elonmusk twitter-username: type: - string - 'null' example: elonmusk github-url: type: - string - 'null' example: github.com/username github-username: type: - string - 'null' example: username instagram-url: type: - string - 'null' example: instagram.com/username instagram-username: type: - string - 'null' example: username relationships: $ref: '#/components/schemas/report-shared-relationships' report-synthetic: title: Synthetic Report description: A Synthetic Report type: object additionalProperties: false properties: type: type: string const: report/synthetic id: type: string description: The ID of the report examples: - rep_9Ht4ZsNjXpZLKrJNHBYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: sentilink-abuse-score: type: - integer - 'null' description: Sentilink abuse score. examples: - 72 sentilink-first-party-synthetic-score: type: - integer - 'null' description: Sentilink first party synthetic score. examples: - 58 sentilink-third-party-synthetic-score: type: - integer - 'null' description: Sentilink third party synthetic score. examples: - 85 report-template-version-name: type: string description: The name of the report template version used for this report. examples: - v2 has-match: type: boolean description: Indicates if the report matched. examples: - true is-continuous: type: boolean description: Indicates if the report is recurring. examples: - false tags: type: array description: Tags associated with the report. items: type: string examples: - - suspicious - reviewed relationships: $ref: '#/components/schemas/report-shared-relationships' report-watchlist-entity: description: A entity that matched from a Watchlist type: object additionalProperties: false properties: name: type: string example: Won Ho Ri alias-type: type: string description: |- Possible values: - primary_name - aka Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. birthdates: type: array description: The birthdate of the entity items: type: object additionalProperties: false properties: day: type: string example: '17' year: type: string example: '1964' month: type: string example: '07' granularity: type: string description: Precision the birthday provided example: day report-watchlist: title: Watchlist Report description: A Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/watchlist id: type: string description: The ID of the report example: rep_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-attributes' - type: object properties: name-first: type: - string - 'null' description: The input first name of the search individual example: Joe name-middle: type: - string - 'null' description: The input middle name of the search individual example: 'N' name-last: type: - string - 'null' description: The input last name of the search individual example: Doe term: type: - string - 'null' description: The input combined term used for searching (first + middle + last name) example: Joe N Doe birthdate: type: - string - 'null' description: The input DOB in YYYY-MM-DD format pattern: '^\d{4}-\d{2}-\d{2}$' example: '1991-10-07' country-code: type: - string - 'null' description: The input search country in alpha2 format example: US matched-lists: type: - array - 'null' description: Lists that matched from the search input items: type: object additionalProperties: false properties: name: type: string example: EU - EC - Programme PRK - North Korea url: type: string example: 'https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017R1509&from=EN' list-type: type: string example: sanction list-types: type: array items: type: string example: sanction slug: type: string example: eu-ec-programme-prk flag-code: type: string example: EU entities: type: array description: A matched person items: $ref: '#/components/schemas/report-watchlist-entity' ignore-list: type: array items: type: object additionalProperties: false properties: ignored-at: type: string format: date-time example: '2023-09-13T22:08:56.618Z' run-history-completed-at: type: string format: date-time example: '2023-08-11T20:36:04.291Z' match: type: object additionalProperties: false properties: name: type: string example: EU - EC - Programme PRK - North Korea url: type: string example: 'https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017R1509&from=EN' list-type: type: string example: sanction list-types: type: array items: type: string example: sanction slug: type: string example: eu-ec-programme-prk flag-code: type: string example: EU entities: type: array items: type: object additionalProperties: false properties: name: type: string example: Won Ho Ri alias-type: type: string example: primary_name birthdates: type: array items: type: object additionalProperties: false properties: day: type: string example: '17' year: type: string format: date example: '1964' month: type: string format: date-time example: '07' granularity: type: string example: day group-id: type: string example: 'EU:110286' user: type: string example: John Doe ignore-reason: type: string example: false positive relationships: $ref: '#/components/schemas/report-shared-relationships' verification-shared-attributes: x-inheritable: true type: object properties: status: type: string description: |- The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. created-at: type: string format: date-time description: The time the verification was created in ISO 8601 format example: '2023-11-16T01:31:16.000Z' created-at-ts: type: integer format: int32 description: The time the verification was created in Unix timestamp format example: 1700098276 submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format example: '2023-11-16T01:31:16.000Z' submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format example: 1700098276 completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format example: '2023-11-16T01:31:16.000Z' completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format example: 1700098276 redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format example: '2023-11-16T01:31:16.000Z' country-code: description: ISO 3166-1 alpha 2 country code. example: US type: - string - 'null' tags: description: Tags on the verification items: type: string type: array checks: items: properties: name: examples: - aamva_identification_number_comparison - document_type_detection type: string status: description: |- Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string reasons: type: array description: 'If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`.' items: type: - string - 'null' requirement: type: string description: |- Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. metadata: description: This is a free-form object containing relevant metadata to the processing and result of the check. type: object additionalProperties: true type: object additionalProperties: false type: array verification-shared-relationships: type: object x-inheritable: true properties: inquiry: type: object additionalProperties: false description: The inquiry linked to the verification properties: data: type: - object - 'null' properties: id: example: inq_ABC123 type: string type: const: inquiry type: string template: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: template id: type: string example: tmpl_ABC123 inquiry-template-version: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: inquiry-template-version id: type: string example: itmplv_ABC123 inquiry-template: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: inquiry-template id: type: string example: itmpl_ABC123 transaction: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: transaction id: type: string example: txn_ABC123 verification-template: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: x-polymorphic: true type: string example: verification-template/aamva id: type: string example: vtmpl_ABC123 verification-template-version: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: x-polymorphic: true type: string example: verification-template-version/aamva id: type: string example: vtmplv_ABC123 accounts: properties: data: items: properties: id: examples: - act_ABC123 type: string type: const: account type: string additionalProperties: false type: object type: array additionalProperties: false type: object verification-aamva: title: AAMVA Verification description: An AAMVA Verification additionalProperties: false type: object properties: type: type: string const: verification/aamva id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. example: Jane type: - string - 'null' name-last: description: Family or last name. example: Doe type: - string - 'null' birthdate: description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date example: '1994-04-12' type: - string issue-date: type: string format: date example: '2021-05-27' expiration-date: type: string format: date example: '2029-05-08' address-postal-code: type: string example: 94115-1010 issuing-authority: type: string example: CA identification-number: type: string example: B12345678 relationships: $ref: '#/components/schemas/verification-shared-relationships' address-fields: properties: address-street-1: description: Street name of residence address. examples: - 123 Main St type: - string - 'null' address-street-2: description: 'Extension of residence address, usually apartment or suite number.' examples: - Apt 1 type: - string - 'null' address-city: description: City of residence address. Not all international addresses use this attribute. examples: - San Francisco type: - string - 'null' address-subdivision: description: 'State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute.' examples: - California type: - string - 'null' address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: - string - 'null' type: object x-inheritable: true default-fields: x-inheritable: true allOf: - type: object properties: birthdate: description: 'Birthdate, must be in the format "YYYY-MM-DD".' format: date examples: - '1994-04-12' type: - string - 'null' name-first: description: Given or first name. examples: - Jane type: - string - 'null' name-middle: description: Middle name. examples: - Marie type: - string - 'null' name-last: description: Family or last name. examples: - Doe type: - string - 'null' phone-number: description: Phone number. examples: - 415-555-1234 type: - string - 'null' email-address: description: Email address. examples: - jane@doe.com type: - string - 'null' - $ref: '#/components/schemas/address-fields' verification-database: title: Database Verification description: A Database Verification type: object additionalProperties: false properties: type: type: string const: verification/database id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - $ref: '#/components/schemas/default-fields' - type: object properties: normalized-address-street-1: description: Normalized street name of residence address. examples: - 123 Main St type: - string - 'null' normalized-address-street-2: description: 'Normalized extension of residence address, usually apartment or suite number.' examples: - Apt 1 type: - string - 'null' normalized-address-city: description: Normalized city of residence address. Not all international addresses use this attribute. examples: - San Francisco type: - string - 'null' normalized-address-subdivision: description: 'Normalized state or subdivision of residence address. In the US, this should be the abbreviated name. Not all international addresses use this attribute.' examples: - CA type: - string - 'null' normalized-address-postal-code: description: Normalized ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: - string - 'null' identification-number: type: - string - 'null' document-number: type: - string - 'null' document-issuing-date: type: - string - 'null' examples: - '2020-01-01' document-expiry-date: type: - string - 'null' examples: - '2025-01-01' document-issuing-subdivision: type: - string - 'null' examples: - NSW - CA - 'ON' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-ecbsv: title: eCBSV Database Verification description: An eCBSV Database Verification type: object additionalProperties: false properties: type: type: string const: verification/database-ecbsv id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: First name of the individual. type: - string - 'null' name-last: description: Last name of the individual. type: - string - 'null' birthdate: description: Birthdate of the individual format: date type: - string - 'null' email-address: description: Email address of the individual. type: - string - 'null' identification-number: description: Social Security Number of the individual. type: - string - 'null' signature-timestamp: description: Timestamp of the signature type: - string - 'null' format: date-time signature-ip: description: IP address of the individual type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-phone-carrier: title: Phone Carrier Database Verification description: A Phone Carrier Database Verification type: object additionalProperties: false properties: type: type: string const: verification/database-phone-carrier id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. examples: - Jane type: - string - 'null' name-last: description: Family or last name. examples: - Doe type: - string - 'null' birthdate: description: Birthdate in the format "YYYY-MM-DD". format: date examples: - '1994-04-12' type: - string - 'null' phone-number: description: Phone number. examples: - 415-555-1234 type: - string - 'null' - $ref: '#/components/schemas/address-fields' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-serpro: title: Serpro Database Verification description: A Serpro Database Verification type: object additionalProperties: false properties: type: type: string const: verification/database-serpro id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: birthdate: description: Birthdate of the individual. format: date type: - string - 'null' cpf: description: The Cadastro de Pessoas Físicas for the individual. type: string name-first: description: First name of the individual. type: string name-full: description: Full name of the individual. type: string name-last: description: Last name of the individual. type: string relationships: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-relationships' - type: object properties: selfie: type: object additionalProperties: false description: The selfie linked to the Verification properties: data: type: - object - 'null' properties: id: example: self_ABC123 type: string type: x-polymorphic: true examples: - selfie/profile-and-center - selfie/center-only - selfie/configurable-poses type: string description: |- Possible values: - selfie/profile-and-center - selfie/center-only - selfie/configurable-poses Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. verification-database-standard: title: Standard Database Verification description: A Standard Database Verification type: object additionalProperties: false properties: type: const: verification/database-standard type: string id: examples: - ver_1rWMmoV3hoy2qWv3wGPcH43c type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - $ref: '#/components/schemas/default-fields' - type: object properties: normalized-address-city: examples: - Los Angeles type: string normalized-address-postal-code: examples: - '55555' type: string normalized-address-street-1: examples: - 555 Beverly Hills type: string normalized-address-street-2: examples: - Apt 123 type: string normalized-address-subdivision: examples: - CA type: string relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-tin: title: TIN Database Verification description: A TIN Database Verification type: object additionalProperties: false properties: type: type: string const: verification/database-tin id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: tin: type: string examples: - '287654321' - '123456789' tin-type: type: - string - 'null' examples: - ssn - ein - itin name-first: type: - string - 'null' name-last: type: - string - 'null' name-business: type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' extraction-responses: type: - 'null' - array description: A list of extractions resulting from processing the uploaded documents corresponding to the document's extraction configuration. items: type: object additionalProperties: false properties: extraction-type: examples: - guided - unguided type: string field-name: type: string structured-results: type: array description: A list of structured AI extraction results with locations stripped. Values are recursive — objects contain nested structured results — but bounding-box location data is omitted from the API response. items: type: object additionalProperties: true results: type: array description: A list of objects containing the actual value extracted and additional information relevant to the extraction result. items: properties: value: type: string page: description: The page number the extraction result is detected. Page is 1-indexed. type: integer match-level: description: 'If extraction-type is guided, match-level describes the degree in which the extracted value is similar to the source value. Otherwise the match-level is full.' examples: - none - partial - full type: string metadata: description: This is a free-form object containing potentially helpful metadata on the extraction result. type: - object - 'null' type: object additionalProperties: false verification-document: title: Document Verification description: A Document Verification additionalProperties: false type: object properties: type: type: string const: verification/document id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: fields: description: JSON key-value pairs of field name to field value. additionalProperties: false type: object files: description: The files uploaded to the associated document for processing. items: $ref: '#/components/schemas/file' type: array files-normalized: items: $ref: '#/components/schemas/file' type: array extraction-responses: $ref: '#/components/schemas/extraction-responses' document-type: description: Document classification assignment based on document content. type: - string - 'null' relationships: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-relationships' - type: object properties: document: properties: data: properties: id: examples: - doc_ABC123 type: string type: x-polymorphic: true examples: - document/generic type: string additionalProperties: false type: object additionalProperties: false type: object verification-email-address: title: Email Address Verification description: An Email Address Verification additionalProperties: false type: object properties: type: type: string const: verification/email-address id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: email-address: example: jane@doe.com type: - string - 'null' confirmation-code: example: '12345' type: string relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-government-id: type: object additionalProperties: false title: Government ID Verification description: A Government ID Verification properties: type: type: string const: verification/government-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: entity-confidence-reasons: items: examples: - generic type: string type: array entity-confidence-score: default: 0 examples: - 100 - 96.1831512451172 type: - number - 'null' front-photo-url: examples: - 'https://files.withpersona.com/...' type: - string - 'null' back-photo-url: examples: - 'https://files.withpersona.com/...' type: - string - 'null' photo-urls: items: properties: byte-size: default: 0 examples: - 316802 type: integer normalized-url: examples: - 'https://files.withpersona.com/...' type: string original-urls: items: examples: - 'https://files.withpersona.com/...' type: string type: array page: examples: - front type: string url: examples: - 'https://files.withpersona.com/...' type: string type: object additionalProperties: false type: - array - 'null' selfie-photo: properties: byte-size: default: 0 examples: - 316802 type: integer url: examples: - 'https://files.withpersona.com/...' type: string type: - object - 'null' selfie-photo-url: examples: - 'https://files.withpersona.com/...' type: - string - 'null' video-url: type: - string - 'null' example: 'https://files.withpersona.com/...' id-class: examples: - dl type: - string - 'null' capture-method: examples: - api type: - string - 'null' name-first: examples: - ALEXANDER type: - string - 'null' name-middle: examples: - AL type: - string - 'null' name-last: examples: - SAMPLE type: - string - 'null' name-suffix: examples: - III type: - string - 'null' native-name-first: description: Native script given or first name. examples: - 简 type: - string - 'null' native-name-middle: description: Native script middle name. type: - string - 'null' native-name-last: description: Native script family or last name. examples: - 李 type: - string - 'null' native-name-title: description: Native script name title or prefix. type: - string - 'null' birthdate: examples: - '2000-01-01' type: - string - 'null' issuing-authority: examples: - State Department type: - string - 'null' issuing-subdivision: examples: - CA type: - string - 'null' nationality: examples: - US type: - string - 'null' document-number: examples: - '123456' type: - string - 'null' visa-status: examples: - H1B type: - string - 'null' issue-date: examples: - '2010-01-01' type: - string - 'null' expiration-date: examples: - '2020-01-01' type: - string - 'null' designations: examples: - - probationary type: - array - 'null' birthplace: examples: - Singapore type: - string - 'null' endorsements: type: - string - 'null' height: examples: - 6'1" type: - string - 'null' sex: examples: - M - F - X type: - string - 'null' restrictions: examples: - A type: - string - 'null' vehicle-class: examples: - C type: - string - 'null' identification-number: examples: - '123456' type: - string - 'null' from-reusable-persona: examples: - true - false type: boolean - $ref: '#/components/schemas/address-fields' relationships: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-relationships' - type: object properties: document: properties: data: properties: id: examples: - doc_ABC123 type: string type: x-polymorphic: true examples: - document/generic type: string type: object additionalProperties: false type: object additionalProperties: false verification-government-id-nfc: type: object additionalProperties: false title: Government ID NFC Verification description: A Government ID NFC Verification properties: type: type: string const: verification/government-id-nfc id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: birthdate: examples: - '2000-01-01' type: - string - 'null' checks: items: properties: metadata: additionalProperties: true type: object name: examples: - id_nfc_expired_detection type: string reasons: items: examples: - expired type: string type: array status: examples: - failed type: string type: object additionalProperties: false type: array expiration-date: examples: - '2000-01-01' type: - string - 'null' id-class: examples: - dl type: - string - 'null' identification-number: examples: - P123456AA type: - string - 'null' name-first: examples: - ALEXANDER type: string name-last: examples: - SAMPLE type: string selfie-photo: properties: byte-size: default: 0 examples: - 316802 type: integer url: examples: - 'https://files.withpersona.com/...' type: string type: - object - 'null' selfie-photo-url: examples: - 'https://files.withpersona.com/...' type: - string - 'null' sex: examples: - M - F - X type: - string - 'null' - $ref: '#/components/schemas/address-fields' relationships: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-relationships' - type: object properties: document: properties: data: properties: id: examples: - doc_ABC123 type: string type: x-polymorphic: true examples: - document/generic type: string type: object additionalProperties: false type: object additionalProperties: false verification-phone-number: type: object additionalProperties: false title: Phone Number Verification description: A Phone Number Verification properties: type: type: string const: verification/phone-number id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: phone-number: example: '+14169671111' type: string confirmation-code: example: '12345' type: string metadata: type: object additionalProperties: false properties: telesign-risk-score: type: integer example: 306 relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-selfie: type: object additionalProperties: false title: Selfie Verification description: A Selfie Verification properties: type: type: string const: verification/selfie id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: capture-method: type: - string - 'null' description: |- Possible values: - photo - video Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. center-photo-face-coordinates: type: - object - 'null' properties: top-left: type: array items: type: number example: - 0.2 - 0.5 minItems: 2 maxItems: 2 top-right: type: array items: type: number example: - 0.5 - 0.5 minItems: 2 maxItems: 2 bottom-left: type: array items: type: number example: - 0.2 - 0.7 minItems: 2 maxItems: 2 bottom-right: type: array items: type: number example: - 0.5 - 0.7 minItems: 2 maxItems: 2 center-photo-url: type: - string - 'null' example: 'https://files.withpersona.com/...' document-similarity-score: type: - number - 'null' entity-confidence-reasons: items: type: string type: array left-photo-url: type: - string - 'null' example: 'https://files.withpersona.com/...' from-reusable-persona: examples: - true - false type: boolean photo-urls: items: properties: byte-size: default: 0 example: 316802 type: integer page: type: string description: |- Possible values: - left_photo - center_photo - right_photo Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. url: example: 'https://files.withpersona.com/...' type: string additionalProperties: false type: object type: array right-photo-url: type: - string - 'null' example: 'https://files.withpersona.com/...' selfie-similarity-score-left: type: - number - 'null' selfie-similarity-score-right: type: - number - 'null' video-url: type: - string - 'null' example: 'https://files.withpersona.com/...' relationships: $ref: '#/components/schemas/verification-shared-relationships' cases-included-objects: type: array items: discriminator: propertyName: type mapping: account: '#/components/schemas/account' case-comment: '#/components/schemas/case-comment' case-template: '#/components/schemas/case-template' case-queue: '#/components/schemas/case-queue' inquiry: '#/components/schemas/inquiry' report/address-lookup: '#/components/schemas/report-address-lookup' report/adverse-media: '#/components/schemas/report-adverse-media' report/business-adverse-media: '#/components/schemas/report-business-adverse-media' report/business-associated-persons: '#/components/schemas/report-business-associated-persons' report/business-registrations-lookup: '#/components/schemas/report-business-registrations-lookup' report/business-lookup: '#/components/schemas/report-business-lookup' report/business-watchlist: '#/components/schemas/report-business-watchlist' report/crypto-address-watchlist: '#/components/schemas/report-crypto-address-watchlist' report/email-address: '#/components/schemas/report-email-address' report/phone-number: '#/components/schemas/report-phone-risk' report/politically-exposed-person: '#/components/schemas/report-politically-exposed-person' report/profile: '#/components/schemas/report-profile' report/profile-non-authoritative: '#/components/schemas/report-profile-non-authoritative' report/integration/sentilink-scores: '#/components/schemas/report-sentilink-scores' report/social-media: '#/components/schemas/report-social-media' report/synthetic: '#/components/schemas/report-synthetic' report/watchlist: '#/components/schemas/report-watchlist' transaction: '#/components/schemas/transaction' verification/aamva: '#/components/schemas/verification-aamva' verification/database: '#/components/schemas/verification-database' verification/database-ecbsv: '#/components/schemas/verification-database-ecbsv' verification/database-phone-carrier: '#/components/schemas/verification-database-phone-carrier' verification/database-serpro: '#/components/schemas/verification-database-serpro' verification/database-standard: '#/components/schemas/verification-database-standard' verification/database-tin: '#/components/schemas/verification-database-tin' verification/document: '#/components/schemas/verification-document' verification/email-address: '#/components/schemas/verification-email-address' verification/government-id: '#/components/schemas/verification-government-id' verification/government-id-nfc: '#/components/schemas/verification-government-id-nfc' verification/phone-number: '#/components/schemas/verification-phone-number' verification/selfie: '#/components/schemas/verification-selfie' oneOf: - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/case-comment' - $ref: '#/components/schemas/case-template' - $ref: '#/components/schemas/case-queue' - $ref: '#/components/schemas/inquiry' - $ref: '#/components/schemas/report-address-lookup' - $ref: '#/components/schemas/report-adverse-media' - $ref: '#/components/schemas/report-business-adverse-media' - $ref: '#/components/schemas/report-business-associated-persons' - $ref: '#/components/schemas/report-business-lookup' - $ref: '#/components/schemas/report-business-registrations-lookup' - $ref: '#/components/schemas/report-business-watchlist' - $ref: '#/components/schemas/report-crypto-address-watchlist' - $ref: '#/components/schemas/report-email-address' - $ref: '#/components/schemas/report-phone-risk' - $ref: '#/components/schemas/report-politically-exposed-person' - $ref: '#/components/schemas/report-profile' - $ref: '#/components/schemas/report-profile-non-authoritative' - $ref: '#/components/schemas/report-sentilink-scores' - $ref: '#/components/schemas/report-social-media' - $ref: '#/components/schemas/report-synthetic' - $ref: '#/components/schemas/report-watchlist' - $ref: '#/components/schemas/transaction' - $ref: '#/components/schemas/verification-aamva' - $ref: '#/components/schemas/verification-database' - $ref: '#/components/schemas/verification-database-ecbsv' - $ref: '#/components/schemas/verification-database-phone-carrier' - $ref: '#/components/schemas/verification-database-serpro' - $ref: '#/components/schemas/verification-database-standard' - $ref: '#/components/schemas/verification-database-tin' - $ref: '#/components/schemas/verification-document' - $ref: '#/components/schemas/verification-email-address' - $ref: '#/components/schemas/verification-government-id' - $ref: '#/components/schemas/verification-government-id-nfc' - $ref: '#/components/schemas/verification-phone-number' - $ref: '#/components/schemas/verification-selfie' device: type: object additionalProperties: false properties: type: const: device type: string id: type: string description: Unique identifier for this Device. Starts with `dev_`. examples: - dev_ABC123 attributes: type: object additionalProperties: false properties: device-vendor-id: type: - string - 'null' examples: - 1a2b3c4d-5e6f-7g8h-9ijk-1A2B3C4D5E6F device-fingerprint: type: - string - 'null' examples: - 1a2b3c4d5e6f7g8h9ijklmnopqrstuvw browser-fingerprint: type: - string - 'null' examples: - 1a2b3c4d5e6f7g8h9ijk document-shared-attributes: x-inheritable: true type: object properties: status: description: |- Possible values: - initiated - submitted - processed - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string created-at: examples: - '2020-04-18T15:43:25.000Z' type: string format: date-time processed-at: examples: - '2020-04-18T15:43:25.000Z' type: - 'null' - string format: date-time processed-at-ts: examples: - 1593047530 type: - 'null' - integer document-shared-relationships: properties: inquiry: properties: data: properties: id: examples: - inq_jdRz9RHNRzkjxUqZApHwX1ZU type: string type: const: inquiry type: string type: - object - 'null' additionalProperties: false type: object additionalProperties: false template: properties: data: properties: id: examples: - tmpl_sXu8UYP3L1xQLAB9XCRUQA5g type: string type: const: template type: string type: - 'null' - object type: object additionalProperties: false inquiry-template-version: properties: data: properties: id: examples: - itmplv_1ivdvZUKPLAtWgsQdEvmi6wj type: string type: const: inquiry-template-version type: string type: - 'null' - object type: object additionalProperties: false inquiry-template: properties: data: properties: id: examples: - itmpl_mNKRtWCMWB9Lbccc85DjgJnK type: string type: const: inquiry-template type: string type: - 'null' - object type: object additionalProperties: false transaction: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: transaction id: type: string example: txn_ABC123 document-files: properties: data: items: properties: id: examples: - docf_aNBCzPCLPC2Ladef86DjbInK type: string type: const: document-file type: string type: object additionalProperties: false type: array type: object additionalProperties: false type: object additionalProperties: false document-generic: type: object additionalProperties: false description: A Document Generic object properties: id: examples: - doc_8HfuATwEZbXT532wv6pzWMTN type: string type: type: string const: document/generic attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/document-shared-attributes' - type: object properties: kind: examples: - document - proof_of_employment type: string files: description: The files uploaded to the document for processing. items: $ref: '#/components/schemas/file' type: array files-normalized: items: $ref: '#/components/schemas/file' type: array extraction-responses: $ref: '#/components/schemas/extraction-responses' document-type: description: 'The classification of the document if detected. If unable to be detected, this will be other.' examples: - bank_statement - standard_utility_bill - other type: - 'null' - string fields: description: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of your template. type: object additionalProperties: true type: object relationships: $ref: '#/components/schemas/document-shared-relationships' inquiry-template: type: object additionalProperties: false description: An Inquiry Template object properties: type: const: inquiry-template type: string id: type: string examples: - itmpl_ABC123 attributes: type: object additionalProperties: false properties: name: type: string description: Name of the Inquiry Template examples: - Government ID Front and Back status: type: string description: |- Possible values: - active - inactive Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. examples: - active embedded-flow-domain-allowlist: type: array items: type: string description: List of domains allowed for embedded flows examples: - - example.com - app.example.com hosted-flow-subdomains: type: array items: type: string description: The subdomain that your hosted flow can be hosted on (e.g. "mycompany.withpersona.com") examples: - - mycompanyname hosted-flow-redirect-uri-schemes: type: array items: type: string description: |- An allowlist that specifies the URI schemes for redirect after completion of a Hosted Flow. This can be used to implement deep linking for mobile integrations. If this list is empty, all URLs with the URI scheme http or https are allowed. examples: - - https - http field-schemas: type: array items: unevaluatedProperties: false $ref: '#/components/schemas/field-schema' relationships: type: object additionalProperties: false properties: latest-published-version: type: object additionalProperties: false properties: data: type: - object - 'null' additionalProperties: false properties: type: type: string const: inquiry-template-version id: type: string examples: - itmplv_ABC123 inquiry-template-version: type: object additionalProperties: false description: An Inquiry Template Version object properties: type: type: string const: inquiry-template-version id: type: string examples: - itmplv_HAVumeSgCxWxhVb8tTRjaiUB attributes: additionalProperties: false type: object properties: name-display: type: - string - 'null' examples: - Collect Government ID - '' status: description: |- Possible values: - published - draft Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string examples: - published enabled-locales: type: array items: type: string examples: - ar-EG - ja - fr - en-US created-at: type: string format: date-time examples: - '2022-11-09T00:22:59.828Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-02-15T23:15:06.034Z' published-at: type: - string - 'null' format: date-time examples: - '2022-11-09T00:29:41.000Z' theme: additionalProperties: false type: object properties: border-radius: type: - string - 'null' border-radius-input: type: - string - 'null' border-radius-modal: type: - string - 'null' border-width: type: - string - 'null' border-width-input: type: - string - 'null' button-background-image: type: - string - 'null' button-font-weight: type: - string - 'null' button-position: type: - string - 'null' button-shadow-strength: type: - string - 'null' button-text-transform: type: - string - 'null' color-button-primary: type: - string - 'null' color-button-secondary: type: - string - 'null' color-button-secondary-fill: type: - string - 'null' color-button-primary-fill-disabled: type: - string - 'null' color-button-secondary-fill-disabled: type: - string - 'null' color-error: type: - string - 'null' color-font: type: - string - 'null' color-font-button-primary: type: - string - 'null' color-font-button-secondary: type: - string - 'null' color-font-small: type: - string - 'null' color-font-title: type: - string - 'null' color-icon-header: type: - string - 'null' color-input-background: type: - string - 'null' color-input-border: type: - string - 'null' color-link: type: - string - 'null' color-modal-background: type: - string - 'null' color-primary: type: - string - 'null' color-progress-bar: type: - string - 'null' color-success: type: - string - 'null' color-warning: type: - string - 'null' color-divider: type: - string - 'null' color-dropdown-background: type: - string - 'null' color-dropdown-option: type: - string - 'null' font-family: type: - string - 'null' font-family-title: type: - string - 'null' font-url: type: - string - 'null' font-size-body: type: - string - 'null' font-size-header: type: - string - 'null' font-size-small: type: - string - 'null' line-height-body: type: - string - 'null' line-height-header: type: - string - 'null' line-height-small: type: - string - 'null' header-font-weight: type: - string - 'null' header-margin-bottom: type: - string - 'null' icon-color-primary: type: - string - 'null' icon-color-highlight: type: - string - 'null' icon-color-stroke: type: - string - 'null' icon-color-background: type: - string - 'null' icon-color-government-id-type: type: - string - 'null' icon-style: type: - string - 'null' input-style: type: - string - 'null' page-transition: type: - string - 'null' text-align: type: - string - 'null' text-decoration-line-link: type: - string - 'null' us-state-input-method: type: - string - 'null' vertical-options-style: type: - string - 'null' government-id-pictograph-position: type: - string - 'null' id-back-pictograph-height: type: - string - 'null' id-back-pictograph-url: type: - string - 'null' id-front-pictograph-height: type: - string - 'null' id-front-pictograph-url: type: - string - 'null' passport-front-pictograph-height: type: - string - 'null' passport-front-pictograph-url: type: - string - 'null' passport-signature-pictograph-height: type: - string - 'null' passport-signature-pictograph-url: type: - string - 'null' government-id-select-pictograph-height: type: - string - 'null' government-id-select-pictograph-url: type: - string - 'null' device-handoff-terms-text-position: type: - string - 'null' selfie-pictograph-url: type: - string - 'null' selfie-pictograph-height: type: - string - 'null' selfie-center-pictograph-url: type: - string - 'null' selfie-center-pictograph-height: type: - string - 'null' selfie-left-pictograph-url: type: - string - 'null' selfie-left-pictograph-height: type: - string - 'null' selfie-right-pictograph-url: type: - string - 'null' selfie-right-pictograph-height: type: - string - 'null' document-pictograph-position: type: - string - 'null' document-pictograph-height: type: - string - 'null' document-pictograph-url: type: - string - 'null' camera-support-pictograph-height: type: - string - 'null' camera-support-pictograph-url: type: - string - 'null' loading-pictograph-height: type: - string - 'null' loading-pictograph-url: type: - string - 'null' navbar-logo-display: type: - string - 'null' logo-url: type: - string - 'null' logo: type: - string - 'null' logo-data: type: - string - 'null' logo-filename: type: - string - 'null' relationships: additionalProperties: false type: object properties: inquiry-template: additionalProperties: false type: object properties: data: additionalProperties: false type: object properties: type: type: string const: inquiry-template id: type: string examples: - itmpl_srQQ2Ui2gvNY353u65vD61gr template: type: object additionalProperties: false description: An Template object for legacy inquiries properties: type: type: string const: template id: examples: - tmpl_jGTjQgGMyei68sdf8NyCeDMh type: string attributes: type: object additionalProperties: false properties: name: examples: - Government ID Front and Back type: string document-file: type: object additionalProperties: false properties: type: const: document-file type: string id: examples: - docf_5FrMN7NAGgFdGGysCDd7DaBW type: string attributes: type: object additionalProperties: false properties: name: type: - string - 'null' capture-method: type: string description: |- Possible values: - auto - manual - upload - api - live Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. originals: type: array items: $ref: '#/components/schemas/file' document-included-objects: description: Objects that _may_ be returned if specified via the `include` query parameter in the request. type: array items: discriminator: propertyName: type mapping: inquiry: '#/components/schemas/inquiry' inquiry-template: '#/components/schemas/inquiry-template' inquiry-template-version: '#/components/schemas/inquiry-template-version' template: '#/components/schemas/template' transaction: '#/components/schemas/transaction' document-file: '#/components/schemas/document-file' oneOf: - $ref: '#/components/schemas/inquiry' - $ref: '#/components/schemas/inquiry-template' - $ref: '#/components/schemas/inquiry-template-version' - $ref: '#/components/schemas/template' - $ref: '#/components/schemas/transaction' - $ref: '#/components/schemas/document-file' document-government-id: type: object additionalProperties: false description: A Document Government ID object properties: id: examples: - doc_8HfuATwEZbXT532wv6pzWMTN type: string type: type: string const: document/government-id attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/document-shared-attributes' - type: object properties: front-photo: $ref: '#/components/schemas/file' back-photo: $ref: '#/components/schemas/file' selfie-photo: $ref: '#/components/schemas/file' id-class: type: - 'null' - string examples: - dl - pp name-first: description: Given or first name. examples: - Jane type: - string - 'null' name-middle: description: Middle name. examples: - Marie type: - string - 'null' name-last: description: Family or last name. examples: - Doe type: - string - 'null' name-suffix: examples: - III - Jr. type: - string - 'null' native-name-first: description: Native script given or first name. examples: - 简 type: - string - 'null' native-name-middle: description: Native script middle name. type: - string - 'null' native-name-last: description: Native script family or last name. examples: - 李 type: - string - 'null' native-name-title: description: Native script name title or prefix. type: - string - 'null' birthdate: format: date examples: - '1994-04-12' type: - string - 'null' issuing-authority: type: - string - 'null' issuing-subdivision: type: - string - 'null' nationality: type: - string - 'null' document-number: type: - string - 'null' visa-status: type: - string - 'null' issue-date: format: date examples: - '2022-06-01' type: - string - 'null' expiration-date: format: date examples: - '2025-02-20' type: - string - 'null' designations: type: - array - 'null' items: type: string description: |- Possible values: - commercial - global_entry - learners - limited_term - nexus - non_domiciled - permanent_resident - provisional - real_id - restricted - temporary - veteran - work_not_permitted Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. birthplace: type: - string - 'null' height: type: - string - 'null' sex: type: - string - 'null' endorsements: type: - string - 'null' restrictions: type: - string - 'null' vehicle-class: type: - string - 'null' identification-number: type: - string - 'null' - $ref: '#/components/schemas/address-fields' type: object relationships: $ref: '#/components/schemas/document-shared-relationships' document-government-id-nfc: type: object additionalProperties: false description: A Document Government ID NFC object properties: id: examples: - doc_8HfuATwEZbXT532wv6pzWMTN type: string type: type: string const: document/government-id-nfc attributes: $ref: '#/components/schemas/document-shared-attributes' relationships: $ref: '#/components/schemas/document-shared-relationships' document-mdoc: type: object additionalProperties: false description: A Document Mdoc object properties: id: examples: - doc_8HfuATwEZbXT532wv6pzWMTN type: string type: type: string const: document/mdoc attributes: $ref: '#/components/schemas/document-shared-attributes' relationships: $ref: '#/components/schemas/document-shared-relationships' document: type: object discriminator: propertyName: type mapping: document/generic: '#/components/schemas/document-generic' document/government-id: '#/components/schemas/document-government-id' document/government-id-nfc: '#/components/schemas/document-government-id-nfc' document/mdoc: '#/components/schemas/document-mdoc' anyOf: - $ref: '#/components/schemas/document-generic' - $ref: '#/components/schemas/document-government-id' - $ref: '#/components/schemas/document-government-id-nfc' - $ref: '#/components/schemas/document-mdoc' event: type: object additionalProperties: false description: An Event object properties: type: type: string const: event id: type: string examples: - evt_ABC123 attributes: type: object additionalProperties: false properties: name: type: string examples: - inquiry.expired - workflow-run.created - account.tag-added payload: description: The entire serialized entity that triggered the event type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: x-polymorphic: true type: string examples: - inquiry - workflow-run - account id: type: string examples: - inq_ABC123 - wfr_ABC123 - act_ABC123 attributes: type: object additionalProperties: true relationships: type: object additionalProperties: true created-at: type: string format: date-time examples: - '2023-09-23T17:14:01.918Z' context: type: object description: Additional context populated for some event types. additionalProperties: true graph-query: type: object additionalProperties: false description: A Graph Query object properties: type: type: string const: graph-query id: type: string examples: - grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: additionalProperties: false type: object properties: status: description: |- Possible values: - submitted - completed - errored - cancelled - timed_out Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string params: type: object description: Dynamic query parameters additionalProperties: true created-at: type: string format: date-time examples: - '2023-09-26T06:31:43.000Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-09-26T06:31:43.000Z' errored-at: type: - string - 'null' format: date-time examples: - '2023-09-26T06:31:43.000Z' completed-at: type: - string - 'null' format: date-time examples: - '2023-09-26T06:31:43.000Z' redacted-at: description: |- This will be set to the time when the graph query results were redacted. In this case, nodes will also be an empty array. type: - string - 'null' format: date-time examples: - '2023-09-26T06:31:43.000Z' stats: additionalProperties: false type: object explorer-url: type: - string - 'null' examples: - 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: type: - boolean - 'null' nodes: items: additionalProperties: false type: object properties: type: type: string value: type: string type: array relationships: properties: accounts: type: object additionalProperties: false properties: data: items: type: object additionalProperties: false properties: id: examples: - act_9e3yoAUApTRMjgNoPAC7TNtz type: string type: const: account type: string type: array type: object additionalProperties: false importer-shared-attributes: type: object additionalProperties: false properties: completed-at: examples: - '2022-08-02T05:02:56.000Z' type: - string - 'null' format: date-time created-at: examples: - '2020-07-12T17:16:54.656Z' type: string duplicate-count: default: 0 examples: - 0 type: integer error-count: default: 0 examples: - 0 type: integer status: description: |- Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. examples: - pending type: string successful-count: default: 0 examples: - 0 type: integer importer-account: title: Account Importer description: An Importer for Accounts type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/account type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-email-address: title: Email address List Item Importer description: An Importer for email address List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/email-address type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-field: title: Field List Item Importer description: An Importer for field List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/field type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-geolocation: title: Geolocation List Item Importer description: An Importer for geolocation List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/geolocation type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-government-id-number: title: Government ID number List Item Importer description: An Importer for government ID number List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/government-id-number type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-ip-address: title: IP address List Item Importer description: An Importer for IP address List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/ip-address type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-name: title: Name List Item Importer description: An Importer for name List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/name type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer-list-item-phone-number: title: Phone number List Item Importer description: An Importer for phone number List Items type: object additionalProperties: false properties: id: description: Unique identifier for this Importer. Starts with `mprt_`. examples: - mprt_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: importer/list-item/phone-number type: string attributes: $ref: '#/components/schemas/importer-shared-attributes' importer: type: object discriminator: propertyName: type mapping: importer/account: '#/components/schemas/importer-account' importer/list-item/email-address: '#/components/schemas/importer-list-item-email-address' importer/list-item/field: '#/components/schemas/importer-list-item-field' importer/list-item/geolocation: '#/components/schemas/importer-list-item-geolocation' importer/list-item/government-id-number: '#/components/schemas/importer-list-item-government-id-number' importer/list-item/ip-address: '#/components/schemas/importer-list-item-ip-address' importer/list-item/name: '#/components/schemas/importer-list-item-name' importer/list-item/phone-number: '#/components/schemas/importer-list-item-phone-number' oneOf: - $ref: '#/components/schemas/importer-account' - $ref: '#/components/schemas/importer-list-item-email-address' - $ref: '#/components/schemas/importer-list-item-field' - $ref: '#/components/schemas/importer-list-item-geolocation' - $ref: '#/components/schemas/importer-list-item-government-id-number' - $ref: '#/components/schemas/importer-list-item-ip-address' - $ref: '#/components/schemas/importer-list-item-name' - $ref: '#/components/schemas/importer-list-item-phone-number' inquiry-fields: unevaluatedProperties: false description: JSON key-value pairs of field name to field value. Schema is defined by your Inquiry Template. allOf: - $ref: '#/components/schemas/default-fields' - type: object properties: address-country-code: description: optional examples: - US - AU - GB type: string additionalProperties: true user: type: object additionalProperties: false description: A User object properties: type: type: string const: user id: type: string examples: - user_ABC123 attributes: type: object additionalProperties: false properties: email-address: type: string examples: - jane@doe.com name-first: type: string examples: - Jane name-last: type: string examples: - Doe selfie: type: object additionalProperties: false description: A Selfie object properties: type: x-polymorphic: true examples: - selfie/profile-and-center - selfie/center-only - selfie/configurable-poses type: string description: |- Possible values: - selfie/profile-and-center - selfie/center-only - selfie/configurable-poses Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. id: description: Unique identifier for this Selfie object. Starts with `self_`. examples: - self_5FrMN7NAGgFdGGysCDd7DaBW type: string attributes: type: object additionalProperties: false properties: status: type: string description: |- Possible values: - initiated - submitted - processed - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. examples: - processed created-at: type: string format: date-time examples: - '2020-07-12T17:16:54.656Z' processed-at: description: Timestamp when the Selfie finished processing. `null` until the Selfie reaches the `processed` or `errored` status. type: - 'null' - string format: date-time examples: - '2020-07-12T17:16:54.656Z' relationships: type: object additionalProperties: false properties: inquiry: properties: data: properties: id: examples: - inq_jdRz9RHNRzkjxUqZApHwX1ZU type: string type: const: inquiry type: string type: object additionalProperties: false type: object additionalProperties: false inquiry-session: type: object additionalProperties: false properties: type: type: string const: inquiry-session id: type: string examples: - iqse_ABC123 attributes: type: object additionalProperties: false properties: status: description: |- Possible values: - new - active - expired Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string examples: - expired created-at: type: string format: date-time examples: - '2023-09-22T17:13:50.000Z' started-at: type: - string - 'null' format: date-time examples: - '2023-09-22T17:14:50.000Z' expired-at: type: - string - 'null' format: date-time examples: - '2023-09-23T17:13:50.000Z' ip-address: type: - string - 'null' examples: - 139.178.128.13 user-agent: type: - string - 'null' examples: - 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36' os-name: type: - string - 'null' examples: - iOS os-full-version: type: - string - 'null' examples: - 17.0.1 device-type: type: - string - 'null' examples: - smartphone - desktop device-name: type: - string - 'null' examples: - 'Apple iPhone11,2' browser-name: type: - string - 'null' examples: - Chrome browser-full-version: type: - string - 'null' examples: - 113.0.0.0 mobile-sdk-name: type: - string - 'null' examples: - Inquiry mobile-sdk-full-version: type: - string - 'null' examples: - 0.0.1-SNAPSHOT device-handoff-method: type: - string - 'null' examples: - email - sms - qr is-proxy: type: - boolean - 'null' is-tor: type: - boolean - 'null' is-datacenter: type: - boolean - 'null' is-vpn: type: - boolean - 'null' threat-level: type: - string - 'null' examples: - low - medium country-code: type: - string - 'null' examples: - US country-name: type: - string - 'null' examples: - United States of America region-code: type: - string - 'null' examples: - CA region-name: type: - string - 'null' examples: - California latitude: type: - number - 'null' examples: - 37.32300186 longitude: type: - number - 'null' examples: - -122.03218079 gps-latitude: type: - number - 'null' examples: - 40.3044 gps-longitude: type: - number - 'null' examples: - -134.29329 gps-precision: type: - string - 'null' examples: - precise ip-connection-type: type: - string - 'null' examples: - mobile - datacenter - residential - corporate - education ip-isp: type: - string - 'null' examples: - Google Cloud network-organization: type: - string - 'null' examples: - Google Cloud relationships: type: object additionalProperties: false properties: inquiry: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string const: inquiry id: type: string examples: - inq_ABC123 device: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: device id: type: string examples: - dev_ABC123 network: type: object additionalProperties: false properties: data: type: - object - 'null' properties: type: type: string const: network id: type: string examples: - net_ABC123 verification-bank-pennydrop: title: Bank Pennydrop Verification description: A Bank Pennydrop Verification type: object additionalProperties: false properties: type: type: string const: verification/bank-pennydrop id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-brand-asset: title: Brand Asset Verification description: A Brand Asset Verification type: object additionalProperties: false properties: type: type: string const: verification/brand-asset id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: business-name: description: Name of the business associated with the brand asset. type: - string - 'null' business-website: description: Website URL associated with the brand asset. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' business-website-extracted-identity-record: title: Business Website Extracted Identity Record description: 'A single identity detail extracted from the business website, with the page it was found on.' type: object additionalProperties: false properties: value: description: 'The extracted value — for example a business name, address, phone number, or email address.' example: Example Inc type: - string - 'null' source: description: The URL of the website page the value was extracted from. example: 'https://example.com' type: - string - 'null' verification-business-website: title: Business Website Verification description: A Business Website Verification type: object additionalProperties: false properties: type: type: string const: verification/business-website id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: website-url: description: The website URL being verified. type: - string - 'null' extracted-identity: description: Identity details extracted from the website. Each list is null when the verification has not finished processing or has been redacted. type: object additionalProperties: false properties: business-names: description: Business names extracted from the website. type: - array - 'null' items: $ref: '#/components/schemas/business-website-extracted-identity-record' addresses: description: Addresses extracted from the website. type: - array - 'null' items: $ref: '#/components/schemas/business-website-extracted-identity-record' phone-numbers: description: Phone numbers extracted from the website. type: - array - 'null' items: $ref: '#/components/schemas/business-website-extracted-identity-record' emails: description: Email addresses extracted from the website. type: - array - 'null' items: $ref: '#/components/schemas/business-website-extracted-identity-record' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-certificate-korea: title: Certificate Korea Verification description: A Certificate Korea Verification type: object additionalProperties: false properties: type: type: string const: verification/certificate-korea id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date certificate-type: description: The type of certificate used for verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-credit-card: title: Credit Card Verification description: A Credit Card Verification type: object additionalProperties: false properties: type: type: string const: verification/credit-card id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-aadhaar: title: Database Aadhaar Verification description: A Database Aadhaar Verification type: object additionalProperties: false properties: type: type: string const: verification/database-aadhaar id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-business: title: Database Business Verification description: A Database Business Verification type: object additionalProperties: false properties: type: type: string const: verification/database-business id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - $ref: '#/components/schemas/default-fields' - type: object properties: business-name: description: Name of the business type: - string registration-number: description: Registration number of the business type: - string - 'null' address-street-1: description: Street name of business address. examples: - 123 Main St type: - string - 'null' address-street-2: description: 'Extension of business address, usually apartment or suite number.' examples: - Apt 1 type: - string - 'null' address-city: description: City of business address. Not all international addresses use this attribute. examples: - San Francisco type: - string - 'null' address-subdivision: description: 'State or subdivision of business address. In the US, this should be the abbreviated name. Not all international addresses use this attribute.' examples: - CA type: - string - 'null' address-postal-code: description: ZIP or postal code of residence address. Not all international addresses use this attribute. examples: - '94111' type: - string - 'null' address-country-code: description: Country code of the business address. examples: - US type: - string relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-business-footprint: title: Database Business Footprint Verification description: A Database Business Footprint Verification type: object additionalProperties: false properties: type: type: string const: verification/database-business-footprint id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-database-vat-number: title: Database VAT Number Verification description: A Database VAT Number Verification type: object additionalProperties: false properties: type: type: string const: verification/database-vat-number id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: vat-number: description: The VAT number being verified. type: - string - 'null' business-name: description: Name of the business as supplied for verification. type: - string - 'null' address-street-1: description: Street name of business address. type: - string - 'null' address-street-2: description: Extension of business address. type: - string - 'null' address-city: type: - string - 'null' address-subdivision: type: - string - 'null' address-postal-code: type: - string - 'null' registered-business-name: description: Business name as returned by the registered VAT record. type: - string - 'null' registered-address-street-1: type: - string - 'null' registered-address-street-2: type: - string - 'null' registered-address-city: type: - string - 'null' registered-address-subdivision: type: - string - 'null' registered-address-postal-code: type: - string - 'null' registered-address-country-code: type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-connect-id: title: Digital ID Connect ID Verification description: A Digital ID Connect ID Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-connect-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-e-do-app: title: Digital ID e-do App Verification description: A Digital ID e-do App Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-e-do-app id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-finnish-trust-network: title: Digital ID Finnish Trust Network Verification description: A Digital ID Finnish Trust Network Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-finnish-trust-network id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-france-identite: title: Digital ID France Identite Verification description: A Digital ID France Identite Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-france-identite id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-generic: title: Digital ID Generic Verification description: A Digital ID Generic Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-generic id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' selected-country-code: description: The country selected by the end user for verification. type: - string - 'null' selected-digital-id-type: description: The digital ID type selected by the end user. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-idin: title: Digital ID iDIN Verification description: A Digital ID iDIN Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-idin id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-its-me: title: Digital ID itsme Verification description: A Digital ID itsme Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-its-me id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: type: - string - 'null' name-last: type: - string - 'null' identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date response-country: type: - string - 'null' response-status: type: - string - 'null' address: description: Registered address as returned by itsme. type: - string - 'null' birth-place: type: - string - 'null' document-number: type: - string - 'null' email: type: - string - 'null' gender: type: - string - 'null' id-expiry-date: type: - string - 'null' format: date id-picture: description: Encoded portrait image returned by the provider. type: - string - 'null' language: type: - string - 'null' nationality: type: - string - 'null' phone: type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-kcb-credit-card: title: Digital ID KCB Credit Card Verification description: A Digital ID KCB Credit Card Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-kcb-credit-card id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-full: description: Full name returned by the provider. type: - string - 'null' birthdate: type: - string - 'null' format: date sex: type: - string - 'null' native-foreigner-code: type: - string - 'null' ci: description: Connecting Information (Korean unique identifier). type: - string - 'null' di: description: Duplication Information (Korean per-service identifier). type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-mit-id: title: Digital ID MitID Verification description: A Digital ID MitID Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-mit-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' level-of-assurance: description: The level of assurance reported by MitID for this verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-one-id: title: Digital ID One ID Verification description: A Digital ID One ID Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-one-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-philsys: title: Digital ID PhilSys Verification description: A Digital ID PhilSys Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-philsys id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: issue-date: type: - string - 'null' format: date issuer: type: - string - 'null' name-first: type: - string - 'null' name-middle: type: - string - 'null' name-last: type: - string - 'null' suffix: type: - string - 'null' sex: type: - string - 'null' birthdate: type: - string - 'null' format: date place-of-birth: type: - string - 'null' pcn: description: PhilSys Card Number. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-serpro: title: Digital ID SERPRO Verification description: A Digital ID SERPRO Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-serpro id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: qr-code-attachment: description: 'QR code attachment returned by SERPRO, if present.' type: - object - 'null' selfie-compare-image-url: description: 'URL of the selfie comparison image, if present.' type: - string - 'null' cpf: description: Brazilian CPF identifier. type: - string - 'null' name: type: - string - 'null' birthdate: type: - string - 'null' format: date identification-number: type: - string - 'null' expiration-date: type: - string - 'null' format: date issue-date: type: - string - 'null' format: date selfie-comparison-error-code: type: - string - 'null' serpro-selfie-available: type: - boolean - 'null' selfie-confidence-level: type: - string - 'null' selfie-similarity-score: type: - number - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-singpass: title: Digital ID Singpass Verification description: A Digital ID Singpass Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-singpass id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: identity-number: type: - string - 'null' identity-coi: description: Country of issue for the identity document. type: - string - 'null' name: type: - string - 'null' alias-name: type: - string - 'null' hanyu-pinyin-name: type: - string - 'null' hanyu-pinyin-alias-name: type: - string - 'null' married-name: type: - string - 'null' birthdate: type: - string - 'null' format: date sex: type: - string - 'null' race: type: - string - 'null' secondary-race: type: - string - 'null' nationality: type: - string - 'null' birth-country: type: - string - 'null' residential-status: type: - string - 'null' pass-type: description: Pass type for foreign residents. type: - string - 'null' pass-status: type: - string - 'null' pass-expiry-date: type: - string - 'null' format: date address-street-1: type: - string - 'null' address-street-2: type: - string - 'null' address-postal-code: type: - string - 'null' address-country-code: type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-swedish-bank-id: title: Digital ID Swedish BankID Verification description: A Digital ID Swedish BankID Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-swedish-bank-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' identification-number: type: - string - 'null' birthdate: description: Birthdate in YYYY-MM-DD format. type: - string - 'null' format: date response-country: description: ISO 3166-1 alpha 2 country code returned by the provider. type: - string - 'null' response-status: description: Provider-reported status of the verification. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-uk-sharecode: title: Digital ID UK Sharecode Verification description: A Digital ID UK Sharecode Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-uk-sharecode id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: sharecode: description: The UK share code used for verification. type: - string - 'null' birthdate: type: - string - 'null' format: date name-full: description: Full name returned by the provider. type: - string - 'null' reference-number: type: - string - 'null' immigration-status: type: - string - 'null' valid-from-date: description: Date from which the immigration status is valid. type: - string - 'null' format: date valid-until-date: description: Date until which the immigration status is valid. type: - string - 'null' format: date relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-digital-id-world-id: title: Digital ID World ID Verification description: A Digital ID World ID Verification type: object additionalProperties: false properties: type: type: string const: verification/digital-id-world-id id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-jp-my-number-nfc-scan: title: JP My Number NFC Scan Verification description: A Japanese My Number Card NFC Scan Verification type: object additionalProperties: false properties: type: type: string const: verification/jp-my-number-nfc-scan id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: operation: description: The operation performed against the NFC card. type: - string - 'null' address: type: - string - 'null' birthdate: type: - string - 'null' format: date expiration-date: type: - string - 'null' format: date face-image: description: 'Face image extracted from the NFC card, when present. Deprecated in favor of `selfie-photo`.' deprecated: true type: - object - 'null' selfie-photo: description: 'Portrait photo of the bearer extracted from the NFC card, when present.' properties: byte-size: default: 0 examples: - 316802 type: integer url: examples: - 'https://files.withpersona.com/...' type: string type: - object - 'null' gender: type: - string - 'null' deprecated: true description: Deprecated in favor of `sex` identification-class: description: 'Persona-standard document class of the scanned card, derived from the scan operation (e.g. "myn" for My Number card, "dl" for driver''s license, "rp" for residence card).' type: - string - 'null' identification-number: description: Identification number on the scanned card — the driver's license number (DL operations) or residence card number (res_read). type: - string - 'null' kana-name: type: - string - 'null' license-number: type: - string - 'null' deprecated: true description: Identification number scanned from drivers license. Deprecated in favor of identification-number. name-full: type: - string - 'null' sex: description: Extracted sex designation from the scanned card. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-mdoc: title: mDoc Verification description: An mDoc (mobile document) Verification type: object additionalProperties: false properties: type: type: string const: verification/mdoc id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: name-first: description: Given or first name. type: - string - 'null' name-last: description: Family or last name. type: - string - 'null' birthdate: description: Date of birth. examples: - '2000-01-01' type: - string - 'null' address-street: description: Street address of residence. examples: - 123 Main St type: - string - 'null' address-city: description: City of residence address. examples: - San Francisco type: - string - 'null' address-state: description: State or subdivision of residence address. examples: - CA type: - string - 'null' address-postal-code: description: ZIP or postal code of residence address. examples: - '94111' type: - string - 'null' address-country-code: description: ISO 3166-1 alpha 2 country code of the residence address. examples: - US type: - string - 'null' issuing-authority: description: The authority that issued the document. examples: - CA type: - string - 'null' issuing-jurisdiction: description: The jurisdiction that issued the document. examples: - CA type: - string - 'null' issuing-country: description: ISO 3166-1 alpha 2 country code of the issuing country. examples: - US type: - string - 'null' nationality: description: Nationality of the holder. examples: - US type: - string - 'null' expiration-date: description: The expiration date of the document. examples: - '2030-01-01' type: - string - 'null' identification-number: description: The document or identification number. examples: - '123456' type: - string - 'null' age-in-years: description: Age of the holder. examples: - 25 type: - integer - 'null' meets-minimum-age: description: Whether the holder meets a minimum age requirement. examples: - true - false type: - boolean - 'null' validated-issuer-key: description: The trusted organization that issued the document credentials. examples: - apple_wallet type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-persona-fff-inquiry: title: Persona FFF Inquiry Verification description: A Persona FFF Inquiry Verification type: object additionalProperties: false properties: type: type: string const: verification/persona-fff-inquiry id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-phone-number-silent-network-authentication: title: Phone Number Silent Network Authentication Verification description: A Phone Number Silent Network Authentication Verification type: object additionalProperties: false properties: type: type: string const: verification/phone-number-silent-network-authentication id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: phone-number: description: The phone number being verified. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-qes-infocert: title: QES InfoCert Verification description: A Qualified Electronic Signature (QES) Verification via InfoCert type: object additionalProperties: false properties: type: type: string const: verification/qes-infocert id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: tentative-sub-state: description: An InfoCert-specific sub-state describing why the verification is in a tentative status. Only populated when the verification status is `tentatively_passed` or `tentatively_failed`. type: - string - 'null' relationships: $ref: '#/components/schemas/verification-shared-relationships' verification-verifiable-credential: title: Verifiable Credential Verification description: A W3C Verifiable Credential Verification type: object additionalProperties: false properties: type: type: string const: verification/verifiable-credential id: type: string description: The token of the verification example: ver_ABC123 attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/verification-shared-attributes' - type: object properties: selected-credential-issuer: description: The issuer of the credential selected for verification. type: - string - 'null' selected-credential-types: description: The list of credential types of the selected credential. type: - array - 'null' items: type: string selected-credential-issuance-date: description: Issuance date of the selected credential. type: - string - 'null' format: date-time selected-credential-expiration-date: description: Expiration date of the selected credential. type: - string - 'null' format: date-time relationships: $ref: '#/components/schemas/verification-shared-relationships' workflow-deployment: type: object additionalProperties: false description: A Workflow Deployment object properties: type: const: workflow-deployment type: string id: examples: - wfd_3JqAR9ddLRVZLK5z4yD8oeHB type: string attributes: properties: status: description: |- The status of the Workflow Deployment Possible values: - active - inactive Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string configuration: type: object description: The deployment configuration containing version information additionalProperties: false properties: versions: type: array items: type: object additionalProperties: false properties: token: type: string description: The token of the workflow version percentage: type: integer description: The percentage of traffic this version should receive minimum: 1 maximum: 100 label: type: string description: The label of the version (treatment or control) created-at: examples: - '2022-08-08T18:55:44.910Z' type: string format: date-time updated-at: examples: - '2022-08-08T18:55:44.910Z' type: string format: date-time type: object additionalProperties: false workflow: type: object additionalProperties: false description: A Workflow object properties: type: const: workflow type: string id: examples: - wfl_3JqAR9ddLRVZLK5z4yD8oeHB type: string attributes: properties: status: description: |- The status of the Workflow Possible values: - paused - running - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string name: type: string created-at: examples: - '2022-08-08T18:55:44.910Z' type: string format: date-time type: object additionalProperties: false relationships: type: object additionalProperties: false properties: latest-published-version: type: object description: latest published version additionalProperties: false properties: data: type: object additionalProperties: false properties: type: const: workflow-version type: string id: type: string active-deployment: type: object description: latest active deployment additionalProperties: false properties: data: oneOf: - type: 'null' - $ref: '#/components/schemas/workflow-deployment' unevaluatedProperties: false workflow-run: type: object additionalProperties: false description: A Workflow Run object properties: type: const: workflow-run type: string id: examples: - wfr_3JqAR9ddLRVZLK5z4yD8oeHB type: string attributes: properties: completed-at: examples: - '2022-08-08T18:55:44.910Z' type: - string - 'null' format: date-time created-at: examples: - '2022-08-08T18:55:44.910Z' type: string format: date-time status: examples: - in_progress type: string type: object additionalProperties: false relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: administrator type: string id: examples: - admn_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object additionalProperties: false - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object additionalProperties: false - properties: type: const: event type: string id: examples: - evt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object additionalProperties: false type: object additionalProperties: false workflow: properties: data: properties: type: const: workflow type: string id: examples: - wfl_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object additionalProperties: false type: object additionalProperties: false workflow-version: properties: data: properties: type: const: workflow-version type: string id: examples: - wfv_DkWeGvK9wojQnubF8ABHzJRQ type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false meta: type: object additionalProperties: false properties: processing-time-seconds: type: - number - 'null' inquiry-included-objects: type: array items: discriminator: propertyName: type mapping: account: '#/components/schemas/account' document/generic: '#/components/schemas/document-generic' document/government-id: '#/components/schemas/document-government-id' document/government-id-nfc: '#/components/schemas/document-government-id-nfc' document/mdoc: '#/components/schemas/document-mdoc' user: '#/components/schemas/user' inquiry-template: '#/components/schemas/inquiry-template' inquiry-template-version: '#/components/schemas/inquiry-template-version' template: '#/components/schemas/template' report/address-lookup: '#/components/schemas/report-address-lookup' report/adverse-media: '#/components/schemas/report-adverse-media' report/business-adverse-media: '#/components/schemas/report-business-adverse-media' report/business-associated-persons: '#/components/schemas/report-business-associated-persons' report/business-registrations-lookup: '#/components/schemas/report-business-registrations-lookup' report/business-lookup: '#/components/schemas/report-business-lookup' report/business-watchlist: '#/components/schemas/report-business-watchlist' report/crypto-address-watchlist: '#/components/schemas/report-crypto-address-watchlist' report/email-address: '#/components/schemas/report-email-address' report/phone-number: '#/components/schemas/report-phone-risk' report/politically-exposed-person: '#/components/schemas/report-politically-exposed-person' report/profile: '#/components/schemas/report-profile' report/profile-non-authoritative: '#/components/schemas/report-profile-non-authoritative' report/integration/sentilink-scores: '#/components/schemas/report-sentilink-scores' report/social-media: '#/components/schemas/report-social-media' report/synthetic: '#/components/schemas/report-synthetic' report/watchlist: '#/components/schemas/report-watchlist' selfie/profile-and-center: '#/components/schemas/selfie' selfie/center-only: '#/components/schemas/selfie' selfie/configurable-poses: '#/components/schemas/selfie' inquiry-session: '#/components/schemas/inquiry-session' transaction: '#/components/schemas/transaction' verification/aamva: '#/components/schemas/verification-aamva' verification/bank-pennydrop: '#/components/schemas/verification-bank-pennydrop' verification/brand-asset: '#/components/schemas/verification-brand-asset' verification/business-website: '#/components/schemas/verification-business-website' verification/certificate-korea: '#/components/schemas/verification-certificate-korea' verification/credit-card: '#/components/schemas/verification-credit-card' verification/database: '#/components/schemas/verification-database' verification/database-aadhaar: '#/components/schemas/verification-database-aadhaar' verification/database-business: '#/components/schemas/verification-database-business' verification/database-business-footprint: '#/components/schemas/verification-database-business-footprint' verification/database-ecbsv: '#/components/schemas/verification-database-ecbsv' verification/database-phone-carrier: '#/components/schemas/verification-database-phone-carrier' verification/database-serpro: '#/components/schemas/verification-database-serpro' verification/database-standard: '#/components/schemas/verification-database-standard' verification/database-tin: '#/components/schemas/verification-database-tin' verification/database-vat-number: '#/components/schemas/verification-database-vat-number' verification/digital-id-connect-id: '#/components/schemas/verification-digital-id-connect-id' verification/digital-id-e-do-app: '#/components/schemas/verification-digital-id-e-do-app' verification/digital-id-finnish-trust-network: '#/components/schemas/verification-digital-id-finnish-trust-network' verification/digital-id-france-identite: '#/components/schemas/verification-digital-id-france-identite' verification/digital-id-generic: '#/components/schemas/verification-digital-id-generic' verification/digital-id-idin: '#/components/schemas/verification-digital-id-idin' verification/digital-id-its-me: '#/components/schemas/verification-digital-id-its-me' verification/digital-id-kcb-credit-card: '#/components/schemas/verification-digital-id-kcb-credit-card' verification/digital-id-mit-id: '#/components/schemas/verification-digital-id-mit-id' verification/digital-id-one-id: '#/components/schemas/verification-digital-id-one-id' verification/digital-id-philsys: '#/components/schemas/verification-digital-id-philsys' verification/digital-id-serpro: '#/components/schemas/verification-digital-id-serpro' verification/digital-id-singpass: '#/components/schemas/verification-digital-id-singpass' verification/digital-id-swedish-bank-id: '#/components/schemas/verification-digital-id-swedish-bank-id' verification/digital-id-uk-sharecode: '#/components/schemas/verification-digital-id-uk-sharecode' verification/digital-id-world-id: '#/components/schemas/verification-digital-id-world-id' verification/document: '#/components/schemas/verification-document' verification/email-address: '#/components/schemas/verification-email-address' verification/government-id: '#/components/schemas/verification-government-id' verification/government-id-nfc: '#/components/schemas/verification-government-id-nfc' verification/jp-my-number-nfc-scan: '#/components/schemas/verification-jp-my-number-nfc-scan' verification/mdoc: '#/components/schemas/verification-mdoc' verification/persona-fff-inquiry: '#/components/schemas/verification-persona-fff-inquiry' verification/phone-number: '#/components/schemas/verification-phone-number' verification/phone-number-silent-network-authentication: '#/components/schemas/verification-phone-number-silent-network-authentication' verification/qes-infocert: '#/components/schemas/verification-qes-infocert' verification/selfie: '#/components/schemas/verification-selfie' verification/verifiable-credential: '#/components/schemas/verification-verifiable-credential' workflow: '#/components/schemas/workflow' workflow-run: '#/components/schemas/workflow-run' oneOf: - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/document-generic' - $ref: '#/components/schemas/document-government-id' - $ref: '#/components/schemas/document-government-id-nfc' - $ref: '#/components/schemas/document-mdoc' - $ref: '#/components/schemas/user' - $ref: '#/components/schemas/inquiry-template' - $ref: '#/components/schemas/inquiry-template-version' - $ref: '#/components/schemas/template' - $ref: '#/components/schemas/report-address-lookup' - $ref: '#/components/schemas/report-adverse-media' - $ref: '#/components/schemas/report-business-adverse-media' - $ref: '#/components/schemas/report-business-associated-persons' - $ref: '#/components/schemas/report-business-lookup' - $ref: '#/components/schemas/report-business-registrations-lookup' - $ref: '#/components/schemas/report-business-watchlist' - $ref: '#/components/schemas/report-crypto-address-watchlist' - $ref: '#/components/schemas/report-email-address' - $ref: '#/components/schemas/report-phone-risk' - $ref: '#/components/schemas/report-politically-exposed-person' - $ref: '#/components/schemas/report-profile' - $ref: '#/components/schemas/report-profile-non-authoritative' - $ref: '#/components/schemas/report-sentilink-scores' - $ref: '#/components/schemas/report-social-media' - $ref: '#/components/schemas/report-synthetic' - $ref: '#/components/schemas/report-watchlist' - $ref: '#/components/schemas/selfie' - $ref: '#/components/schemas/inquiry-session' - $ref: '#/components/schemas/transaction' - $ref: '#/components/schemas/verification-aamva' - $ref: '#/components/schemas/verification-bank-pennydrop' - $ref: '#/components/schemas/verification-brand-asset' - $ref: '#/components/schemas/verification-business-website' - $ref: '#/components/schemas/verification-certificate-korea' - $ref: '#/components/schemas/verification-credit-card' - $ref: '#/components/schemas/verification-database' - $ref: '#/components/schemas/verification-database-aadhaar' - $ref: '#/components/schemas/verification-database-business' - $ref: '#/components/schemas/verification-database-business-footprint' - $ref: '#/components/schemas/verification-database-ecbsv' - $ref: '#/components/schemas/verification-database-phone-carrier' - $ref: '#/components/schemas/verification-database-serpro' - $ref: '#/components/schemas/verification-database-standard' - $ref: '#/components/schemas/verification-database-tin' - $ref: '#/components/schemas/verification-database-vat-number' - $ref: '#/components/schemas/verification-digital-id-connect-id' - $ref: '#/components/schemas/verification-digital-id-e-do-app' - $ref: '#/components/schemas/verification-digital-id-finnish-trust-network' - $ref: '#/components/schemas/verification-digital-id-france-identite' - $ref: '#/components/schemas/verification-digital-id-generic' - $ref: '#/components/schemas/verification-digital-id-idin' - $ref: '#/components/schemas/verification-digital-id-its-me' - $ref: '#/components/schemas/verification-digital-id-kcb-credit-card' - $ref: '#/components/schemas/verification-digital-id-mit-id' - $ref: '#/components/schemas/verification-digital-id-one-id' - $ref: '#/components/schemas/verification-digital-id-philsys' - $ref: '#/components/schemas/verification-digital-id-serpro' - $ref: '#/components/schemas/verification-digital-id-singpass' - $ref: '#/components/schemas/verification-digital-id-swedish-bank-id' - $ref: '#/components/schemas/verification-digital-id-uk-sharecode' - $ref: '#/components/schemas/verification-digital-id-world-id' - $ref: '#/components/schemas/verification-document' - $ref: '#/components/schemas/verification-email-address' - $ref: '#/components/schemas/verification-government-id' - $ref: '#/components/schemas/verification-government-id-nfc' - $ref: '#/components/schemas/verification-jp-my-number-nfc-scan' - $ref: '#/components/schemas/verification-mdoc' - $ref: '#/components/schemas/verification-persona-fff-inquiry' - $ref: '#/components/schemas/verification-phone-number' - $ref: '#/components/schemas/verification-phone-number-silent-network-authentication' - $ref: '#/components/schemas/verification-qes-infocert' - $ref: '#/components/schemas/verification-selfie' - $ref: '#/components/schemas/verification-verifiable-credential' - $ref: '#/components/schemas/workflow' - $ref: '#/components/schemas/workflow-run' inquiry-status-action: title: Inquiry Status Action type: object additionalProperties: false properties: type: description: 'The type of simulate action. See [valid actions](https://docs.withpersona.com/integration-testing#inquiry-status).' type: string enum: - start_inquiry - complete_inquiry - fail_inquiry - expire_inquiry - mark_for_review_inquiry - approve_inquiry - decline_inquiry required: - type create-verification-action: title: Create Verification Action type: object additionalProperties: false properties: type: description: 'The type of simulate action. See [valid actions](https://docs.withpersona.com/integration-testing#creating-verification-with-status).' type: string enum: - create_passed_verification - create_failed_verification data: type: object additionalProperties: false properties: verification-template-id: description: 'The token of the Verification Template. See [supported Verification types](https://docs.withpersona.com/integration-testing#supported-verification-types).' type: string required: - verification-template-id required: - type - data network: type: object additionalProperties: false properties: type: const: network type: string id: type: string description: Unique identifier for this Network. Starts with `net_`. examples: - net_ABC123 attributes: type: object additionalProperties: false properties: created-at: type: string format: date-time examples: - '2023-09-22T17:13:50.000Z' ip-address: type: - string - 'null' examples: - 139.178.128.13 service-provider: type: - string - 'null' examples: - Comcast Cable Communications service-type: description: |- Possible values: - residential - mobile - datacenter - corporate - education Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' examples: - residential proxy-type: description: |- Possible values: - residential - mobile - corporate - vpn - unknown - tor Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' examples: - vpn threat-level: description: |- Possible values: - unknown - low - medium - high Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: - string - 'null' examples: - low country-code: type: - string - 'null' examples: - US country-name: type: - string - 'null' examples: - United States of America region-code: type: - string - 'null' examples: - CA region-name: type: - string - 'null' examples: - California latitude: type: - number - 'null' examples: - 37.32300186 longitude: type: - number - 'null' examples: - -122.03218079 inquiry-sessions-included-objects: type: array items: discriminator: propertyName: type mapping: device: '#/components/schemas/device' inquiry: '#/components/schemas/inquiry' network: '#/components/schemas/network' oneOf: - $ref: '#/components/schemas/device' - $ref: '#/components/schemas/inquiry' - $ref: '#/components/schemas/network' inquiry-template-included-objects: type: array items: discriminator: propertyName: type mapping: inquiry-template-version: '#/components/schemas/inquiry-template-version' oneOf: - $ref: '#/components/schemas/inquiry-template-version' list-item-shared-attributes: x-inheritable: true type: object properties: status: description: |- Possible values: - pending - active - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string archived-at: examples: - '2020-04-18T15:43:25.000Z' type: - string - 'null' format: date-time updated-at: examples: - '2020-04-18T15:43:25.000Z' type: - 'null' - string format: date-time created-at: examples: - '2020-04-18T15:43:25.000Z' type: - string format: date-time redacted-at: examples: - '2020-04-18T15:43:25.000Z' type: - 'null' - string format: date-time match-count: default: 0 examples: - 0 type: integer list-item-browser-fingerprint: title: Browser Fingerprint List Item description: A Browser Fingerprint List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `libf_`. examples: - libf_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: list-item/browser-fingerprint type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: value: examples: - 3082c312c9bfc8f0a43bc7173b18afe6 type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-country: title: Country List Item description: A Country List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `lic_`. examples: - lic_wt5cgLbSi7twJ8itK7jxCs8q type: string type: type: string const: list-item/country attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: country-code: description: Alpha-2 country code type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-device-fingerprint: title: Device Fingerprint List Item description: A Device Fingerprint List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `lidf_`. examples: - lidf_N6PqYkfSqeqiQYWoeHA3GGDo type: string type: const: list-item/device-fingerprint type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: value: examples: - 3082c312c9bfc8f0a43bc7173b18afe6 type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-email-address: title: Email Address List Item description: An Email Address List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `liea_`. examples: - liea_wt5cgLbSi7twJ8itK7jxCs8q type: string type: const: list-item/email-address type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: match-type: examples: - email_address type: string value: examples: - joe-imposter@yahoo.com type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/email-address type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-field: title: Field List Item description: A Field List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `liif_`. examples: - liif_soqGRWaUXZct3pCRbjRaXFqz type: string type: type: string const: list-item/field attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: field-value: type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-geolocation: title: Geolocation List Item description: A Geolocation List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `ligl_`. examples: - ligl_DQdchRN288UN6sn9mAmEcMu5 type: string type: const: list-item/geolocation type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: latitude: default: 0 examples: - 37.7879461 type: number longitude: default: 0 examples: - -122.3977409 type: number radius-meters: default: 0 examples: - 10 type: integer relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/geolocation type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-government-id-number: title: Government ID Number List Item description: A Government ID Number List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `ligin_`. examples: - ligin_soqGRWaUXZct3pCRbjRaXFqz type: string type: const: list-item/government-id-number type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: id-class: examples: - dl type: string id-number: examples: - F4K3NUM type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/government-id-number type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-ip-address: title: IP Address List Item description: An IP Address List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `liip_`. examples: - liip_soqGRWaUXZct3pCRbjRaXFqz type: string type: const: list-item/ip-address type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: value: examples: - 127.0.0.0/24 type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/ip-address type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-name: title: Name List Item description: A Name List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `lin_`. examples: - lin_soqGRWaUXZct3pCRbjRaXFqz type: string type: const: list-item/name type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: name-first: examples: - Joe type: string name-last: examples: - Imposter type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/name type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-phone-number: title: Phone Number List Item description: A Phone Number List Item type: object additionalProperties: false properties: id: description: Unique identifier for this list item. Starts with `lipn_`. examples: - lipn_soqGRWaUXZct3pCRbjRaXFqz type: string type: type: string const: list-item/phone-number attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: value: examples: - '18006009777' type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: importer/list-item/phone-number type: string id: examples: - mprt_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false list-item-string: title: String List Item description: A String List Item type: object additionalProperties: false properties: id: examples: - lin_soqGRWaUXZct3pCRbjRaXFqz type: string type: type: string const: list-item/string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/list-item-shared-attributes' - type: object properties: value: type: string relationships: properties: creator: properties: data: unevaluatedProperties: false oneOf: - type: 'null' - properties: type: const: user type: string id: examples: - user_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-run type: string id: examples: - wfr_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: workflow-step/action type: string id: examples: - wfs_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object - properties: type: const: api-key type: string id: examples: - api_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object type: object additionalProperties: false type: object additionalProperties: false lists-shared-attributes: x-inheritable: true type: object properties: name: type: string status: type: string archived-at: type: - 'null' - string format: date-time created-at: type: string format: date-time updated-at: type: string format: date-time lists-browser-fingerprints: type: object description: A Browser Fingerprint List object additionalProperties: false properties: type: type: string const: list/browser-fingerprint id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Browser Fingerprint List items associated with this list. lists-countries: type: object description: A Country List object additionalProperties: false properties: type: type: string const: list/country id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Country List items associated with this list. lists-email-addresses: type: object description: A Email Address List object additionalProperties: false properties: type: type: string const: list/email-address id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Email Address List items associated with this list. lists-geolocations: type: object description: A Geolocation List object additionalProperties: false properties: type: type: string const: list/geolocation id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Geolocation List items associated with this list. lists-government-id-numbers: type: object description: A Government Id Number List object additionalProperties: false properties: type: type: string const: list/government-id-number id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Government Id Number List items associated with this list. lists-ip-addresses: type: object description: A Ip Address List object additionalProperties: false properties: type: type: string const: list/ip-address id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Ip Address List items associated with this list. lists-names: type: object description: A Name List object additionalProperties: false properties: type: type: string const: list/name id: type: string attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/lists-shared-attributes' - type: object properties: allow-fuzzy-name-first: type: boolean relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Name List items associated with this list. lists-phone-numbers: type: object description: A Phone Number List object additionalProperties: false properties: type: type: string const: list/phone-number id: type: string attributes: unevaluatedProperties: false $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Phone Number List items associated with this list. lists-strings: type: object description: A Strings List object additionalProperties: false properties: type: type: string const: list/string id: type: string attributes: unevaluatedProperties: false $ref: '#/components/schemas/lists-shared-attributes' relationships: additionalProperties: false type: object properties: list-items: additionalProperties: false type: object properties: data: type: array items: additionalProperties: false type: object description: Strings List items associated with this list. list: discriminator: propertyName: type mapping: list/browser-fingerprint: '#/components/schemas/lists-browser-fingerprints' list/country: '#/components/schemas/lists-countries' list/email-address: '#/components/schemas/lists-email-addresses' list/geolocation: '#/components/schemas/lists-geolocations' list/government-id-number: '#/components/schemas/lists-government-id-numbers' list/ip-address: '#/components/schemas/lists-ip-addresses' list/name: '#/components/schemas/lists-names' list/phone-number: '#/components/schemas/lists-phone-numbers' anyOf: - $ref: '#/components/schemas/lists-browser-fingerprints' - $ref: '#/components/schemas/lists-countries' - $ref: '#/components/schemas/lists-email-addresses' - $ref: '#/components/schemas/lists-geolocations' - $ref: '#/components/schemas/lists-government-id-numbers' - $ref: '#/components/schemas/lists-ip-addresses' - $ref: '#/components/schemas/lists-names' - $ref: '#/components/schemas/lists-phone-numbers' rate-limit: type: object additionalProperties: false description: The current rate limit for a resource. properties: type: type: string enum: - rate-limit/api attributes: type: object additionalProperties: false properties: limit: type: integer description: The maximum number of requests allowed in the current time window example: 300 remaining: type: integer description: The number of requests remaining in the current time window example: 250 seconds-to-reset: type: integer description: The number of seconds until the rate limit resets example: 60 report: type: object discriminator: propertyName: type mapping: report/address-lookup: '#/components/schemas/report-address-lookup' report/adverse-media: '#/components/schemas/report-adverse-media' report/business-adverse-media: '#/components/schemas/report-business-adverse-media' report/business-associated-persons: '#/components/schemas/report-business-associated-persons' report/business-registrations-lookup: '#/components/schemas/report-business-registrations-lookup' report/business-lookup: '#/components/schemas/report-business-lookup' report/business-watchlist: '#/components/schemas/report-business-watchlist' report/crypto-address-watchlist: '#/components/schemas/report-crypto-address-watchlist' report/email-address: '#/components/schemas/report-email-address' report/phone-number: '#/components/schemas/report-phone-risk' report/politically-exposed-person: '#/components/schemas/report-politically-exposed-person' report/profile: '#/components/schemas/report-profile' report/profile-non-authoritative: '#/components/schemas/report-profile-non-authoritative' report/integration/sentilink-scores: '#/components/schemas/report-sentilink-scores' report/social-media: '#/components/schemas/report-social-media' report/synthetic: '#/components/schemas/report-synthetic' report/watchlist: '#/components/schemas/report-watchlist' oneOf: - $ref: '#/components/schemas/report-address-lookup' - $ref: '#/components/schemas/report-adverse-media' - $ref: '#/components/schemas/report-business-adverse-media' - $ref: '#/components/schemas/report-business-associated-persons' - $ref: '#/components/schemas/report-business-registrations-lookup' - $ref: '#/components/schemas/report-business-lookup' - $ref: '#/components/schemas/report-business-watchlist' - $ref: '#/components/schemas/report-crypto-address-watchlist' - $ref: '#/components/schemas/report-email-address' - $ref: '#/components/schemas/report-phone-risk' - $ref: '#/components/schemas/report-politically-exposed-person' - $ref: '#/components/schemas/report-profile' - $ref: '#/components/schemas/report-profile-non-authoritative' - $ref: '#/components/schemas/report-sentilink-scores' - $ref: '#/components/schemas/report-social-media' - $ref: '#/components/schemas/report-synthetic' - $ref: '#/components/schemas/report-watchlist' report-shared-request-attributes: x-inheritable: true type: object properties: account-id: description: Account ID to associate with this Report. examples: - act_ABC123 type: string reference-id: description: Reference ID to refer to an entity in your user model. This field is deprecated in favor of `meta.auto-create-account-reference-id`. deprecated: true examples: - abc-123 type: string report-template-id: description: 'ID of Verification Template. Starts with `rptp_`. You can find your Report Template IDs [here](https://app.withpersona.com/dashboard/report-templates).' examples: - rptp_abc123 type: string report-address-lookup-request: title: Address Lookup Report description: Fields required to create an Address Lookup Report. type: object additionalProperties: false properties: type: type: string const: report/address-lookup attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: addressee: description: The name of an individual at this location. type: - string - 'null' example: Joe Doe address-street-1: description: 'Address line 1 (e.g., street, PO Box, or company name).' type: string example: 1 Example Way address-street-2: description: 'Address line 2 (e.g., apartment, suite, unit, or building).' type: - string - 'null' example: Ste 300 address-city: description: City. type: string example: Cupertino address-subdivision: description: 'Subnational division of a country, such as a state or province.' type: string example: California address-postal-code: description: ZIP or postal code. type: string example: '95014' address-country-code: description: ISO 3166-1 alpha-2 country code. type: string example: US required: - address-street-1 - address-city - address-subdivision - address-postal-code - address-country-code required: - query required: - attributes report-adverse-media-request: title: Adverse Media Report description: Fields required to create an Adverse Media Report type: object additionalProperties: false properties: type: type: string const: report/adverse-media attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false description: 'At least one of `name-first`, `name-middle`, `name-last`, or `term` is required.' properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: Joe name-middle: type: - string - 'null' description: The middle name of the individual to search. example: 'N' name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe term: type: - string - 'null' description: Custom search term instead of separate name parts of the individual (i.e. first + middle + last name). example: Joe N Doe birthdate: type: - string - 'null' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1991-10-07' country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code. example: US required: - query required: - attributes report-business-adverse-media-request: title: Business Adverse Media Report description: Fields required to create a Business Adverse Media Report type: object additionalProperties: false properties: type: type: string const: report/business-adverse-media attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: term: type: string description: 'The search term for the adverse media report, typically the name of the business.' example: Acme Corporation required: - term required: - query required: - attributes report-business-lookup-request: title: Business Lookup Report description: Fields required to create a Business Lookup Report type: object additionalProperties: false properties: type: type: string const: report/business-lookup attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: business-name: description: The name of the business to search. type: string example: Coffee Shop phone-number: description: The phone number of the business to search. type: - string - 'null' website: description: The website of the business to search. type: - string - 'null' ein: description: The Employer Identification Number (EIN) of the business to search. type: - string - 'null' address-street-1: description: 'Address line 1 (e.g., street, PO Box, or company name).' type: string example: 123 Funky St address-street-2: description: 'Address line 2 (e.g., apartment, suite, unit, or building).' type: - string - 'null' address-city: description: City type: string example: Funkyville address-subdivision: type: string description: 'Subnational division of a country, such as a state or province.' example: CA address-postal-code: description: ZIP or postal code type: string example: '12345' address-country-code: description: ISO 3166-1 alpha-2 country code. type: string example: US associated-people: description: Officers or agents associated with the business. type: array items: type: object additionalProperties: false properties: name-full: description: The full name of an officer or agent associated with the business. type: - string - 'null' example: Jane Doe name-first: description: The first name of an officer or agent associated with the business. type: - string - 'null' example: Jane name-last: description: The last name of an officer or agent associated with the business. type: - string - 'null' example: Doe titles: description: Titles of an officer or agent associated with the business. type: array items: type: - string - 'null' example: CEO required: - business-name - address-street-1 - address-city - address-subdivision - address-postal-code required: - query required: - attributes report-business-watchlist-request: title: Business Watchlist Report description: Fields required to create a Business Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/business-watchlist attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: term: type: string description: 'The search term for the business watchlist report, typically the name of the business.' example: Acme Corporation address-country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code. example: US required: - term required: - query required: - attributes report-crypto-address-watchlist-request: title: Crypto Address Watchlist Report description: Fields required to create a Crypto Address Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/crypto-address-watchlist attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: crypto-address: type: string description: The crypto wallet address to search. example: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 required: - crypto-address required: - query required: - attributes report-email-address-request: title: Email Address Report description: Fields required to create an Email Address Report type: object additionalProperties: false properties: type: type: string const: report/email-address attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: email-address: type: string description: The email address to search. example: example@domain.com required: - email-address required: - query required: - attributes report-phone-risk-request: title: Phone Risk Report description: Fields required to create a Phone Risk Report type: object additionalProperties: false properties: type: type: string const: report/phone-number attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: phone-number: type: string description: The phone number to search. example: '+14169671111' required: - phone-number required: - query required: - attributes report-politically-exposed-person-request: title: Politically Exposed Person Report description: Fields required to create a Politically Exposed Person Report type: object additionalProperties: false properties: type: type: string const: report/politically-exposed-person attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false description: 'At least one of `name-first`, `name-middle`, `name-last`, or `term` is required.' properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: Joe name-middle: type: - string - 'null' description: The middle name of the individual to search. example: 'N' name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe term: type: - string - 'null' description: Custom search term instead of separate name parts of the individual (i.e. first + middle + last name). example: Joe N Doe birthdate: type: - string - 'null' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1991-10-07' country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code. example: US required: - query required: - attributes report-profile-request: title: Profile Report description: Fields required to create a Profile Report type: object additionalProperties: false properties: type: type: string const: report/profile attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: John name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe birthdate: type: - string - 'null' pattern: '^\d{4}-\d{2}-\d{2}$' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1970-01-01' social-security-number: type: - string - 'null' pattern: '^\d{3}-\d{2}-\d{4}$' description: Social security number. example: 123-45-6789 address-street-1: type: - string - 'null' description: 'Address line 1 (e.g., street or PO Box).' example: 123 Main St address-street-2: type: - string - 'null' description: 'Address line 2 (e.g., apartment, suite, unit, or building).' example: Apt 4 address-city: type: - string - 'null' description: City of residence. example: Anytown address-subdivision: type: - string - 'null' description: 'State or subdivision of residence, unabbreviated.' example: California address-postal-code: type: - string - 'null' description: ZIP or postal code of residence. example: '12345' country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code for the location of residence. example: US phone-number: type: - string - 'null' description: Phone number. example: 555-555-5555 report-profile-non-authoritative-request: title: Profile Non-Authoritative Report description: Fields required to create a Profile Non-Authoritative Report type: object additionalProperties: false properties: type: type: string const: report/profile-non-authoritative attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false description: 'Requires `phone-number`, or `email-address`, or all of `name-first`, `name-last`, `address-city`, and `address-subdivision`.' properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: Jane name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe phone-number: type: - string - 'null' description: Phone number of the individual to search. example: '+14169671111' email-address: description: Email address of the individual to search. type: - string - 'null' example: address@domain.com address-city: type: - string - 'null' description: City example: Funkyville address-subdivision: type: - string - 'null' description: Subnational division (such as a state or province) of the country of residence. example: Wisconsin required: - query required: - attributes report-social-media-request: title: Social Media Report description: Fields required to create a Social Media Report type: object additionalProperties: false properties: type: type: string const: report/social-media attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false description: 'Requires `phone-number` or `email-address` or `name-first`, `name-last`, `address-city`, and `address-subdivision`.' properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: Jane name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe birthdate: type: - string - 'null' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1991-10-07' phone-number: type: - string - 'null' description: Phone number of the individual to search. example: '+14169671111' email-address: description: Email address of the individual to search. type: - string - 'null' example: address@domain.com address-city: type: - string - 'null' description: City example: Funkyville address-subdivision: type: - string - 'null' description: Subnational division (such as a state or province) of the country of residence. example: Wisconsin address-postal-code: type: - string - 'null' description: ZIP or postal code of residence. example: '12345' address-country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code for the location of residence. example: US required: - query required: - attributes report-synthetic-request: title: Synthetic Report Report description: Fields required to create a Synthetic Report type: object additionalProperties: false properties: type: type: string const: report/synthetic attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false properties: name-first: type: string description: The first name of the individual to search. example: John name-last: type: string description: The last name of the individual to search. example: Doe birthdate: type: string pattern: '^\d{4}-\d{2}-\d{2}$' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1980-07-15' social-security-number: type: - string - 'null' pattern: '^\d{3}-\d{2}-\d{4}$' description: Social security number. One of `identification-number` or `social-security-number` is required. example: 123-45-6789 identification-number: type: - string - 'null' description: Any identification number that is not a social security number. One of `identification-number` or `social-security-number` is required. address-street-1: type: string description: 'Address line 1 (e.g., street, PO Box, or company name).' example: 456 Elm St address-street-2: type: - string - 'null' description: 'Address line 2 (e.g., apartment, suite, unit, or building).' example: Suite 2 address-city: type: string description: City example: Springfield address-subdivision: type: string description: 'Subnational division of a country, such as a state or province. Unabbreviated.' example: California address-postal-code: type: string description: ZIP or postal code. example: '12345' address-country-code: type: string description: ISO 3166-1 alpha-2 country code. example: US phone-number: type: - string - 'null' description: Phone number. example: 555-555-1234 email-address: type: - string - 'null' description: Email address. example: john.doe@example.com required: - name-first - name-last - birthdate - address-street-1 - address-city - address-subdivision - address-postal-code - address-country-code required: - query required: - attributes report-watchlist-request: title: Watchlist Report description: Fields required to create a Watchlist Report type: object additionalProperties: false properties: type: type: string const: report/watchlist attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-shared-request-attributes' - type: object properties: query: type: object additionalProperties: false description: 'At least one of `name-first`, `name-middle`, `name-last`, or `term` is required.' properties: name-first: type: - string - 'null' description: The first name of the individual to search. example: Joe name-middle: type: - string - 'null' description: The middle name of the individual to search. example: 'N' name-last: type: - string - 'null' description: The last name of the individual to search. example: Doe term: type: - string - 'null' description: Custom search term instead of separate name parts of the individual (i.e. first + middle + last name). example: Joe N Doe birthdate: type: - string - 'null' description: 'The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601).' example: '1991-10-07' address-country-code: type: - string - 'null' description: ISO 3166-1 alpha-2 country code. example: US required: - query required: - attributes report-template-shared-attributes: x-inheritable: true type: object properties: name: type: string created-at: format: date-time examples: - '2020-04-12T05:08:51.000Z' type: string updated-at: format: date-time examples: - '2020-04-12T05:08:51.000Z' type: string report-template-shared-meta: x-inheritable: true type: object properties: version: type: object additionalProperties: false properties: name: type: string created-at: format: date-time examples: - '2020-04-12T05:08:51.000Z' type: string updated-at: format: date-time examples: - '2020-04-12T05:08:51.000Z' type: string report-template-address-lookup: title: Address Lookup Report Template description: An Address Lookup Report Template type: object additionalProperties: false properties: type: type: string const: report-template/address-lookup id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-adverse-media: title: Adverse Media Report Template description: An Adverse Media Report Template type: object additionalProperties: false properties: type: type: string const: report-template/adverse-media id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-business-adverse-media: title: Business Adverse Media Report Template description: A Business Adverse Media Report Template type: object additionalProperties: false properties: type: type: string const: report-template/business-adverse-media id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-business-associated-persons: title: Business Associated Persons Report Template description: A Business Associated Persons Report Template type: object additionalProperties: false properties: type: type: string const: report-template/business-associated-persons id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-business-lookup: title: Business Lookup Report Template description: A Business Lookup Report Template type: object additionalProperties: false properties: type: type: string const: report-template/business-lookup id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-business-registrations-lookup: title: Business Registrations Lookup Report Template description: A Business Registrations Lookup Report Template type: object additionalProperties: false properties: type: type: string const: report-template/business-registrations-lookup id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-business-watchlist: title: Business Watchlist Report Template description: A Business Watchlist Report Template type: object additionalProperties: false properties: type: type: string const: report-template/business-watchlist id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-crypto-address-watchlist: title: Crypto Address Watchlist Report Template description: A Crypto Address Watchlist Report Template type: object additionalProperties: false properties: type: type: string const: report-template/crypto-address-watchlist id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-email-address: title: Email Address Report Template description: An Email Address Report Template type: object additionalProperties: false properties: type: type: string const: report-template/email-address id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-phone-risk: title: Phone Risk Report Template description: A Phone Risk Report Template type: object additionalProperties: false properties: type: type: string const: report-template/phone-number id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-politically-exposed-person: title: Politically Exposed Person Report Template description: A Politically Exposed Person Report Template type: object additionalProperties: false properties: type: type: string const: report-template/politically-exposed-person id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-profile: title: Profile Report Template description: A Profile Report Template type: object additionalProperties: false properties: type: type: string const: report-template/profile id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-sentilink-scores: title: SentiLink Report Template description: A SentiLink Report Template type: object additionalProperties: false properties: type: type: string const: report-template/integration/sentilink-scores id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-social-media: title: Social Media Report Template description: A Social Media Report Template type: object additionalProperties: false properties: type: type: string const: report-template/social-media id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-synthetic: title: Synthetic Template description: A Synthetic Template type: object additionalProperties: false properties: type: type: string const: report-template/synthetic id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-attributes' meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' report-template-watchlist: title: Watchlist Report Template description: A Watchlist Report Template type: object additionalProperties: false properties: type: type: string const: report-template/watchlist id: type: string description: The ID of the Report Template example: rptp_7WNzPaNcroBKLarNHBjYDLAp attributes: unevaluatedProperties: false allOf: - $ref: '#/components/schemas/report-template-shared-attributes' - type: object properties: search-lists: type: array items: type: object additionalProperties: false properties: slug: type: string type: type: string meta: unevaluatedProperties: false $ref: '#/components/schemas/report-template-shared-meta' reports-included-objects: type: array items: discriminator: propertyName: type mapping: inquiry: '#/components/schemas/inquiry' account: '#/components/schemas/account' case: '#/components/schemas/case' report-template/address-lookup: '#/components/schemas/report-template-address-lookup' report-template/adverse-media: '#/components/schemas/report-template-adverse-media' report-template/business-adverse-media: '#/components/schemas/report-template-business-adverse-media' report-template/business-associated-persons: '#/components/schemas/report-template-business-associated-persons' report-template/business-lookup: '#/components/schemas/report-template-business-lookup' report-template/business-registrations-lookup: '#/components/schemas/report-template-business-registrations-lookup' report-template/business-watchlist: '#/components/schemas/report-template-business-watchlist' report-template/crypto-address-watchlist: '#/components/schemas/report-template-crypto-address-watchlist' report-template/email-address: '#/components/schemas/report-template-email-address' report-template/phone-number: '#/components/schemas/report-template-phone-risk' report-template/politically-exposed-person: '#/components/schemas/report-template-politically-exposed-person' report-template/profile: '#/components/schemas/report-template-profile' report-template/integration/sentilink-scores: '#/components/schemas/report-template-sentilink-scores' report-template/social-media: '#/components/schemas/report-template-social-media' report-template/synthetic: '#/components/schemas/report-template-synthetic' report-template/watchlist: '#/components/schemas/report-template-watchlist' transaction: '#/components/schemas/transaction' oneOf: - $ref: '#/components/schemas/inquiry' - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/case' - $ref: '#/components/schemas/report-template-address-lookup' - $ref: '#/components/schemas/report-template-adverse-media' - $ref: '#/components/schemas/report-template-business-adverse-media' - $ref: '#/components/schemas/report-template-business-associated-persons' - $ref: '#/components/schemas/report-template-business-lookup' - $ref: '#/components/schemas/report-template-business-registrations-lookup' - $ref: '#/components/schemas/report-template-business-watchlist' - $ref: '#/components/schemas/report-template-crypto-address-watchlist' - $ref: '#/components/schemas/report-template-email-address' - $ref: '#/components/schemas/report-template-phone-risk' - $ref: '#/components/schemas/report-template-politically-exposed-person' - $ref: '#/components/schemas/report-template-profile' - $ref: '#/components/schemas/report-template-sentilink-scores' - $ref: '#/components/schemas/report-template-social-media' - $ref: '#/components/schemas/report-template-synthetic' - $ref: '#/components/schemas/report-template-watchlist' - $ref: '#/components/schemas/transaction' report-history-run: type: object title: Report History Run Entry description: A run entry in the report history additionalProperties: false required: - type - run-type properties: id: type: string description: The unique identifier for this history entry example: rpr_xSwbLw3ikLrcy7bwzhc5zA3ZRkpr type: type: string const: run description: The type of history entry example: run run-type: type: string description: |- The type of run Possible values: - manual - scheduled Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. example: scheduled scheduled-date: type: string format: date description: The date the report is scheduled to run on example: '2025-10-22' completed-at: type: - string - 'null' format: date-time description: When the run was completed example: '2025-10-22T05:07:10.000+00:00' matches: type: - integer - 'null' description: The number of matches found (only present if the run is completed) example: 30 report-history-dismiss: type: object title: Report History Dismissal Entry description: A dismissal entry in the report history additionalProperties: false required: - type - created-at - creator-name properties: id: type: string description: The unique identifier for this history entry example: rpr_xSwbLw3ikLrcy7bwzhc5zA3ZRkpr type: type: string const: dismiss description: The type of history entry example: dismiss created-at: type: string format: date-time description: When the dismissal was created example: '2025-10-22T05:09:22.065+00:00' creator-name: type: string description: The name of the user that dismissed the report example: John Doe report-history-pause: type: object title: Report History Pause Entry description: A pause entry in the report history additionalProperties: false required: - type - created-at - creator-name properties: id: type: string description: The unique identifier for this history entry example: rpr_xSwbLw3ikLrcy7bwzhc5zA3ZRkpr type: type: string const: pause description: The type of history entry example: pause created-at: type: string format: date-time description: When the report was paused example: '2025-10-22T05:09:22.065+00:00' creator-name: type: string description: The name of the user that paused the report example: John Doe report-history-resume: type: object title: Report History Resume Entry description: A resume entry in the report history additionalProperties: false required: - type - created-at - creator-name properties: id: type: string description: The unique identifier for this history entry example: rpr_xSwbLw3ikLrcy7bwzhc5zA3ZRkpr type: type: string const: resume description: The type of history entry example: resume created-at: type: string format: date-time description: When the report was resumed example: '2025-10-22T05:09:22.065+00:00' creator-name: type: string description: The name of the user that resumed the report example: John Doe report-history-review: type: object title: Report History Review Entry description: A review entry in the report history additionalProperties: false required: - type - created-at - creator-name properties: id: type: string description: The unique identifier for this history entry example: rpr_xSwbLw3ikLrcy7bwzhc5zA3ZRkpr type: type: string const: review description: The type of history entry example: review created-at: type: string format: date-time description: When the review was created example: '2025-10-22T04:30:03.000+00:00' creator-name: type: string description: The name of the user that reviewed the report example: John Doe report-history: type: array title: Report History description: The history of runs and actions for a report items: type: object discriminator: propertyName: type mapping: run: '#/components/schemas/report-history-run' dismiss: '#/components/schemas/report-history-dismiss' pause: '#/components/schemas/report-history-pause' resume: '#/components/schemas/report-history-resume' review: '#/components/schemas/report-history-review' oneOf: - $ref: '#/components/schemas/report-history-dismiss' - $ref: '#/components/schemas/report-history-run' - $ref: '#/components/schemas/report-history-review' - $ref: '#/components/schemas/report-history-pause' - $ref: '#/components/schemas/report-history-resume' transaction-label: type: object additionalProperties: false properties: type: type: string const: transaction-label id: description: Unique identifier for this Transaction Label. Starts with `txnl_`. type: string examples: - txnl_ABC123 attributes: type: object additionalProperties: false properties: model-label: type: string examples: - test model-version: type: - string - 'null' examples: - 1.2.3 created-at: type: string format: date-time examples: - '2023-06-29T23:54:35.293Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-06-29T23:54:35.293Z' transaction-type: type: object additionalProperties: false properties: type: type: string const: transaction-type id: description: Unique identifier for this Transaction Type. Starts with `txntp_`. type: string examples: - txntp_ABC123 attributes: type: object additionalProperties: false properties: name: type: string created-at: type: string format: date-time examples: - '2023-06-29T23:54:35.293Z' updated-at: type: - string - 'null' format: date-time examples: - '2023-06-29T23:54:35.293Z' field-schemas: type: array items: unevaluatedProperties: false $ref: '#/components/schemas/field-schema' user-audit-log: type: object additionalProperties: false properties: type: type: string const: user-audit-log id: type: string examples: - ual_ABC123 attributes: type: object additionalProperties: false properties: path: type: string examples: - /api/internal/dashboard/v1/cases/case_ABC123 method: type: string examples: - GET - POST get-params: type: - object - string description: | The GET params of the request. Schema depends on the action taken. Note: For large payloads, the value may appear as [FILTERED] to indicate redaction or truncation. additionalProperties: true post-params: type: - object - string description: | The POST params of the request. Schema depends on the action taken. Note: For large payloads, the value may appear as [FILTERED] to indicate redaction or truncation. additionalProperties: true ip-address: type: string examples: - 127.0.0.1 user-agent: type: string examples: - Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 response-status: type: integer format: int32 examples: - 200 created-at: type: string format: date-time examples: - '2023-10-03T19:41:30.155Z' impersonator-email-address: type: - string - 'null' examples: - user@withpersona.com context: type: object properties: inquiry-id: type: string description: ID of the inquiry created -- this property is only present when path is /api/internal/dashboard/v1/inquiries and method is POST examples: - inq_ABC123 additionalProperties: true description: 'Context of the audit log. Currently, this property is only present for dashboard inquiry creation audit logs -- when path is /api/internal/dashboard/v1/inquiries and method is POST.' relationships: type: object additionalProperties: false properties: user: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string const: user id: type: string examples: - user_ABC123 user-session: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: type: type: string const: user-session id: type: string examples: - uses_ABC123 verification: type: object discriminator: propertyName: type mapping: verification/aamva: '#/components/schemas/verification-aamva' verification/bank-pennydrop: '#/components/schemas/verification-bank-pennydrop' verification/brand-asset: '#/components/schemas/verification-brand-asset' verification/business-website: '#/components/schemas/verification-business-website' verification/certificate-korea: '#/components/schemas/verification-certificate-korea' verification/credit-card: '#/components/schemas/verification-credit-card' verification/database: '#/components/schemas/verification-database' verification/database-aadhaar: '#/components/schemas/verification-database-aadhaar' verification/database-business: '#/components/schemas/verification-database-business' verification/database-business-footprint: '#/components/schemas/verification-database-business-footprint' verification/database-ecbsv: '#/components/schemas/verification-database-ecbsv' verification/database-phone-carrier: '#/components/schemas/verification-database-phone-carrier' verification/database-serpro: '#/components/schemas/verification-database-serpro' verification/database-standard: '#/components/schemas/verification-database-standard' verification/database-tin: '#/components/schemas/verification-database-tin' verification/database-vat-number: '#/components/schemas/verification-database-vat-number' verification/digital-id-connect-id: '#/components/schemas/verification-digital-id-connect-id' verification/digital-id-e-do-app: '#/components/schemas/verification-digital-id-e-do-app' verification/digital-id-finnish-trust-network: '#/components/schemas/verification-digital-id-finnish-trust-network' verification/digital-id-france-identite: '#/components/schemas/verification-digital-id-france-identite' verification/digital-id-generic: '#/components/schemas/verification-digital-id-generic' verification/digital-id-idin: '#/components/schemas/verification-digital-id-idin' verification/digital-id-its-me: '#/components/schemas/verification-digital-id-its-me' verification/digital-id-kcb-credit-card: '#/components/schemas/verification-digital-id-kcb-credit-card' verification/digital-id-mit-id: '#/components/schemas/verification-digital-id-mit-id' verification/digital-id-one-id: '#/components/schemas/verification-digital-id-one-id' verification/digital-id-philsys: '#/components/schemas/verification-digital-id-philsys' verification/digital-id-serpro: '#/components/schemas/verification-digital-id-serpro' verification/digital-id-singpass: '#/components/schemas/verification-digital-id-singpass' verification/digital-id-swedish-bank-id: '#/components/schemas/verification-digital-id-swedish-bank-id' verification/digital-id-uk-sharecode: '#/components/schemas/verification-digital-id-uk-sharecode' verification/digital-id-world-id: '#/components/schemas/verification-digital-id-world-id' verification/document: '#/components/schemas/verification-document' verification/email-address: '#/components/schemas/verification-email-address' verification/government-id: '#/components/schemas/verification-government-id' verification/government-id-nfc: '#/components/schemas/verification-government-id-nfc' verification/jp-my-number-nfc-scan: '#/components/schemas/verification-jp-my-number-nfc-scan' verification/mdoc: '#/components/schemas/verification-mdoc' verification/persona-fff-inquiry: '#/components/schemas/verification-persona-fff-inquiry' verification/phone-number: '#/components/schemas/verification-phone-number' verification/phone-number-silent-network-authentication: '#/components/schemas/verification-phone-number-silent-network-authentication' verification/qes-infocert: '#/components/schemas/verification-qes-infocert' verification/selfie: '#/components/schemas/verification-selfie' verification/verifiable-credential: '#/components/schemas/verification-verifiable-credential' oneOf: - $ref: '#/components/schemas/verification-aamva' - $ref: '#/components/schemas/verification-bank-pennydrop' - $ref: '#/components/schemas/verification-brand-asset' - $ref: '#/components/schemas/verification-business-website' - $ref: '#/components/schemas/verification-certificate-korea' - $ref: '#/components/schemas/verification-credit-card' - $ref: '#/components/schemas/verification-database' - $ref: '#/components/schemas/verification-database-aadhaar' - $ref: '#/components/schemas/verification-database-business' - $ref: '#/components/schemas/verification-database-business-footprint' - $ref: '#/components/schemas/verification-database-ecbsv' - $ref: '#/components/schemas/verification-database-phone-carrier' - $ref: '#/components/schemas/verification-database-serpro' - $ref: '#/components/schemas/verification-database-standard' - $ref: '#/components/schemas/verification-database-tin' - $ref: '#/components/schemas/verification-database-vat-number' - $ref: '#/components/schemas/verification-digital-id-connect-id' - $ref: '#/components/schemas/verification-digital-id-e-do-app' - $ref: '#/components/schemas/verification-digital-id-finnish-trust-network' - $ref: '#/components/schemas/verification-digital-id-france-identite' - $ref: '#/components/schemas/verification-digital-id-generic' - $ref: '#/components/schemas/verification-digital-id-idin' - $ref: '#/components/schemas/verification-digital-id-its-me' - $ref: '#/components/schemas/verification-digital-id-kcb-credit-card' - $ref: '#/components/schemas/verification-digital-id-mit-id' - $ref: '#/components/schemas/verification-digital-id-one-id' - $ref: '#/components/schemas/verification-digital-id-philsys' - $ref: '#/components/schemas/verification-digital-id-serpro' - $ref: '#/components/schemas/verification-digital-id-singpass' - $ref: '#/components/schemas/verification-digital-id-swedish-bank-id' - $ref: '#/components/schemas/verification-digital-id-uk-sharecode' - $ref: '#/components/schemas/verification-digital-id-world-id' - $ref: '#/components/schemas/verification-document' - $ref: '#/components/schemas/verification-email-address' - $ref: '#/components/schemas/verification-government-id' - $ref: '#/components/schemas/verification-government-id-nfc' - $ref: '#/components/schemas/verification-jp-my-number-nfc-scan' - $ref: '#/components/schemas/verification-mdoc' - $ref: '#/components/schemas/verification-persona-fff-inquiry' - $ref: '#/components/schemas/verification-phone-number' - $ref: '#/components/schemas/verification-phone-number-silent-network-authentication' - $ref: '#/components/schemas/verification-qes-infocert' - $ref: '#/components/schemas/verification-selfie' - $ref: '#/components/schemas/verification-verifiable-credential' verification-template: title: Verification Template description: A reference to a Verification Template. The external API exposes Verification Templates as opaque pointers — only `type` and `id` are returned. The `type` is namespaced by the underlying verification subtype (for example `verification-template/government-id`). type: object additionalProperties: false required: - type - id properties: type: x-polymorphic: true type: string pattern: '^verification-template/[a-z0-9-]+$' example: verification-template/government-id id: type: string description: The token of the Verification Template. example: vtmpl_ABC123 verification-template-version: title: Verification Template Version description: A reference to a Verification Template Version. The external API exposes Verification Template Versions as opaque pointers — only `type` and `id` are returned. The `type` is namespaced by the underlying verification subtype (for example `verification-template-version/government-id`). type: object additionalProperties: false required: - type - id properties: type: x-polymorphic: true type: string pattern: '^verification-template-version/[a-z0-9-]+$' example: verification-template-version/government-id id: type: string description: The token of the Verification Template Version. example: vtmplv_ABC123 verification-included-objects: type: array items: discriminator: propertyName: type mapping: account: '#/components/schemas/account' document/generic: '#/components/schemas/document-generic' document/government-id: '#/components/schemas/document-government-id' document/government-id-nfc: '#/components/schemas/document-government-id-nfc' document/mdoc: '#/components/schemas/document-mdoc' inquiry: '#/components/schemas/inquiry' inquiry-template: '#/components/schemas/inquiry-template' inquiry-template-version: '#/components/schemas/inquiry-template-version' template: '#/components/schemas/template' transaction: '#/components/schemas/transaction' verification-template/aamva: '#/components/schemas/verification-template' verification-template/bank-pennydrop: '#/components/schemas/verification-template' verification-template/brand-asset: '#/components/schemas/verification-template' verification-template/business-website: '#/components/schemas/verification-template' verification-template/certificate-korea: '#/components/schemas/verification-template' verification-template/credit-card: '#/components/schemas/verification-template' verification-template/database: '#/components/schemas/verification-template' verification-template/database-aadhaar: '#/components/schemas/verification-template' verification-template/database-business: '#/components/schemas/verification-template' verification-template/database-business-footprint: '#/components/schemas/verification-template' verification-template/database-ecbsv: '#/components/schemas/verification-template' verification-template/database-phone-carrier: '#/components/schemas/verification-template' verification-template/database-serpro: '#/components/schemas/verification-template' verification-template/database-standard: '#/components/schemas/verification-template' verification-template/database-tin: '#/components/schemas/verification-template' verification-template/database-vat-number: '#/components/schemas/verification-template' verification-template/digital-id-connect-id: '#/components/schemas/verification-template' verification-template/digital-id-e-do-app: '#/components/schemas/verification-template' verification-template/digital-id-finnish-trust-network: '#/components/schemas/verification-template' verification-template/digital-id-france-identite: '#/components/schemas/verification-template' verification-template/digital-id-generic: '#/components/schemas/verification-template' verification-template/digital-id-idin: '#/components/schemas/verification-template' verification-template/digital-id-its-me: '#/components/schemas/verification-template' verification-template/digital-id-kcb-credit-card: '#/components/schemas/verification-template' verification-template/digital-id-mit-id: '#/components/schemas/verification-template' verification-template/digital-id-one-id: '#/components/schemas/verification-template' verification-template/digital-id-philsys: '#/components/schemas/verification-template' verification-template/digital-id-serpro: '#/components/schemas/verification-template' verification-template/digital-id-singpass: '#/components/schemas/verification-template' verification-template/digital-id-swedish-bank-id: '#/components/schemas/verification-template' verification-template/digital-id-uk-sharecode: '#/components/schemas/verification-template' verification-template/digital-id-world-id: '#/components/schemas/verification-template' verification-template/document: '#/components/schemas/verification-template' verification-template/email-address: '#/components/schemas/verification-template' verification-template/government-id: '#/components/schemas/verification-template' verification-template/government-id-nfc: '#/components/schemas/verification-template' verification-template/jp-my-number-nfc-scan: '#/components/schemas/verification-template' verification-template/mdoc: '#/components/schemas/verification-template' verification-template/persona-fff-inquiry: '#/components/schemas/verification-template' verification-template/phone-number: '#/components/schemas/verification-template' verification-template/phone-number-silent-network-authentication: '#/components/schemas/verification-template' verification-template/qes-infocert: '#/components/schemas/verification-template' verification-template/selfie: '#/components/schemas/verification-template' verification-template/verifiable-credential: '#/components/schemas/verification-template' verification-template-version/aamva: '#/components/schemas/verification-template-version' verification-template-version/bank-pennydrop: '#/components/schemas/verification-template-version' verification-template-version/brand-asset: '#/components/schemas/verification-template-version' verification-template-version/business-website: '#/components/schemas/verification-template-version' verification-template-version/certificate-korea: '#/components/schemas/verification-template-version' verification-template-version/credit-card: '#/components/schemas/verification-template-version' verification-template-version/database: '#/components/schemas/verification-template-version' verification-template-version/database-aadhaar: '#/components/schemas/verification-template-version' verification-template-version/database-business: '#/components/schemas/verification-template-version' verification-template-version/database-business-footprint: '#/components/schemas/verification-template-version' verification-template-version/database-ecbsv: '#/components/schemas/verification-template-version' verification-template-version/database-phone-carrier: '#/components/schemas/verification-template-version' verification-template-version/database-serpro: '#/components/schemas/verification-template-version' verification-template-version/database-standard: '#/components/schemas/verification-template-version' verification-template-version/database-tin: '#/components/schemas/verification-template-version' verification-template-version/database-vat-number: '#/components/schemas/verification-template-version' verification-template-version/digital-id-connect-id: '#/components/schemas/verification-template-version' verification-template-version/digital-id-e-do-app: '#/components/schemas/verification-template-version' verification-template-version/digital-id-finnish-trust-network: '#/components/schemas/verification-template-version' verification-template-version/digital-id-france-identite: '#/components/schemas/verification-template-version' verification-template-version/digital-id-generic: '#/components/schemas/verification-template-version' verification-template-version/digital-id-idin: '#/components/schemas/verification-template-version' verification-template-version/digital-id-its-me: '#/components/schemas/verification-template-version' verification-template-version/digital-id-kcb-credit-card: '#/components/schemas/verification-template-version' verification-template-version/digital-id-mit-id: '#/components/schemas/verification-template-version' verification-template-version/digital-id-one-id: '#/components/schemas/verification-template-version' verification-template-version/digital-id-philsys: '#/components/schemas/verification-template-version' verification-template-version/digital-id-serpro: '#/components/schemas/verification-template-version' verification-template-version/digital-id-singpass: '#/components/schemas/verification-template-version' verification-template-version/digital-id-swedish-bank-id: '#/components/schemas/verification-template-version' verification-template-version/digital-id-uk-sharecode: '#/components/schemas/verification-template-version' verification-template-version/digital-id-world-id: '#/components/schemas/verification-template-version' verification-template-version/document: '#/components/schemas/verification-template-version' verification-template-version/email-address: '#/components/schemas/verification-template-version' verification-template-version/government-id: '#/components/schemas/verification-template-version' verification-template-version/government-id-nfc: '#/components/schemas/verification-template-version' verification-template-version/jp-my-number-nfc-scan: '#/components/schemas/verification-template-version' verification-template-version/mdoc: '#/components/schemas/verification-template-version' verification-template-version/persona-fff-inquiry: '#/components/schemas/verification-template-version' verification-template-version/phone-number: '#/components/schemas/verification-template-version' verification-template-version/phone-number-silent-network-authentication: '#/components/schemas/verification-template-version' verification-template-version/qes-infocert: '#/components/schemas/verification-template-version' verification-template-version/selfie: '#/components/schemas/verification-template-version' verification-template-version/verifiable-credential: '#/components/schemas/verification-template-version' oneOf: - $ref: '#/components/schemas/account' - $ref: '#/components/schemas/document-generic' - $ref: '#/components/schemas/document-government-id' - $ref: '#/components/schemas/document-government-id-nfc' - $ref: '#/components/schemas/document-mdoc' - $ref: '#/components/schemas/inquiry' - $ref: '#/components/schemas/inquiry-template' - $ref: '#/components/schemas/inquiry-template-version' - $ref: '#/components/schemas/template' - $ref: '#/components/schemas/transaction' - $ref: '#/components/schemas/verification-template' - $ref: '#/components/schemas/verification-template-version' included-allowlist: description: 'Controls which related objects appear in the `included` array of webhook payloads. The default is `include_none`. When `state` is `custom`, `event-types` configures which related objects to include per event type: event types you are subscribed to (via `enabled-events`) but do not list are excluded, and event types you list but are not subscribed to are dropped on save. A `custom` config whose event types are all `["*"]` is equivalent to, and is normalized to, `include_all`.' unevaluatedProperties: false oneOf: - title: Include all type: object additionalProperties: false required: - state properties: state: type: string const: include_all description: Include all related objects for every subscribed event type. - title: Include none type: object additionalProperties: false required: - state properties: state: type: string const: include_none description: Include no related objects (the default). - title: Custom type: object additionalProperties: false required: - state - event-types properties: state: type: string const: custom description: Configure included related objects per event type via `event-types`. event-types: type: array minItems: 1 maxItems: 200 description: Per-event-type include configuration. At most one entry per event type. items: type: object additionalProperties: false required: - event-type - relationships properties: event-type: type: string description: 'Event type identifier (e.g. `inquiry`, `account`).' relationships: type: array minItems: 1 description: 'Related object names to include for this event type, or `["*"]` to include all related objects. `"*"` cannot be combined with named relationships.' items: type: string relationship-allowlist: description: Controls whether relationships are serialized in webhook payload objects. The default is `include_all`. The object shape leaves room for future granular relationship configuration. unevaluatedProperties: false oneOf: - title: Include all type: object additionalProperties: false required: - state properties: state: type: string const: include_all description: Include relationship linkages in webhook payload objects. - title: Include none type: object additionalProperties: false required: - state properties: state: type: string const: include_none description: Omit relationship linkages from webhook payload objects. webhook: type: object additionalProperties: false description: A Webhook object properties: type: type: string const: webhook id: examples: - wbh_ABC123 type: string attributes: type: object additionalProperties: false properties: status: type: string examples: - disabled url: type: string examples: - 'https://withpersona.com' name: type: - string - 'null' examples: - Test webhook description: type: - string - 'null' examples: - Webhook for testing api-version: $ref: '#/components/schemas/api-version' api-key-inflection: type: string examples: - kebab api-attributes-blocklist: type: array items: type: - string - 'null' examples: - - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: type: integer format: int32 examples: - 21600 enabled-events: type: array items: type: string examples: - - account.created - verification.created - '*' payload-filter: type: - object - 'null' included-allowlist: oneOf: - type: 'null' - $ref: '#/components/schemas/included-allowlist' unevaluatedProperties: false examples: - state: include_all relationship-allowlist: $ref: '#/components/schemas/relationship-allowlist' created-at: type: string format: date-time examples: - '2023-09-21T18:29:40.000Z' webhook-request-attributes: type: object additionalProperties: false properties: name: description: A name for remembering webhook type: string description: description: An optional description for this webhook type: - string - 'null' url: description: URL to which webhook events are forwarded. type: string enabled-events: description: 'Supported events that you want to receive webhooks for. Set `*` to enable all events. Descriptions of all events can be found [here](https://docs.withpersona.com/events). Retrieve Events for your organization using the [Events API](https://docs.withpersona.com/api-reference/events/list-all-events).' items: type: string enum: - '*' - account-property.redacted - account-type.deleted-field - account.added-relation - account.archived - account.consolidated - account.consolidated-with - account.created - account.redacted - account.removed-relation - account.restored - account.status-updated - account.tag-added - account.tag-removed - account.updated-fields - account.updated-tags - agent-conversation.created - agent-conversation.errored - agent-conversation.message-added - authentication.completed - authentication.created - authentication.expired - authentication.failed - authentication.redacted - case-comment.created - case-message.received - case-message.sent - case-template.deleted-field - case.assigned - case.created - case.exported - case.print-initiated - case.queue-updated - case.redacted - case.reopened - case.resolved - case.sla-expired - case.status-updated - case.updated - case.updated-fields - case.updated-tags - checkpoint.completed - checkpoint.created - checkpoint.expired - checkpoint.failed - checkpoint.reusable-persona-used - checkpoint.started - connect/share-token.inbound-created - connect/share-token.inbound-redeemed - connect/share-token.outbound-created - connect/share-token.outbound-redeemed - document.created - document.errored - document.extracted - document.pending - document.processed - document.submitted - filing.created - filing.filed - graph-query.cancelled - graph-query.completed - graph-query.errored - graph-query.reran - graph-query.submitted - graph-query.timed-out - importer-pipeline-run.canceled - importer-pipeline-run.completed - importer-pipeline-run.errored - importer-pipeline-run.paused - importer-pipeline-run.resumed - importer-pipeline-run.started - inquiry-session.canceled - inquiry-session.expired - inquiry-session.started - inquiry-template-version.created - inquiry-template-version.published - inquiry.approved - inquiry.completed - inquiry.created - inquiry.declined - inquiry.expired - inquiry.failed - inquiry.marked-for-review - inquiry.redacted - inquiry.reusable-persona-assurance-failed - inquiry.reusable-persona-created - inquiry.reusable-persona-updated - inquiry.reusable-persona-used - inquiry.started - inquiry.transitioned - inquiry.updated-tags - integration-log.created - report/address-lookup.errored - report/address-lookup.ready - report/address-lookup.submitted - report/adverse-media.dismissed - report/adverse-media.errored - report/adverse-media.matched - report/adverse-media.ready - report/background-check.ready - report/better-business-bureau.errored - report/better-business-bureau.ready - report/business-adverse-media.dismissed - report/business-adverse-media.errored - report/business-adverse-media.matched - report/business-adverse-media.ready - report/business-associated-persons.errored - report/business-associated-persons.ready - report/business-classification.errored - report/business-classification.ready - report/business-classification.submitted - report/business-enforcement-action.errored - report/business-enforcement-action.ready - report/business-enforcement-action.submitted - report/business-industry-classification.errored - report/business-industry-classification.ready - report/business-industry-classification.submitted - report/business-liens-lookup.errored - report/business-liens-lookup.ready - report/business-lookup-eu.errored - report/business-lookup-eu.ready - report/business-lookup.errored - report/business-lookup.ready - report/business-media-coverage.errored - report/business-media-coverage.matched - report/business-media-coverage.ready - report/business-media-coverage.submitted - report/business-nonprofit.changed - report/business-nonprofit.errored - report/business-nonprofit.ready - report/business-online-presence.errored - report/business-online-presence.ready - report/business-online-presence.submitted - report/business-personnel-insights.errored - report/business-personnel-insights.ready - report/business-personnel-insights.submitted - report/business-registrations-lookup.errored - report/business-registrations-lookup.ready - report/business-social-media.errored - report/business-social-media.ready - report/business-watchlist.dismissed - report/business-watchlist.errored - report/business-watchlist.matched - report/business-watchlist.ready - report/business-website.errored - report/business-website.ready - report/chainalysis-address-screening.errored - report/chainalysis-address-screening.ready - report/clearbit-business-lookup.errored - report/clearbit-business-lookup.ready - report/coinbase-check-crypto-risk.errored - report/coinbase-check-crypto-risk.ready - report/community-safety.errored - report/community-safety.matched - report/community-safety.ready - report/comply-advantage-search.ready - report/comprehensive-profile.ready - report/crypto-address-watchlist.errored - report/crypto-address-watchlist.matched - report/crypto-address-watchlist.ready - report/crypto_address.matched - report/crypto_address.ready - report/custom-list.dismissed - report/custom-list.errored - report/custom-list.matched - report/custom-list.ready - report/email-address.errored - report/email-address.ready - report/employer-lookup.ready - report/equifax-oneview.errored - report/equifax-oneview.ready - report/finra-broker-check.errored - report/finra-broker-check.ready - report/kyckr-business-lookup.errored - report/kyckr-business-lookup.ready - report/middesk.errored - report/middesk.ready - report/middesk.submitted - report/mx-account.errored - report/mx-account.ready - report/nces.errored - report/nces.ready - report/novacredit-cash-atlas.errored - report/novacredit-cash-atlas.ready - report/novacredit-cash-atlas.submitted - report/novacredit-credit-passport.errored - report/novacredit-credit-passport.ready - report/novacredit-credit-passport.submitted - report/phone-number.errored - report/phone-number.ready - report/politically-exposed-person.dismissed - report/politically-exposed-person.errored - report/politically-exposed-person.matched - report/politically-exposed-person.ready - report/profile-non-authoritative.errored - report/profile-non-authoritative.ready - report/profile.errored - report/profile.ready - report/screening.errored - report/screening.matched - report/screening.ready - report/sec-action-lookup.errored - report/sec-action-lookup.ready - report/sentilink-application-risk.errored - report/sentilink-application-risk.ready - report/sentilink-scores.errored - report/sentilink-scores.ready - report/social-media.errored - report/social-media.ready - report/synthetic.errored - report/synthetic.ready - report/trm-wallet-screening.errored - report/trm-wallet-screening.ready - report/watchlist.dismissed - report/watchlist.errored - report/watchlist.matched - report/watchlist.ready - sar.created - sar.filed - selfie.created - selfie.errored - selfie.processed - selfie.submitted - session.created - session.expired - transaction-type.deleted-field - transaction.added-relation - transaction.created - transaction.labeled - transaction.redacted - transaction.removed-relation - transaction.sentinel-session-processed - transaction.status-updated - transaction.updated-fields - user.availability-updated - verification.canceled - verification.created - verification.escalated - verification.failed - verification.passed - verification.requires-retry - verification.skipped - verification.submitted - verification.tentatively-failed - verification.tentatively-passed - verification.updated-tags - workflow-run.created - workflow-run.errored - workflow-run.resumed - workflow.published type: array api-version: description: API version that will be used for incoming webhook requests. Defaults to the API version used when making this request. $ref: '#/components/schemas/api-version' api-key-inflection: description: 'Default key inflection for attribute keys in incoming webhook requests. For more info see the [Key Inflection docs](https://docs.withpersona.com/key-inflection).' type: string default: kebab enum: - camel - kebab - snake api-attributes-blocklist: description: 'Attributes blocked from webhook requests. For more info see [Webhook Attributes Blocklist](https://docs.withpersona.com/webhook-blocklists#attribute-blocklist).' items: type: string type: array file-access-token-expires-in: description: 'How soon any file access tokens in webhook requests expire. For more info see [Downloading Files](https://docs.withpersona.com/downloading-files).' example: 21600 type: integer payload-filter: type: object additionalProperties: false description: 'Filter webhook events based on payload data. Only available for enterprise clients. For more info see [Webhook Event Filters](https://docs.withpersona.com/webhook-event-filters).' properties: data: type: object additionalProperties: true format: json included-allowlist: $ref: '#/components/schemas/included-allowlist' relationship-allowlist: $ref: '#/components/schemas/relationship-allowlist' custom-http-headers: description: 'Custom HTTP headers to include in webhook requests. For more info see [Webhook Custom HTTP Headers](https://docs.withpersona.com/webhook-custom-http-headers).' type: object additionalProperties: true properties: Authorization: type: string Calling-Application: type: string CF-Access-Client-Id: type: string CF-Access-Client-Secret: type: string X-API-Key: type: string webhook-with-secret: type: object additionalProperties: false description: A Webhook object properties: type: type: string const: webhook id: examples: - wbh_ABC123 type: string attributes: type: object additionalProperties: false properties: status: type: string examples: - disabled url: type: string examples: - 'https://withpersona.com' name: type: - string - 'null' examples: - Test webhook description: type: - string - 'null' examples: - Webhook for testing secret: description: secret is deprecated in favor of secrets type: string examples: - wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw secrets: type: array items: type: object additionalProperties: false properties: value: type: string examples: - wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw expires-at: type: - string - 'null' format: date-time api-version: $ref: '#/components/schemas/api-version' api-key-inflection: type: string examples: - kebab api-attributes-blocklist: type: array items: type: - string - 'null' examples: - - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: type: integer format: int32 examples: - 21600 enabled-events: type: array items: type: string examples: - - account.created - verification.created - '*' payload-filter: type: - object - 'null' included-allowlist: oneOf: - type: 'null' - $ref: '#/components/schemas/included-allowlist' unevaluatedProperties: false examples: - state: include_all relationship-allowlist: $ref: '#/components/schemas/relationship-allowlist' created-at: type: string format: date-time examples: - '2023-09-21T18:29:40.000Z' workflow-version: type: object additionalProperties: false description: A Workflow Version object properties: type: const: workflow-version type: string id: examples: - wfv_3JqAR9ddLRVZLK5z4yD8oeHB type: string attributes: properties: description: type: string status: description: |- The status of the Workflow Version Possible values: - draft - published - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. type: string created-at: examples: - '2022-08-08T18:55:44.910Z' type: string format: date-time type: object additionalProperties: false relationships: properties: workflow: properties: data: properties: type: const: workflow type: string id: examples: - wfl_3VghhbvDc7UuUNT8uZrqZjsk type: string type: object additionalProperties: false type: object additionalProperties: false type: object additionalProperties: false workflow-run-included-objects: type: array items: discriminator: propertyName: type mapping: workflow: '#/components/schemas/workflow' workflow-version: '#/components/schemas/workflow-version' event: '#/components/schemas/event' user: '#/components/schemas/user' oneOf: - $ref: '#/components/schemas/workflow' - $ref: '#/components/schemas/workflow-version' - $ref: '#/components/schemas/event' - $ref: '#/components/schemas/user' webhook-body-shared-data: x-inheritable: true type: object properties: type: type: string const: event id: type: string description: Unique identifier for this Event. Starts with `evt_`. examples: - evt_ABC123 webhook-body-shared-attributes: x-inheritable: true type: object properties: created-at: type: string format: date-time description: Datetime when the event was created. examples: - '2023-09-21T18:29:40.000Z' importer-pipeline-run: type: object additionalProperties: false description: An Importer Pipeline Run object. properties: type: type: string const: importer-pipeline-run id: type: string examples: - mprtpr_ABC123DEF456 attributes: type: object additionalProperties: false properties: reference-id: type: - string - 'null' description: Reference identifier for the pipeline run examples: - import-batch-001 status: type: string description: 'Current status of the pipeline run. Possible values include `pending`, `running`, `paused`, `canceled`, `completed`, `errored`, and `killed`.' examples: - running run-count: type: integer description: Number of times this pipeline run has been executed examples: - 1 started-at: format: date-time type: - string - 'null' description: When the pipeline run started processing examples: - '2020-04-12T05:08:51.000Z' ended-at: format: date-time type: - string - 'null' description: When the pipeline run finished processing examples: - '2020-04-12T05:18:32.000Z' created-at: format: date-time type: string description: When the pipeline run was created examples: - '2020-04-12T05:08:51.000Z' updated-at: format: date-time type: string description: When the pipeline run was last updated examples: - '2020-04-13T00:23:57.000Z' redacted-at: format: date-time type: - string - 'null' description: When the pipeline run was redacted examples: - '2020-04-14T00:22:43.000Z' run-data: type: object description: Runtime data and statistics for the pipeline run properties: column-names: type: array items: type: string description: Names of columns being processed error-count: type: integer description: Number of errors encountered examples: - 0 rows-read: type: integer description: Number of rows read from the source examples: - 1000 row-count: type: integer description: Total number of rows processed examples: - 1000 success-count: type: integer description: Number of rows successfully processed examples: - 995 created-count: type: integer description: Number of new records created examples: - 500 updated-count: type: integer description: Number of existing records updated examples: - 495 estimated-total-count: type: - integer - 'null' description: Estimated total number of rows to process examples: - 1000 additionalProperties: true relationships: type: object additionalProperties: false properties: importer-pipeline: type: object additionalProperties: false properties: data: type: object additionalProperties: false properties: id: type: string examples: - mprtp_XYZ789ABC123 type: const: importer-pipeline type: string importer-pipeline: type: object additionalProperties: false description: An Importer Pipeline object. properties: type: type: string const: importer-pipeline id: type: string examples: - mprtp_ABC123DEF456 attributes: type: object additionalProperties: false properties: name: type: string description: Name of the importer pipeline examples: - Customer Data Import status: type: string description: Current status of the importer pipeline. Possible values include `active` and `inactive`. examples: - active run-type: type: - string - 'null' description: Type of run schedule. Possible values include `manual` and `recurring`. examples: - recurring destination: type: - string - 'null' description: Destination model type for imported data examples: - account next-run-at: format: date-time type: - string - 'null' description: When the next run is scheduled examples: - '2020-04-12T05:08:51.000Z' created-at: format: date-time type: string description: When the pipeline was created examples: - '2020-04-12T05:08:51.000Z' updated-at: format: date-time type: string description: When the pipeline was last updated examples: - '2020-04-13T00:23:57.000Z' archived-at: format: date-time type: - string - 'null' description: When the pipeline was archived examples: - '2020-04-14T00:22:43.000Z' pipeline-config: type: object description: Configuration settings for the pipeline properties: destination: type: - string - 'null' description: Target destination for imported data sync-mode: type: - string - 'null' description: 'How data should be synced. Possible values include `upsert`, `insert`, and `update`.' archive-after-completion: type: - boolean - 'null' description: Whether to archive the pipeline after completion additionalProperties: true importer-pipeline-runs-included-objects: type: array items: discriminator: propertyName: type mapping: importer-pipeline: '#/components/schemas/importer-pipeline' oneOf: - $ref: '#/components/schemas/importer-pipeline' selfie-included-objects: description: 'Objects referenced in `payload.data.relationships` may be provided in `included` when related-object inclusion is enabled for the webhook subscription. When inclusion is not enabled, the `included` key is omitted.' type: array items: discriminator: propertyName: type mapping: inquiry: '#/components/schemas/inquiry' oneOf: - $ref: '#/components/schemas/inquiry' transactions-included-objects: type: array description: 'Full representations of the objects referenced in `data.attributes.relationships` — the Transaction''s Transaction Type, its reviewer (a Workflow Run, Workflow Step, or User), and any related objects such as Accounts, Inquiries, Verifications, Reports, or Cases. The set of types that appear depends on what the Transaction is related to.' items: type: object additionalProperties: true required: - type - id properties: type: x-polymorphic: true type: string description: The type of the included object. examples: - transaction-type - account - inquiry - workflow-run - report/watchlist id: type: string description: Unique identifier for the included object. examples: - txntp_ABC123 headers: rate-limit-limit: description: The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response. schema: type: integer examples: - 300 rate-limit-remaining: description: The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response. schema: type: integer examples: - 299 rate-limit-reset: description: The number of seconds until the current rate limit window resets. Returned on every authenticated response. schema: type: integer examples: - 42 request-id: description: 'The unique identifier of the API log entry that recorded this request. Starts with `req_`. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.' schema: type: string examples: - req_AbcDeFGhIjKlMnOpQrStUvWxYz1 persona-environment-id: description: 'The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.' schema: type: string examples: - env_AbcDeFGhIjKlMnOpQrStUvWxYz1 persona-organization-id: description: 'The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.' schema: type: string examples: - org_AbcDeFGhIjKlMnOpQrStUvWxYz1 examples: account-type: value: data: type: account-type id: acttp_7X5W5w9GMtQntE6oPtKnj44c attributes: name: User created-at: '2022-11-09T00:22:59.828Z' updated-at: '2023-02-15T23:15:06.034Z' field-schemas: - type: string key: name_first label: Name First config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: name_last label: Name Last config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: date key: birthdate label: Birthdate config: required: false archived-at: null deactivated-at: null min-date: null max-date: null included: [] account-list: value: data: - type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 account-type-name: User created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 relationships: account-type: data: type: account-type id: acttp_7X5W5w9GMtQntE6oPtKnj44c links: prev: null next: /api/v1/accounts?page%5Bafter%5D=act_hpNqyAbEG4HeVjZoBRNCMKkA account: value: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 account-type-name: User created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 relationships: account-type: data: type: account-type id: acttp_7X5W5w9GMtQntE6oPtKnj44c set-relation: value: meta: relation-schema-key: beneficial_owners target-object-id: act_ABC123 set-tag: value: meta: tag-name: Apple consolidate-accounts: value: meta: source-account-ids: - act_1fVnCte2V9joRjYQ82QX8mPzKYzD - act_zWHTCWmYbjFL4fCQSDF6NqztWXDT set-tags: value: meta: tag-name: - Apple - Orange run-account-action: summary: Basic account action trigger value: data: account-action-id: accac_h4Ln3agRBwdpZD55Lef8fDwjuvjG parameters: status: activated account-with-meta: value: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 account-type-name: User created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 relationships: account-type: data: type: account-type id: acttp_7X5W5w9GMtQntE6oPtKnj44c meta: workflow-run-id: wfr_abc123def456ghi789 account-list-search: value: data: - type: account id: act_ABC123 attributes: reference-id: abc-123 account-type-name: User created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 relationships: account-type: data: type: account-type id: acttp_7X5W5w9GMtQntE6oPtKnj44c links: prev: null next: /api/v1/accounts/search?page%5Bafter%5D=act_ABC123&page%5Bsize%5D=10 api-key-list: value: data: - type: api-key id: api_ABC123 attributes: name: Default API Key note: null api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number permissions: - account.read - account.write - api_log.read ip-address-allowlist: - '*' file-access-token-expires-in: 21600 last-used-at: '2023-08-17T23:24:00.000Z' expires-at: null created-at: '2023-08-17T23:18:13.000Z' links: prev: null next: /api/v1/api-keys?page%5Bafter%5D=api_ByBdXDqUrguLAHjGZMuDZLCx create-api-key: value: data: attributes: name: Default API Key api-key-with-value: value: data: type: api-key id: api_ABC123 attributes: name: Default API Key note: null api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number permissions: - account.read - account.write - api_log.read ip-address-allowlist: - '*' file-access-token-expires-in: 21600 last-used-at: '2023-08-17T23:24:00.000Z' expires-at: null created-at: '2023-08-17T23:18:13.000Z' value: persona_production_abcdefg api-key: value: data: type: api-key id: api_ABC123 attributes: name: Default API Key note: null api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number permissions: - account.read - account.write - api_log.read ip-address-allowlist: - '*' file-access-token-expires-in: 21600 last-used-at: '2023-08-17T23:24:00.000Z' expires-at: null created-at: '2023-08-17T23:18:13.000Z' expire-api-key: value: meta: expires-in-seconds: 10 connect-connection-list: value: data: - type: connect/connection id: cxn_ABC123 attributes: status: active source-organization-id: org_ABC123 destination-organization-id: org_XYZ789 created-at: '2018-06-01T00:00:00.000Z' updated-at: '2018-06-01T00:00:00.000Z' - type: connect/connection id: cxn_XYZ789 attributes: status: pending source-organization-id: org_XYZ789 destination-organization-id: org_ABC123 created-at: '2018-06-01T00:00:00.000Z' updated-at: '2018-06-01T00:00:00.000Z' links: prev: null next: /api/v1/connect/connections?page%5Bafter%5D=cxn_XYZ789 create-connection: value: data: attributes: destination-organization-id: org_XYZ789 connect-connection: value: data: type: connect/connection id: cxn_ABC123 attributes: status: pending source-organization-id: org_ABC123 destination-organization-id: org_XYZ789 created-at: '2018-06-01T00:00:00.000Z' updated-at: '2018-06-01T00:00:00.000Z' connect-connection-inactive: value: data: type: connect/connection id: cxn_ABC123 attributes: status: inactive source-organization-id: org_ABC123 destination-organization-id: org_XYZ789 created-at: '2018-06-01T00:00:00.000Z' updated-at: '2018-06-01T00:00:00.000Z' connect-share-token-list: value: data: - type: connect/share-token id: cnst_ABC123 attributes: status: created direction: outbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:18:13.000Z' pending-at: null redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: null relationships: creator: data: type: api-key id: api_ABC123 source: data: type: inquiry id: inq_ABC123 connection: data: type: connect/connection id: cxn_ABC123 - type: connect/share-token id: cnst_ABC456 attributes: status: redeemed direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:30:15.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: '2023-08-17T23:30:15.000Z' expires-at: null failed-at: null failure-reason: null redeem-mode: hydrate relationships: destination: data: type: inquiry id: inq_XYZ789 connection: data: type: connect/connection id: cxn_ABC123 links: prev: null next: /api/v1/connect/share-tokens?page%5Bafter%5D=cnst_ABC456 create-share-token: value: data: attributes: connection-id: cxn_ABC123 source-id: inq_ABC123 connect-share-token: value: data: type: connect/share-token id: cnst_ABC123 attributes: status: created direction: outbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:18:13.000Z' pending-at: null redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: null relationships: creator: data: type: user id: user_ABC123 source: data: type: inquiry id: inq_ABC123 connection: data: type: connect/connection id: cxn_ABC123 connect-share-token-redeemed: value: data: type: connect/share-token id: cnst_ABC123 attributes: status: redeemed direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:30:15.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: '2023-08-17T23:30:15.000Z' expires-at: null failed-at: null failure-reason: null redeem-mode: hydrate relationships: destination: data: type: inquiry id: inq_XYZ789 connection: data: type: connect/connection id: cxn_ABC123 connect-share-token-failed: value: data: type: connect/share-token id: cnst_ABC123 attributes: status: failed direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:35:20.000Z' pending-at: '2023-08-17T23:30:15.000Z' redeemed-at: null expires-at: null failed-at: '2023-08-17T23:35:20.000Z' failure-reason: import_failed redeem-mode: hydrate relationships: destination: data: type: inquiry id: inq_XYZ789 connection: data: type: connect/connection id: cxn_ABC123 connect-share-token-expired: value: data: type: connect/share-token id: cnst_ABC123 attributes: status: expired direction: outbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-18T23:18:13.000Z' pending-at: null redeemed-at: null expires-at: '2023-08-18T23:18:13.000Z' failed-at: null failure-reason: null redeem-mode: null relationships: creator: data: type: api-key id: api_ABC123 source: data: type: inquiry id: inq_ABC123 connection: data: type: connect/connection id: cxn_ABC123 redeem-share-token-clone-object: summary: Clone an object description: Omit `destination-id` to create a new object from the Share Token source. value: data: attributes: {} redeem-share-token-hydrate-object: summary: Hydrate an object description: Provide `destination-id` to import data into an existing destination object. value: data: attributes: destination-id: inq_XYZ789 connect-share-token-clone-object-pending: summary: Clone an object description: The Share Token is pending while Persona creates the new object. The destination is available after cloning completes. value: data: type: connect/share-token id: cnst_ABC123 attributes: status: pending direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:25:00.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: clone relationships: destination: data: null connection: data: type: connect/connection id: cxn_ABC123 connect-share-token-hydrate-object-pending: summary: Hydrate an object description: The Share Token is pending while Persona imports the source data into an existing object. This example hydrates an Inquiry. value: data: type: connect/share-token id: cnst_DEF456 attributes: status: pending direction: inbound created-at: '2023-08-17T23:18:13.000Z' updated-at: '2023-08-17T23:25:00.000Z' pending-at: '2023-08-17T23:25:00.000Z' redeemed-at: null expires-at: null failed-at: null failure-reason: null redeem-mode: hydrate relationships: destination: data: type: inquiry id: inq_XYZ789 connection: data: type: connect/connection id: cxn_ABC123 api-log-list: value: data: - type: api-log id: req_ABC123 attributes: request: method: GET path: /api/v1/inquiries headers: Accept: application/json Host: withpersona.com Persona-Version: '2023-01-05' User-Agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/' get-params: {} post-params: {} ip-address: 127.0.0.1 response: status: 200 headers: Persona-Host: us-central1 persona-web-web-77b874ff88-rrdk9 53e23b240 Cache-Control: 'no-cache, no-store, max-age=0, must-revalidate' Pragma: no-cache Expires: 'Fri, 01 Jan 1990 00:00:00 GMT' RateLimit-Limit: 300 RateLimit-Remaining: 299 RateLimit-Reset: 60 Request-Id: req_ABC123 Content-Type: application/json; charset=utf-8 Vary: Accept created-at: '2023-09-20T20:20:03.485+00:00' redacted-at: null links: prev: null next: /api/v1/api-logs?page%5Bafter%5D=req_ByBdXDqUrguLAHjGZMuDZLCx api-log: value: data: type: api-log id: req_ABC123 attributes: request: method: GET path: /api/v1/inquiries headers: Accept: application/json Host: withpersona.com Persona-Version: '2023-01-05' User-Agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/' get-params: {} post-params: {} ip-address: 127.0.0.1 response: status: 200 headers: Persona-Host: us-central1 persona-web-web-77b874ff88-rrdk9 53e23b240 Cache-Control: 'no-cache, no-store, max-age=0, must-revalidate' Pragma: no-cache Expires: 'Fri, 01 Jan 1990 00:00:00 GMT' RateLimit-Limit: 300 RateLimit-Remaining: 299 RateLimit-Reset: 60 Request-Id: req_ABC123 Content-Type: application/json; charset=utf-8 Vary: Accept created-at: '2023-09-20T20:20:03.485+00:00' redacted-at: null case-template: value: data: type: case-template id: ctmpl_yd2urRmjaCWcSSxqTSHvUcsn attributes: status: active name: Standard Review resolutions: - Approved - Declined created-at: '2021-03-25T07:04:16.667Z' updated-at: '2021-03-25T07:04:16.667Z' archived-at: null field-schemas: - type: string key: notes label: Reviewer Notes config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: multi-choices key: risk_tags label: Risk Tags config: required: false archived-at: null deactivated-at: null allow-empty: true options: - high_risk - medium_risk - low_risk included: [] create-case: value: data: attributes: case-template-id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC add-objects: value: meta: object-ids: - inq_eGK41TM6GjcZgdcoox7x8Hh0 - rep_PN3xspEwWCWWRp1eGpedaSNj remove-objects: value: meta: object-ids: - inq_eGK41TM6GjcZgdcoox7x8Hh0 - rep_PN3xspEwWCWWRp1eGpedaSNj assign-case: value: meta: user-email-address: name@domain.com set-status: value: meta: status: Approved case-list-search: value: data: - type: case id: case_ABC123 attributes: status: open name: KCAS-1 resolution: null created-at: '2025-01-15T10:30:00.000Z' updated-at: '2025-01-15T14:22:00.000Z' assigned-at: '2025-01-15T10:35:00.000Z' resolved-at: null redacted-at: null sla-expires-at: '2025-01-20T10:30:00.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: manager@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_updater@withpersona.com updater-type: user tags: - urgent - review-needed fields: priority: type: string value: high amount: type: number value: 1000 attachments: [] relationships: case-template: data: type: case-template id: ctmpl_ABC123 case-queue: data: type: case-queue id: cqueue_XYZ789 case-comments: data: [] accounts: data: [] inquiries: data: [] reports: data: [] verifications: data: [] txns: data: [] - type: case id: case_DEF456 attributes: status: pending name: KCAS-2 resolution: null created-at: '2025-01-14T15:20:00.000Z' updated-at: '2025-01-14T16:10:00.000Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: null creator-id: api_key_123 creator-type: api-key assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: api_key_123 updater-type: api-key tags: [] fields: priority: type: string value: medium attachments: [] relationships: case-template: data: type: case-template id: ctmpl_ABC123 case-queue: data: null case-comments: data: [] accounts: data: [] inquiries: data: [] reports: data: [] verifications: data: [] txns: data: [] links: prev: null next: /api/v1/cases/search?page%5Bafter%5D=case_DEF456&page%5Bsize%5D=10 device-list: value: data: - type: device id: dev_ABC123 attributes: device-vendor-id: 1a2b3c4d-5e6f-7g8h-9ijk-1A2B3C4D5E6F device-fingerprint: 1a2b3c4d5e6f7g8h9ijk browser-fingerprint: 1a2b3c4d5e6f7g8h9ijklmnopqrstuvw links: prev: null next: null device: value: data: type: device id: dev_ABC123 attributes: device-vendor-id: 1a2b3c4d-5e6f-7g8h-9ijk-1A2B3C4D5E6F device-fingerprint: 1a2b3c4d5e6f7g8h9ijk browser-fingerprint: 1a2b3c4d5e6f7g8h9ijklmnopqrstuvw document-generic: value: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: processed created-at: '2023-12-20T00:47:09.000Z' processed-at: '2023-12-20T00:47:15.000Z' processed-at-ts: 1703033235 kind: document files: - filename: abc123.JPEG url: 'https://files.withpersona.com/abc123.JPEG?access_token=ACCESS_TOKEN' byte-size: 124917 files-normalized: - filename: abc123.JPEG url: 'https://files.withpersona.com/abc123.JPEG?access_token=ACCESS_TOKEN' byte-size: 124917 extraction-responses: - extraction-type: unguided field-name: dates results: - value: Oct 14 2023 page: 1 match-level: full metadata: day: 14 month: 10 year: 2023 - extraction-type: guided field-name: address_street_1 results: - value: 1234 Main St. page: 1 match-level: full metadata: null - extraction-type: guided field-name: address_street_2 results: [] - extraction-type: guided field-name: address_city results: [] - extraction-type: guided field-name: address_postal_code results: [] - extraction-type: guided field-name: name results: [] document-type: other fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh document-files: data: [] document-government-id: value: data: type: document/government-id id: doc_vXwNeVfVCcgedQ2Sg4R5F9VD attributes: status: processed created-at: '2024-01-23T20:54:08.000Z' processed-at: '2024-01-23T20:54:14.000Z' processed-at-ts: 1706043254 front-photo: filename: persona_camera_1706043245796.jpg url: 'https://files.withpersona.com/persona_camera_1706043245796.jpg?access_token=ACCESS_TOKEN' byte-size: 298279 back-photo: null selfie-photo: filename: selfie_photo.jpg url: 'https://files.withpersona.com/selfie_photo.jpg?access_token=ACCESS_TOKEN' byte-size: 11686 id-class: dl name-first: Jane name-middle: Marie name-last: Doe name-suffix: null birthdate: '1994-12-30' address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: CA address-postal-code: '94111' issuing-authority: null issuing-subdivision: CA nationality: null document-number: null visa-status: null issue-date: '2021-04-29' expiration-date: '2029-05-11' designations: [] birthplace: null height: null sex: null endorsements: null restrictions: null vehicle-class: null identification-number: '25995844' relationships: inquiry: data: type: inquiry id: inq_VbHWkX4hjmZryYCTGtVWHFRy template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_HAVumeSgCxWxhVb8tTRjaiUB inquiry-template: data: type: inquiry-template id: itmpl_srQQ2Ui2gvNY353u65vD61gr document-files: data: [] inquiry-list: value: data: - type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null updated-at: '2023-03-30T19:07:01.000Z' previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] links: prev: null next: /api/v1/inquiries?page%5Bafter%5D=inq_ByBdXDqUrguLAHjGZMuDZLCx create-inquiry: value: data: attributes: inquiry-template-id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-created: value: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' updated-at: '2023-03-29T20:08:47.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] meta: session-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example one-time-link: 'https://withpersona.com/verify?code=ABC123' one-time-link-short: 'https://go.perso.na/ABC123' inquiry-retrieve: value: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' started-at: '2023-03-30T19:07:01.000Z' updated-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] included: - type: inquiry-session id: iqse_ABC123 attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 relationships: inquiry: data: type: inquiry id: inq_ABC123 - type: inquiry-template id: itmpl_ABC123 attributes: status: active name: Twilio Desktop relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry: value: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' updated-at: '2023-03-29T20:08:47.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] inquiry-one-time-link: value: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null updated-at: '2023-03-30T19:07:01.000Z' previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] meta: one-time-link: 'https://withpersona.com/verify?code=us1-asdf' one-time-link-short: 'https://perso.na/verify?code=ABC123' inquiry-resume: value: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: [] creator: creator@withpersona.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' updated-at: '2023-03-30T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@doe.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] meta: session-token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJpcXNlX1Q4UHJxcG9FaHdoVVYxd0hSZXVVOW9mcyIsImF1ZCI6InBlcnNvbmEtdmVyaWZ5IiwiaXNzIjoic3RhZ2luZy53aXRocGVyc29uYS5jb20iLCJpYXQiOjE1NzM4NTI2NjEsIm5iZiI6MTU3Mzg1MjY2MSwiZXhwIjoxNTczOTM5MDYxLCJqdGkiOiI5NWRlNjhkOS1hZjI4LTRiMzItOWIxYi03MjA4MTg3NTI3N2IiLCJzaWQiOiJpcXNlX1Q4UHJxcG9FaHdoVVYxd0hSZXVVOW9mcyJ9.LN6DEnfjP5cZoZ3w41RgyX5QVmutmjHja_bRHOmDjg0 inquiry-list-search: value: data: - type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: abc-123 note: null behaviors: {} tags: - tag1 - tag2 creator: creator@example.com reviewer-comment: null created-at: '2023-03-29T19:06:45.000Z' started-at: '2023-03-30T19:07:01.000Z' expires-at: '2023-03-31T19:07:01.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null updated-at: '2023-03-30T19:07:01.000Z' previous-step-name: start next-step-name: verification_document fields: name_first: type: string value: Jane name_middle: type: string value: Marie name_last: type: string value: Doe address_street_1: type: string value: 123 Main St address_street_2: type: string value: null address_city: type: string value: San Francisco address_subdivision: type: string value: California address_postal_code: type: string value: '94111' address_country_code: type: string value: US birthdate: type: date value: '1995-09-08' email_address: type: string value: jane@doe.com phone_number: type: string value: null identification_number: type: string value: null relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: - type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE sessions: data: [] documents: data: [] selfies: data: [] links: prev: null next: /api/v1/inquiries/search?page%5Bafter%5D=inq_ByBdXDqUrguLAHjGZMuDZLCx&page%5Bsize%5D=10 inquiry-session: value: data: type: inquiry-session id: iqse_ABC123 attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 relationships: inquiry: data: type: inquiry id: inq_ABC123 device: data: type: device id: dev_ABC123 inquiry-template-list: value: data: - type: inquiry-template id: itmpl_ABC123 attributes: name: Basic KYC verification flow status: active embedded-flow-domain-allowlist: - example.com - app.example.com hosted-flow-subdomains: - mycompanyname hosted-flow-redirect-uri-schemes: - https - http relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_XYZ789 links: prev: null next: /api/v1/inquiry-templates?page%5Bafter%5D=itmpl_ABC123 inquiry-template: value: data: type: inquiry-template id: itmpl_ABC123 attributes: name: Basic KYC verification flow status: active embedded-flow-domain-allowlist: - example.com - app.example.com hosted-flow-subdomains: - mycompanyname hosted-flow-redirect-uri-schemes: - https - http field-schemas: - type: string key: name_first label: First Name config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: date key: birthdate label: Birthdate config: required: false archived-at: null deactivated-at: null min-date: null max-date: null relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_XYZ789 list-item-browser-fingerprint: value: data: type: list-item/browser-fingerprint id: libf_N6PqYkfSqeqiQYWoeHA3GGDo attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:06:40.515Z' created-at: '2020-09-18T18:06:40.515Z' match-count: 0 value: 3082c312c9bfc8f0a43bc7173b18afe6 relationships: creator: data: null list-item-browser-fingerprint-archived: value: data: type: list-item/browser-fingerprint id: libf_N6PqYkfSqeqiQYWoeHA3GGDo attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:06:40.515Z' created-at: '2020-09-18T18:06:40.515Z' match-count: 0 value: 3082c312c9bfc8f0a43bc7173b18afe6 relationships: creator: data: null list-item-country: value: data: type: list-item/country id: lic_wt5cgLbSi7twJ8itK7jxCs8q attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T17:58:06.866Z' created-at: '2020-09-18T17:58:06.866Z' match-count: 0 country-code: US relationships: creator: data: null list-item-country-archived: value: data: type: list-item/country id: lic_wt5cgLbSi7twJ8itK7jxCs8q attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T17:58:06.866Z' created-at: '2020-09-18T17:58:06.866Z' match-count: 0 country-code: US relationships: creator: data: null list-item-device-fingerprint: value: data: type: list-item/device-fingerprint id: libf_N6PqYkfSqeqiQYWoeHA3GGDo attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:06:40.515Z' created-at: '2020-09-18T18:06:40.515Z' match-count: 0 value: 3082c312c9bfc8f0a43bc7173b18afe6 relationships: creator: data: null list-item-device-fingerprint-archived: value: data: type: list-item/device-fingerprint id: libf_N6PqYkfSqeqiQYWoeHA3GGDo attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:06:40.515Z' created-at: '2020-09-18T18:06:40.515Z' match-count: 0 value: 3082c312c9bfc8f0a43bc7173b18afe6 relationships: creator: data: null list-item-email-address: value: data: type: list-item/email-address id: liea_wt5cgLbSi7twJ8itK7jxCs8q attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T17:58:06.866Z' created-at: '2020-09-18T17:58:06.866Z' match-count: 0 value: joe-imposter@yahoo.com match-type: email_address relationships: creator: data: null list-item-email-address-archived: value: data: type: list-item/email-address id: liea_wt5cgLbSi7twJ8itK7jxCs8q attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T17:58:06.866Z' created-at: '2020-09-18T17:58:06.866Z' match-count: 0 value: joe-imposter@yahoo.com match-type: email_address relationships: creator: data: null list-item-field: value: data: type: list-item/field id: liif_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 field-value: abc123 relationships: creator: data: null list-item-field-archived: value: data: type: list-item/field id: liif_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 field-value: abc123 relationships: creator: data: null list-item-geolocation: value: data: type: list-item/geolocation id: ligl_DQdchRN288UN6sn9mAmEcMu5 attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:03:30.324Z' created-at: '2020-09-18T18:03:30.324Z' match-count: 0 latitude: 37.7879461 longitude: -122.3977409 radius-meters: 10 relationships: creator: data: null list-item-geolocation-archived: value: data: type: list-item/geolocation id: ligl_DQdchRN288UN6sn9mAmEcMu5 attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:03:30.324Z' created-at: '2020-09-18T18:03:30.324Z' match-count: 0 latitude: 37.7879461 longitude: -122.3977409 radius-meters: 10 relationships: creator: data: null list-item-government-id-number: value: data: type: list-item/government-id-number id: ligin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 id-class: dl id-number: F4K3NUM relationships: creator: data: null list-item-government-id-number-archived: value: data: type: list-item/government-id-number id: ligin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 id-class: dl id-number: F4K3NUM relationships: creator: data: null list-item-ip-address: value: data: type: list-item/ip-address id: liip_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: 127.0.0.0/24 relationships: creator: data: null list-item-ip-address-archived: value: data: type: list-item/ip-address id: liip_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: 127.0.0.0/24 relationships: creator: data: null list-item-name: value: data: type: list-item/name id: lin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 name-first: Joe name-last: Imposter relationships: creator: data: null list-item-name-archived: value: data: type: list-item/name id: lin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 name-first: Joe name-last: Imposter relationships: creator: data: null list-item-phone-number: value: data: type: list-item/phone-number id: lipn_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: '18006009777' relationships: creator: data: null list-item-phone-number-archived: value: data: type: list-item/phone-number id: lipn_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: '18006009777' relationships: creator: data: null list-item-string: value: data: type: list-item/string id: lin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: pending archived-at: null redacted-at: null updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: abc123 relationships: creator: data: null list-item-string-archived: value: data: type: list-item/string id: lin_soqGRWaUXZct3pCRbjRaXFqz attributes: status: archived archived-at: '2020-12-18T19:07:53.000Z' updated-at: '2020-09-18T18:07:53.000Z' created-at: '2020-09-18T18:07:53.000Z' match-count: 0 value: abc123 relationships: creator: data: null report-watchlist: value: data: type: report/watchlist id: rep_ARR4XUoYJRgQd7VMVaGEY2Gc attributes: status: ready created-at: '2023-06-07T14:12:16.000Z' completed-at: '2023-06-07T14:12:16.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false tags: [] name-first: Jane name-middle: null name-last: Doe term: Jane Doe birthdate: null country-code: null matched-lists: [] ignore-list: [] relationships: inquiry: data: null account: data: type: account id: act_rD4wFHtwhkgbpy2pc3o2G94a transaction: data: null report-template: data: type: report-template/watchlist id: rptp_2t2xwqxPDE1gw8DtYVFB9Vua transaction-list: value: data: - type: transaction id: txn_ABC123 attributes: status: declined reference-id: null fields: country: type: string value: US name-first: type: string value: LeBron name-last: type: string value: James selected-id-class: type: string value: dl front-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' back-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' tags: [] created-at: '2023-05-26T16:49:33.860Z' updated-at: '2023-05-26T16:49:43.965Z' relationships: reviewer: data: type: workflow-run id: wfr_ABC123 transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_ABC123 related-objects: data: - type: account id: act_ABC123 - type: verification/government-id id: ver_ABC123 links: prev: null next: /api/v1/transactions?page%5Bafter%5D=txn_ABC123 transaction: value: data: type: transaction id: txn_ABC123 attributes: status: declined reference-id: null fields: country: type: string value: US name-first: type: string value: LeBron name-last: type: string value: James selected-id-class: type: string value: dl front-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' back-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' tags: [] created-at: '2023-05-26T16:49:33.860Z' updated-at: '2023-05-26T16:49:43.965Z' relationships: reviewer: data: type: workflow-run id: wfr_ABC123 transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_ABC123 related-objects: data: - type: account id: act_ABC123 - type: verification/government-id id: ver_ABC123 transaction-retrieve: value: data: type: transaction id: txn_ABC123 attributes: status: declined reference-id: null fields: country: type: string value: US name-first: type: string value: LeBron name-last: type: string value: James selected-id-class: type: string value: dl front-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' back-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' tags: [] created-at: '2023-05-26T16:49:33.860Z' updated-at: '2023-05-26T16:49:43.965Z' relationships: reviewer: data: type: workflow-run id: wfr_ABC123 transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_ABC123 related-objects: data: - type: account id: act_ABC123 - type: verification/government-id id: ver_ABC123 included: - type: account id: act_ABC123 attributes: reference-id: null created-at: '2023-05-26T16:49:35.000Z' updated-at: '2023-05-26T16:49:35.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: null middle: type: string value: null last: type: string value: null address: type: hash value: street-1: type: string value: null street-2: type: string value: null subdivision: type: string value: null city: type: string value: null postal-code: type: string value: null country-code: type: string value: null identification-numbers: type: array value: [] birthdate: type: date value: null phone-number: type: string value: null email-address: type: string value: null selfie-photo: type: file value: null country-code: null tags: [] - type: verification/government-id id: ver_ABC123 attributes: status: failed created-at: '2023-05-26T16:49:43.000Z' created-at-ts: 1685119783 submitted-at: '2023-05-26T16:49:43.000Z' submitted-at-ts: 1685119783 completed-at: '2023-05-26T16:49:43.000Z' completed-at-ts: 1685119783 country-code: null entity-confidence-score: 0 entity-confidence-reasons: - generic front-photo-url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' back-photo-url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' photo-urls: - page: front url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' normalized-url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' original-urls: - 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' byte-size: 62347 - page: back url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' normalized-url: 'https://files.withpersona.com/image.jpg?access_token=ACCESS_ABC123' original-urls: - 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' byte-size: 62347 selfie-photo: null selfie-photo-url: null video-url: null id-class: null capture-method: api expiration-date: null endorsements: null restrictions: null vehicle-class: null checks: - name: id_aamva_database_lookup status: not_applicable reasons: - disabled requirement: not_required metadata: {} - name: id_account_comparison status: not_applicable reasons: - no_account requirement: not_required metadata: {} - name: id_age_comparison status: not_applicable reasons: - missing_birthdate requirement: not_required metadata: {} - name: id_barcode_detection status: failed reasons: - barcode_not_decoded requirement: not_required metadata: {} - name: id_barcode_inconsistency_detection status: not_applicable reasons: - barcode_not_decoded requirement: not_required metadata: {} - name: id_blur_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_color_inconsistency_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_disallowed_country_detection status: not_applicable reasons: - no_country requirement: required metadata: {} - name: id_disallowed_type_detection status: failed reasons: - type_not_detected requirement: required metadata: country-code: null detected-id-designations: [] disallowed-id-designations: [] - name: id_double_side_detection status: failed reasons: - side_submitted_twice requirement: not_required metadata: {} - name: id_electronic_replica_detection status: failed reasons: - replica_detected requirement: not_required metadata: {} - name: id_entity_detection status: failed reasons: - cannot_verify_id requirement: required metadata: {} - name: id_expired_detection status: not_applicable reasons: - no_expiration_date requirement: required metadata: {} - name: id_extraction_inconsistency_detection status: not_applicable reasons: - missing_properties requirement: not_required metadata: check-requirements: [] - name: id_extracted_properties_detection status: not_applicable reasons: - no_required_properties requirement: not_required metadata: {} - name: id_fabrication_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_glare_detection status: failed reasons: - too_much_glare requirement: not_required metadata: {} - name: id_handwriting_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_inquiry_comparison status: not_applicable reasons: - no_inquiry requirement: not_required metadata: {} - name: id_mrz_detection status: not_applicable reasons: [] requirement: required metadata: {} - name: id_mrz_inconsistency_detection status: not_applicable reasons: - mrz_not_found requirement: not_required metadata: {} - name: id_number_format_inconsistency_detection status: not_applicable reasons: - invalid_country requirement: not_required metadata: {} - name: id_po_box_detection status: not_applicable reasons: - missing_address requirement: not_required metadata: {} - name: id_portrait_clarity_detection status: not_applicable reasons: [] requirement: required metadata: {} - name: id_portrait_detection status: failed reasons: - portrait_not_found requirement: required metadata: {} - name: id_real_id_detection status: not_applicable reasons: - disabled requirement: not_required metadata: {} - name: id_tamper_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_valid_dates_detection status: not_applicable reasons: [] requirement: not_required metadata: {} - name: id_age_inconsistency_detection status: not_applicable reasons: - disabled requirement: not_required metadata: {} - name: id_compromised_detection status: passed reasons: [] requirement: required metadata: {} - name: id_inconsistent_repeat_detection status: not_applicable reasons: - not_enabled requirement: not_required metadata: {} - name: id_public_figure_detection status: passed reasons: [] requirement: not_required metadata: {} - name: id_repeat_detection status: not_applicable reasons: - not_enabled requirement: not_required metadata: {} - name: id_selfie_comparison status: not_applicable reasons: - no_selfie requirement: required metadata: {} relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 document: data: type: document/government-id id: doc_ABC123 transaction-with-label: value: data: type: transaction id: txn_ABC123 attributes: status: declined reference-id: null fields: country: type: string value: US name-first: type: string value: LeBron name-last: type: string value: James selected-id-class: type: string value: dl front-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' back-photo: type: file value: filename: image.png byte-size: 237011 mime-type: image/png url: 'https://files.withpersona.com/image.png?access_token=ACCESS_ABC123' tags: [] created-at: '2023-05-26T16:49:33.860Z' updated-at: '2023-05-26T16:49:43.965Z' relationships: reviewer: data: type: workflow-run id: wfr_ABC123 transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_ABC123 related-objects: data: - type: account id: act_ABC123 - type: verification/government-id id: ver_ABC123 included: - type: transaction-label id: txnl_ABC123 attributes: model-label: test model-version: 1.2.3 created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' transaction-type: value: data: type: transaction-type id: txntp_5jr7hePm1772FBVG28vpBghC attributes: name: Transaction Type A created-at: '2023-05-09T21:49:02.514Z' updated-at: '2024-01-12T23:17:50.627Z' field-schemas: - type: string key: name_first label: Name First config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: name_middle label: Name Middle config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: name_last label: Name Last config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_street_1 label: Address Street 1 config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_street_2 label: Address Street 2 config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_city label: Address City config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_subdivision label: Address Subdivision config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_postal_code label: Address Postal Code config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: address_country_code label: Address Country Code config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: date key: birthdate label: Birthdate config: required: false archived-at: null deactivated-at: null min-date: null max-date: null - type: string key: email_address label: Email Address config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: phone_number label: Phone Number config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: identification_number label: Identification Number config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: identification_class label: Identification Class config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: selected_country_code label: Selected Country Code config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: string key: selected_id_class label: Selected ID class config: required: false archived-at: null deactivated-at: null max-char-length: 255 sanitize: [] - type: relation-schema key: current_government_id label: Current Government ID config: required: false archived-at: null deactivated-at: null target: document-government-id verification-aamva: value: data: type: verification/aamva id: ver_ABC123 attributes: status: initiated created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: Jane name-last: Doe birthdate: '1994-04-12' issue-date: '2021-05-27' expiration-date: '2029-05-08' address-postal-code: '94111' issuing-authority: CA identification-number: B12345678 relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template: data: type: verification-template/aamva id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/aamva id: vtmplv_ABC123 verification-database-ecbsv: value: data: type: verification/database-ecbsv id: ver_2wpqiEtejRcTA1hMJEXmbrJ6 attributes: status: initiated created-at: '2022-08-03T04:11:32.000Z' created-at-ts: 1659499892 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: Jane name-last: Doe birthdate: '1994-04-12' email-address: jane@doe.com identification-number: B12345678 signature-timestamp: '2022-09-03T04:13:06.000Z' signature-ip: 127.0.0.1 relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template-version: data: type: verification-template-version/database-ecbsv id: vtmplv_ABC123 verification-template: data: type: verification-template/database-ecbsv id: vtmpl_ABC123 verification-database-phone-carrier: value: data: type: verification/database-phone-carrier id: ver_sg4L6Zax4TfXrVsGbVaBoSdr attributes: status: initiated created-at: '2022-08-03T03:15:56.000Z' created-at-ts: 1659496556 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: Jane name-last: Doe address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' birthdate: '1994-12-30' relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template-version: data: type: verification-template-version/database-tin id: vtmplv_ABC123 verification-template: data: type: verification-template/database-tin id: vtmpl_ABC123 verification-database-serpro: value: data: type: verification/database-serpro id: ver_ixBrVPK2jKwg4qGmbWZvwMmw attributes: status: initiated created-at: '2022-08-03T03:42:20.000Z' created-at-ts: 1659498140 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: BR checks: [] cpf: '123456789' name-full: Jane Doe name-first: Jane name-last: Doe birthdate: '1994-12-30' relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template-version: data: type: verification-template-version/database-serpro id: vtmplv_ABC123 verification-template: data: type: verification-template/database-serpro id: vtmpl_ABC123 selfie: data: type: selfie/profile-and-center id: self_ABC123 verification-database-standard: value: data: type: verification/database-standard id: ver_6hhbmCZyhrhTjqHVwwP66QGe attributes: status: initiated created-at: '2022-08-02T04:53:19.000Z' created-at-ts: 1659415999 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: ALEXANDER name-middle: JAMES name-last: HAMILTON address-street-1: 555 Beverly Hills address-street-2: Apartment 123 address-city: Los Angeles address-subdivision: CA address-postal-code: '55555' normalized-address-street-1: 555 Beverly Hills normalized-address-street-2: Apt 123 normalized-address-city: Los Angeles normalized-address-subdivision: CA normalized-address-postal-code: '55555' relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template-version: data: type: verification-template-version/database-standard id: vtmplv_ABC123 verification-template: data: type: verification-template/database-standard id: vtmpl_ABC123 verification-database-tin: value: data: type: verification/database-tin id: ver_2wpqiEtejRcTA1hMJEXmbrJ6 attributes: status: passed created-at: '2022-08-03T04:11:32.000Z' created-at-ts: 1659499892 submitted-at: '2022-08-03T04:13:00.000Z' submitted-at-ts: 1659499980 completed-at: '2022-08-03T04:13:06.000Z' completed-at-ts: 1659499986 country-code: US checks: [] tin: '123456789' tin-type: itin name-first: JANE name-last: DOE name-business: null relationships: inquiry: data: null template: data: null inquiry-template-version: data: null inquiry-template: data: null transaction: data: null verification-template-version: data: type: verification-template-version/database-tin id: vtmplv_ABC123 verification-template: data: type: verification-template/database-tin id: vtmpl_ABC123 verification-database: value: data: type: verification/database id: ver_ABC123 attributes: status: initiated created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: Jane name-middle: null name-last: Doe address-street-1: 555 Beverly Hills address-street-2: Apartment 123 address-city: Los Angeles address-subdivision: California address-postal-code: '55555' normalized-address-street-1: 555 Beverly Hills normalized-address-street-2: Apt 123 normalized-address-city: Los Angeles normalized-address-subdivision: CA normalized-address-postal-code: '55555' birthdate: '1999-01-01' identification-number: null document-number: null phone-number: null email-address: jane@doe.com relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 verification-document: value: data: type: verification/document id: ver_ABC123 attributes: status: initiated created-at: '2023-11-15T16:21:09.000Z' created-at-ts: 1700065269 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: null checks: [] fields: {} files: - filename: multipage_example.pdf url: 'https://files.withpersona.com/multipage_example.pdf?access_token=ACCESS_ABC123' byte-size: 123456 files-normalized: - filename: multipage_example.pdf url: 'https://files.withpersona.com/multipage_example.pdf?access_token=ACCESS_ABC123' byte-size: 123456 extraction-responses: [] relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template-version: data: type: verification-template-version/document id: vtmplv_ABC123 verification-template: data: type: verification-template/document id: vtmpl_ABC123 document: data: type: document/generic id: doc_BDxMaFYynbVrKPiGdfv4aJyC verification-email-address: value: data: type: verification/email-address id: ver_ABC123 attributes: status: initiated created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] email-address: jane@doe.com confirmation-code: '12345' relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/email-address id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/email-address id: vtmplv_ABC123 verification-government-id-passed: value: data: type: verification/government-id id: ver_ABC123 attributes: status: passed created-at: '2024-03-20T21:22:25.000Z' created-at-ts: 1710969745 submitted-at: '2024-03-20T21:22:25.000Z' submitted-at-ts: 1710969745 completed-at: '2024-03-20T21:22:31.000Z' completed-at-ts: 1710969751 country-code: US checks: [] entity-confidence-score: 96.1831512451172 entity-confidence-reasons: - generic front-photo-url: 'https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN' back-photo-url: null photo-urls: - page: front url: 'https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN' normalized-url: 'https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN' original-urls: - 'https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN' byte-size: 2849115 selfie-photo: url: 'https://files.withpersona.com/selfie-photo.jpg?access_token=ACCESS_TOKEN' byte-size: 201105 selfie-photo-url: 'https://files.withpersona.com/selfie-photo.jpg?access_token=ACCESS_TOKEN' video-url: null id-class: dl capture-method: upload name-first: JANE name-middle: null name-last: DOE native-name-first: 三 native-name-middle: null native-name-last: 张 native-name-title: null name-suffix: null birthdate: '1990-01-01' address-street-1: 123 MAIN ST address-street-2: null address-city: SAN FRANCISCO address-subdivision: CA address-postal-code: '94111' issuing-authority: null issuing-subdivision: CA nationality: null document-number: null visa-status: null issue-date: '2020-07-28' expiration-date: '2025-01-01' designations: [] birthplace: null endorsements: null height: null sex: null restrictions: null vehicle-class: null identification-number: Y123ABC from-reusable-persona: false relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 document: data: type: document/government-id id: doc_ABC123 verification-phone-number: value: data: type: verification/phone-number id: ver_ABC123 attributes: status: initiated created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] phone-number: '+14169671111' confirmation-code: '12345' metadata: {} relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/email-address id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/email-address id: vtmplv_ABC123 verification-retrieve: value: data: type: verification/database id: ver_ABC123 attributes: status: initiated created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null country-code: US checks: [] name-first: Jane name-middle: null name-last: Doe address-street-1: 555 Beverly Hills address-street-2: Apartment 123 address-city: Los Angeles address-subdivision: California address-postal-code: '55555' normalized-address-street-1: 555 Beverly Hills normalized-address-street-2: Apt 123 normalized-address-city: Los Angeles normalized-address-subdivision: CA normalized-address-postal-code: '55555' birthdate: '1999-01-01' identification-number: null document-number: null phone-number: null email-address: jane@doe.com relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 included: - type: verification-template/database id: vtmpl_ABC123 - type: verification-template-version/database id: vtmplv_ABC123 verification-business-website: value: data: type: verification/business-website id: ver_ABC123 attributes: status: passed created-at: '2023-11-03T17:37:06.000Z' created-at-ts: 1699033026 submitted-at: '2023-11-03T17:37:10.000Z' submitted-at-ts: 1699033030 completed-at: '2023-11-03T17:37:15.000Z' completed-at-ts: 1699033035 country-code: US website-url: 'https://example.com' checks: - name: business_website_backlink_detection status: passed reasons: [] requirement: not_required metadata: backlink-count: 2443 backlink-threshold: 10 - name: business_website_malicious_website_detection status: passed reasons: [] requirement: not_required metadata: {} - name: business_website_domain_age_detection status: passed reasons: [] requirement: not_required metadata: {} extracted-identity: business-names: - value: Example Corp source: 'https://example.com' addresses: null phone-numbers: null emails: null relationships: inquiry: data: type: inquiry id: inq_ABC123 template: data: null inquiry-template-version: data: type: inquiry-template-version id: itmplv_ABC123 inquiry-template: data: type: inquiry-template id: itmpl_ABC123 transaction: data: null verification-template: data: type: verification-template/business-website id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/business-website id: vtmplv_ABC123 create-webhook: value: data: attributes: name: Inquiry Webhook url: 'https://withpersona.com' enabled-events: - account.created - verification.created included-allowlist: state: include_all relationship-allowlist: state: include_all webhook-created: value: data: type: webhook id: wbh_ABC123 attributes: status: disabled url: 'https://withpersona.com' secret: wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw secrets: - value: wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw expires-at: null api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 included-allowlist: state: include_all relationship-allowlist: state: include_all created-at: '2023-08-17T23:18:13.000Z' webhook-disabled: value: data: type: webhook id: wbh_ABC123 attributes: status: disabled url: 'https://withpersona.com' api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 included-allowlist: state: include_all relationship-allowlist: state: include_all created-at: '2023-08-17T23:18:13.000Z' webhook-archived: value: data: type: webhook id: wbh_ABC123 attributes: status: archived url: 'https://withpersona.com' api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 included-allowlist: state: include_all relationship-allowlist: state: include_all created-at: '2023-08-17T23:18:13.000Z' webhook-enabled: value: data: type: webhook id: wbh_ABC123 attributes: status: enabled url: 'https://withpersona.com' api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 included-allowlist: state: include_all relationship-allowlist: state: include_all created-at: '2023-08-17T23:18:13.000Z' rotate-webhook-secret: value: meta: expires-in-seconds: 15 webhook-cloned: value: data: type: webhook id: wbh_ABC123 attributes: name: Webhook Copy description: A cloned webhook status: disabled url: 'https://withpersona.com' secret: wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw secrets: - value: wbhsec_abcdefgh-1234-5678-9ijk-lmnopqrstuvw expires-at: null api-version: '2023-01-05' api-key-inflection: kebab api-attributes-blocklist: - address-* - name-last - /data/attributes/fields/*-number file-access-token-expires-in: 21600 enabled-events: - account.created - verification.created payload-filter: data: relationships: inquiry-template: data: id: itmpl_abc123def456 included-allowlist: state: include_all relationship-allowlist: state: include_all created-at: '2023-08-17T23:18:13.000Z' account-created-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.created payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-redacted-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.redacted payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-archived-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.archived payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-restored-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.restored payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-consolidated-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.consolidated payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-consolidated-with-webhook-body: value: data: type: event id: evt_6vXpL9sJ2cH5dQzT8mWnK3rB attributes: name: account.consolidated-with payload: data: type: account id: act_9yGqWZ8jK4pN2dR7sVxL3bTm attributes: reference-id: customer-1090 account-type-name: User created-at: '2023-11-20T08:00:00.000Z' updated-at: '2024-02-15T23:48:10.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Taylor middle: type: string value: null last: type: string value: Quinn email_address: type: string value: taylor.quinn@example.com tags: [] account-status: Approved created-at: '2024-02-15T23:48:17.732Z' account-tag-added-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.tag-added payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-tag-removed-webhook-body: value: data: type: event id: evt_o9byQRbjygu76Jbtea9wuJ1boP7a attributes: name: account.tag-removed payload: data: type: account id: act_hpNqyAbEG4HeVjZoBRNCMKkA attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe address: type: hash value: street_1: type: string value: 123 Main St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94111' country_code: type: string value: US identification_numbers: type: array value: - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '12345678' issuing_country: type: string value: US - type: hash value: identification_class: type: string value: visa identification_number: type: string value: '87654321' issuing_country: type: string value: UK - type: hash value: identification_class: type: string value: cct identification_number: type: string value: A12345678 issuing_country: type: string value: AF birthdate: type: date value: '1994-12-30' phone_number: type: string value: 111-222-3333 email_address: type: string value: jane@doe.com selfie_photo: type: file value: null tags: - tag1 - tag2 created-at: '2024-02-15T23:48:17.732Z' account-added-relation-webhook-body: value: data: type: event id: evt_ArYe9fEGrjzDnWs3DhTZRdGi attributes: name: account.added-relation payload: data: type: account id: act_ArYe9fESV7LHXdGqHDJuJPwQ attributes: reference-id: customer-2274 account-type-name: Individual created-at: '2024-04-10T19:10:02.000Z' updated-at: '2024-04-10T19:10:02.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Morgan middle: type: string value: null last: type: string value: Avery email_address: type: string value: morgan.avery@example.com tags: [] account-status: Default context: relation-schema-key: business target-account-id: act_8GV2ULqZ5VHURTJtYjGjV8nU target-txn-id: null created-at: '2024-04-10T19:10:03.089Z' account-removed-relation-webhook-body: value: data: type: event id: evt_AQMVkV1FLwBaCNjTzRmjoSov attributes: name: account.removed-relation payload: data: type: account id: act_wbk4s6zfyboAmDYvyMpwVf6F attributes: reference-id: customer-2274 account-type-name: Individual created-at: '2024-04-10T19:10:02.000Z' updated-at: '2024-05-22T10:40:00.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Morgan middle: type: string value: null last: type: string value: Avery email_address: type: string value: morgan.avery@example.com tags: [] account-status: Default context: relation-schema-key: business target-account-id: act_8GV2ULqZ5VHURTJtYjGjV8nU target-txn-id: null created-at: '2024-05-22T10:40:13.043Z' account-status-updated-webhook-body: value: data: type: event id: evt_3KqH4xVnR2bPmYwL9sTgD3cE attributes: name: account.status-updated payload: data: type: account id: act_7sVxL3bTm9yGqWZ8jK4pN2dR attributes: reference-id: customer-4821 account-type-name: User created-at: '2024-02-01T10:15:30.000Z' updated-at: '2024-02-15T23:48:10.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jordan middle: type: string value: null last: type: string value: Rivera email_address: type: string value: jordan.rivera@example.com tags: - vip account-status: Approved created-at: '2024-02-15T23:48:17.732Z' account-updated-fields-webhook-body: value: data: type: event id: evt_5dQzT8mWnK3rB6vXpL9sJ2cH attributes: name: account.updated-fields payload: data: type: account id: act_2dR7sVxL3bTm9yGqWZ8jK4pN attributes: reference-id: customer-4821 account-type-name: User created-at: '2024-02-01T10:15:30.000Z' updated-at: '2024-03-04T18:02:55.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jordan middle: type: string value: null last: type: string value: Rivera address: type: hash value: street_1: type: string value: 500 Market St street_2: type: string value: null subdivision: type: string value: California city: type: string value: San Francisco postal_code: type: string value: '94105' country_code: type: string value: US email_address: type: string value: jordan.rivera@example.com tags: [] account-status: Approved created-at: '2024-03-04T18:03:01.118Z' account-updated-tags-webhook-body: value: data: type: event id: evt_8mWnK3rB6vXpL9sJ2cH5dQzT attributes: name: account.updated-tags payload: data: type: account id: act_4pN2dR7sVxL3bTm9yGqWZ8jK attributes: reference-id: customer-4821 account-type-name: User created-at: '2024-02-01T10:15:30.000Z' updated-at: '2024-03-11T09:25:04.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jordan middle: type: string value: null last: type: string value: Rivera email_address: type: string value: jordan.rivera@example.com tags: - vip - manual-review account-status: Approved context: added-tags: - manual-review removed-tags: - new-customer created-at: '2024-03-11T09:25:04.231Z' case-assigned-webhook-body: value: data: type: event id: evt_8LrJ5yWoS3cQnZxM0tUhE4dF attributes: name: case.assigned payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-01-16T14:05:21.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_assigner@withpersona.com updater-type: user tags: - high-priority - manual-review fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-01-16T14:05:21.000Z' case-created-webhook-body: value: data: type: event id: evt_9MsK6zXpT4dRoAyN1uViF5eG attributes: name: case.created payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-01-15T08:12:03.000Z' assigned-at: null resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: external-integration-id: ind_123 attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-01-15T08:12:03.000Z' case-exported-webhook-body: value: data: type: event id: evt_AnTL7aYqU5eSpBzO2vWjG6fH attributes: name: case.exported payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Approved name: MRR-3 resolution: Approved created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-02-15T23:48:17.732Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: '2024-02-15T23:48:17.732Z' redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: case_resolver@withpersona.com resolver-type: user updater-id: case_resolver@withpersona.com updater-type: user tags: - high-priority - manual-review fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-02-16T10:30:00.000Z' case-queue-updated-webhook-body: value: data: type: event id: evt_CpVN9caSW7gUrDBQ4xYlI8hJ attributes: name: case.queue-updated payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-01-17T09:22:11.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_updater@withpersona.com updater-type: user tags: - high-priority fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_2HNbpdebw1gQhpttL97KvSScpk2 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_2HNbpdebw1gQhpttL97KvSScpk2 attributes: status: active name: Escalations Queue created-at: '2023-04-12T11:18:33.000Z' updated-at: '2023-07-15T08:30:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-01-17T09:22:11.000Z' case-redacted-webhook-body: value: data: type: event id: evt_DqWO0dbTX8hVsECR5yZmJ9iK attributes: name: case.redacted payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Approved name: MRR-3 resolution: Approved created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-04-20T10:00:00.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: '2024-02-15T23:48:17.732Z' redacted-at: '2024-04-20T10:00:00.000Z' sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: null creator-type: null assignee-id: null assigner-id: null assigner-type: null resolver-id: null resolver-type: null updater-id: null updater-type: null tags: [] fields: {} attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: [] txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2024-04-20T10:00:00.000Z' redacted-at: '2024-04-20T10:00:00.000Z' fields: {} tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] created-at: '2024-04-20T10:00:00.000Z' case-reopened-webhook-body: value: data: type: event id: evt_ErXP1ecUY9iWtFDS6zAnK0jL attributes: name: case.reopened payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-03-05T16:42:55.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-04-05T16:42:55.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_reviewer@withpersona.com updater-type: user tags: - high-priority - manual-review - reopened fields: external-integration-id: ind_123 risk-level: medium reviewer-notes: Reopened after additional documentation received. attachments: - filename: supporting_doc.pdf url: 'https://files.withpersona.com/abc123.pdf?access_token=ACCESS_TOKEN' byte-size: 124917 relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-03-05T16:42:55.000Z' case-resolved-webhook-body: value: data: type: event id: evt_FsYQ2fdVZ0jXuGET7aBoL1kM attributes: name: case.resolved payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Approved name: MRR-3 resolution: Approved created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-02-15T23:48:17.732Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: '2024-02-15T23:48:17.732Z' redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: case_resolver@withpersona.com resolver-type: user updater-id: case_resolver@withpersona.com updater-type: user tags: - high-priority - manual-review fields: external-integration-id: ind_123 risk-level: medium reviewer-notes: All required documentation verified. attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-02-15T23:48:17.732Z' case-sla-expired-webhook-body: value: data: type: event id: evt_GtZR3geWa1kYvHFU8bCpM2lN attributes: name: case.sla-expired payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-02-16T14:05:21.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_assigner@withpersona.com updater-type: user tags: - high-priority - manual-review - sla-overdue fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-02-16T14:05:22.000Z' case-status-updated-webhook-body: value: data: type: event id: evt_HuAS4hfXb2lZwIGV9cDqN3mO attributes: name: case.status-updated payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Pending name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-01-18T11:30:42.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_assignee@withpersona.com updater-type: user tags: - high-priority - manual-review fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-01-18T11:30:42.000Z' case-updated-fields-webhook-body: value: data: type: event id: evt_7KqH4xVnR2bPmYwL9sTgD3cE attributes: name: case.updated-fields payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-02-15T23:48:17.732Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_updater@withpersona.com updater-type: user tags: - high-priority - manual-review fields: external-integration-id: ind_123 risk-level: medium reviewer-notes: Updated after additional documentation received. attachments: - filename: supporting_doc.pdf url: 'https://files.withpersona.com/abc123.pdf?access_token=ACCESS_TOKEN' byte-size: 124917 relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE created-at: '2024-02-15T23:48:17.732Z' case-updated-tags-webhook-body: value: data: type: event id: evt_IvBT5igYc3maxJHW0dErO4nP attributes: name: case.updated-tags payload: data: type: case id: case_gqe7rH38FvxtzhGBQmDBsjkB attributes: status: Open name: MRR-3 resolution: null created-at: '2024-01-15T08:12:03.000Z' updated-at: '2024-01-19T13:15:08.000Z' assigned-at: '2024-01-16T14:05:21.000Z' resolved-at: null redacted-at: null sla-expires-at: '2024-02-16T14:05:21.000Z' creator-id: case_creator@withpersona.com creator-type: user assignee-id: case_assignee@withpersona.com assigner-id: case_assigner@withpersona.com assigner-type: user resolver-id: null resolver-type: null updater-id: case_assignee@withpersona.com updater-type: user tags: - high-priority - manual-review - escalated fields: external-integration-id: ind_123 risk-level: medium attachments: [] relationships: accounts: data: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz case-comments: data: [] case-template: data: type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC case-queue: data: type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 inquiries: data: - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN txns: data: [] included: - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz attributes: reference-id: abc-123 created-at: '2023-09-22T17:13:49.000Z' updated-at: '2023-09-23T00:22:19.000Z' redacted-at: null fields: name: type: hash value: first: type: string value: Jane middle: type: string value: Marie last: type: string value: Doe email_address: type: string value: jane@doe.com tags: [] - type: case-template id: ctmpl_Jumm3K4zHwaLBBdyLUCnHbBC attributes: status: active name: Manual Review Cases resolutions: - Approved - Declined created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: case-queue id: cqueue_7JRbkcdbx9fTossK98NJvRZcmk1 attributes: status: active name: High Priority Queue created-at: '2023-03-25T07:04:16.667Z' updated-at: '2023-06-01T12:00:00.000Z' archived-at: null - type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE attributes: status: needs_review reference-id: abc-123 note: null behaviors: {} tags: - manual-review creator: API reviewer-comment: null created-at: '2024-01-15T08:00:00.000Z' started-at: '2024-01-15T08:01:00.000Z' expires-at: null completed-at: '2024-01-15T08:11:00.000Z' failed-at: null marked-for-review-at: '2024-01-15T08:11:30.000Z' decisioned-at: null expired-at: null redacted-at: null updated-at: '2024-01-15T08:11:30.000Z' previous-step-name: verification_selfie next-step-name: success fields: {} relationships: account: data: type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reports: data: [] verifications: data: - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN sessions: data: [] documents: data: [] selfies: data: [] - type: verification/government-id id: ver_govid7Hw3XjPbN8f2Lq9kWtZmYrAdEC attributes: status: passed created-at: '2024-01-15T08:03:24.000Z' submitted-at: '2024-01-15T08:03:24.000Z' completed-at: '2024-01-15T08:03:31.000Z' country-code: US checks: - name: id_unprocessable_submission_detection status: passed reasons: [] requirement: required - name: id_compromised_detection status: passed reasons: [] requirement: required - name: id_disallowed_country_detection status: passed reasons: [] requirement: required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE - type: verification/selfie id: ver_self2VkP9bRcMqLnXtZjAhYdEgKfBN attributes: status: passed created-at: '2024-01-15T08:08:10.000Z' submitted-at: '2024-01-15T08:08:30.000Z' completed-at: '2024-01-15T08:08:40.000Z' checks: - name: selfie_id_comparison status: passed reasons: [] requirement: required - name: selfie_pose_detection status: passed reasons: [] requirement: required - name: selfie_liveness_detection status: passed reasons: [] requirement: not_required relationships: inquiry: data: type: inquiry id: inq_KHK4MJCE4QvfocWB2intQ3YE context: added-tags: - escalated removed-tags: - standard-priority created-at: '2024-01-19T13:15:08.000Z' document-created-webhook-body: value: data: type: event id: evt_9RkPmXvN3bQwYsL7tHdFc2jE attributes: name: document.created payload: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: initiated created-at: '2023-12-20T00:47:09.000Z' processed-at: null processed-at-ts: null kind: document files: [] files-normalized: [] extraction-responses: [] document-type: null fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-12-20T00:47:09.000Z' updated-at: '2023-12-20T00:47:09.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-submitted-webhook-body: value: data: type: event id: evt_9RkPmXvN3bQwYsL7tHdFc2jE attributes: name: document.submitted payload: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: submitted created-at: '2023-12-20T00:47:09.000Z' processed-at: null processed-at-ts: null kind: document files: [] files-normalized: [] extraction-responses: [] document-type: null fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-12-20T00:47:09.000Z' updated-at: '2023-12-20T00:47:09.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-processed-webhook-body: value: data: type: event id: evt_9RkPmXvN3bQwYsL7tHdFc2jE attributes: name: document.processed payload: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: processed created-at: '2023-12-20T00:47:09.000Z' processed-at: null processed-at-ts: null kind: document files: [] files-normalized: [] extraction-responses: [] document-type: null fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-12-20T00:47:09.000Z' updated-at: '2023-12-20T00:47:09.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-processed-government-id-webhook-body: value: data: type: event id: evt_4TmLwQxK8dRfYpN2vJhBs6cA attributes: name: document.processed payload: data: type: document/government-id id: doc_vXwNeVfVCcgedQ2Sg4R5F9VD attributes: status: processed created-at: '2024-01-23T20:54:08.000Z' processed-at: '2024-01-23T20:54:14.000Z' processed-at-ts: 1706043254 front-photo: filename: persona_camera_1706043245796.jpg url: 'https://files.withpersona.com/persona_camera_1706043245796.jpg?access_token=ACCESS_TOKEN' byte-size: 298279 back-photo: null selfie-photo: filename: selfie_photo.jpg url: 'https://files.withpersona.com/selfie_photo.jpg?access_token=ACCESS_TOKEN' byte-size: 11686 id-class: dl name-first: Jane name-middle: Marie name-last: Doe name-suffix: null birthdate: '1994-12-30' address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: CA address-postal-code: '94111' issuing-authority: null issuing-subdivision: CA nationality: null document-number: null visa-status: null issue-date: '2021-04-29' expiration-date: '2029-05-11' designations: [] birthplace: null height: null sex: null endorsements: null restrictions: null vehicle-class: null identification-number: '25995844' relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-01-23T20:54:08.000Z' updated-at: '2024-01-23T20:54:14.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_government_id fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/government-id id: doc_vXwNeVfVCcgedQ2Sg4R5F9VD selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-errored-webhook-body: value: data: type: event id: evt_9RkPmXvN3bQwYsL7tHdFc2jE attributes: name: document.errored payload: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: errored created-at: '2023-12-20T00:47:09.000Z' processed-at: null processed-at-ts: null kind: document files: [] files-normalized: [] extraction-responses: [] document-type: null fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-12-20T00:47:09.000Z' updated-at: '2023-12-20T00:47:09.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-extracted-government-id-webhook-body: value: data: type: event id: evt_4TmLwQxK8dRfYpN2vJhBs6cA attributes: name: document.extracted payload: data: type: document/government-id id: doc_vXwNeVfVCcgedQ2Sg4R5F9VD attributes: status: processed created-at: '2024-01-23T20:54:08.000Z' processed-at: '2024-01-23T20:54:14.000Z' processed-at-ts: 1706043254 front-photo: filename: persona_camera_1706043245796.jpg url: 'https://files.withpersona.com/persona_camera_1706043245796.jpg?access_token=ACCESS_TOKEN' byte-size: 298279 back-photo: null selfie-photo: filename: selfie_photo.jpg url: 'https://files.withpersona.com/selfie_photo.jpg?access_token=ACCESS_TOKEN' byte-size: 11686 id-class: dl name-first: Jane name-middle: Marie name-last: Doe name-suffix: null birthdate: '1994-12-30' address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: CA address-postal-code: '94111' issuing-authority: null issuing-subdivision: CA nationality: null document-number: null visa-status: null issue-date: '2021-04-29' expiration-date: '2029-05-11' designations: [] birthplace: null height: null sex: null endorsements: null restrictions: null vehicle-class: null identification-number: '25995844' relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-01-23T20:54:08.000Z' updated-at: '2024-01-23T20:54:14.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_government_id fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/government-id id: doc_vXwNeVfVCcgedQ2Sg4R5F9VD selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' document-pending-webhook-body: value: data: type: event id: evt_9RkPmXvN3bQwYsL7tHdFc2jE attributes: name: document.pending payload: data: type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W attributes: status: submitted created-at: '2023-12-20T00:47:09.000Z' processed-at: null processed-at-ts: null kind: document files: [] files-normalized: [] extraction-responses: [] document-type: null fields: {} relationships: inquiry: data: type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt template: data: null inquiry-template-version: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh transaction: data: null document-files: data: [] included: - type: inquiry id: inq_5noeVrHSRUWeFMv5T6wLA8qt attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-12-20T00:47:09.000Z' updated-at: '2023-12-20T00:47:09.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh inquiry-template-version: data: null reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: - type: document/generic id: doc_bzyijToBPnSHtbW2mMdpKM8W selfies: data: [] - type: inquiry-template id: itmpl_jGTjQgGMyei68sdf8NyCeDMh attributes: status: active name: Government ID Front and Back created-at: '2024-02-15T23:48:17.732Z' graph-query-cancelled-webhook-body: value: data: type: event id: evt_r5zBSCeM0jiSx3Lt4gFeziOyNsXe attributes: name: graph-query.cancelled payload: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: cancelled params: type: n_hops_from_account node_limit: 100 num_hops: 4 variables: [] known_node_ids: [] traversal_conditionals: [] conditionals: - left: account operator: equals right: - type: text raw_value: act_n2uq9eKMboaCQzu9ALWYcVdN value: act_n2uq9eKMboaCQzu9ALWYcVdN created-at: '2026-05-26T19:06:45.000Z' updated-at: '2026-05-26T19:07:03.000Z' errored-at: null completed-at: null redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: null nodes: [] relationships: accounts: data: [] created-at: '2026-05-26T19:07:03.732Z' graph-query-completed-webhook-body: value: data: type: event id: evt_p3xZQAcK8hgPv1Jr2eDcxGmwLqVc attributes: name: graph-query.completed payload: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: completed params: type: n_hops_from_account node_limit: 100 num_hops: 2 variables: [] known_node_ids: [] traversal_conditionals: [] conditionals: - left: account operator: equals right: - type: text raw_value: act_n2uq9eKMboaCQzu9ALWYcVdN value: act_n2uq9eKMboaCQzu9ALWYcVdN - left: shared_properties operator: includes-any-of right: - type: text raw_value: gdt_WV7mWfBrrr51UkBZfmFmobLU created-at: '2026-05-26T19:06:45.000Z' updated-at: '2026-05-26T19:07:12.000Z' errored-at: null completed-at: '2026-05-26T19:07:12.000Z' redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: false nodes: - type: Account value: act_n2uq9eKMboaCQzu9ALWYcVdN - type: Account value: act_9e3yoAUApTRMjgNoPAC7TNtz - type: Email Address value: jane@doe.com - type: Phone Number value: '+14155550100' relationships: accounts: data: - type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN - type: account id: act_9e3yoAUApTRMjgNoPAC7TNtz created-at: '2026-05-26T19:07:12.732Z' graph-query-errored-webhook-body: value: data: type: event id: evt_q4yARBdL9ihRw2Ks3fEdyHnxMrWd attributes: name: graph-query.errored payload: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: errored params: type: n_hops_from_account node_limit: 100 num_hops: 6 variables: [] known_node_ids: [] traversal_conditionals: [] conditionals: - left: account operator: equals right: - type: text raw_value: act_n2uq9eKMboaCQzu9ALWYcVdN value: act_n2uq9eKMboaCQzu9ALWYcVdN created-at: '2026-05-26T19:06:45.000Z' updated-at: '2026-05-26T19:06:58.000Z' errored-at: '2026-05-26T19:06:58.000Z' completed-at: null redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: null nodes: [] relationships: accounts: data: [] created-at: '2026-05-26T19:06:58.732Z' graph-query-reran-webhook-body: value: data: type: event id: evt_t7bDUEgO2lkUz5Nv6iHgbkQ0PuZg attributes: name: graph-query.reran payload: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: submitted params: type: n_hops_from_account node_limit: 100 num_hops: 2 variables: [] known_node_ids: [] traversal_conditionals: [] conditionals: - left: account operator: equals right: - type: text raw_value: act_n2uq9eKMboaCQzu9ALWYcVdN value: act_n2uq9eKMboaCQzu9ALWYcVdN created-at: '2026-05-26T19:06:45.000Z' updated-at: '2026-05-26T19:09:30.000Z' errored-at: null completed-at: null redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: null nodes: [] relationships: accounts: data: [] created-at: '2026-05-26T19:09:30.732Z' graph-query-timed-out-webhook-body: value: data: type: event id: evt_s6aCTDfN1kjTy4Mu5hGfajPzOtYf attributes: name: graph-query.timed-out payload: data: type: graph-query id: grphq_prM3gdSL6ciwGjSjj4aXgKJT attributes: status: timed_out params: type: by_cluster node_limit: 500 num_hops: 4 variables: [] known_node_ids: [] traversal_conditionals: [] conditionals: - left: cluster operator: equals right: - type: text raw_value: '42' value: '42' created-at: '2026-05-26T19:06:45.000Z' updated-at: '2026-05-26T19:08:45.000Z' errored-at: null completed-at: null redacted-at: null stats: {} explorer-url: 'https://withpersona.com/dashboard/explorer?queryId=grphq_prM3gdSL6ciwGjSjj4aXgKJT' node-limit-reached: null nodes: [] relationships: accounts: data: [] created-at: '2026-05-26T19:08:45.732Z' inquiry-created-webhook-body: value: data: type: event id: evt_aBcDeFgHiJkLmNoPqRsTuVwX attributes: name: inquiry.created payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: created reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:30:00.000Z' started-at: null expires-at: '2024-03-16T18:30:00.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: null next-step-name: start fields: identification-number: type: string value: null relationships: account: data: null template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc created-at: '2024-03-15T18:30:00.000Z' inquiry-started-webhook-body: value: data: type: event id: evt_bCdEfGhIjKlMnOpQrStUvWxY attributes: name: inquiry.started payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: '2024-03-16T18:30:00.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_government_id fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: null template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: [] sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: active created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: null ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:31:00.100Z' inquiry-expired-webhook-body: value: data: type: event id: evt_fGhIjKlMnOpQrStUvWxYzAbC attributes: name: inquiry.expired payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: expired reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-16T18:30:00.000Z' started-at: null expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: '2024-03-16T18:30:00.000Z' redacted-at: null previous-step-name: null next-step-name: start fields: identification-number: type: string value: null relationships: account: data: null template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc created-at: '2024-03-16T18:30:00.100Z' inquiry-completed-webhook-body: value: data: type: event id: evt_dEfGhIjKlMnOpQrStUvWxYzA attributes: name: inquiry.completed payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: completed reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:35:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: '2024-03-15T18:35:00.000Z' failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: verification_selfie next-step-name: success fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:35:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:35:00.100Z' inquiry-failed-webhook-body: value: data: type: event id: evt_eFgHiJkLmNoPqRsTuVwXyZaB attributes: name: inquiry.failed payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: failed reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:33:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: '2024-03-15T18:33:00.000Z' marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: verification_government_id next-step-name: failure fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:33:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:33:00.100Z' inquiry-marked-for-review-webhook-body: value: data: type: event id: evt_gHiJkLmNoPqRsTuVwXyZaBcD attributes: name: inquiry.marked-for-review payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: needs_review reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:34:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: '2024-03-15T18:34:00.000Z' decisioned-at: null expired-at: null redacted-at: null previous-step-name: verification_government_id next-step-name: review fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:34:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:34:00.100Z' inquiry-approved-webhook-body: value: data: type: event id: evt_hIjKlMnOpQrStUvWxYzAbCdE attributes: name: inquiry.approved payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: approved reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:35:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: '2024-03-15T18:35:00.000Z' expired-at: null redacted-at: null previous-step-name: verification_selfie next-step-name: success fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:35:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:35:00.100Z' inquiry-declined-webhook-body: value: data: type: event id: evt_iJkLmNoPqRsTuVwXyZaBcDeF attributes: name: inquiry.declined payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: declined reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:35:04.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: '2024-03-15T18:34:00.000Z' failed-at: null marked-for-review-at: null decisioned-at: '2024-03-15T18:35:04.000Z' expired-at: null redacted-at: null previous-step-name: verification_government_id next-step-name: failure fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:35:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:35:04.100Z' inquiry-transitioned-webhook-body: value: data: type: event id: evt_cDeFgHiJkLmNoPqRsTuVwXyZ attributes: name: inquiry.transitioned payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:32:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: '2024-03-16T18:30:00.000Z' completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: verification_government_id next-step-name: verification_selfie fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: null template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: null reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: active created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: null ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:32:00.100Z' inquiry-redacted-webhook-body: value: data: type: event id: evt_jKlMnOpQrStUvWxYzAbCdEfG attributes: name: inquiry.redacted payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: approved reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-09-15T00:00:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: '2024-03-15T18:35:00.000Z' expired-at: null redacted-at: '2024-09-15T00:00:00.000Z' previous-step-name: verification_selfie next-step-name: success fields: name-first: type: string value: null name-last: type: string value: null birthdate: type: date value: null address-street-1: type: string value: null address-city: type: string value: null address-subdivision: type: string value: null address-postal-code: type: string value: null address-country-code: type: string value: null email-address: type: string value: null phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: [] documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc created-at: '2024-09-15T00:00:00.100Z' inquiry-reusable-persona-created-webhook-body: value: data: type: event id: evt_kLmNoPqRsTuVwXyZaBcDeFgH attributes: name: inquiry.reusable-persona-created payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: approved reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-15T18:35:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: '2024-03-15T18:35:00.000Z' expired-at: null redacted-at: null previous-step-name: verification_selfie next-step-name: success fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:35:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ created-at: '2024-03-15T18:35:01.100Z' inquiry-reusable-persona-used-webhook-body: value: data: type: event id: evt_lMnOpQrStUvWxYzAbCdEfGhI attributes: name: inquiry.reusable-persona-used payload: data: type: inquiry id: inq_qR5sT7vXNwJpZkLcBdFmYhGe attributes: status: approved reference-id: null note: null behaviors: {} tags: [] creator: creator@example.com reviewer-comment: null created-at: '2024-08-22T14:00:00.000Z' updated-at: '2024-08-22T14:00:20.000Z' started-at: '2024-08-22T14:00:10.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: '2024-08-22T14:00:20.000Z' expired-at: null redacted-at: null previous-step-name: reusable_persona_match next-step-name: success fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: [] sessions: data: - type: inquiry-session id: iqse_TvW9bXcKpRyZmJ4LnQsHfDvN documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_TvW9bXcKpRyZmJ4LnQsHfDvN attributes: status: expired created-at: '2024-08-22T14:00:10.000Z' started-at: '2024-08-22T14:00:10.000Z' expired-at: '2024-08-22T14:00:20.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_qR5sT7vXNwJpZkLcBdFmYhGe created-at: '2024-08-22T14:00:20.100Z' inquiry-updated-tags-webhook-body: value: data: type: event id: evt_mNoPqRsTuVwXyZaBcDeFgHiJ attributes: name: inquiry.updated-tags payload: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ attributes: status: approved reference-id: null note: null behaviors: {} tags: - high_value_customer - manual_review_complete creator: creator@example.com reviewer-comment: null created-at: '2024-03-15T18:30:00.000Z' updated-at: '2024-03-16T09:15:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: '2024-03-15T18:35:00.000Z' expired-at: null redacted-at: null previous-step-name: verification_selfie next-step-name: success fields: name-first: type: string value: Jane name-middle: type: string value: Marie name-last: type: string value: Doe address-street-1: type: string value: 123 Main St address-street-2: type: string value: null address-city: type: string value: San Francisco address-subdivision: type: string value: California address-postal-code: type: string value: '94111' address-country-code: type: string value: US birthdate: type: date value: '1995-09-08' email-address: type: string value: jane@example.com phone-number: type: string value: null identification-number: type: string value: null relationships: account: data: type: account id: act_fJ8mQpDLrYvNcBzWk5HsAxRy template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA transaction: data: null reviewer: data: type: workflow-run id: wfr_M7vXNqRpL3kBzW4tYcHdJgFs reports: data: [] verifications: data: - type: verification/government-id id: ver_X3kHmRqV9YpZ2nBwL5tGdJcE sessions: data: - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF documents: data: [] selfies: data: [] included: - type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc attributes: status: active name: Example KYC Template relationships: latest-published-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA - type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA attributes: status: published name-display: Example KYC Flow relationships: inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc - type: inquiry-session id: iqse_NkPwRtQv5xB8cYm2L4jZdHsF attributes: status: expired created-at: '2024-03-15T18:31:00.000Z' started-at: '2024-03-15T18:31:00.000Z' expired-at: '2024-03-15T18:35:00.000Z' ip-address: 192.0.2.4 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7749 longitude: -122.4194 relationships: inquiry: data: type: inquiry id: inq_kT4xVnR2bPmYwL9sTgD3cExZ context: added-tags: - manual_review_complete removed-tags: - pending_review created-at: '2024-03-16T09:15:00.100Z' inquiry-session-started-webhook-body: value: data: type: event id: evt_7KqH4xVnR2bPmYwL9sTgD3cE attributes: name: inquiry-session.started payload: data: type: inquiry-session id: iqse_mN5pQ8rJkX2vHsYw4tBcFdGa attributes: status: active created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: null ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 gps-latitude: null gps-longitude: null gps-precision: null ip-connection-type: residential ip-isp: Comcast Cable Communications network-organization: Comcast Cable Communications relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 device: data: type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa network: data: type: network id: net_wL5xQ8rJkM2vHsYn4tBcFdGa included: - type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa attributes: device-vendor-id: null device-fingerprint: null browser-fingerprint: null - type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-07-25T04:15:20.000Z' updated-at: '2023-07-25T05:14:50.000Z' started-at: '2023-07-25T05:14:50.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] created-at: '2024-02-15T23:48:17.732Z' inquiry-session-expired-webhook-body: value: data: type: event id: evt_7KqH4xVnR2bPmYwL9sTgD3cE attributes: name: inquiry-session.expired payload: data: type: inquiry-session id: iqse_mN5pQ8rJkX2vHsYw4tBcFdGa attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 gps-latitude: null gps-longitude: null gps-precision: null ip-connection-type: residential ip-isp: Comcast Cable Communications network-organization: Comcast Cable Communications relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 device: data: type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa network: data: type: network id: net_wL5xQ8rJkM2vHsYn4tBcFdGa included: - type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa attributes: device-vendor-id: null device-fingerprint: null browser-fingerprint: null - type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: expired reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-07-25T04:15:20.000Z' updated-at: '2023-07-26T05:14:50.000Z' started-at: '2023-07-25T05:14:50.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: '2023-07-26T05:14:50.000Z' redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] created-at: '2024-02-15T23:48:17.732Z' inquiry-session-canceled-webhook-body: value: data: type: event id: evt_7KqH4xVnR2bPmYwL9sTgD3cE attributes: name: inquiry-session.canceled payload: data: type: inquiry-session id: iqse_mN5pQ8rJkX2vHsYw4tBcFdGa attributes: status: expired created-at: '2023-07-25T04:15:20.000Z' started-at: '2023-07-25T05:14:50.000Z' expired-at: '2023-07-26T05:14:50.000Z' ip-address: 127.0.0.1 user-agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36' os-name: Mac os-full-version: 10.15.7 device-type: desktop device-name: null browser-name: Chrome browser-full-version: 115.0.0.0 mobile-sdk-name: null mobile-sdk-full-version: null device-handoff-method: null is-proxy: false is-tor: false is-datacenter: false is-vpn: false threat-level: low country-code: US country-name: United States region-code: CA region-name: California latitude: 37.7688 longitude: -122.262 gps-latitude: null gps-longitude: null gps-precision: null ip-connection-type: residential ip-isp: Comcast Cable Communications network-organization: Comcast Cable Communications relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 device: data: type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa network: data: type: network id: net_wL5xQ8rJkM2vHsYn4tBcFdGa included: - type: device id: dev_kR7nP3mQvX9sHtYw2cBdFgJa attributes: device-vendor-id: null device-fingerprint: null browser-fingerprint: null - type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 attributes: status: expired reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2023-07-25T04:15:20.000Z' updated-at: '2023-07-26T05:14:50.000Z' started-at: '2023-07-25T05:14:50.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: '2023-07-26T05:14:50.000Z' redacted-at: null previous-step-name: start next-step-name: verification_document fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: {} inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: [] created-at: '2024-02-15T23:48:17.732Z' importer-pipeline-run-canceled-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.canceled payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-003 status: canceled run-count: 1 started-at: '2024-01-15T12:00:00.000Z' ended-at: '2024-01-15T12:02:30.000Z' created-at: '2024-01-15T11:59:45.000Z' updated-at: '2024-01-15T12:02:30.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 0 rows-read: 50 row-count: 50 success-count: 50 created-count: 25 updated-count: 25 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: manual destination: account next-run-at: null created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T12:02:30.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T12:02:30.732Z' importer-pipeline-run-completed-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.completed payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-001 status: completed run-count: 1 started-at: '2024-01-15T10:00:00.000Z' ended-at: '2024-01-15T10:15:30.000Z' created-at: '2024-01-15T09:59:45.000Z' updated-at: '2024-01-15T10:15:30.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 5 rows-read: 1000 row-count: 1000 success-count: 995 created-count: 500 updated-count: 495 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: recurring destination: account next-run-at: '2024-01-16T10:00:00.000Z' created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T10:15:30.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T10:15:30.732Z' importer-pipeline-run-errored-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.errored payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-002 status: errored run-count: 2 started-at: '2024-01-15T11:00:00.000Z' ended-at: '2024-01-15T11:05:15.000Z' created-at: '2024-01-15T10:59:45.000Z' updated-at: '2024-01-15T11:05:15.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 150 rows-read: 150 row-count: 150 success-count: 0 created-count: 0 updated-count: 0 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: manual destination: account next-run-at: null created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T11:05:15.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T11:05:15.732Z' importer-pipeline-run-paused-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.paused payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-004 status: paused run-count: 1 started-at: '2024-01-15T13:00:00.000Z' ended-at: null created-at: '2024-01-15T12:59:45.000Z' updated-at: '2024-01-15T13:03:15.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 2 rows-read: 200 row-count: 200 success-count: 198 created-count: 100 updated-count: 98 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: manual destination: account next-run-at: null created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T13:03:15.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T13:03:15.732Z' importer-pipeline-run-resumed-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.resumed payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-004 status: running run-count: 2 started-at: '2024-01-15T13:00:00.000Z' ended-at: null created-at: '2024-01-15T12:59:45.000Z' updated-at: '2024-01-15T13:10:00.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 2 rows-read: 200 row-count: 200 success-count: 198 created-count: 100 updated-count: 98 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: manual destination: account next-run-at: null created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T13:10:00.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T13:10:00.732Z' importer-pipeline-run-started-webhook-body: value: data: type: event id: evt_ABC123DEF456GHI789JKL012MNO345 attributes: name: importer-pipeline-run.started payload: data: type: importer-pipeline-run id: mprtpr_ABC123DEF456 attributes: reference-id: import-batch-001 status: running run-count: 1 started-at: '2024-01-15T10:00:00.000Z' ended-at: null created-at: '2024-01-15T09:59:45.000Z' updated-at: '2024-01-15T10:00:00.000Z' redacted-at: null run-data: column-names: - name - email - phone error-count: 0 rows-read: 0 row-count: 0 success-count: 0 created-count: 0 updated-count: 0 estimated-total-count: 1000 relationships: importer-pipeline: data: type: importer-pipeline id: mprtp_XYZ789ABC123 included: - type: importer-pipeline id: mprtp_XYZ789ABC123 attributes: name: Customer Data Import status: active run-type: recurring destination: account next-run-at: '2024-01-16T10:00:00.000Z' created-at: '2024-01-01T12:00:00.000Z' updated-at: '2024-01-15T09:59:45.000Z' archived-at: null pipeline-config: destination: account sync-mode: upsert archive-after-completion: false created-at: '2024-01-15T10:00:00.732Z' report-address-lookup-ready-webhook-body: value: data: type: event id: evt_s4F6EwpbqbHyX6dHbfHfG6BD attributes: name: report/address-lookup.ready payload: data: type: report/address-lookup id: rep_aH26JqEsr7pMzU55cLuT3kn6 attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] addressee: Joe Doe address-street-1: 1 Infinite Loop address-street-2: null address-city: Cupertino address-subdivision: California relationships: inquiry: data: type: inquiry id: inq_Mh92F4nVG7KW91yhYbkAdrtV account: data: type: account id: act_8ztHa7r9psA9DjEQczTncyhm transaction: data: null report-template: data: type: report-template/address-lookup id: rptp_DKV5tRduPeiZTTFx2UTTrwBK created-at: '2024-02-15T23:48:17.732Z' report-address-lookup-errored-webhook-body: value: data: type: event id: evt_KbaYwVADnNFjV53wufNXojRQ attributes: name: report/address-lookup.errored payload: data: type: report/address-lookup id: rep_NxoAqrP1hSMNJTJNjCBWHQvP attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] addressee: Joe Doe address-street-1: 1 Infinite Loop address-street-2: null address-city: Cupertino address-subdivision: California relationships: inquiry: data: type: inquiry id: inq_rCKSwrin88K2ydfZiVkw9RJM account: data: type: account id: act_y46cSrRxWx2ausdQ1GkpMfQ8 transaction: data: null report-template: data: type: report-template/address-lookup id: rptp_KzBrhQNAHb4qhVuxFFM4pGmp created-at: '2024-02-15T23:48:17.732Z' report-address-lookup-submitted-webhook-body: value: data: type: event id: evt_My3BDzdjTYJYSyPJzShcAwmy attributes: name: report/address-lookup.submitted payload: data: type: report/address-lookup id: rep_Uvhgosx2HxDCVuq5THDxusS1 attributes: status: submitted created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] addressee: Joe Doe address-street-1: 1 Infinite Loop address-street-2: null address-city: Cupertino address-subdivision: California relationships: inquiry: data: type: inquiry id: inq_vLnm3Atgb6NPTx5iXSqRNRAm account: data: type: account id: act_aaHZrAKdiGQoLwhZNVPi9Hxn transaction: data: null report-template: data: type: report-template/address-lookup id: rptp_LQydFk1EJdYXatzUbTMSVLij created-at: '2024-02-15T23:48:17.732Z' report-adverse-media-ready-webhook-body: value: data: type: event id: evt_4hkfgSU1FwfacVL2QWZyo8r5 attributes: name: report/adverse-media.ready payload: data: type: report/adverse-media id: rep_Vrv8tKKkFuwUxG2nXtCKKKjL attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate-year: 1992 birthdate: '1991-10-07' country-code: US relationships: inquiry: data: type: inquiry id: inq_UcpryBGDdN1ZK4FTRWzJM8UG account: data: type: account id: act_mED8V8EMpKtfqRpuWznwh2iF transaction: data: null report-template: data: type: report-template/adverse-media id: rptp_VaJACjVM367z6cPpKfdcEAzh created-at: '2024-02-15T23:48:17.732Z' report-adverse-media-errored-webhook-body: value: data: type: event id: evt_ohzjwLcm4C3ynUrd4KvLQYNh attributes: name: report/adverse-media.errored payload: data: type: report/adverse-media id: rep_5c6HpWs4DKj9pDXAVbwW8Mfs attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate-year: 1992 birthdate: '1991-10-07' country-code: US relationships: inquiry: data: type: inquiry id: inq_tj8cGgkwNNzwvDzVq9F5udh6 account: data: type: account id: act_d7Ze1nwSd5eEPkfFkwvVMEFE transaction: data: null report-template: data: type: report-template/adverse-media id: rptp_6krC8rsXzGgdRozxeQ91Udcp created-at: '2024-02-15T23:48:17.732Z' report-adverse-media-matched-webhook-body: value: data: type: event id: evt_8QRWZHgA1ccUKiSmobkcrMFZ attributes: name: report/adverse-media.matched payload: data: type: report/adverse-media id: rep_5DQhuR6AqqnycyErew9V7MiZ attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate-year: 1992 birthdate: '1991-10-07' country-code: US relationships: inquiry: data: type: inquiry id: inq_F2HuEzyrAMbwRw8esbuhe1zx account: data: type: account id: act_qbWWLKaKQ82ot5yDVTaacf2p transaction: data: null report-template: data: type: report-template/adverse-media id: rptp_fMeKgESq42V2kPqixbzJCHhY created-at: '2024-02-15T23:48:17.732Z' report-adverse-media-dismissed-webhook-body: value: data: type: event id: evt_gFCwzK84s45fBFMHok7NGS4Q attributes: name: report/adverse-media.dismissed payload: data: type: report/adverse-media id: rep_otGSUDpURLL5Y3dSdAQNJdAm attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: true is-recurring: true tags: [] name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate-year: 1992 birthdate: '1991-10-07' country-code: US relationships: inquiry: data: type: inquiry id: inq_PxxpbyFY3Z124FXTMBU4MxDn account: data: type: account id: act_aHexop9yEFGqiVrzF1NBM7So transaction: data: null report-template: data: type: report-template/adverse-media id: rptp_TVVeKkN7UPpDMMyy6NWfeiDt created-at: '2024-02-15T23:48:17.732Z' report-business-adverse-media-ready-webhook-body: value: data: type: event id: evt_vRLSZ8vLygoQh8TnGd3citj5 attributes: name: report/business-adverse-media.ready payload: data: type: report/business-adverse-media id: rep_rzcseUGJWDqpTM7RafdKt1dd attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] term: Acme Corporation relationships: inquiry: data: null account: data: type: account id: act_47BqHqKF2pCpxgM3RDNDQgUT transaction: data: null report-template: data: type: report-template/business-adverse-media id: rptp_6hdLidF53AcJMmkTPU6wbWC1 created-at: '2024-02-15T23:48:17.732Z' report-business-adverse-media-errored-webhook-body: value: data: type: event id: evt_marhLiVgTSZBZk6yD8p876Cu attributes: name: report/business-adverse-media.errored payload: data: type: report/business-adverse-media id: rep_vH8bEB38q6oojjfdfNeS6Qmd attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] term: Acme Corporation relationships: inquiry: data: null account: data: type: account id: act_GM8wLC8TLbyM5dVFASaGgZ89 transaction: data: null report-template: data: type: report-template/business-adverse-media id: rptp_JbUkNrycBtup6QmtZrd8TqKj created-at: '2024-02-15T23:48:17.732Z' report-business-adverse-media-matched-webhook-body: value: data: type: event id: evt_esqdvYcGae67L374UV92KXAv attributes: name: report/business-adverse-media.matched payload: data: type: report/business-adverse-media id: rep_o3Uph1H55m2rw9v5nLdse2TG attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] term: Acme Corporation relationships: inquiry: data: null account: data: type: account id: act_ovG8LgntLvm3E6nqCXWc28ny transaction: data: null report-template: data: type: report-template/business-adverse-media id: rptp_tuDEiL79vd1JoWRYEpYwhpi7 created-at: '2024-02-15T23:48:17.732Z' report-business-adverse-media-dismissed-webhook-body: value: data: type: event id: evt_B8Yti7q9eRghycEYzhBV1ggm attributes: name: report/business-adverse-media.dismissed payload: data: type: report/business-adverse-media id: rep_oiBDPaWaNxEhSF7YWxUpAAzV attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: true is-recurring: true tags: [] term: Acme Corporation relationships: inquiry: data: null account: data: type: account id: act_RGLXhQfbFgJz3YM5ubUPztDZ transaction: data: null report-template: data: type: report-template/business-adverse-media id: rptp_n38ihWa5Kqw5GKz8yry2epiE created-at: '2024-02-15T23:48:17.732Z' report-business-associated-persons-ready-webhook-body: value: data: type: event id: evt_96aBhUdmKWMmokZn2GQkbUKt attributes: name: report/business-associated-persons.ready payload: data: type: report/business-associated-persons id: rep_x9Y4ngASdZsHLa467yWx6kRk attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: address-country-code: US associated-persons: [] ownership-information: owners: - type: person name: Jane Doe birthdate: 1980-05 address: street-1: 123 Main St street-2: null city: San Francisco subdivision: CA postal-code: '94105' country-code: US roles: - description: Ownership of 75-100% shares data: key: ownership-of-shares-75-to-100-percent lower-bound: 75 upper-bound: 100 relationships: inquiry: data: null account: data: type: account id: act_XukzDq5RGJJsoGDtLdq34Kd3 transaction: data: null report-template: data: type: report-template/business-associated-persons id: rptp_DrbN9qfLxJmqAjhGXA3nxpcL created-at: '2024-02-15T23:48:17.732Z' report-business-associated-persons-errored-webhook-body: value: data: type: event id: evt_vZmgpGsc1j2ECuuRqicBuiEs attributes: name: report/business-associated-persons.errored payload: data: type: report/business-associated-persons id: rep_uAkMR8t4CTCAtm1LFonXA7fi attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: address-country-code: US associated-persons: [] ownership-information: owners: [] relationships: inquiry: data: null account: data: type: account id: act_C65v91gRhDZoypnkjHfPSArt transaction: data: null report-template: data: type: report-template/business-associated-persons id: rptp_pVo3c7HY29QSJSkyYwGJGnfQ created-at: '2024-02-15T23:48:17.732Z' report-business-lookup-ready-webhook-body: value: data: type: event id: evt_aUm74yYwBg2KworKhhBaMn7B attributes: name: report/business-lookup.ready payload: data: type: report/business-lookup id: rep_r76WyFFkAhqHpHcKrBuX3ugA attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: business-name: Coffee Shop phone-number: '+11234567890' website: 'https://website.com' ein: null address-street-1: 123 Funky St address-street-2: null relationships: inquiry: data: null account: data: type: account id: act_wiU8LbfSnXpXVAokjPAf9eTp transaction: data: null report-template: data: type: report-template/business-lookup id: rptp_NosHCHiTSQkjbACwbAaoMqzC created-at: '2024-02-15T23:48:17.732Z' report-business-lookup-errored-webhook-body: value: data: type: event id: evt_SrhpHdXUj99JSqZqi1PM3hzB attributes: name: report/business-lookup.errored payload: data: type: report/business-lookup id: rep_8oPHDM1jztbzPnMMmdVzJwds attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: business-name: Coffee Shop phone-number: '+11234567890' website: 'https://website.com' ein: null address-street-1: 123 Funky St address-street-2: null relationships: inquiry: data: null account: data: type: account id: act_XkHmE7tM3Du5PAhenFNbNwtM transaction: data: null report-template: data: type: report-template/business-lookup id: rptp_3j7tBBvJGyqdpVLV7J21FDYg created-at: '2024-02-15T23:48:17.732Z' report-business-registrations-lookup-ready-webhook-body: value: data: type: event id: evt_BvNVBknQbK2UHWtTz66RVQgf attributes: name: report/business-registrations-lookup.ready payload: data: type: report/business-registrations-lookup id: rep_nqbhyxn7JiWo9KTXxAabbEzD attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: address-country-code: US result: business-name: Acme Corporation legal-entity-type: LLC formation-country: US formation-subdivision: Delaware formation-date: '2015-06-01' registry-records: [] relationships: inquiry: data: null account: data: type: account id: act_yvV8wsVby8powVVnZ5cjJFGf transaction: data: null report-template: data: type: report-template/business-registrations-lookup id: rptp_pZYMHyRjBmHUrC5cqiRqauQQ created-at: '2024-02-15T23:48:17.732Z' report-business-registrations-lookup-errored-webhook-body: value: data: type: event id: evt_NdKRa3aAh4qTCmG412iW38PJ attributes: name: report/business-registrations-lookup.errored payload: data: type: report/business-registrations-lookup id: rep_xEjdKitHM4fpuDzdZSMDM5GS attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: address-country-code: US result: {} relationships: inquiry: data: null account: data: type: account id: act_UEoNdbUouEitKiba7gF5eWPG transaction: data: null report-template: data: type: report-template/business-registrations-lookup id: rptp_nmVozhYuwE3jixHGxsm2KHo8 created-at: '2024-02-15T23:48:17.732Z' report-business-watchlist-ready-webhook-body: value: data: type: event id: evt_j6YyL58ec2T7EYZVdvfk1wUw attributes: name: report/business-watchlist.ready payload: data: type: report/business-watchlist id: rep_UYRpnk7oBG1pUaKqXUnM4ZbN attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] matched-lists: [] sanction-list: [] fitness-probity-list: [] warning-list: [] relationships: inquiry: data: null account: data: type: account id: act_yWvCSWWziuevqmEcEmaLdabL transaction: data: null report-template: data: type: report-template/business-watchlist id: rptp_5DAw1mPXzqeXwZSpHw6Bc4nq created-at: '2024-02-15T23:48:17.732Z' report-business-watchlist-errored-webhook-body: value: data: type: event id: evt_czzLcuFxUZ5qCPzmZn472tbJ attributes: name: report/business-watchlist.errored payload: data: type: report/business-watchlist id: rep_X7KFU4YKrwkdkncX2PS4BuGo attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] matched-lists: [] sanction-list: [] fitness-probity-list: [] warning-list: [] relationships: inquiry: data: null account: data: type: account id: act_jtquhbjZmtui43qprcgze8Qq transaction: data: null report-template: data: type: report-template/business-watchlist id: rptp_rEkKQwJqrtBo6B6BYcCArhtm created-at: '2024-02-15T23:48:17.732Z' report-business-watchlist-matched-webhook-body: value: data: type: event id: evt_mSqJQhzhT8Njaa3h5zFSsynG attributes: name: report/business-watchlist.matched payload: data: type: report/business-watchlist id: rep_QyMJiuWYTXdhSfFEFxp2BTgR attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] matched-lists: - eu-ec-programme-prk sanction-list: [] fitness-probity-list: [] warning-list: [] relationships: inquiry: data: null account: data: type: account id: act_cEPKcwtmLnLKCttWH1tcU59v transaction: data: null report-template: data: type: report-template/business-watchlist id: rptp_Zdx5wRL74gcP9PyHFTp5TWrx created-at: '2024-02-15T23:48:17.732Z' report-business-watchlist-dismissed-webhook-body: value: data: type: event id: evt_Z9hrNjBVFnF75RPHjuMEujfL attributes: name: report/business-watchlist.dismissed payload: data: type: report/business-watchlist id: rep_sMB4tznTEURp7fbF9txMF6dQ attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: true is-recurring: true tags: [] matched-lists: - eu-ec-programme-prk sanction-list: [] fitness-probity-list: [] warning-list: [] relationships: inquiry: data: null account: data: type: account id: act_hCGZmthvbbkkN61wJGccLBHB transaction: data: null report-template: data: type: report-template/business-watchlist id: rptp_9zF79TAEtMVFnisEUfEPZgS2 created-at: '2024-02-15T23:48:17.732Z' report-crypto-address-watchlist-ready-webhook-body: value: data: type: event id: evt_Y2ix9gqDRHegyCPDZa6k4Wrc attributes: name: report/crypto-address-watchlist.ready payload: data: type: report/crypto-address-watchlist id: rep_Eu2ampkb3KAQmW55iXXgycbj attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] query: crypto-address: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 relationships: inquiry: data: type: inquiry id: inq_HtQnr1KZ1P2VDUCK6WBmZxtQ account: data: type: account id: act_561QKF6UctmDdEzdQ7Txg5kG transaction: data: null report-template: data: type: report-template/crypto-address-watchlist id: rptp_4iej3UpQgaZ9cc7F8T8Jd5Mn created-at: '2024-02-15T23:48:17.732Z' report-crypto-address-watchlist-errored-webhook-body: value: data: type: event id: evt_nLAAt8VKqnPGSGtyFU8m8t9C attributes: name: report/crypto-address-watchlist.errored payload: data: type: report/crypto-address-watchlist id: rep_dy4qUZxiKvnWXa1Si8dnbY5s attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] query: crypto-address: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 relationships: inquiry: data: type: inquiry id: inq_sP5SkTCyQ8LAePz8H3o5srJR account: data: type: account id: act_pEhujUH1XHRgKTNEib44JnME transaction: data: null report-template: data: type: report-template/crypto-address-watchlist id: rptp_Dw78jkLW1gacc3Uh9jjXY5HA created-at: '2024-02-15T23:48:17.732Z' report-crypto-address-watchlist-matched-webhook-body: value: data: type: event id: evt_wWPdwXv4tAX8N4A5PMqezMA4 attributes: name: report/crypto-address-watchlist.matched payload: data: type: report/crypto-address-watchlist id: rep_UYcDUtTgGTMTYjVUy5Woreq4 attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] query: crypto-address: 1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3 relationships: inquiry: data: type: inquiry id: inq_GSVnXAVoLReWo5PS8A68kyUg account: data: type: account id: act_BWKmNBQWsEfjUnamvEE3eWjz transaction: data: null report-template: data: type: report-template/crypto-address-watchlist id: rptp_wxrbgH8qYB5z9nxjaLk2sjYu created-at: '2024-02-15T23:48:17.732Z' report-email-address-ready-webhook-body: value: data: type: event id: evt_fv5UkKutsLJYyysmwXWawjrL attributes: name: report/email-address.ready payload: data: type: report/email-address id: rep_xLnE9n9YGvxCDo3Ci42mnoBN attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] email-address: example@domain.com email-reputation: high email-reference-count: 4 relationships: inquiry: data: type: inquiry id: inq_U9RWbmB3111PGyv5YxtZGr6h account: data: type: account id: act_3xUSrojXTj69fLtBu8W5h9hW transaction: data: null report-template: data: type: report-template/email-address id: rptp_UxbVnwpMLZg8SNMCJ2k6zat6 created-at: '2024-02-15T23:48:17.732Z' report-email-address-errored-webhook-body: value: data: type: event id: evt_Ytvh4jE4ewAAhQ8p7QMRFoMk attributes: name: report/email-address.errored payload: data: type: report/email-address id: rep_Htbg3uBJdZpXxTxwohNhG4UP attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] email-address: example@domain.com email-reputation: high email-reference-count: 4 relationships: inquiry: data: type: inquiry id: inq_AyfRn6RQB2nMgpydE4zKHq7j account: data: type: account id: act_QZZiEvCyvTQz268LTgaaGcKU transaction: data: null report-template: data: type: report-template/email-address id: rptp_9qJPXSNP7CrscGwp7q24q82K created-at: '2024-02-15T23:48:17.732Z' report-phone-number-ready-webhook-body: value: data: type: event id: evt_jGcsK5nsnbbXLMm3uMuk2Hfd attributes: name: report/phone-number.ready payload: data: type: report/phone-number id: rep_B2x7bibmyn5QGX9J49bk11pZ attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] phone-number: '+14169671111' phone-type: MOBILE phone-carrier: Rogers Communications Canada Inc. relationships: inquiry: data: type: inquiry id: inq_6UvESKVTtNZgGGD5vjJGCrvw account: data: type: account id: act_ujUee23FneX3GsZAxMuf8AsB transaction: data: null report-template: data: type: report-template/phone-number id: rptp_eaT8sd4nnvYhxK6dSnpiwN3C created-at: '2024-02-15T23:48:17.732Z' report-phone-number-errored-webhook-body: value: data: type: event id: evt_XrHsCobaJVDw3tY2cznYE8AL attributes: name: report/phone-number.errored payload: data: type: report/phone-number id: rep_HPGX36Ybr41HvgLXGGqxKYgm attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] phone-number: '+14169671111' phone-type: MOBILE phone-carrier: Rogers Communications Canada Inc. relationships: inquiry: data: type: inquiry id: inq_odnbLjue5CsrZ4cqxGqmtwYn account: data: type: account id: act_QNvrdvfc7rwqmuBfYCRrNGgo transaction: data: null report-template: data: type: report-template/phone-number id: rptp_W7fwkZd8T64fZrmJeutAUouU created-at: '2024-02-15T23:48:17.732Z' report-politically-exposed-person-ready-webhook-body: value: data: type: event id: evt_cw6WhnBUKGy8UqsSJ8MgNYf6 attributes: name: report/politically-exposed-person.ready payload: data: type: report/politically-exposed-person id: rep_1ZJyhWGasSsEP4uoV1ScoC5V attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate: '1991-10-07' country-code: US result: null relationships: inquiry: data: type: inquiry id: inq_6yfRoebRL2GSya8uEXMZvtAc account: data: type: account id: act_hbETU51hZU9yUadqRk9ukutL transaction: data: null report-template: data: type: report-template/politically-exposed-person id: rptp_1AEkvLsfBtLenqRKZpBghR7L created-at: '2024-02-15T23:48:17.732Z' report-politically-exposed-person-errored-webhook-body: value: data: type: event id: evt_rv6Y1RTia239PXJYA546cEuV attributes: name: report/politically-exposed-person.errored payload: data: type: report/politically-exposed-person id: rep_gYPxCHS3SYtDJErH84JYC4nd attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate: '1991-10-07' country-code: US result: null relationships: inquiry: data: type: inquiry id: inq_89jSzMKvAneX9sbut8DentG4 account: data: type: account id: act_kwLopQsXSNmaZAvUTdxoqX1W transaction: data: null report-template: data: type: report-template/politically-exposed-person id: rptp_cF8893jBegVMrecE55M2FMpG created-at: '2024-02-15T23:48:17.732Z' report-politically-exposed-person-matched-webhook-body: value: data: type: event id: evt_d5LCcfL9SevUCurWyCdH2MyT attributes: name: report/politically-exposed-person.matched payload: data: type: report/politically-exposed-person id: rep_9TGiBriSDNHBMgxHap49ySZS attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate: '1991-10-07' country-code: US result: [] relationships: inquiry: data: type: inquiry id: inq_Bbsxcm6cZQazvVyTAgrPSxzu account: data: type: account id: act_7cMRvpsP2rYcmUpuG9CD5kd6 transaction: data: null report-template: data: type: report-template/politically-exposed-person id: rptp_Ev65rkYjTEKRdEUUjapCxEc5 created-at: '2024-02-15T23:48:17.732Z' report-politically-exposed-person-dismissed-webhook-body: value: data: type: event id: evt_gvkQJdn1x65E78R1NNWzo7LB attributes: name: report/politically-exposed-person.dismissed payload: data: type: report/politically-exposed-person id: rep_yXFp4tZezW9JdV51Gp9sGFJg attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: true is-recurring: true tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe term: Joe N Doe birthdate: '1991-10-07' country-code: US result: [] relationships: inquiry: data: type: inquiry id: inq_KRZ14ehHTkt5pG6xFjHsz7jo account: data: type: account id: act_xiY9kW8aDJ7fCuVsCVUCXNFw transaction: data: null report-template: data: type: report-template/politically-exposed-person id: rptp_EGgBp74LiawxqMnmBiSSPTpy created-at: '2024-02-15T23:48:17.732Z' report-profile-ready-webhook-body: value: data: type: event id: evt_1DU95D3dxPeceLFiGFuQJ83m attributes: name: report/profile.ready payload: data: type: report/profile id: rep_EEf2AHYPw6Krs4T6RJ76teuz attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] name-first: John name-last: Doe birthdate: '1980-04-12' social-security-number-last-4: '6789' address-street-1: 123 Main St address-city: Metropolis address-subdivision: New York address-subdivision-abbr: NY address-postal-code: '12345' phone-number: 555-1234 identity-records: [] omitted-identity-records: [] relationships: inquiry: data: type: inquiry id: inq_rm7xTX7E46NcybpK9oKJs6hs account: data: type: account id: act_y5suPAXEB6c3MbTXD2Xw14kj transaction: data: null report-template: data: type: report-template/profile id: rptp_kWa5sRECizVCiiJFBMXTrjsN created-at: '2024-02-15T23:48:17.732Z' report-profile-errored-webhook-body: value: data: type: event id: evt_sdDrZ3xtqavZ7rwpLrCZ37Rk attributes: name: report/profile.errored payload: data: type: report/profile id: rep_FWfQgqkYukpCpNh1dLtdcpSz attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] name-first: John name-last: Doe birthdate: '1980-04-12' social-security-number-last-4: '6789' address-street-1: 123 Main St address-city: Metropolis address-subdivision: New York address-subdivision-abbr: NY address-postal-code: '12345' phone-number: 555-1234 identity-records: [] omitted-identity-records: [] relationships: inquiry: data: type: inquiry id: inq_XwuaXhNk2RsC8ZRH7orfEmBA account: data: type: account id: act_zkTNPytyxHjLvvCxDs7sCFEP transaction: data: null report-template: data: type: report-template/profile id: rptp_sEg7aKFrKo2V1pxEvvj7xE8i created-at: '2024-02-15T23:48:17.732Z' report-profile-non-authoritative-ready-webhook-body: value: data: type: event id: evt_9NeL4obNgQQaW8W3uFyxb6Co attributes: name: report/profile-non-authoritative.ready payload: data: type: report/profile-non-authoritative id: rep_Gehh3tY2k2tbKEpHWymJj1rN attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe address-city: San Francisco relationships: inquiry: data: type: inquiry id: inq_1n1kfmYTVp9GMzMccEcFbZuN account: data: type: account id: act_GzywAv13vWDam7XuyWehpBbc transaction: data: null report-template: data: type: report-template/profile-non-authoritative id: rptp_okoxcjVf1zcHHmZhu4x2Nx1x created-at: '2024-02-15T23:48:17.732Z' report-profile-non-authoritative-errored-webhook-body: value: data: type: event id: evt_MiBkotMQmAQSqUrWY6timSo8 attributes: name: report/profile-non-authoritative.errored payload: data: type: report/profile-non-authoritative id: rep_BSdmGhoEwpr5vtnpG8k6hcY6 attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: name-first: Joe name-middle: 'N' name-last: Doe address-city: San Francisco relationships: inquiry: data: type: inquiry id: inq_1rd2KNafzYfbyEVt2UF1m2oh account: data: type: account id: act_xGi1FUc9kirizqaBAvVAZqNM transaction: data: null report-template: data: type: report-template/profile-non-authoritative id: rptp_HwY1AkHds2uDkP3FZTVxVbzo created-at: '2024-02-15T23:48:17.732Z' report-sentilink-scores-ready-webhook-body: value: data: type: event id: evt_LA7dSdmHHcu39Z3SVYdHKDPd attributes: name: report/sentilink-scores.ready payload: data: type: report/integration/sentilink-scores id: rep_pv1oK7DHhuFAfeoeV45KUhiU attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: birthdate: '1994-04-12' name-first: Jane name-last: Doe address-street-1: 123 Main St address-city: San Francisco relationships: inquiry: data: type: inquiry id: inq_GBUCtJ1qKGTQu8dQ2vkja2TH account: data: type: account id: act_YjQEj3uCH59DBsrWM92f26Gc transaction: data: null report-template: data: type: report-template/integration/sentilink-scores id: rptp_2xsRWwMAE74GaAEbTxLsYLXi created-at: '2024-02-15T23:48:17.732Z' report-sentilink-scores-errored-webhook-body: value: data: type: event id: evt_DnjiLmdD4Yjvmk6WF9x3Hi7z attributes: name: report/sentilink-scores.errored payload: data: type: report/integration/sentilink-scores id: rep_91AU1uCEeLY9wJzEYnsHYsbu attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] query: birthdate: '1994-04-12' name-first: Jane name-last: Doe address-street-1: 123 Main St address-city: San Francisco relationships: inquiry: data: type: inquiry id: inq_x4uYaT1WdeWuchoV9QB5FSvH account: data: type: account id: act_CMu66YcakEpz9sGrCKv35m5Q transaction: data: null report-template: data: type: report-template/integration/sentilink-scores id: rptp_iULzwfgPQ91hkAPxKB6SiTED created-at: '2024-02-15T23:48:17.732Z' report-social-media-ready-webhook-body: value: data: type: event id: evt_mpjDCZT4fjsrUhF8dVKudLQs attributes: name: report/social-media.ready payload: data: type: report/social-media id: rep_f3ndFEpFP6hH4DqtTXxhxsD6 attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] name-first: Norman name-last: Mannor birthdate: '1991-10-07' phone-number: '+14169671111' email-address: address@domain.com address-city: Funkyville relationships: inquiry: data: type: inquiry id: inq_AtzBraYx39FE8uFQjkdxhc7q account: data: type: account id: act_ZbRJWwQkDBPbuq6xNcZCsejQ transaction: data: null report-template: data: type: report-template/social-media id: rptp_2FdgKktQMAb9CGgJmfRbBzLo created-at: '2024-02-15T23:48:17.732Z' report-social-media-errored-webhook-body: value: data: type: event id: evt_seVGDFDNR1Syk3KDvYrGzBqQ attributes: name: report/social-media.errored payload: data: type: report/social-media id: rep_ukVCwf6xvGkrB4cMb8LrE92z attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] name-first: Norman name-last: Mannor birthdate: '1991-10-07' phone-number: '+14169671111' email-address: address@domain.com address-city: Funkyville relationships: inquiry: data: type: inquiry id: inq_As5HzVSjQU5buS8Wq3F1HvAQ account: data: type: account id: act_w2eo4Stu1im3RpS5xZnmyTcM transaction: data: null report-template: data: type: report-template/social-media id: rptp_SRtRSvKTA4pszE88RhpE6EnH created-at: '2024-02-15T23:48:17.732Z' report-synthetic-ready-webhook-body: value: data: type: event id: evt_krv1HzHj3qJMNcWHN7Hfvj1J attributes: name: report/synthetic.ready payload: data: type: report/synthetic id: rep_cZoRJKArtv3UhCBe3ZxTravy attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] sentilink-abuse-score: 72 sentilink-first-party-synthetic-score: 58 sentilink-third-party-synthetic-score: 85 relationships: inquiry: data: type: inquiry id: inq_4nqZZyibZfT8REdzX2Y8dhBM account: data: type: account id: act_29houKsWpo7ccSkaW55yp9Be transaction: data: null report-template: data: type: report-template/synthetic id: rptp_xJ8vTRnjvZyMGJdAMf3iHcgr created-at: '2024-02-15T23:48:17.732Z' report-synthetic-errored-webhook-body: value: data: type: event id: evt_xKjUyA7i7CRdFJr9heXw1dtu attributes: name: report/synthetic.errored payload: data: type: report/synthetic id: rep_5gPBic5ak9uwFUjgDV2cGSz9 attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: false tags: [] sentilink-abuse-score: 72 sentilink-first-party-synthetic-score: 58 sentilink-third-party-synthetic-score: 85 relationships: inquiry: data: type: inquiry id: inq_GTLxWXbig9VbtQsP9hsZHdQS account: data: type: account id: act_Ru8yR5EvffouZ9VfjC1hHDF9 transaction: data: null report-template: data: type: report-template/synthetic id: rptp_GMVzyGxXaGU1bgVPBexAHNZc created-at: '2024-02-15T23:48:17.732Z' report-watchlist-ready-webhook-body: value: data: type: event id: evt_H29QdkVRDr94kAJaHGxEkmzG attributes: name: report/watchlist.ready payload: data: type: report/watchlist id: rep_h9dqK1fHRwzn5EJNBWuJvBSB attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] name-first: Jane name-middle: null name-last: Doe term: Jane Doe birthdate: null country-code: null matched-lists: [] ignore-list: [] relationships: inquiry: data: type: inquiry id: inq_2PqthYuCBRKPBenmQju6YqWp account: data: type: account id: act_wQUuFdsRMyxEeSgFJGLJEe5s transaction: data: null report-template: data: type: report-template/watchlist id: rptp_uXhRXnTQx3jqQbnAzy2jcVot created-at: '2024-02-15T23:48:17.732Z' report-watchlist-errored-webhook-body: value: data: type: event id: evt_usSNqySFixduY67JAnoDA3DN attributes: name: report/watchlist.errored payload: data: type: report/watchlist id: rep_AXiYzt7DL79K3soo1MAVhXqW attributes: status: errored created-at: '2024-02-15T23:48:11.000Z' completed-at: null redacted-at: null report-template-version-name: v1 has-match: false is-continuous: false is-recurring: true tags: [] name-first: Jane name-middle: null name-last: Doe term: Jane Doe birthdate: null country-code: null matched-lists: [] ignore-list: [] relationships: inquiry: data: type: inquiry id: inq_pZbB26BkXF8wjEEwNXdssDMT account: data: type: account id: act_7cwr22pxxSWHczLRgvy82Yri transaction: data: null report-template: data: type: report-template/watchlist id: rptp_aLdFtoSDFwUGpdu9xsvnH7Xn created-at: '2024-02-15T23:48:17.732Z' report-watchlist-matched-webhook-body: value: data: type: event id: evt_fEG3T9cWCTwcyUhioYFkxeoV attributes: name: report/watchlist.matched payload: data: type: report/watchlist id: rep_3a89rYD7zSLd8sPMAa2Bh5B6 attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: false is-recurring: true tags: [] name-first: Jane name-middle: null name-last: Doe term: Jane Doe birthdate: null country-code: null matched-lists: - name: EU - EC - Programme PRK - North Korea url: 'https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017R1509&from=EN' list-type: sanction list-types: - sanction slug: eu-ec-programme-prk flag-code: EU entities: [] ignore-list: [] relationships: inquiry: data: type: inquiry id: inq_VVpTcAmqY1iHGYmB8gPrtNLf account: data: type: account id: act_mQFfJtWNAKkGy7DeQ1aCZ5CL transaction: data: null report-template: data: type: report-template/watchlist id: rptp_eKPgsbgE16U7irWYMwEWj9RV created-at: '2024-02-15T23:48:17.732Z' report-watchlist-dismissed-webhook-body: value: data: type: event id: evt_3EenGd9ZzeXLWBL11K5mnSBi attributes: name: report/watchlist.dismissed payload: data: type: report/watchlist id: rep_ovJKonLv97aSCLVUpsLBR75M attributes: status: ready created-at: '2024-02-15T23:48:11.000Z' completed-at: '2024-02-15T23:48:17.000Z' redacted-at: null report-template-version-name: v1 has-match: true is-continuous: true is-recurring: true tags: [] name-first: Jane name-middle: null name-last: Doe term: Jane Doe birthdate: null country-code: null matched-lists: - name: EU - EC - Programme PRK - North Korea url: 'https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017R1509&from=EN' list-type: sanction list-types: - sanction slug: eu-ec-programme-prk flag-code: EU entities: [] ignore-list: - ignored-at: '2024-02-16T10:00:00.000Z' run-history-completed-at: '2024-02-15T23:48:17.000Z' match: name: EU - EC - Programme PRK - North Korea url: 'https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017R1509&from=EN' list-type: sanction list-types: - sanction slug: eu-ec-programme-prk flag-code: EU entities: [] user: Jordan Lee ignore-reason: false positive relationships: inquiry: data: type: inquiry id: inq_mrAQrPasWWNefviwRZbPnvmk account: data: type: account id: act_XtfNKtxNBpPghwNRj7h3LiUU transaction: data: null report-template: data: type: report-template/watchlist id: rptp_QY18iAaeJaXDhhhuzEe6WEAW created-at: '2024-02-15T23:48:17.732Z' selfie-created-webhook-body: value: data: type: event id: evt_3KqH4xVnR2bPmYwL9sTgD7cE attributes: name: selfie.created payload: data: type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s attributes: status: initiated created-at: '2024-02-15T23:45:01.000Z' processed-at: null relationships: inquiry: data: type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c included: - type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-02-15T23:45:01.000Z' updated-at: '2024-02-15T23:45:01.000Z' started-at: '2024-02-15T23:45:01.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_selfie fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: - type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s created-at: '2024-02-15T23:45:01.100Z' selfie-submitted-webhook-body: value: data: type: event id: evt_5MpJ6zWoT4dRnZyN1vUiF9eG attributes: name: selfie.submitted payload: data: type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s attributes: status: submitted created-at: '2024-02-15T23:45:01.000Z' processed-at: null relationships: inquiry: data: type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c included: - type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-02-15T23:45:01.000Z' updated-at: '2024-02-15T23:45:02.000Z' started-at: '2024-02-15T23:45:01.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_selfie fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: - type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s created-at: '2024-02-15T23:45:02.500Z' selfie-processed-webhook-body: value: data: type: event id: evt_7NrL8bYqV6fToBzP3xWkH1gI attributes: name: selfie.processed payload: data: type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s attributes: status: processed created-at: '2024-02-15T23:45:01.000Z' processed-at: '2024-02-15T23:45:04.000Z' relationships: inquiry: data: type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c included: - type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-02-15T23:45:01.000Z' updated-at: '2024-02-15T23:45:04.000Z' started-at: '2024-02-15T23:45:01.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_selfie fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: - type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s created-at: '2024-02-15T23:45:04.100Z' selfie-errored-webhook-body: value: data: type: event id: evt_9PtM0dArX8hVqDcR5zYmJ3iK attributes: name: selfie.errored payload: data: type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s attributes: status: errored created-at: '2024-02-15T23:45:01.000Z' processed-at: '2024-02-15T23:45:04.000Z' relationships: inquiry: data: type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c included: - type: inquiry id: inq_7HmRpYxLn4Qw9NvTzKdBgF3c attributes: status: pending reference-id: null note: null behaviors: {} tags: [] creator: jane@doe.com reviewer-comment: null created-at: '2024-02-15T23:45:01.000Z' updated-at: '2024-02-15T23:45:04.000Z' started-at: '2024-02-15T23:45:01.000Z' expires-at: null completed-at: null failed-at: null marked-for-review-at: null decisioned-at: null expired-at: null redacted-at: null previous-step-name: start next-step-name: verification_selfie fields: {} relationships: account: data: type: account id: act_n2uq9eKMboaCQzu9ALWYcVdN template: data: null inquiry-template: data: type: inquiry-template id: itmpl_AbN9KvR4LmT2WqYxPdHsZgFc inquiry-template-version: data: type: inquiry-template-version id: itmplv_LqX3jYwK7HnRpZmCvBdF8RtA reviewer: data: {} reports: data: [] verifications: data: [] sessions: data: [] documents: data: [] selfies: data: - type: selfie/profile-and-center id: self_C8dHpYxLm3Rq7NwTzKvBgF2s created-at: '2024-02-15T23:45:04.100Z' transaction-created-webhook-body: value: data: type: event id: evt_7KqH4xVnR2bPmYwL9sTgD3cE attributes: name: transaction.created payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: order-490020245 fields: name_first: type: string value: Daniel name_middle: type: string value: null name_last: type: string value: Webster account_id: type: string value: null tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-15T23:48:17.732Z' relationships: reviewer: data: null transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] included: - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] created-at: '2024-02-15T23:48:17.732Z' transaction-status-updated-webhook-body: value: data: type: event id: evt_3KqH4xVnR2bPmYwL9sTgD3cE attributes: name: transaction.status-updated payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: approved reference-id: order-490020245 fields: name_first: type: string value: Daniel name_last: type: string value: Webster account_id: type: string value: act_9yGqWZ8jK4pN2dR7sVxL3bTm tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-16T09:12:04.118Z' relationships: reviewer: data: type: workflow-run id: wfr_3nK7pQ2sV9mXbYwL4tRcD6eH transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: - type: account id: act_9yGqWZ8jK4pN2dR7sVxL3bTm - type: report/watchlist id: rep_5mZ8kT3nQ7pXwYbL2vRcD9eH included: - type: workflow-run id: wfr_3nK7pQ2sV9mXbYwL4tRcD6eH attributes: status: completed created-at: '2024-02-16T09:11:58.004Z' completed-at: '2024-02-16T09:12:04.061Z' - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] - type: account id: act_9yGqWZ8jK4pN2dR7sVxL3bTm attributes: reference-id: customer-4821 account-type-name: Individual created-at: '2024-02-01T10:15:30.000Z' updated-at: '2024-02-16T09:12:04.000Z' redacted-at: null fields: {} tags: [] account-status: Approved - type: report/watchlist id: rep_5mZ8kT3nQ7pXwYbL2vRcD9eH attributes: status: ready created-at: '2024-02-16T09:11:59.412Z' completed-at: '2024-02-16T09:12:01.882Z' has-match: false created-at: '2024-02-16T09:12:04.118Z' transaction-updated-fields-webhook-body: value: data: type: event id: evt_9sTgD3cE7KqH4xVnR2bPmYwL attributes: name: transaction.updated-fields payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: order-490020245 fields: name_first: type: string value: Daniel name_last: type: string value: Webster account_id: type: string value: null tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-15T23:55:02.640Z' relationships: reviewer: data: null transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] included: - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] created-at: '2024-02-15T23:55:02.640Z' transaction-labeled-webhook-body: value: data: type: event id: evt_2bPmYwL9sTgD3cE7KqH4xVnR attributes: name: transaction.labeled payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: order-490020245 fields: name_first: type: string value: Daniel name_last: type: string value: Webster tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-15T23:48:17.732Z' relationships: reviewer: data: null transaction-label: data: type: transaction-label id: txnl_8GV2ULqZ5VHURTJtYjGjV8nU transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] included: - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] created-at: '2024-02-15T23:59:41.205Z' transaction-redacted-webhook-body: value: data: type: event id: evt_4xVnR2bPmYwL9sTgD3cE7KqH attributes: name: transaction.redacted payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: approved reference-id: order-490020245 fields: name_first: type: string value: null name_last: type: string value: null account_id: type: string value: null tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-03-01T12:00:00.000Z' relationships: reviewer: data: type: workflow-run id: wfr_3nK7pQ2sV9mXbYwL4tRcD6eH transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] included: - type: workflow-run id: wfr_3nK7pQ2sV9mXbYwL4tRcD6eH attributes: status: completed created-at: '2024-02-16T09:11:58.004Z' completed-at: '2024-02-16T09:12:04.061Z' - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] created-at: '2024-03-01T12:00:00.000Z' transaction-added-relation-webhook-body: value: data: type: event id: evt_5VHURTJtYjGjV8nU8GV2ULqZ attributes: name: transaction.added-relation payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: order-490020245 fields: name_first: type: string value: Jane name_last: type: string value: OConnor tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-15T23:48:17.732Z' relationships: reviewer: data: null transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: - type: account id: act_9yGqWZ8jK4pN2dR7sVxL3bTm context: relation-schema-key: txn_account target-account-id: act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: null created-at: '2024-02-15T23:50:33.089Z' transaction-removed-relation-webhook-body: value: data: type: event id: evt_8nU8GV2ULqZ5VHURTJtYjGjV attributes: name: transaction.removed-relation payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: created reference-id: order-490020245 fields: name_first: type: string value: Jane name_last: type: string value: OConnor tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-15T23:48:17.732Z' relationships: reviewer: data: null transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: [] context: relation-schema-key: txn_account target-account-id: act_9yGqWZ8jK4pN2dR7sVxL3bTm target-txn-id: null created-at: '2024-02-15T23:52:18.402Z' transaction-sentinel-session-processed-webhook-body: value: data: type: event id: evt_6kuj7RkZgdP26wUfNNK6Ze7q attributes: name: transaction.sentinel-session-processed payload: data: type: transaction id: txn_26wUfNNK6Ze7qkwyK6kuj7RkZgdP attributes: status: approved reference-id: order-490020245 fields: name_first: type: string value: Daniel name_last: type: string value: Webster account_id: type: string value: act_9yGqWZ8jK4pN2dR7sVxL3bTm tags: [] created-at: '2024-02-15T23:48:17.732Z' updated-at: '2024-02-16T09:12:04.118Z' relationships: reviewer: data: null transaction-label: data: null transaction-type: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt related-objects: data: - type: account id: act_9yGqWZ8jK4pN2dR7sVxL3bTm included: - type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2023-06-29T23:54:35.293Z' field-schemas: [] created-at: '2024-02-16T09:13:10.552Z' transaction-type-deleted-field-webhook-body: value: data: type: event id: evt_YjGjV8nU8GV2ULqZ5VHURTJt attributes: name: transaction-type.deleted-field payload: data: type: transaction-type id: txntp_N1687FCwgERcW3M88M5U4mAt attributes: name: Payment created-at: '2023-06-29T23:54:35.293Z' updated-at: '2024-02-20T17:03:55.118Z' field-schemas: [] created-at: '2024-02-20T17:03:55.118Z' verification-canceled-webhook-body: value: data: type: event id: evt_3kPa7VnRq2bMcYwL9sTgD3cE attributes: name: verification.canceled payload: data: type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: canceled created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:48:09.000Z' completed-at-ts: 1708040889 redacted-at: null country-code: US tags: [] checks: [] name-first: Jane name-middle: Marie name-last: Doe birthdate: '1995-09-08' phone-number: null email-address: jane@doe.com address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' normalized-address-street-1: 123 Main St normalized-address-street-2: null normalized-address-city: San Francisco normalized-address-subdivision: CA normalized-address-postal-code: '94111' identification-number: null document-number: null document-issuing-date: null document-expiry-date: null document-issuing-subdivision: null relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:48:17.732Z' verification-created-webhook-body: value: data: type: event id: evt_5wQbHmK4xTyNcZw9LpRgD7jF attributes: name: verification.created payload: data: type: verification/government-id id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: initiated created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: null submitted-at-ts: null completed-at: null completed-at-ts: null redacted-at: null country-code: null tags: [] checks: [] entity-confidence-reasons: [] entity-confidence-score: null front-photo-url: null back-photo-url: null photo-urls: null selfie-photo: null selfie-photo-url: null video-url: null id-class: null capture-method: null name-first: null name-middle: null name-last: null name-suffix: null native-name-first: null native-name-middle: null native-name-last: null native-name-title: null birthdate: null issuing-authority: null issuing-subdivision: null nationality: null document-number: null visa-status: null issue-date: null expiration-date: null designations: null birthplace: null endorsements: null height: null sex: null restrictions: null vehicle-class: null identification-number: null from-reusable-persona: false address-street-1: null address-street-2: null address-city: null address-subdivision: null address-postal-code: null relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:45:03.732Z' verification-escalated-webhook-body: value: data: type: event id: evt_8tRcJpL5yUxOdAwM0qSgE2hK attributes: name: verification.escalated payload: data: type: verification/government-id id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: passed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:47:01.000Z' completed-at-ts: 1708040821 redacted-at: null country-code: US tags: [] checks: - name: id_type_detection status: passed reasons: [] requirement: required metadata: {} - name: id_entity_detection status: passed reasons: [] requirement: required metadata: {} - name: id_expired_detection status: passed reasons: [] requirement: required metadata: {} entity-confidence-reasons: [] entity-confidence-score: 92.4 front-photo-url: 'https://files.withpersona.com/...' back-photo-url: 'https://files.withpersona.com/...' photo-urls: null selfie-photo: null selfie-photo-url: null video-url: null id-class: dl capture-method: api name-first: Jane name-middle: Marie name-last: Doe name-suffix: null native-name-first: null native-name-middle: null native-name-last: null native-name-title: null birthdate: '1995-09-08' issuing-authority: CA issuing-subdivision: CA nationality: US document-number: '123456' visa-status: null issue-date: '2018-01-15' expiration-date: '2028-09-08' designations: null birthplace: null endorsements: null height: null sex: F restrictions: null vehicle-class: C identification-number: B1234567 from-reusable-persona: false address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 accounts: data: [] document: data: type: document/government-id id: doc_AbcDefGhiJkLmNoPq12345 included: [] created-at: '2024-02-15T23:48:02.732Z' verification-failed-webhook-body: value: data: type: event id: evt_2nVaKqM6zVyPdBwN1rTgF4iL attributes: name: verification.failed payload: data: type: verification/government-id id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: failed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:48:09.000Z' completed-at-ts: 1708040889 redacted-at: null country-code: US tags: [] checks: - name: id_type_detection status: passed reasons: [] requirement: required metadata: {} - name: id_entity_detection status: failed reasons: - low_confidence_entity_match requirement: required metadata: {} - name: id_expired_detection status: not_applicable reasons: [] requirement: required metadata: {} entity-confidence-reasons: - low_confidence_entity_match entity-confidence-score: 42.5 front-photo-url: 'https://files.withpersona.com/...' back-photo-url: 'https://files.withpersona.com/...' photo-urls: null selfie-photo: null selfie-photo-url: null video-url: null id-class: dl capture-method: api name-first: Jane name-middle: Marie name-last: Doe name-suffix: null native-name-first: null native-name-middle: null native-name-last: null native-name-title: null birthdate: '1995-09-08' issuing-authority: CA issuing-subdivision: CA nationality: US document-number: '123456' visa-status: null issue-date: '2018-01-15' expiration-date: '2028-09-08' designations: null birthplace: null endorsements: null height: null sex: F restrictions: null vehicle-class: C identification-number: B1234567 from-reusable-persona: false address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 accounts: data: [] document: data: type: document/government-id id: doc_AbcDefGhiJkLmNoPq12345 included: [] created-at: '2024-02-15T23:48:17.732Z' verification-passed-webhook-body: value: data: type: event id: evt_4mUbLrN7aWzQeCxO2sUhG5jM attributes: name: verification.passed payload: data: type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: passed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:48:09.000Z' completed-at-ts: 1708040889 redacted-at: null country-code: US tags: [] checks: - name: database_name_comparison status: passed reasons: [] requirement: required metadata: {} - name: database_address_comparison status: passed reasons: [] requirement: required metadata: {} - name: database_birthdate_comparison status: passed reasons: [] requirement: required metadata: {} name-first: Jane name-middle: Marie name-last: Doe birthdate: '1995-09-08' phone-number: null email-address: jane@doe.com address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' normalized-address-street-1: 123 Main St normalized-address-street-2: null normalized-address-city: San Francisco normalized-address-subdivision: CA normalized-address-postal-code: '94111' identification-number: null document-number: null document-issuing-date: null document-expiry-date: null document-issuing-subdivision: null relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:48:17.732Z' verification-requires-retry-webhook-body: value: data: type: event id: evt_6sScMtP8bXAReDyP3tViH6kN attributes: name: verification.requires-retry payload: data: type: verification/selfie id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: requires_retry created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:48:09.000Z' completed-at-ts: 1708040889 redacted-at: null country-code: US tags: [] checks: - name: selfie_liveness_detection status: failed reasons: - low_liveness_confidence requirement: requires_retry metadata: {} - name: selfie_image_quality_detection status: not_applicable reasons: [] requirement: required metadata: {} - name: selfie_id_comparison status: not_applicable reasons: [] requirement: required metadata: {} capture-method: video center-photo-face-coordinates: null center-photo-url: 'https://files.withpersona.com/...' document-similarity-score: null entity-confidence-reasons: - low_liveness_confidence left-photo-url: 'https://files.withpersona.com/...' from-reusable-persona: false photo-urls: [] right-photo-url: 'https://files.withpersona.com/...' selfie-similarity-score-left: null selfie-similarity-score-right: null video-url: 'https://files.withpersona.com/...' relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/selfie id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/selfie id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:48:17.732Z' verification-skipped-webhook-body: value: data: type: event id: evt_7nTdNuQ9cYBSfEzQ4uWjI7lO attributes: name: verification.skipped payload: data: type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: skipped created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: null submitted-at-ts: null completed-at: '2024-02-15T23:45:10.000Z' completed-at-ts: 1708040710 redacted-at: null country-code: null tags: [] checks: [] name-first: null name-middle: null name-last: null birthdate: null phone-number: null email-address: null address-street-1: null address-street-2: null address-city: null address-subdivision: null address-postal-code: null normalized-address-street-1: null normalized-address-street-2: null normalized-address-city: null normalized-address-subdivision: null normalized-address-postal-code: null identification-number: null document-number: null document-issuing-date: null document-expiry-date: null document-issuing-subdivision: null relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:45:11.732Z' verification-submitted-webhook-body: value: data: type: event id: evt_9kUePvR0dZCTgFaR5vXkJ8mP attributes: name: verification.submitted payload: data: type: verification/government-id id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: submitted created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: null completed-at-ts: null redacted-at: null country-code: US tags: [] checks: [] entity-confidence-reasons: [] entity-confidence-score: null front-photo-url: 'https://files.withpersona.com/...' back-photo-url: 'https://files.withpersona.com/...' photo-urls: null selfie-photo: null selfie-photo-url: null video-url: null id-class: dl capture-method: api name-first: Jane name-middle: Marie name-last: Doe name-suffix: null native-name-first: null native-name-middle: null native-name-last: null native-name-title: null birthdate: '1995-09-08' issuing-authority: CA issuing-subdivision: CA nationality: US document-number: '123456' visa-status: null issue-date: '2018-01-15' expiration-date: '2028-09-08' designations: null birthplace: null endorsements: null height: null sex: F restrictions: null vehicle-class: C identification-number: B1234567 from-reusable-persona: false address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/government-id id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/government-id id: vtmplv_ABC123 accounts: data: [] document: data: type: document/government-id id: doc_AbcDefGhiJkLmNoPq12345 included: [] created-at: '2024-02-15T23:46:13.732Z' verification-tentatively-failed-webhook-body: value: data: type: event id: evt_1pVfQwS1eAEUhGbS6wYlK9nQ attributes: name: verification.tentatively-failed payload: data: type: verification/database-business id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: tentatively_failed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: null completed-at-ts: null redacted-at: null country-code: US tags: [] checks: - name: database_business_service_available_detection status: passed reasons: [] requirement: required metadata: {} - name: database_business_enabled_country_detection status: passed reasons: [] requirement: required metadata: {} - name: database_business_active_business_detection status: passed reasons: [] requirement: required metadata: {} - name: database_business_identity_comparison status: failed reasons: - low_confidence_match requirement: required metadata: {} - name: database_business_associated_persons_comparison status: not_applicable reasons: [] requirement: required metadata: {} business-name: 'Example Holdings, Inc.' registration-number: C1234567 address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: CA address-postal-code: '94111' address-country-code: US relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/database-business id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database-business id: vtmplv_ABC123 accounts: data: [] included: [] created-at: '2024-02-15T23:47:05.732Z' verification-tentatively-passed-webhook-body: value: data: type: event id: evt_3qWgRxT2fBFViHcT7xZmL0oR attributes: name: verification.tentatively-passed payload: data: type: verification/document id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: tentatively_passed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: null completed-at-ts: null redacted-at: null country-code: US tags: [] checks: - name: document_type_detection status: passed reasons: [] requirement: required metadata: {} - name: document_extracted_properties_detection status: passed reasons: [] requirement: required metadata: {} - name: document_expired_detection status: passed reasons: [] requirement: required metadata: {} - name: document_fabrication_detection status: passed reasons: [] requirement: required metadata: {} fields: {} files: - filename: document_front.jpg url: 'https://files.withpersona.com/...' byte-size: 102400 files-normalized: - filename: document_front_normalized.jpg url: 'https://files.withpersona.com/...' byte-size: 98304 extraction-responses: [] document-type: proof_of_residence relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/document id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/document id: vtmplv_ABC123 accounts: data: [] document: data: type: document/generic id: doc_AbcDefGhiJkLmNoPq12345 included: [] created-at: '2024-02-15T23:47:05.732Z' verification-updated-tags-webhook-body: value: data: type: event id: evt_5rXhSyU3gCGWjJdU8yAnM1pS attributes: name: verification.updated-tags payload: data: type: verification/database id: ver_uHDiwtcx3htjajvEaeMjPQcE attributes: status: passed created-at: '2024-02-15T23:45:01.000Z' created-at-ts: 1708040701 submitted-at: '2024-02-15T23:46:12.000Z' submitted-at-ts: 1708040772 completed-at: '2024-02-15T23:48:09.000Z' completed-at-ts: 1708040889 redacted-at: null country-code: US tags: - flagged_for_followup - manual_review_complete checks: - name: database_name_comparison status: passed reasons: [] requirement: required metadata: {} - name: database_address_comparison status: passed reasons: [] requirement: required metadata: {} name-first: Jane name-middle: Marie name-last: Doe birthdate: '1995-09-08' phone-number: null email-address: jane@doe.com address-street-1: 123 Main St address-street-2: null address-city: San Francisco address-subdivision: California address-postal-code: '94111' normalized-address-street-1: 123 Main St normalized-address-street-2: null normalized-address-city: San Francisco normalized-address-subdivision: CA normalized-address-postal-code: '94111' identification-number: null document-number: null document-issuing-date: null document-expiry-date: null document-issuing-subdivision: null relationships: inquiry: data: type: inquiry id: inq_zEx4jL84ShbUyuwX6AzPSqt6 template: data: null inquiry-template: data: type: inquiry-template id: itmpl_p8ANAJy9iqadm2buF2xcVgqH inquiry-template-version: data: type: inquiry-template-version id: itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo transaction: data: null verification-template: data: type: verification-template/database id: vtmpl_ABC123 verification-template-version: data: type: verification-template-version/database id: vtmplv_ABC123 accounts: data: [] included: [] context: added-tags: - manual_review_complete removed-tags: - flagged_for_followup created-at: '2024-02-16T15:12:47.732Z' workflow-run-created-webhook-body: value: data: type: event id: evt_62Ax9zhSjpkngkHWdgdETqLWGV8k attributes: name: workflow-run.created payload: data: type: workflow-run id: wfr_GVocwJmMpw6viz29eijVoc5rit7u attributes: status: in_progress created-at: '2025-09-10T20:42:28.032Z' completed-at: null relationships: creator: data: type: event id: evt_3VghhbvDc7UuUNT8uZrqZjsk workflow: data: type: workflow id: wfl_6DHtVFHizt77UZt8XX4yt9Hp workflow-version: data: type: workflow-version id: wfv_2mmawjLXMzWs91uz9oKhp4Wy meta: processing-time-seconds: null included: - type: workflow id: wfl_6DHtVFHizt77UZt8XX4yt9Hp attributes: name: KYC Review Workflow status: running created-at: '2023-11-01T12:00:00.000Z' relationships: latest-published-version: data: type: workflow-version id: wfv_2mmawjLXMzWs91uz9oKhp4Wy - type: workflow-version id: wfv_2mmawjLXMzWs91uz9oKhp4Wy attributes: description: Initial published version status: published created-at: '2023-11-01T12:05:00.000Z' relationships: workflow: data: type: workflow id: wfl_6DHtVFHizt77UZt8XX4yt9Hp - type: event id: evt_3VghhbvDc7UuUNT8uZrqZjsk attributes: name: inquiry.completed payload: data: type: inquiry id: inq_3VghhbvDc7UuUNT8uZrqZjsk attributes: {} relationships: {} created-at: '2025-09-10T20:42:27.500Z' context: {} created-at: '2025-09-10T20:42:28.100Z' context: {} workflow-run-errored-webhook-body: value: data: type: event id: evt_b9kfWbmzixpGLSo7qZmEaWFREWiL attributes: name: workflow-run.errored payload: data: type: workflow-run id: wfr_85ZjhktrgWeQx6FEb9sGfvyPNFWz attributes: status: errored created-at: '2025-11-15T13:32:31.172Z' completed-at: null relationships: creator: data: type: event id: evt_3VghhbvDc7UuUNT8uZrqZjsk workflow: data: type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa workflow-version: data: type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK meta: processing-time-seconds: null included: - type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa attributes: name: KYC Review Workflow status: running created-at: '2023-11-01T12:00:00.000Z' relationships: latest-published-version: data: type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK - type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK attributes: description: Initial published version status: published created-at: '2023-11-01T12:05:00.000Z' relationships: workflow: data: type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa - type: event id: evt_3VghhbvDc7UuUNT8uZrqZjsk attributes: name: inquiry.completed payload: data: type: inquiry id: inq_3VghhbvDc7UuUNT8uZrqZjsk attributes: {} relationships: {} created-at: '2025-11-15T13:32:30.500Z' context: {} created-at: '2025-11-15T13:32:35.000Z' context: {} workflow-run-resumed-webhook-body: value: data: type: event id: evt_9NuK6zXpT4dRoAyO1vUkF5eG attributes: name: workflow-run.resumed payload: data: type: workflow-run id: wfr_85ZjhktrgWeQx6FEb9sGfvyPNFWz attributes: status: in_progress created-at: '2025-11-15T13:32:31.172Z' completed-at: null relationships: creator: data: type: user id: user_3VghhbvDc7UuUNT8uZrqZjsk workflow: data: type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa workflow-version: data: type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK meta: processing-time-seconds: null included: - type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa attributes: name: KYC Review Workflow status: running created-at: '2023-11-01T12:00:00.000Z' relationships: latest-published-version: data: type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK - type: workflow-version id: wfv_744igEoBXwB7UG2eFt994aUEcziK attributes: description: Initial published version status: published created-at: '2023-11-01T12:05:00.000Z' relationships: workflow: data: type: workflow id: wfl_p6YpUH4NhqVf8n4ducnoPSVa - type: user id: user_3VghhbvDc7UuUNT8uZrqZjsk attributes: email-address: jane@example.com name-first: Jane name-last: Doe created-at: '2025-11-16T10:05:00.000Z' context: {} responses: bad-request: description: 'The request was unacceptable, often due to invalid parameters.' headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Bad Request: value: errors: - title: Bad Request details: data.attributes.type must be a string schema: properties: errors: type: array items: additionalProperties: false properties: title: description: Bad Request type: string details: type: string examples: - data.attributes.name is missing - data.type must be filled - meta.object_ids must be an array meta: type: object description: Additional metadata about the error additionalProperties: true type: object additionalProperties: false unauthorized: description: An invalid API key was provided. content: application/json: examples: Unauthorized: value: errors: - title: Must be authenticated to access this endpoint schema: properties: errors: type: array items: additionalProperties: false properties: title: description: Unauthorized examples: - Must be authenticated to access this endpoint - Token is invalid type: string type: object additionalProperties: false forbidden: description: The given API key doesn’t have permissions to perform the request or a quota has been exceeded. headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Forbidden: value: errors: - title: Forbidden details: IP address is not permitted access to current environment schema: properties: errors: type: array items: additionalProperties: false properties: title: description: Forbidden type: string details: type: string examples: - Resource cannot be created in an inactive environment - Verification creation API is not enabled - IP address is not permitted access to current environment meta: type: object description: Additional metadata about the error additionalProperties: true type: object additionalProperties: false not-found: description: The requested resource doesn’t exist. headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Not Found: value: errors: - title: Record not found schema: properties: errors: items: additionalProperties: false properties: title: examples: - Record not found type: string details: examples: - data.attributes.inquiry_id is not found type: string meta: type: object description: Additional metadata about the error additionalProperties: true type: object type: array type: object additionalProperties: false too-many-requests: description: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Too Many Requests: value: errors: - title: Rate limit exceeded details: You have hit your rate limit of 300 requests / min. Please reach out to support@withpersona.com if you need this changed. schema: properties: errors: type: array items: additionalProperties: false properties: title: type: string examples: - Rate limit exceeded - Quota exceeded details: type: string examples: - You have hit your rate limit of 300 requests / min. Please reach out to support@withpersona.com if you need this changed. - You have hit your create_verification quota limit of 300 requests. Please reach out to support@withpersona.com if you need this changed. type: object additionalProperties: false conflict: description: 'The request conflicts with another request, often due to attempting to create a duplicate resource.' headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Conflict: value: errors: - title: Conflict details: Resource already exists as an active resource schema: properties: errors: type: array items: additionalProperties: false properties: title: description: Conflict examples: - Conflict - Record not unique - Stale object error type: string details: type: string examples: - Name already exists as an active item in list - Inquiry already redacted - Record not unique - Attempted to update a record that was just modified. Please try again. - data.attributes.inquiry_id does not require verification/email-address meta: type: object description: Additional metadata about the error additionalProperties: true type: object additionalProperties: false unprocessable-entity: description: 'The request modifies the resource in an unacceptable way, often due to an invalid action or parameter.' headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Unprocessable Entity: value: errors: - title: Unprocessable entity details: Invalid confirmation code schema: properties: errors: type: array items: additionalProperties: false properties: title: type: string examples: - Unprocessable entity - Record invalid details: type: string examples: - File must be under 2 bytes - Selected country code invalid selected country code of ZX - Invalid confirmation code source: type: object additionalProperties: false properties: pointer: type: string examples: - /data/attributes/files - /data/attributes/selected-country-code type: object additionalProperties: false service-unavailable: description: Something went wrong on Persona’s end. These are rare. headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Service Unavailable: value: errors: - title: Service unavailable schema: properties: errors: type: array items: additionalProperties: false properties: title: description: Service unavailable type: string details: type: string type: object additionalProperties: false request-timeout: description: Something went wrong on Persona’s end. headers: RateLimit-Limit: $ref: '#/components/headers/rate-limit-limit' RateLimit-Remaining: $ref: '#/components/headers/rate-limit-remaining' RateLimit-Reset: $ref: '#/components/headers/rate-limit-reset' Request-Id: $ref: '#/components/headers/request-id' Persona-Environment-Id: $ref: '#/components/headers/persona-environment-id' Persona-Organization-Id: $ref: '#/components/headers/persona-organization-id' content: application/json: examples: Request Timeout: value: errors: - title: Request Timeout details: The server timed out waiting for the request schema: properties: errors: type: array items: type: object additionalProperties: false properties: title: description: Request Timeout type: string details: type: string examples: - The server timed out waiting for the request - Client did not produce a request within the time that the server was prepared to wait type: object additionalProperties: false success: description: 'Return a 2xx status code to indicate that the data was received successfully. Any other status will trigger retries. For more info see [Retry Logic](https://docs.withpersona.com/webhooks#retry-logic).' requestBodies: create-api-key-request: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Human-readable name of the API key. type: string note: description: Human readable context about the use of the API key. type: string api-version: description: API version that will be used for requests made with this API key. Defaults to the API version used when making this request. $ref: '#/components/schemas/api-version' api-key-inflection: description: Default API response key inflection. Default is kebab-case. type: string api-attributes-blocklist: description: Attributes blocked from API responses. items: type: string type: array ip-address-allowlist: description: IP addresses permitted for use by the API key. items: type: string type: array permissions: description: Abilities permitted to the API key. items: type: string type: array file-access-token-expires-in: description: 'How soon any file access tokens returned in API responses expire. For more info see [Downloading Files](https://docs.withpersona.com/downloading-files).' type: integer type: object additionalProperties: false required: - name type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data examples: Created: $ref: '#/components/examples/create-api-key' update-api-key-request: content: application/json: schema: properties: data: properties: attributes: properties: name: description: Human-readable name of the API key. type: string note: description: Human readable context about the use of the API key. type: string api-version: description: API version that will be used for requests made with this API key. Defaults to the API version used when making this request. $ref: '#/components/schemas/api-version' api-key-inflection: description: Default API response key inflection. Default is kebab-case. type: string api-attributes-blocklist: description: Attributes blocked from API responses. items: type: string type: array ip-address-allowlist: description: IP addresses permitted for use by the API key. items: type: string type: array permissions: description: Abilities permitted to the API key. items: type: string type: array file-access-token-expires-in: description: 'How soon any file access tokens returned in API responses expire. For more info see [Downloading Files](https://docs.withpersona.com/downloading-files).' type: integer type: object additionalProperties: false type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data examples: Success: $ref: '#/components/examples/create-api-key' list-item-importer-csv-request: content: multipart/form-data: schema: properties: data: properties: attributes: properties: file: type: string contentMediaType: application/octet-stream list-id: type: string required: - file - list-id type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false application/json: schema: properties: data: properties: attributes: properties: file: properties: data: description: Base64 encoded file format: binary type: string filename: description: Name of file type: string type: object additionalProperties: false list-id: type: string required: - file - list-id type: object additionalProperties: false required: - attributes type: object additionalProperties: false required: - data type: object additionalProperties: false inquiries-tag-request: content: application/json: schema: properties: meta: properties: tag-name: type: string examples: - apple - orange - banana tag-id: type: string additionalProperties: false type: object additionalProperties: false type: object examples: Success: $ref: '#/components/examples/set-tag' inquiries-review-request: content: application/json: schema: properties: meta: properties: comment: description: Unstructured comment for auditing purposes examples: - A comment about this inquiry type: string additionalProperties: false type: object additionalProperties: false type: object