> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # Generate a one-time link for an Inquiry POST https://api.withpersona.com/api/v1/inquiries/{inquiry-id}/generate-one-time-link Content-Type: application/json Creates a new inquiry session and returns `meta.one-time-link`. Reference: https://docs.withpersona.com/api-reference/inquiries/generate-a-one-time-link ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: '2025-12-08' version: 1.0.0 paths: /inquiries/{inquiry-id}/generate-one-time-link: post: operationId: generate-a-one-time-link summary: Generate a one-time link for an Inquiry description: Creates a new inquiry session and returns `meta.one-time-link`. tags: - subpackage_inquiries parameters: - name: inquiry-id in: path description: Inquiry ID (starts with "inq_") required: true schema: type: string - name: include in: query 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. required: false schema: type: string - name: fields in: query description: >- Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. required: false schema: type: object additionalProperties: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string - name: Key-Inflection in: header description: Determines casing for the API response. required: false schema: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostParametersKeyInflection - name: Idempotency-Key in: header description: Ensures the request is idempotent. required: false schema: type: string - name: Persona-Version in: header required: false schema: $ref: '#/components/schemas/api-version' responses: '200': description: >- This endpoint returns an Inquiry object and (optionally) its related objects in `included`. content: application/json: schema: $ref: >- #/components/schemas/Inquiries_generate-a-one-time-link_Response_200 '400': description: The request was unacceptable, often due to invalid parameters. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestBadRequestError '401': description: An invalid API key was provided. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestUnauthorizedError '403': description: >- The given API key doesn’t have permissions to perform the request or a quota has been exceeded. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestForbiddenError '404': description: The requested resource doesn’t exist. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestNotFoundError '409': description: >- The request conflicts with another request, often due to attempting to create a duplicate resource. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestConflictError '422': description: >- The request modifies the resource in an unacceptable way, often due to an invalid action or parameter. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestUnprocessableEntityError '429': description: >- Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. content: application/json: schema: $ref: >- #/components/schemas/Generate-a-one-time-linkRequestTooManyRequestsError requestBody: content: application/json: schema: type: object properties: meta: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostRequestBodyContentApplicationJsonSchemaMeta servers: - url: https://api.withpersona.com/api/v1 description: https://api.withpersona.com/api/v1 components: schemas: InquiriesInquiryIdGenerateOneTimeLinkPostParametersKeyInflection: type: string enum: - camel - kebab - snake title: InquiriesInquiryIdGenerateOneTimeLinkPostParametersKeyInflection api-version: type: string 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' description: >- Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). title: api-version InquiriesInquiryIdGenerateOneTimeLinkPostRequestBodyContentApplicationJsonSchemaMeta: type: object properties: expires-in-seconds: type: integer description: >- Number of seconds from now to expire the key (must be greater than 0). If not provided, the one-time link expiration setting from the inquiry template version will apply. Default expiry is 24 hours. title: >- InquiriesInquiryIdGenerateOneTimeLinkPostRequestBodyContentApplicationJsonSchemaMeta SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameFirst: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameFirst SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1 SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2 SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity: type: object properties: type: type: string value: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision: type: object properties: type: type: string value: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressPostalCode: type: object properties: type: type: string value: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressPostalCode SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode: type: object properties: type: type: string value: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate: type: object properties: type: type: string value: type: - string - 'null' description: Date of birth in YYYY-MM-DD format title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsIdentificationNumber: type: object properties: type: type: string value: type: - string - 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsIdentificationNumber SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFields: type: object properties: name-first: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameFirst name-middle: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle name-last: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast address-street-1: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1 address-street-2: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2 address-city: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressPostalCode description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. address-country-code: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode description: ISO 3166-1 alpha 2 country code. birthdate: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate email-address: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress phone-number: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber identification-number: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsIdentificationNumber 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. title: SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFields SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes: type: object properties: status: type: string 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. reference-id: type: - string - 'null' note: type: - string - 'null' behaviors: type: - object - 'null' additionalProperties: description: Any type 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. tags: type: array items: type: - string - 'null' creator: type: string reviewer-comment: type: - string - 'null' created-at: type: string format: date-time updated-at: type: string format: date-time started-at: type: - string - 'null' format: date-time expires-at: type: - string - 'null' format: date-time completed-at: type: - string - 'null' format: date-time failed-at: type: - string - 'null' format: date-time 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. marked-for-review-at: type: - string - 'null' format: date-time decisioned-at: type: - string - 'null' format: date-time expired-at: type: - string - 'null' format: date-time redacted-at: type: - string - 'null' format: date-time previous-step-name: type: - string - 'null' next-step-name: type: - string - 'null' fields: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFields 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. 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 title: SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData: type: object properties: id: type: string type: type: string enum: - account title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData - type: 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems: type: object properties: id: type: string type: type: string title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments: type: object properties: data: type: array items: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData: type: object properties: id: type: string type: type: string enum: - template title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData - type: 'null' description: Only present for Legacy 2.0 inquiries title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData: type: object properties: id: type: string type: type: string enum: - inquiry-template title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData - type: 'null' description: Only present for Dynamic Flow inquiries title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData: type: object properties: id: type: string type: type: string enum: - inquiry-template-version title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData - type: 'null' description: Only present for Dynamic Flow inquiries title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems: type: object properties: id: type: string type: type: string title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports: type: object properties: data: type: array items: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData: type: object properties: id: type: string type: type: string enum: - transaction title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData - type: 'null' title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewerData: type: object properties: id: type: string type: type: string description: One of `user`, `workflow`, or `workflow-run`. title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewerData SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewer: type: object properties: data: oneOf: - $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewerData - type: 'null' 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). title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewer SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems: type: object properties: id: type: string type: type: string title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies: type: object properties: data: type: array items: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems: type: object properties: id: type: string type: type: string enum: - inquiry-session title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions: type: object properties: data: type: array items: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems: type: object properties: id: type: string type: type: string title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications: type: object properties: data: type: array items: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems title: >- SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships: type: object properties: account: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount documents: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments template: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate description: Only present for Legacy 2.0 inquiries inquiry-template: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate description: Only present for Dynamic Flow inquiries inquiry-template-version: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion description: Only present for Dynamic Flow inquiries reports: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports transaction: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction reviewer: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewer 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). selfies: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies sessions: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions verifications: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications title: SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships inquiry: type: object properties: id: type: string attributes: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes relationships: $ref: >- #/components/schemas/SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships required: - id - attributes - relationships description: An Inquiry object title: inquiry VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueFirst: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueFirst VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueMiddle: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueMiddle VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueLast: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueLast VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValue: type: object properties: first: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueFirst middle: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueMiddle last: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValueLast title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValue VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsName: type: object properties: type: type: string value: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsNameValue title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsName VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet1: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet1 VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet2: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet2 VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueSubdivision: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueSubdivision VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCity: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCity VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValuePostalCode: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValuePostalCode VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCountryCode: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCountryCode VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValue: type: object properties: street_1: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet1 street_2: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueStreet2 subdivision: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueSubdivision city: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCity postal_code: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValuePostalCode country_code: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValueCountryCode title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValue VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddress: type: object properties: type: type: string value: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddressValue title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddress VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationClass: type: object properties: type: type: string value: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationClass VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationNumber: type: object properties: type: type: string value: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationNumber VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIssuingCountry: type: object properties: type: type: string value: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIssuingCountry VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueHashedIdentificationNumber: type: object properties: type: type: string value: type: - string - 'null' 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. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueHashedIdentificationNumber VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValue: type: object properties: identification_class: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationClass identification_number: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIdentificationNumber issuing_country: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueIssuingCountry hashed_identification_number: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValueHashedIdentificationNumber 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. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValue VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItems: type: object properties: type: type: string value: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItemsValue title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItems VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbers: type: object properties: type: type: string value: type: array items: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbersValueItems title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbers VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsBirthdate: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsBirthdate VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsPhoneNumber: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsPhoneNumber VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsEmailAddress: type: object properties: type: type: string value: type: - string - 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsEmailAddress File: type: object properties: filename: type: string url: type: string byte-size: type: integer title: File file: oneOf: - $ref: '#/components/schemas/File' - type: 'null' title: file VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsSelfiePhoto: type: object properties: type: type: string enum: - file value: $ref: '#/components/schemas/file' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsSelfiePhoto VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFields: type: object properties: name: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsName address: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddress identification_numbers: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbers birthdate: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsBirthdate phone_number: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsPhoneNumber email_address: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsEmailAddress selfie_photo: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsSelfiePhoto 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. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFields VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributes: type: object properties: reference-id: type: - string - 'null' account-type-name: type: string created-at: type: string format: date-time updated-at: type: string format: date-time redacted-at: type: - string - 'null' format: date-time fields: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFields 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. tags: type: array items: type: string account-status: type: string title: VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributes VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountTypeData: type: object properties: id: type: string type: type: string enum: - account-type title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountTypeData VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountType: type: object properties: data: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountTypeData title: >- VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountType VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationships: type: object properties: account-type: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountType title: VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationships ExtractionResponsesItemsResultsItemsMetadata: type: object properties: {} description: >- This is a free-form object containing potentially helpful metadata on the extraction result. title: ExtractionResponsesItemsResultsItemsMetadata ExtractionResponsesItemsResultsItems: type: object properties: value: type: string page: type: integer description: >- The page number the extraction result is detected. Page is 1-indexed. match-level: type: string 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. metadata: oneOf: - $ref: >- #/components/schemas/ExtractionResponsesItemsResultsItemsMetadata - type: 'null' description: >- This is a free-form object containing potentially helpful metadata on the extraction result. title: ExtractionResponsesItemsResultsItems ExtractionResponsesItems: type: object properties: extraction-type: type: string field-name: type: string structured-results: type: array items: type: object additionalProperties: description: Any type 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. results: type: array items: $ref: '#/components/schemas/ExtractionResponsesItemsResultsItems' description: >- A list of objects containing the actual value extracted and additional information relevant to the extraction result. title: ExtractionResponsesItems extraction-responses: type: - array - 'null' items: $ref: '#/components/schemas/ExtractionResponsesItems' description: >- A list of extractions resulting from processing the uploaded documents corresponding to the document's extraction configuration. title: extraction-responses VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributes: type: object 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. created-at: type: string format: date-time processed-at: type: - string - 'null' format: date-time processed-at-ts: type: - integer - 'null' kind: type: string files: type: array items: $ref: '#/components/schemas/file' description: The files uploaded to the document for processing. files-normalized: type: array items: $ref: '#/components/schemas/file' extraction-responses: $ref: '#/components/schemas/extraction-responses' document-type: type: - string - 'null' description: >- The classification of the document if detected. If unable to be detected, this will be other. fields: type: object additionalProperties: description: Any type description: >- JSON key-value pairs of field name to field value. Exact schema depends on the configuration of your template. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributes DocumentSharedRelationshipsInquiryData: type: object properties: id: type: string type: type: string enum: - inquiry title: DocumentSharedRelationshipsInquiryData DocumentSharedRelationshipsInquiry: type: object properties: data: oneOf: - $ref: '#/components/schemas/DocumentSharedRelationshipsInquiryData' - type: 'null' title: DocumentSharedRelationshipsInquiry DocumentSharedRelationshipsTemplateData: type: object properties: id: type: string type: type: string enum: - template title: DocumentSharedRelationshipsTemplateData DocumentSharedRelationshipsTemplate: type: object properties: data: oneOf: - $ref: '#/components/schemas/DocumentSharedRelationshipsTemplateData' - type: 'null' title: DocumentSharedRelationshipsTemplate DocumentSharedRelationshipsInquiryTemplateVersionData: type: object properties: id: type: string type: type: string enum: - inquiry-template-version title: DocumentSharedRelationshipsInquiryTemplateVersionData DocumentSharedRelationshipsInquiryTemplateVersion: type: object properties: data: oneOf: - $ref: >- #/components/schemas/DocumentSharedRelationshipsInquiryTemplateVersionData - type: 'null' title: DocumentSharedRelationshipsInquiryTemplateVersion DocumentSharedRelationshipsInquiryTemplateData: type: object properties: id: type: string type: type: string enum: - inquiry-template title: DocumentSharedRelationshipsInquiryTemplateData DocumentSharedRelationshipsInquiryTemplate: type: object properties: data: oneOf: - $ref: >- #/components/schemas/DocumentSharedRelationshipsInquiryTemplateData - type: 'null' title: DocumentSharedRelationshipsInquiryTemplate DocumentSharedRelationshipsTransactionData: type: object properties: type: type: string enum: - transaction id: type: string title: DocumentSharedRelationshipsTransactionData DocumentSharedRelationshipsTransaction: type: object properties: data: oneOf: - $ref: '#/components/schemas/DocumentSharedRelationshipsTransactionData' - type: 'null' title: DocumentSharedRelationshipsTransaction DocumentSharedRelationshipsDocumentFilesDataItems: type: object properties: id: type: string type: type: string enum: - document-file title: DocumentSharedRelationshipsDocumentFilesDataItems DocumentSharedRelationshipsDocumentFiles: type: object properties: data: type: array items: $ref: >- #/components/schemas/DocumentSharedRelationshipsDocumentFilesDataItems title: DocumentSharedRelationshipsDocumentFiles document-shared-relationships: type: object properties: inquiry: $ref: '#/components/schemas/DocumentSharedRelationshipsInquiry' template: $ref: '#/components/schemas/DocumentSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/DocumentSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/DocumentSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/DocumentSharedRelationshipsTransaction' document-files: $ref: '#/components/schemas/DocumentSharedRelationshipsDocumentFiles' title: document-shared-relationships VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGovernmentIdAttributes: type: object 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. created-at: type: string format: date-time processed-at: type: - string - 'null' format: date-time processed-at-ts: type: - integer - 'null' address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. front-photo: $ref: '#/components/schemas/file' back-photo: $ref: '#/components/schemas/file' selfie-photo: $ref: '#/components/schemas/file' id-class: type: - string - 'null' name-first: type: - string - 'null' description: Given or first name. name-middle: type: - string - 'null' description: Middle name. name-last: type: - string - 'null' description: Family or last name. name-suffix: type: - string - 'null' native-name-first: type: - string - 'null' description: Native script given or first name. native-name-middle: type: - string - 'null' description: Native script middle name. native-name-last: type: - string - 'null' description: Native script family or last name. native-name-title: type: - string - 'null' description: Native script name title or prefix. birthdate: type: - string - 'null' format: date 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: type: - string - 'null' format: date expiration-date: type: - string - 'null' format: date designations: type: - array - 'null' items: type: string 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' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGovernmentIdAttributes document-shared-attributes: type: object 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. created-at: type: string format: date-time processed-at: type: - string - 'null' format: date-time processed-at-ts: type: - integer - 'null' title: document-shared-attributes WorkflowRunIncludedObjectsItemsDiscriminatorMappingUserAttributes: type: object properties: email-address: type: string name-first: type: string name-last: type: string title: WorkflowRunIncludedObjectsItemsDiscriminatorMappingUserAttributes FieldSchemaArrayConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. item-schema: $ref: '#/components/schemas/field-schema' title: FieldSchemaArrayConfig FieldSchemaBooleanConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. title: FieldSchemaBooleanConfig FieldSchemaChoicesConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. allow-empty: type: boolean default: false options: type: array items: type: string option-labels: type: array items: type: string description: Display labels for each value in `options`, in the same order. title: FieldSchemaChoicesConfig FieldSchemaDateConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. min-date: type: - string - 'null' format: date max-date: type: - string - 'null' format: date title: FieldSchemaDateConfig FieldSchemaDatetimeConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. title: FieldSchemaDatetimeConfig FieldSchemaEmailAddressConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. title: FieldSchemaEmailAddressConfig FieldSchemaFileConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. max-file-size-bytes: type: integer default: 10000000 min-file-size-bytes: type: integer default: 1 supported-mime-types: type: array items: type: string page-count-limit-enabled: type: boolean default: false description: Whether the document page-count limits are enforced. page-count-min: type: - integer - 'null' description: Minimum allowed page count when `page-count-limit-enabled` is true. page-count-max: type: - integer - 'null' description: Maximum allowed page count when `page-count-limit-enabled` is true. title: FieldSchemaFileConfig FieldSchemaHashConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. ignore-unknown-keys: type: boolean default: false item-schemas: type: array items: $ref: '#/components/schemas/field-schema' title: FieldSchemaHashConfig FieldSchemaIntegerConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. min: type: number format: double max: type: number format: double title: FieldSchemaIntegerConfig FieldSchemaJsonConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. json-schema: type: object additionalProperties: description: Any type 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. title: FieldSchemaJsonConfig FieldSchemaMultiChoicesConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. allow-empty: type: boolean default: false options: type: array items: type: string option-labels: type: array items: type: string description: Display labels for each value in `options`, in the same order. title: FieldSchemaMultiChoicesConfig FieldSchemaNumberConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. min: type: number format: double max: type: number format: double title: FieldSchemaNumberConfig FieldSchemaStringConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. max-char-length: type: integer default: 255 sanitize: type: array items: type: string title: FieldSchemaStringConfig FieldSchemaRelationConfig: type: object properties: required: type: boolean archived-at: type: - string - 'null' format: date-time deactivated-at: type: - string - 'null' format: date-time source-key-path: type: - string - 'null' description: >- When the field schema is an alias, the dotted key path of the source field; absent for non-alias schemas. 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. target: type: string 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. title: FieldSchemaRelationConfig field-schema: oneOf: - type: object properties: type: type: string enum: - array key: type: string label: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaArrayConfig' required: - type description: array variant - type: object properties: type: type: string enum: - boolean key: type: string label: type: - string - 'null' default-value: type: - boolean - 'null' config: $ref: '#/components/schemas/FieldSchemaBooleanConfig' required: - type description: boolean variant - type: object properties: type: type: string enum: - choices key: type: string label: type: - string - 'null' default-value: type: - string - 'null' description: Must be one of the values in `config.options`, or null. config: $ref: '#/components/schemas/FieldSchemaChoicesConfig' required: - type description: choices variant - type: object properties: type: type: string enum: - date key: type: string label: type: - string - 'null' default-value: type: - string - 'null' format: date config: $ref: '#/components/schemas/FieldSchemaDateConfig' required: - type description: date variant - type: object properties: type: type: string enum: - datetime key: type: string label: type: - string - 'null' default-value: type: - string - 'null' format: date-time config: $ref: '#/components/schemas/FieldSchemaDatetimeConfig' required: - type description: datetime variant - type: object properties: type: type: string enum: - email-address key: type: string label: type: - string - 'null' default-value: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaEmailAddressConfig' required: - type description: email-address variant - type: object properties: type: type: string enum: - file key: type: string label: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaFileConfig' required: - type description: file variant - type: object properties: type: type: string enum: - hash key: type: string label: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaHashConfig' required: - type description: hash variant - type: object properties: type: type: string enum: - integer key: type: string label: type: - string - 'null' default-value: type: - integer - 'null' config: $ref: '#/components/schemas/FieldSchemaIntegerConfig' required: - type description: integer variant - type: object properties: type: type: string enum: - 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`). config: $ref: '#/components/schemas/FieldSchemaJsonConfig' required: - type description: json variant - type: object properties: type: type: string enum: - multi-choices key: type: string label: type: - string - 'null' default-value: type: - array - 'null' items: type: string description: Each entry must be one of the values in `config.options`. config: $ref: '#/components/schemas/FieldSchemaMultiChoicesConfig' required: - type description: multi-choices variant - type: object properties: type: type: string enum: - number key: type: string label: type: - string - 'null' default-value: type: - number - 'null' format: double config: $ref: '#/components/schemas/FieldSchemaNumberConfig' required: - type description: number variant - type: object properties: type: type: string enum: - string key: type: string label: type: - string - 'null' default-value: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaStringConfig' required: - type description: string variant - type: object properties: type: type: string enum: - relation-schema key: type: string label: type: - string - 'null' config: $ref: '#/components/schemas/FieldSchemaRelationConfig' required: - type description: relation-schema variant discriminator: propertyName: type title: field-schema VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateAttributes: type: object properties: name: type: string description: Name of the Inquiry Template 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. embedded-flow-domain-allowlist: type: array items: type: string description: List of domains allowed for embedded flows hosted-flow-subdomains: type: array items: type: string description: >- The subdomain that your hosted flow can be hosted on (e.g. "mycompany.withpersona.com") 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. field-schemas: type: array items: $ref: '#/components/schemas/field-schema' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateAttributes VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersionData: type: object properties: type: type: string enum: - inquiry-template-version id: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersionData VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersion: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersionData - type: 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersion VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationships: type: object properties: latest-published-version: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersion title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationships VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesTheme: 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' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesTheme VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributes: type: object properties: name-display: type: - string - 'null' status: type: string 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. enabled-locales: type: array items: type: string created-at: type: string format: date-time updated-at: type: - string - 'null' format: date-time published-at: type: - string - 'null' format: date-time theme: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesTheme title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributes VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplateData: type: object properties: type: type: string enum: - inquiry-template id: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplateData VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplate: type: object properties: data: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplateData title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplate VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationships: type: object properties: inquiry-template: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplate title: >- VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationships VerificationIncludedObjectsItemsDiscriminatorMappingTemplateAttributes: type: object properties: name: type: string title: VerificationIncludedObjectsItemsDiscriminatorMappingTemplateAttributes ReportDiscriminatorMappingReportAddressLookupAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report addressee: type: - string - 'null' description: The name of an individual at this location. address-street-1: type: - string - 'null' description: Address line 1 (e.g., street, PO Box, or company name). address-street-2: type: - string - 'null' description: Address line 2 (e.g., apartment, suite, unit, or building). address-city: type: - string - 'null' description: City address-subdivision: type: - string - 'null' description: Subnational division of a country, such as a state or province. address-postal-code: type: - string - 'null' description: ZIP or postal code. resolved-addressee: type: - string - 'null' resolved-address-street-1: type: - string - 'null' resolved-address-street-2: type: - string - 'null' resolved-address-city: type: - string - 'null' resolved-address-subdivision: type: - string - 'null' resolved-address-postal-code: type: - string - 'null' metadata-record-type: type: - string - 'null' metadata-zip-type: type: - string - 'null' metadata-county-fips: type: - string - 'null' metadata-county-name: type: - string - 'null' metadata-carrier-route: type: - string - 'null' metadata-carrier-route-type: type: - string - 'null' metadata-congressional-district: type: - string - 'null' metadata-building-default-indicator: type: - string - 'null' metadata-residential-delivery-indicator: type: - string - 'null' metadata-latitude: type: - number - 'null' format: double metadata-longitude: type: - number - 'null' format: double metadata-precision: type: - string - 'null' metadata-time-zone: type: - string - 'null' metadata-utc-offset: type: - integer - 'null' metadata-obeys-daylight-savings: type: - boolean - 'null' analysis-dpv-match-code: type: - string - 'null' analysis-dpv-match-code-decoded: type: - string - 'null' analysis-dpv-footnotes: type: - array - 'null' items: type: string analysis-dpv-footnotes-decoded: type: - array - 'null' items: type: string analysis-dpv-cmra: type: - string - 'null' analysis-dpv-vacant: type: - string - 'null' analysis-active: type: - string - 'null' 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' title: ReportDiscriminatorMappingReportAddressLookupAttributes ReportSharedRelationshipsInquiryData: type: object properties: id: type: string type: type: string enum: - inquiry title: ReportSharedRelationshipsInquiryData ReportSharedRelationshipsInquiry: type: object properties: data: oneOf: - $ref: '#/components/schemas/ReportSharedRelationshipsInquiryData' - type: 'null' description: The inquiry linked to the report title: ReportSharedRelationshipsInquiry ReportSharedRelationshipsAccountData: type: object properties: id: type: string type: type: string enum: - account title: ReportSharedRelationshipsAccountData ReportSharedRelationshipsAccount: type: object properties: data: oneOf: - $ref: '#/components/schemas/ReportSharedRelationshipsAccountData' - type: 'null' description: The account linked to the report title: ReportSharedRelationshipsAccount ReportSharedRelationshipsTransactionData: type: object properties: id: type: string type: type: string enum: - transaction title: ReportSharedRelationshipsTransactionData ReportSharedRelationshipsTransaction: type: object properties: data: oneOf: - $ref: '#/components/schemas/ReportSharedRelationshipsTransactionData' - type: 'null' description: The transaction linked to the report title: ReportSharedRelationshipsTransaction ReportSharedRelationshipsReportTemplateData: type: object properties: id: type: string type: type: string title: ReportSharedRelationshipsReportTemplateData ReportSharedRelationshipsReportTemplate: type: object properties: data: $ref: '#/components/schemas/ReportSharedRelationshipsReportTemplateData' description: The report template used to create this report title: ReportSharedRelationshipsReportTemplate report-shared-relationships: type: object properties: inquiry: $ref: '#/components/schemas/ReportSharedRelationshipsInquiry' description: The inquiry linked to the report account: $ref: '#/components/schemas/ReportSharedRelationshipsAccount' description: The account linked to the report transaction: $ref: '#/components/schemas/ReportSharedRelationshipsTransaction' description: The transaction linked to the report report-template: $ref: '#/components/schemas/ReportSharedRelationshipsReportTemplate' description: The report template used to create this report description: Other Persona objects related to the report title: report-shared-relationships ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsMediaItems: type: object properties: date: type: - string - 'null' format: date snippet: type: string description: Snippet from matched article url: type: string description: URL of matched article title: type: string description: Title of matched article title: >- ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsMediaItems ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsSourcesItems: type: object properties: country-codes: type: array items: type: string name: type: string types: type: array items: type: string title: >- ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsSourcesItems ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItems: type: object properties: akas: type: array items: type: - string - 'null' birthdates: type: array items: type: - string - 'null' match-types: type: array items: type: string media: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsMediaItems name: type: string sources: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsSourcesItems entity-id: type: string title: >- ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItems ReportDiscriminatorMappingReportAdverseMediaAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report name-first: type: - string - 'null' description: The input first name of the search individual name-middle: type: - string - 'null' description: The input middle name of the search individual name-last: type: - string - 'null' description: The input last name of the search individual term: type: string description: >- The input combined term used for searching (first + middle + last name) birthdate-year: type: - integer - 'null' birthdate: type: - string - 'null' description: The input DOB in YYYY-MM-DD format country-code: type: - string - 'null' description: The input search country in alpha2 format related-sources: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItems description: The sources that matched for the search ignore-list-media: type: object additionalProperties: description: Any type ignore-list-entity: type: array items: type: object additionalProperties: description: Any type title: ReportDiscriminatorMappingReportAdverseMediaAttributes ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsMediaItems: type: object properties: date: type: string format: date snippet: type: string description: Snippet from matched article url: type: string description: URL of matched article title: type: string description: Title of matched article title: >- ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsMediaItems ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsSourcesItems: type: object properties: country_codes: type: array items: type: string name: type: string token: type: string types: type: array items: type: string title: >- ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsSourcesItems ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItems: type: object properties: akas: type: array items: type: string birthdates: type: array items: type: - string - 'null' match_types: type: array items: type: string media: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsMediaItems name: type: string sources: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsSourcesItems id: type: string title: >- ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItems ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesQuery: type: object properties: business-name: type: string description: The name of the business being queried. address-street: type: string description: The street address of the business being queried. address-city: type: string description: The city in which the business is located. address-state: type: string description: >- Subnational division of a country (such as a state or province) where the business is located. address-country: type: string description: The country in which the business is located. incorporation-date: type: string format: date description: The date the business was incorporated. title: ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesQuery ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResultAdverseMediaItems: type: object properties: title: type: string description: The title of the media article. url: type: string format: uri description: The URL to the full media article. date: type: string format: date description: The publication date of the media article. title: >- ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResultAdverseMediaItems ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResult: type: object properties: adverse-media: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResultAdverseMediaItems description: A list of adverse media articles related to the business. title: ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResult ReportDiscriminatorMappingReportBusinessAdverseMediaAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report term: type: string description: >- The search term for the adverse media report, typically the name of the business. related-sources: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItems description: The sources that matched for the search query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesQuery result: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResult title: ReportDiscriminatorMappingReportBusinessAdverseMediaAttributes ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesQuery: type: object properties: address-country-code: type: string description: The country code used for the search required: - address-country-code title: ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesQuery ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsNamesItems: type: object properties: value: type: string description: The person's name required: - value title: >- ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsNamesItems ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsPositionsItems: type: object properties: value: type: string description: The position title required: - value title: >- ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsPositionsItems ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItems: type: object properties: names: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsNamesItems description: Names associated with the person positions: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsPositionsItems description: Positions held by the person required: - names - positions title: >- ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItems ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesQuery associated-persons: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItems description: List of persons associated with the business required: - query - associated-persons title: ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributes ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesQuery: type: object properties: address-country-code: type: string description: The country code used for the search required: - address-country-code title: >- ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesQuery ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsStatus: type: object properties: raw: type: string description: Status on the registry record standardized: type: string description: Normalized status value title: >- ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsStatus ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsAddressesItems: type: object 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 title: >- ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsAddressesItems ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItems: type: object properties: type: type: string description: The type of registry record 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: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsStatus registration-state: type: string description: State/subdivision where business is registered addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItemsAddressesItems title: >- ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItems ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResult: type: object 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 format: date description: The date the business was formed registry-records: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItems description: List of business registration records title: >- ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResult ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesQuery result: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResult required: - query - result title: ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributes ReportDiscriminatorMappingReportBusinessLookupAttributesQueryAssociatedPeopleItems: type: object properties: name-first: type: - string - 'null' name-last: type: - string - 'null' name-full: type: - string - 'null' titles: type: array items: type: - string - 'null' title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesQueryAssociatedPeopleItems ReportDiscriminatorMappingReportBusinessLookupAttributesQuery: type: object properties: business-name: type: string phone-number: type: - string - 'null' website: type: - string - 'null' ein: type: - string - 'null' address-street-1: type: string address-street-2: type: - string - 'null' address-city: type: string address-subdivision: type: string description: Subnational division of a country such as a US state. address-postal-code: type: string address-country-code: type: - string - 'null' incorporation-state: type: - string - 'null' associated-people: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesQueryAssociatedPeopleItems title: ReportDiscriminatorMappingReportBusinessLookupAttributesQuery ReportDiscriminatorMappingReportBusinessLookupAttributesResultDateOfIncorporation: type: object properties: granularity: type: string day: type: - string - 'null' month: type: - string - 'null' year: type: - string - 'null' title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultDateOfIncorporation ReportDiscriminatorMappingReportBusinessLookupAttributesResultIndustryClassificationsItems: type: object properties: code: type: string title: type: string type: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultIndustryClassificationsItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItemsAddressesItems: type: object properties: street-1: type: string street-2: type: - string - 'null' city: type: string subdivision: type: string postal-code: type: string 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 title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItemsAddressesItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItems: type: object properties: state: type: string country: type: string issue-date: type: string format: date file-number: type: string type: type: string addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItemsAddressesItems status: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultAddressesItems: type: object properties: street-1: type: string street-2: type: - string - 'null' city: type: string subdivision: type: string postal-code: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultAddressesItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultAgentsItems: type: object properties: name-full: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultAgentsItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultOfficersItems: type: object properties: name-full: type: string name-first: type: - string - 'null' name-last: type: - string - 'null' titles: type: array items: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultOfficersItems ReportDiscriminatorMappingReportBusinessLookupAttributesResultSourcesItems: type: object properties: name: type: string title: >- ReportDiscriminatorMappingReportBusinessLookupAttributesResultSourcesItems ReportDiscriminatorMappingReportBusinessLookupAttributesResult: type: object properties: name: type: string aliases: type: array items: type: string description: type: - string - 'null' legal-status: type: - string - 'null' legal-entity-type: type: string date-of-incorporation: oneOf: - $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultDateOfIncorporation - type: 'null' industry-classifications: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultIndustryClassificationsItems identifiers: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItems addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultAddressesItems websites: type: array items: type: string phone-numbers: type: array items: type: string agents: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultAgentsItems officers: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultOfficersItems headcount: type: - string - 'null' sources: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResultSourcesItems title: ReportDiscriminatorMappingReportBusinessLookupAttributesResult ReportDiscriminatorMappingReportBusinessLookupAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesQuery result: oneOf: - $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributesResult - type: 'null' 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. title: ReportDiscriminatorMappingReportBusinessLookupAttributes ReportDiscriminatorMappingReportBusinessWatchlistAttributesSanctionListItems: type: object 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. title: >- ReportDiscriminatorMappingReportBusinessWatchlistAttributesSanctionListItems ReportDiscriminatorMappingReportBusinessWatchlistAttributesFitnessProbityListItems: type: object 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. title: >- ReportDiscriminatorMappingReportBusinessWatchlistAttributesFitnessProbityListItems ReportDiscriminatorMappingReportBusinessWatchlistAttributesWarningListItems: type: object 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. title: >- ReportDiscriminatorMappingReportBusinessWatchlistAttributesWarningListItems ReportDiscriminatorMappingReportBusinessWatchlistAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report matched-lists: type: array items: type: string description: A list of slugs identifying the lists on which matches were found. sanction-list: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessWatchlistAttributesSanctionListItems description: Detailed information about matches found on sanction lists. fitness-probity-list: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessWatchlistAttributesFitnessProbityListItems description: >- Detailed information about matches found on fitness and probity lists. warning-list: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessWatchlistAttributesWarningListItems description: Detailed information about matches found on warning lists. title: ReportDiscriminatorMappingReportBusinessWatchlistAttributes ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesQuery: type: object properties: crypto-address: type: string title: ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesQuery ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsBirthdatesItems: type: object properties: day: type: string year: type: string month: type: string granularity: type: string title: >- ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsBirthdatesItems ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsCryptoAddressesItems: type: object properties: type: type: string address: type: string title: >- ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsCryptoAddressesItems ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItems: type: object properties: name: type: string alias-type: type: string birthdates: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsBirthdatesItems crypto-addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItemsCryptoAddressesItems title: >- ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItems ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItems: type: object properties: name: type: string url: type: string list-type: type: string slug: type: string flag-code: type: string entities: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItems title: >- ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItems ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesQuery result: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItems title: ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributes ReportDiscriminatorMappingReportEmailAddressAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report email-address: type: string description: The input email address of the search 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) email-domain-reputation: type: - string - 'null' 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) email-last-seen-days: type: - integer - 'null' description: How many days it has been since the email was last seen (Deprecated) email-estimated-age-days: type: - integer - 'null' description: The estimated age of the email in days email-domain-age-days: type: - integer - 'null' description: The estimated age of the domain in days email-credentials-leaked: type: - boolean - 'null' description: >- Whether the email has ever been detected to have been leaked (Deprecated) email-credentials-leaked-recent: type: - boolean - 'null' description: Whether the email has been recently detected as leaked email-data-breached: type: - boolean - 'null' description: Whether the email was involved in a data breach (Deprecated) email-malicious-activity-detected: type: - boolean - 'null' description: >- Whether the email has ever been detected for suspected malicious activity (Deprecated) email-malicious-activity-detected-recent: type: - boolean - 'null' description: >- Whether the email has recently been detected for suspected malicious activity email-is-blocklisted: type: - boolean - 'null' description: Whether the email appears on blocklists (Deprecated) email-is-spam: type: - boolean - 'null' description: Whether the email is spam or a spam trap email-is-free-provider: type: - boolean - 'null' description: Whether the email was made with a free provider (Deprecated) email-is-disposable: type: - boolean - 'null' description: Whether the email is one that is disposable or temporary email-is-deliverable: type: - boolean - 'null' description: Whether the email is deliverable email-is-valid-mx: type: - boolean - 'null' description: Whether the domain has a valid MX record 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) email-is-spf-strict: type: - boolean - 'null' description: Whether there is a sufficiently strict SPF record (Deprecated) email-is-dmarc-enforced: type: - boolean - 'null' description: Whether DMARC is configured correctly and enforced (Deprecated) age-estimated-13-plus: type: - boolean - 'null' description: Whether email address user is 13 or older age-estimated-16-plus: type: - boolean - 'null' description: Whether email address user is 16 or older age-estimated-18-plus: type: - boolean - 'null' description: Whether email address user is 18 or older email-is-suspicious: type: - boolean - 'null' description: Whether the email is suspicious or risky email-domain-exists: type: - boolean - 'null' description: Whether the domain of the email exists email-domain: type: string description: The domain of the email title: ReportDiscriminatorMappingReportEmailAddressAttributes ReportDiscriminatorMappingReportPhoneNumberAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report phone-number: type: string description: The input phone number of the search 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' phone-city: type: - string - 'null' description: City associated with the phone number location. phone-subdivision: type: - string - 'null' description: State or region associated with the phone number location. phone-country-code: type: - string - 'null' description: >- ISO 3166-1 alpha-2 country code associated with the phone number location. phone-risk-level: type: - string - 'null' description: Assessment of the phone number's risk (low - high) 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 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. title: ReportDiscriminatorMappingReportPhoneNumberAttributes ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesQuery: type: object properties: name-first: type: - string - 'null' description: The input first name of the search individual name-middle: type: - string - 'null' description: The input middle name of the search individual name-last: type: - string - 'null' description: The input last name of the search individual term: type: string description: >- The input combined term used for searching (first + middle + last name). Either the name or the term fields are required. birthdate: type: string description: The input DOB in YYYY-MM-DD format country-code: type: - string - 'null' description: The input search country in alpha2 format title: ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesQuery ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsPositionsItems: type: object properties: pep-class: type: string source-key: type: string name: type: string topics: type: array items: type: string description: The applicable categories of the position. start-date: type: string description: The start date of the position. end-date: type: - string - 'null' description: The end date of the position. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsPositionsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAssociatesItems: type: object 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 description: The applicable categories of the associate. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAssociatesItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAffiliationsItems: type: object properties: source-key: type: string name: type: string title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAffiliationsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsRelatedUrlsItems: type: object properties: source-key: type: string name: type: string title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsRelatedUrlsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsSources: type: object properties: {} description: A map of the sources that matched by entity title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsSources ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItems: type: object properties: entity-id: type: string name: type: string birthdates: type: array items: type: string format: date death-dates: type: array items: type: - string - 'null' locations: type: array items: type: - string - 'null' country: type: string sex: type: - string - 'null' topics: type: array items: type: string description: The applicable categories of the PEP. positions: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsPositionsItems associates: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAssociatesItems affiliations: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAffiliationsItems related-urls: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsRelatedUrlsItems images: type: array items: type: - string - 'null' sources: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsSources description: A map of the sources that matched by entity match-types: type: array items: type: string pep-type: type: - string - 'null' title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchPositionsItems: type: object 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. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchPositionsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAssociatesItems: type: object properties: name: type: string description: The name of the associate. relationship: type: string description: The relationship of the associate to the individual. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAssociatesItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAffiliationsItems: type: object properties: source-key: type: string description: The source key of the affiliation. name: type: string description: The name of the affiliation. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAffiliationsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchRelatedUrlsItems: type: object properties: source-key: type: string description: The source key for the URL. name: type: string format: uri description: The URL related to the match. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchRelatedUrlsItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchSources: type: object 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. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchSources ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatch: type: object 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: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchPositionsItems associates: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAssociatesItems affiliations: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchAffiliationsItems related-urls: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchRelatedUrlsItems images: type: array items: type: string format: uri description: The URLs of images associated with the match. sources: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatchSources match-types: type: array items: type: string description: The types of matches found. pep-type: type: string description: The type of politically exposed person. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatch ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItems: type: object 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: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatch 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. title: >- ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItems ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesQuery result: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItems ignore-list: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItems title: ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributes ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsNamesItems: type: object properties: name-full: type: string name-first: type: string name-middle: type: string name-last: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsNamesItems ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsAddressesItems: type: object properties: country-code: type: string street-1: type: string street-2: type: string city: type: string postal-code: type: string longitude: type: number format: double latitude: type: number format: double subdivision: type: string date-first-seen: type: string date-last-seen: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsAddressesItems ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsDriversLicensesItems: type: object properties: number: type: string state: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsDriversLicensesItems ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItems: type: object properties: names: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsNamesItems birthdates: type: array items: type: string addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsAddressesItems 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: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsDriversLicensesItems title: ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItems ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsNamesItems: type: object properties: name-full: type: string name-first: type: string name-middle: type: string name-last: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsNamesItems ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsAddressesItems: type: object properties: country-code: type: string street-1: type: string street-2: type: string city: type: string postal-code: type: string longitude: type: number format: double latitude: type: number format: double subdivision: type: string date-first-seen: type: string date-last-seen: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsAddressesItems ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsDriversLicensesItems: type: object properties: number: type: string state: type: string title: >- ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsDriversLicensesItems ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItems: type: object properties: names: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsNamesItems birthdates: type: array items: type: string addresses: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsAddressesItems 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: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsDriversLicensesItems title: >- ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItems ReportDiscriminatorMappingReportProfileAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. birthdate: type: - string - 'null' format: date description: Birthdate, must be in the format "YYYY-MM-DD". social-security-number: type: - string - 'null' description: Full social security number. social-security-number-last-4: type: - string - 'null' description: Last 4 digits of social security number. address-street-1: type: - string - 'null' description: Primary street address. address-street-2: type: - string - 'null' description: Secondary street address (if any). address-city: type: - string - 'null' description: City of residence. address-subdivision: type: - string - 'null' description: State or subdivision of residence. address-subdivision-abbr: type: - string - 'null' description: State or subdivision abbreviation. address-postal-code: type: - string - 'null' description: ZIP or postal code. address-postal-code-abbr: type: - string - 'null' description: ZIP or postal code abbreviation (if applicable). phone-number: type: - string - 'null' description: Phone number. identity-records: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItems description: Detailed identity records which passed matching logic, if available. omitted-identity-records: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItems description: >- Detailed identity records which did not pass matching logic, if available. title: ReportDiscriminatorMappingReportProfileAttributes ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesQuery: type: object properties: name-first: type: - string - 'null' description: The input first name of the search individual name-middle: type: - string - 'null' description: The input middle name of the search individual name-last: type: - string - 'null' description: The input last name of the search individual address-city: type: - string - 'null' description: The locality of the search individual address-subdivision: type: - string - 'null' description: The subdivision of the search individual address-postal-code: type: - string - 'null' description: The postal code of the search individual address-street-1: type: - string - 'null' description: The street address of the search individual address-street-2: type: - string - 'null' description: The address line 2 of the search individual address-country-code: type: - string - 'null' description: The country code of the search individual email-address: type: - string - 'null' description: The email address of the search individual 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 title: ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesQuery ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEmailsItems: type: object properties: address: type: - string - 'null' type: type: - string - 'null' title: >- ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEmailsItems ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultLocation: type: object properties: locality: type: - string - 'null' region: type: - string - 'null' country: type: - string - 'null' continent: type: - string - 'null' street-address: type: - string - 'null' address-line-2: type: - string - 'null' postal-code: type: - string - 'null' title: >- ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultLocation ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEducationItems: type: object properties: start-date: type: - string - 'null' end-date: type: - string - 'null' school-name: type: - string - 'null' school-type: type: - string - 'null' title: >- ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEducationItems ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultExperienceItems: type: object properties: end-date: type: - string - 'null' start-date: type: - string - 'null' company-name: type: - string - 'null' title-name: type: - string - 'null' title: >- ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultExperienceItems ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultSocialMediaProfilesItems: type: object properties: network: type: string url: type: - string - 'null' username: type: - string - 'null' title: >- ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultSocialMediaProfilesItems ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResult: type: object properties: name: type: - string - 'null' birthdate: type: - string - 'null' description: Date of birth in YYYY-MM-DD format emails: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEmailsItems phone-numbers: type: - array - 'null' items: type: string location: oneOf: - $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultLocation - type: 'null' education: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEducationItems experience: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultExperienceItems social-media-profiles: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultSocialMediaProfilesItems title: ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResult ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: oneOf: - $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesQuery - type: 'null' result: oneOf: - $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResult - type: 'null' title: ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributes ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesQuery: type: object properties: birthdate: type: string format: date description: Birthdate, must be in the format "YYYY-MM-DD". name-first: type: string description: Given or first name. name-last: type: string description: Family or last name. address-street-1: type: string description: Street name of residence address. address-city: type: string description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: string description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: string description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. address-country-code: type: - string - 'null' description: Country code of residence address. social-security-number: type: string description: Social security number user-id: type: string description: Reference ID of applicant phone-number: type: - string - 'null' description: Phone number. email-address: type: - string - 'null' description: Email address. title: >- ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesQuery ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResultScoresItems: type: object properties: name: type: string score: type: integer version: type: string reason-codes: type: array items: type: string title: >- ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResultScoresItems ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResult: type: object properties: application-id: type: string customer-id: type: string environment: type: string notes: type: - string - 'null' scores: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResultScoresItems status: type: string transaction-id: type: string title: >- ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResult ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report query: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesQuery result: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResult title: ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributes ReportDiscriminatorMappingReportSocialMediaAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report name-first: type: - string - 'null' name-last: type: - string - 'null' birthdate: type: string description: Date of birth in YYYY-MM-DD format phone-number: type: - string - 'null' email-address: type: - string - 'null' address-city: type: - string - 'null' address-subdivision: type: - string - 'null' description: Sub-national subdivision such as a US state or a Canadian province linkedin-url: type: - string - 'null' linkedin-username: type: - string - 'null' linkedin-id: type: - string - 'null' facebook-url: type: - string - 'null' facebook-username: type: - string - 'null' facebook-id: type: - string - 'null' twitter-url: type: - string - 'null' twitter-username: type: - string - 'null' github-url: type: - string - 'null' github-username: type: - string - 'null' instagram-url: type: - string - 'null' instagram-username: type: - string - 'null' title: ReportDiscriminatorMappingReportSocialMediaAttributes ReportDiscriminatorMappingReportSyntheticAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report. has-match: type: boolean description: Indicates if the report matched. is-continuous: type: boolean description: Indicates if the report is recurring. is-recurring: type: boolean description: Whether or not this report is scheduled to run in the future tags: type: array items: type: string description: Tags associated with the report. sentilink-abuse-score: type: - integer - 'null' description: Sentilink abuse score. sentilink-first-party-synthetic-score: type: - integer - 'null' description: Sentilink first party synthetic score. sentilink-third-party-synthetic-score: type: - integer - 'null' description: Sentilink third party synthetic score. title: ReportDiscriminatorMappingReportSyntheticAttributes ReportWatchlistEntityBirthdatesItems: type: object properties: day: type: string year: type: string month: type: string granularity: type: string description: Precision the birthday provided title: ReportWatchlistEntityBirthdatesItems report-watchlist-entity: type: object properties: name: type: string 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 items: $ref: '#/components/schemas/ReportWatchlistEntityBirthdatesItems' description: The birthdate of the entity description: A entity that matched from a Watchlist title: report-watchlist-entity ReportDiscriminatorMappingReportWatchlistAttributesMatchedListsItems: type: object properties: name: type: string url: type: string list-type: type: string list-types: type: array items: type: string slug: type: string flag-code: type: string entities: type: array items: $ref: '#/components/schemas/report-watchlist-entity' description: A matched person title: ReportDiscriminatorMappingReportWatchlistAttributesMatchedListsItems ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItemsBirthdatesItems: type: object properties: day: type: string year: type: string format: date month: type: string format: date-time granularity: type: string title: >- ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItemsBirthdatesItems ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItems: type: object properties: name: type: string alias-type: type: string birthdates: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItemsBirthdatesItems group-id: type: string title: >- ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItems ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatch: type: object properties: name: type: string url: type: string list-type: type: string list-types: type: array items: type: string slug: type: string flag-code: type: string entities: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatchEntitiesItems title: ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatch ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItems: type: object properties: ignored-at: type: string format: date-time run-history-completed-at: type: string format: date-time match: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatch user: type: string ignore-reason: type: string title: ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItems ReportDiscriminatorMappingReportWatchlistAttributes: 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 completed-at: type: - string - 'null' description: The time the report completed processing in ISO 8601 format redacted-at: type: - string - 'null' description: The time the report was redacted in ISO 8601 format report-template-version-name: type: string description: The name of the report template version used for this report 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 items: type: string description: Tags on the report name-first: type: - string - 'null' description: The input first name of the search individual name-middle: type: - string - 'null' description: The input middle name of the search individual name-last: type: - string - 'null' description: The input last name of the search individual term: type: - string - 'null' description: >- The input combined term used for searching (first + middle + last name) birthdate: type: - string - 'null' description: The input DOB in YYYY-MM-DD format country-code: type: - string - 'null' description: The input search country in alpha2 format matched-lists: type: - array - 'null' items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributesMatchedListsItems description: Lists that matched from the search input ignore-list: type: array items: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItems title: ReportDiscriminatorMappingReportWatchlistAttributes InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesAttributes: type: object 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. created-at: type: string format: date-time processed-at: type: - string - 'null' format: date-time description: >- Timestamp when the Selfie finished processing. `null` until the Selfie reaches the `processed` or `errored` status. title: >- InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesAttributes InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiryData: type: object properties: id: type: string type: type: string enum: - inquiry title: >- InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiryData InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiry: type: object properties: data: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiryData title: >- InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiry InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationships: type: object properties: inquiry: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationshipsInquiry title: >- InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationships InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes: type: object properties: status: type: string 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. created-at: type: string format: date-time started-at: type: - string - 'null' format: date-time expired-at: type: - string - 'null' format: date-time ip-address: type: - string - 'null' user-agent: type: - string - 'null' os-name: type: - string - 'null' os-full-version: type: - string - 'null' device-type: type: - string - 'null' device-name: type: - string - 'null' browser-name: type: - string - 'null' browser-full-version: type: - string - 'null' mobile-sdk-name: type: - string - 'null' mobile-sdk-full-version: type: - string - 'null' device-handoff-method: type: - string - 'null' 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' country-code: type: - string - 'null' country-name: type: - string - 'null' region-code: type: - string - 'null' region-name: type: - string - 'null' latitude: type: - number - 'null' format: double longitude: type: - number - 'null' format: double gps-latitude: type: - number - 'null' format: double gps-longitude: type: - number - 'null' format: double gps-precision: type: - string - 'null' ip-connection-type: type: - string - 'null' ip-isp: type: - string - 'null' network-organization: type: - string - 'null' title: InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData: type: object properties: type: type: string enum: - inquiry id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry: type: object properties: data: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData: type: object properties: type: type: string enum: - device id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice: type: object properties: data: oneOf: - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData - type: 'null' title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData: type: object properties: type: type: string enum: - network id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork: type: object properties: data: oneOf: - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData - type: 'null' title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships: type: object properties: inquiry: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry device: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice network: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork title: >- InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships VerificationIncludedObjectsItemsDiscriminatorMappingTransactionAttributes: type: object properties: status: type: string reference-id: type: - string - 'null' fields: type: object additionalProperties: description: Any type 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. tags: type: array items: type: string created-at: type: string format: date-time updated-at: type: - string - 'null' format: date-time title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionAttributes VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewerData: type: object properties: type: type: string id: type: string title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewerData VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewer: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewerData - type: 'null' description: The entity that reviewed the transaction title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewer VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabelData: type: object properties: type: type: string enum: - transaction-label id: type: string description: Unique identifier for this Transaction Label. Starts with `txnl_`. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabelData VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabel: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabelData - type: 'null' title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabel VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionTypeData: type: object properties: type: type: string enum: - transaction-type id: type: string description: Unique identifier for this Transaction Type. Starts with `txntp_`. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionTypeData VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionType: type: object properties: data: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionTypeData title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionType VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjectsDataItems: type: object properties: type: type: string id: type: string description: Unique identifier for this object. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjectsDataItems VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjects: type: object properties: data: type: array items: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjectsDataItems description: >- Objects involved in this Transaction's related Workflow runs. Will include a maximum of 100 related objects. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjects VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationships: type: object properties: reviewer: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewer description: The entity that reviewed the transaction transaction-label: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabel transaction-type: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionType related-objects: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjects description: >- Objects involved in this Transaction's related Workflow runs. Will include a maximum of 100 related objects. title: >- VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationships VerificationSharedAttributesChecksItems: type: object properties: name: type: string status: type: string 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. reasons: type: array items: type: - string - 'null' description: >- If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. 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: type: object additionalProperties: description: Any type description: >- This is a free-form object containing relevant metadata to the processing and result of the check. title: VerificationSharedAttributesChecksItems VerificationDiscriminatorMappingVerificationAamvaAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. birthdate: type: string format: date description: Birthdate, must be in the format "YYYY-MM-DD". issue-date: type: string format: date expiration-date: type: string format: date address-postal-code: type: string issuing-authority: type: string identification-number: type: string title: VerificationDiscriminatorMappingVerificationAamvaAttributes VerificationSharedRelationshipsInquiryData: type: object properties: id: type: string type: type: string enum: - inquiry title: VerificationSharedRelationshipsInquiryData VerificationSharedRelationshipsInquiry: type: object properties: data: oneOf: - $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryData' - type: 'null' description: The inquiry linked to the verification title: VerificationSharedRelationshipsInquiry VerificationSharedRelationshipsTemplateData: type: object properties: type: type: string enum: - template id: type: string title: VerificationSharedRelationshipsTemplateData VerificationSharedRelationshipsTemplate: type: object properties: data: oneOf: - $ref: '#/components/schemas/VerificationSharedRelationshipsTemplateData' - type: 'null' title: VerificationSharedRelationshipsTemplate VerificationSharedRelationshipsInquiryTemplateVersionData: type: object properties: type: type: string enum: - inquiry-template-version id: type: string title: VerificationSharedRelationshipsInquiryTemplateVersionData VerificationSharedRelationshipsInquiryTemplateVersion: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersionData - type: 'null' title: VerificationSharedRelationshipsInquiryTemplateVersion VerificationSharedRelationshipsInquiryTemplateData: type: object properties: type: type: string enum: - inquiry-template id: type: string title: VerificationSharedRelationshipsInquiryTemplateData VerificationSharedRelationshipsInquiryTemplate: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateData - type: 'null' title: VerificationSharedRelationshipsInquiryTemplate VerificationSharedRelationshipsTransactionData: type: object properties: type: type: string enum: - transaction id: type: string title: VerificationSharedRelationshipsTransactionData VerificationSharedRelationshipsTransaction: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationSharedRelationshipsTransactionData - type: 'null' title: VerificationSharedRelationshipsTransaction VerificationSharedRelationshipsVerificationTemplateData: type: object properties: type: type: string id: type: string title: VerificationSharedRelationshipsVerificationTemplateData VerificationSharedRelationshipsVerificationTemplate: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateData - type: 'null' title: VerificationSharedRelationshipsVerificationTemplate VerificationSharedRelationshipsVerificationTemplateVersionData: type: object properties: type: type: string id: type: string title: VerificationSharedRelationshipsVerificationTemplateVersionData VerificationSharedRelationshipsVerificationTemplateVersion: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersionData - type: 'null' title: VerificationSharedRelationshipsVerificationTemplateVersion VerificationSharedRelationshipsAccountsDataItems: type: object properties: id: type: string type: type: string enum: - account title: VerificationSharedRelationshipsAccountsDataItems VerificationSharedRelationshipsAccounts: type: object properties: data: type: array items: $ref: >- #/components/schemas/VerificationSharedRelationshipsAccountsDataItems title: VerificationSharedRelationshipsAccounts verification-shared-relationships: type: object properties: inquiry: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiry' description: The inquiry linked to the verification template: $ref: '#/components/schemas/VerificationSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/VerificationSharedRelationshipsTransaction' verification-template: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplate verification-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersion accounts: $ref: '#/components/schemas/VerificationSharedRelationshipsAccounts' title: verification-shared-relationships verification-shared-attributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' title: verification-shared-attributes VerificationDiscriminatorMappingVerificationBrandAssetAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' business-name: type: - string - 'null' description: Name of the business associated with the brand asset. business-website: type: - string - 'null' description: Website URL associated with the brand asset. title: VerificationDiscriminatorMappingVerificationBrandAssetAttributes VerificationDiscriminatorMappingVerificationBusinessWebsiteAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' website-url: type: - string - 'null' description: The website URL being verified. title: VerificationDiscriminatorMappingVerificationBusinessWebsiteAttributes VerificationDiscriminatorMappingVerificationCertificateKoreaAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. certificate-type: type: - string - 'null' description: The type of certificate used for verification. title: VerificationDiscriminatorMappingVerificationCertificateKoreaAttributes VerificationDiscriminatorMappingVerificationDatabaseAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. birthdate: type: - string - 'null' format: date description: Birthdate, must be in the format "YYYY-MM-DD". name-first: type: - string - 'null' description: Given or first name. name-middle: type: - string - 'null' description: Middle name. name-last: type: - string - 'null' description: Family or last name. phone-number: type: - string - 'null' description: Phone number. email-address: type: - string - 'null' description: Email address. normalized-address-street-1: type: - string - 'null' description: Normalized street name of residence address. normalized-address-street-2: type: - string - 'null' description: >- Normalized extension of residence address, usually apartment or suite number. normalized-address-city: type: - string - 'null' description: >- Normalized city of residence address. Not all international addresses use this attribute. normalized-address-subdivision: type: - string - 'null' description: >- Normalized state or subdivision of residence address. In the US, this should be the abbreviated name. Not all international addresses use this attribute. normalized-address-postal-code: type: - string - 'null' description: >- Normalized ZIP or postal code of residence address. Not all international addresses use this attribute. identification-number: type: - string - 'null' document-number: type: - string - 'null' document-issuing-date: type: - string - 'null' document-expiry-date: type: - string - 'null' document-issuing-subdivision: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationDatabaseAttributes VerificationDiscriminatorMappingVerificationDatabaseAadhaarAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. title: VerificationDiscriminatorMappingVerificationDatabaseAadhaarAttributes VerificationDiscriminatorMappingVerificationDatabaseBusinessAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' address-street-1: type: - string - 'null' description: Street name of business address. address-street-2: type: - string - 'null' description: Extension of business address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of business address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of business address. In the US, this should be the abbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. birthdate: type: - string - 'null' format: date description: Birthdate, must be in the format "YYYY-MM-DD". name-first: type: - string - 'null' description: Given or first name. name-middle: type: - string - 'null' description: Middle name. name-last: type: - string - 'null' description: Family or last name. phone-number: type: - string - 'null' description: Phone number. email-address: type: - string - 'null' description: Email address. business-name: type: string description: Name of the business registration-number: type: - string - 'null' description: Registration number of the business address-country-code: type: string description: Country code of the business address. title: VerificationDiscriminatorMappingVerificationDatabaseBusinessAttributes VerificationDiscriminatorMappingVerificationDatabaseEcbsvAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: First name of the individual. name-last: type: - string - 'null' description: Last name of the individual. birthdate: type: - string - 'null' format: date description: Birthdate of the individual email-address: type: - string - 'null' description: Email address of the individual. identification-number: type: - string - 'null' description: Social Security Number of the individual. signature-timestamp: type: - string - 'null' format: date-time description: Timestamp of the signature signature-ip: type: - string - 'null' description: IP address of the individual title: VerificationDiscriminatorMappingVerificationDatabaseEcbsvAttributes VerificationDiscriminatorMappingVerificationDatabasePhoneCarrierAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. birthdate: type: - string - 'null' format: date description: Birthdate in the format "YYYY-MM-DD". phone-number: type: - string - 'null' description: Phone number. title: >- VerificationDiscriminatorMappingVerificationDatabasePhoneCarrierAttributes VerificationDiscriminatorMappingVerificationDatabaseSerproAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' birthdate: type: - string - 'null' format: date description: Birthdate of the individual. cpf: type: string description: The Cadastro de Pessoas Físicas for the individual. name-first: type: string description: First name of the individual. name-full: type: string description: Full name of the individual. name-last: type: string description: Last name of the individual. title: VerificationDiscriminatorMappingVerificationDatabaseSerproAttributes VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfieData: type: object properties: id: type: string type: 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. title: >- VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfieData VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfie: type: object properties: data: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfieData - type: 'null' description: The selfie linked to the Verification title: >- VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfie VerificationDiscriminatorMappingVerificationDatabaseSerproRelationships: type: object properties: inquiry: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiry' description: The inquiry linked to the verification template: $ref: '#/components/schemas/VerificationSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/VerificationSharedRelationshipsTransaction' verification-template: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplate verification-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersion accounts: $ref: '#/components/schemas/VerificationSharedRelationshipsAccounts' selfie: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfie description: The selfie linked to the Verification title: VerificationDiscriminatorMappingVerificationDatabaseSerproRelationships VerificationDiscriminatorMappingVerificationDatabaseStandardAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. birthdate: type: - string - 'null' format: date description: Birthdate, must be in the format "YYYY-MM-DD". name-first: type: - string - 'null' description: Given or first name. name-middle: type: - string - 'null' description: Middle name. name-last: type: - string - 'null' description: Family or last name. phone-number: type: - string - 'null' description: Phone number. email-address: type: - string - 'null' description: Email address. normalized-address-city: type: string normalized-address-postal-code: type: string normalized-address-street-1: type: string normalized-address-street-2: type: string normalized-address-subdivision: type: string title: VerificationDiscriminatorMappingVerificationDatabaseStandardAttributes VerificationDiscriminatorMappingVerificationDatabaseTinAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' tin: type: string tin-type: type: - string - 'null' name-first: type: - string - 'null' name-last: type: - string - 'null' name-business: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationDatabaseTinAttributes VerificationDiscriminatorMappingVerificationDatabaseVatNumberAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' vat-number: type: - string - 'null' description: The VAT number being verified. business-name: type: - string - 'null' description: Name of the business as supplied for verification. address-street-1: type: - string - 'null' description: Street name of business address. address-street-2: type: - string - 'null' description: Extension of business address. address-city: type: - string - 'null' address-subdivision: type: - string - 'null' address-postal-code: type: - string - 'null' registered-business-name: type: - string - 'null' description: Business name as returned by the registered VAT record. 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' title: VerificationDiscriminatorMappingVerificationDatabaseVatNumberAttributes VerificationDiscriminatorMappingVerificationDigitalIdEDoAppAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: VerificationDiscriminatorMappingVerificationDigitalIdEDoAppAttributes VerificationDiscriminatorMappingVerificationDigitalIdFinnishTrustNetworkAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: >- VerificationDiscriminatorMappingVerificationDigitalIdFinnishTrustNetworkAttributes VerificationDiscriminatorMappingVerificationDigitalIdFranceIdentiteAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: >- VerificationDiscriminatorMappingVerificationDigitalIdFranceIdentiteAttributes VerificationDiscriminatorMappingVerificationDigitalIdGenericAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. selected-country-code: type: - string - 'null' description: The country selected by the end user for verification. selected-digital-id-type: type: - string - 'null' description: The digital ID type selected by the end user. title: VerificationDiscriminatorMappingVerificationDigitalIdGenericAttributes VerificationDiscriminatorMappingVerificationDigitalIdIdinAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: VerificationDiscriminatorMappingVerificationDigitalIdIdinAttributes VerificationDiscriminatorMappingVerificationDigitalIdItsMeAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' 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: type: - string - 'null' description: Registered address as returned by itsme. 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: type: - string - 'null' description: Encoded portrait image returned by the provider. language: type: - string - 'null' nationality: type: - string - 'null' phone: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationDigitalIdItsMeAttributes VerificationDiscriminatorMappingVerificationDigitalIdKcbCreditCardAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-full: type: - string - 'null' description: Full name returned by the provider. birthdate: type: - string - 'null' format: date sex: type: - string - 'null' native-foreigner-code: type: - string - 'null' ci: type: - string - 'null' description: Connecting Information (Korean unique identifier). di: type: - string - 'null' description: Duplication Information (Korean per-service identifier). title: >- VerificationDiscriminatorMappingVerificationDigitalIdKcbCreditCardAttributes VerificationDiscriminatorMappingVerificationDigitalIdMitIdAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. level-of-assurance: type: - string - 'null' description: The level of assurance reported by MitID for this verification. title: VerificationDiscriminatorMappingVerificationDigitalIdMitIdAttributes VerificationDiscriminatorMappingVerificationDigitalIdOneIdAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: VerificationDiscriminatorMappingVerificationDigitalIdOneIdAttributes VerificationDiscriminatorMappingVerificationDigitalIdPhilsysAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' 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: type: - string - 'null' description: PhilSys Card Number. title: VerificationDiscriminatorMappingVerificationDigitalIdPhilsysAttributes VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributesQrCodeAttachment: type: object properties: {} description: QR code attachment returned by SERPRO, if present. title: >- VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributesQrCodeAttachment VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' qr-code-attachment: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributesQrCodeAttachment - type: 'null' description: QR code attachment returned by SERPRO, if present. selfie-compare-image-url: type: - string - 'null' description: URL of the selfie comparison image, if present. cpf: type: - string - 'null' description: Brazilian CPF identifier. 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' format: double title: VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributes VerificationDiscriminatorMappingVerificationDigitalIdSingpassAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' identity-number: type: - string - 'null' identity-coi: type: - string - 'null' description: Country of issue for the identity document. 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: type: - string - 'null' description: Pass type for foreign residents. 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' title: VerificationDiscriminatorMappingVerificationDigitalIdSingpassAttributes VerificationDiscriminatorMappingVerificationDigitalIdSwedishBankIdAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. identification-number: type: - string - 'null' birthdate: type: - string - 'null' format: date description: Birthdate in YYYY-MM-DD format. response-country: type: - string - 'null' description: ISO 3166-1 alpha 2 country code returned by the provider. response-status: type: - string - 'null' description: Provider-reported status of the verification. title: >- VerificationDiscriminatorMappingVerificationDigitalIdSwedishBankIdAttributes VerificationDiscriminatorMappingVerificationDigitalIdUkSharecodeAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' sharecode: type: - string - 'null' description: The UK share code used for verification. birthdate: type: - string - 'null' format: date name-full: type: - string - 'null' description: Full name returned by the provider. reference-number: type: - string - 'null' immigration-status: type: - string - 'null' valid-from-date: type: - string - 'null' format: date description: Date from which the immigration status is valid. valid-until-date: type: - string - 'null' format: date description: Date until which the immigration status is valid. title: >- VerificationDiscriminatorMappingVerificationDigitalIdUkSharecodeAttributes VerificationDiscriminatorMappingVerificationDocumentAttributesFields: type: object properties: {} description: JSON key-value pairs of field name to field value. title: VerificationDiscriminatorMappingVerificationDocumentAttributesFields VerificationDiscriminatorMappingVerificationDocumentAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' fields: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDocumentAttributesFields description: JSON key-value pairs of field name to field value. files: type: array items: $ref: '#/components/schemas/file' description: The files uploaded to the associated document for processing. files-normalized: type: array items: $ref: '#/components/schemas/file' extraction-responses: $ref: '#/components/schemas/extraction-responses' document-type: type: - string - 'null' description: Document classification assignment based on document content. title: VerificationDiscriminatorMappingVerificationDocumentAttributes VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocumentData: type: object properties: id: type: string type: type: string title: >- VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocumentData VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocument: type: object properties: data: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocumentData title: >- VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocument VerificationDiscriminatorMappingVerificationDocumentRelationships: type: object properties: inquiry: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiry' description: The inquiry linked to the verification template: $ref: '#/components/schemas/VerificationSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/VerificationSharedRelationshipsTransaction' verification-template: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplate verification-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersion accounts: $ref: '#/components/schemas/VerificationSharedRelationshipsAccounts' document: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDocumentRelationshipsDocument title: VerificationDiscriminatorMappingVerificationDocumentRelationships VerificationDiscriminatorMappingVerificationEmailAddressAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' email-address: type: - string - 'null' confirmation-code: type: string title: VerificationDiscriminatorMappingVerificationEmailAddressAttributes VerificationDiscriminatorMappingVerificationGovernmentIdAttributesPhotoUrlsItems: type: object properties: byte-size: type: integer default: 0 normalized-url: type: string original-urls: type: array items: type: string page: type: string url: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdAttributesPhotoUrlsItems VerificationDiscriminatorMappingVerificationGovernmentIdAttributesSelfiePhoto: type: object properties: byte-size: type: integer default: 0 url: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdAttributesSelfiePhoto VerificationDiscriminatorMappingVerificationGovernmentIdAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. entity-confidence-reasons: type: array items: type: string entity-confidence-score: type: - number - 'null' format: double default: 0 front-photo-url: type: - string - 'null' back-photo-url: type: - string - 'null' photo-urls: type: - array - 'null' items: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdAttributesPhotoUrlsItems selfie-photo: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdAttributesSelfiePhoto - type: 'null' selfie-photo-url: type: - string - 'null' video-url: type: - string - 'null' id-class: type: - string - 'null' capture-method: type: - string - 'null' name-first: type: - string - 'null' name-middle: type: - string - 'null' name-last: type: - string - 'null' name-suffix: type: - string - 'null' native-name-first: type: - string - 'null' description: Native script given or first name. native-name-middle: type: - string - 'null' description: Native script middle name. native-name-last: type: - string - 'null' description: Native script family or last name. native-name-title: type: - string - 'null' description: Native script name title or prefix. birthdate: 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: type: - string - 'null' expiration-date: type: - string - 'null' designations: type: - array - 'null' items: description: Any type birthplace: type: - string - 'null' endorsements: type: - string - 'null' height: type: - string - 'null' sex: type: - string - 'null' restrictions: type: - string - 'null' vehicle-class: type: - string - 'null' identification-number: type: - string - 'null' from-reusable-persona: type: boolean title: VerificationDiscriminatorMappingVerificationGovernmentIdAttributes VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocumentData: type: object properties: id: type: string type: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocumentData VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocument: type: object properties: data: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocumentData title: >- VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocument VerificationDiscriminatorMappingVerificationGovernmentIdRelationships: type: object properties: inquiry: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiry' description: The inquiry linked to the verification template: $ref: '#/components/schemas/VerificationSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/VerificationSharedRelationshipsTransaction' verification-template: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplate verification-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersion accounts: $ref: '#/components/schemas/VerificationSharedRelationshipsAccounts' document: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocument title: VerificationDiscriminatorMappingVerificationGovernmentIdRelationships VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesChecksItems: type: object properties: metadata: type: object additionalProperties: description: Any type name: type: string reasons: type: array items: type: string status: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesChecksItems VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesSelfiePhoto: type: object properties: byte-size: type: integer default: 0 url: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesSelfiePhoto VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesChecksItems address-street-1: type: - string - 'null' description: Street name of residence address. address-street-2: type: - string - 'null' description: Extension of residence address, usually apartment or suite number. address-city: type: - string - 'null' description: >- City of residence address. Not all international addresses use this attribute. address-subdivision: type: - string - 'null' description: >- State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. address-postal-code: type: - string - 'null' description: >- ZIP or postal code of residence address. Not all international addresses use this attribute. birthdate: type: - string - 'null' expiration-date: type: - string - 'null' id-class: type: - string - 'null' identification-number: type: - string - 'null' name-first: type: string name-last: type: string selfie-photo: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributesSelfiePhoto - type: 'null' selfie-photo-url: type: - string - 'null' sex: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributes VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocumentData: type: object properties: id: type: string type: type: string title: >- VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocumentData VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocument: type: object properties: data: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocumentData title: >- VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocument VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationships: type: object properties: inquiry: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiry' description: The inquiry linked to the verification template: $ref: '#/components/schemas/VerificationSharedRelationshipsTemplate' inquiry-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsInquiryTemplateVersion inquiry-template: $ref: '#/components/schemas/VerificationSharedRelationshipsInquiryTemplate' transaction: $ref: '#/components/schemas/VerificationSharedRelationshipsTransaction' verification-template: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplate verification-template-version: $ref: >- #/components/schemas/VerificationSharedRelationshipsVerificationTemplateVersion accounts: $ref: '#/components/schemas/VerificationSharedRelationshipsAccounts' document: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationshipsDocument title: VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationships VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributesFaceImage: type: object properties: {} description: Face image extracted from the NFC card, when present. title: >- VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributesFaceImage VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' operation: type: - string - 'null' description: The operation performed against the NFC card. address: type: - string - 'null' birthdate: type: - string - 'null' format: date expiration-date: type: - string - 'null' format: date face-image: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributesFaceImage - type: 'null' description: Face image extracted from the NFC card, when present. gender: type: - string - 'null' kana-name: type: - string - 'null' license-number: type: - string - 'null' name-full: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributes VerificationDiscriminatorMappingVerificationMdocAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' name-first: type: - string - 'null' description: Given or first name. name-last: type: - string - 'null' description: Family or last name. title: VerificationDiscriminatorMappingVerificationMdocAttributes VerificationDiscriminatorMappingVerificationPhoneNumberAttributesMetadata: type: object properties: telesign-risk-score: type: integer title: >- VerificationDiscriminatorMappingVerificationPhoneNumberAttributesMetadata VerificationDiscriminatorMappingVerificationPhoneNumberAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' phone-number: type: string confirmation-code: type: string metadata: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationPhoneNumberAttributesMetadata title: VerificationDiscriminatorMappingVerificationPhoneNumberAttributes VerificationDiscriminatorMappingVerificationPhoneNumberSilentNetworkAuthenticationAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' phone-number: type: - string - 'null' description: The phone number being verified. code: type: - string - 'null' description: The verification code or token returned by the provider. title: >- VerificationDiscriminatorMappingVerificationPhoneNumberSilentNetworkAuthenticationAttributes VerificationDiscriminatorMappingVerificationQesInfocertAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' tentative-sub-state: type: - string - 'null' 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`. title: VerificationDiscriminatorMappingVerificationQesInfocertAttributes VerificationDiscriminatorMappingVerificationSelfieAttributesCenterPhotoFaceCoordinates: type: object properties: top-left: type: array items: type: number format: double top-right: type: array items: type: number format: double bottom-left: type: array items: type: number format: double bottom-right: type: array items: type: number format: double title: >- VerificationDiscriminatorMappingVerificationSelfieAttributesCenterPhotoFaceCoordinates VerificationDiscriminatorMappingVerificationSelfieAttributesPhotoUrlsItems: type: object properties: byte-size: type: integer default: 0 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: type: string title: >- VerificationDiscriminatorMappingVerificationSelfieAttributesPhotoUrlsItems VerificationDiscriminatorMappingVerificationSelfieAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' 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: oneOf: - $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationSelfieAttributesCenterPhotoFaceCoordinates - type: 'null' center-photo-url: type: - string - 'null' document-similarity-score: type: - number - 'null' format: double entity-confidence-reasons: type: array items: type: string left-photo-url: type: - string - 'null' from-reusable-persona: type: boolean photo-urls: type: array items: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationSelfieAttributesPhotoUrlsItems right-photo-url: type: - string - 'null' selfie-similarity-score-left: type: - number - 'null' format: double selfie-similarity-score-right: type: - number - 'null' format: double video-url: type: - string - 'null' title: VerificationDiscriminatorMappingVerificationSelfieAttributes VerificationDiscriminatorMappingVerificationVerifiableCredentialAttributes: 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 created-at-ts: type: integer description: The time the verification was created in Unix timestamp format submitted-at: type: - string - 'null' format: date-time description: The time the verification was submitted in ISO 8601 format submitted-at-ts: type: - integer - 'null' description: The time the verification was submitted in Unix timestamp format completed-at: type: - string - 'null' format: date-time description: The time the verification was completed in ISO 8601 format completed-at-ts: type: - integer - 'null' description: The time the verification was completed in Unix timestamp format redacted-at: type: - string - 'null' format: date-time description: The time the verification was redacted in ISO 8601 format country-code: type: - string - 'null' description: ISO 3166-1 alpha 2 country code. tags: type: array items: type: string description: Tags on the verification checks: type: array items: $ref: '#/components/schemas/VerificationSharedAttributesChecksItems' selected-credential-issuer: type: - string - 'null' description: The issuer of the credential selected for verification. selected-credential-types: type: - array - 'null' items: type: string description: The list of credential types of the selected credential. selected-credential-issuance-date: type: - string - 'null' format: date-time description: Issuance date of the selected credential. selected-credential-expiration-date: type: - string - 'null' format: date-time description: Expiration date of the selected credential. title: >- VerificationDiscriminatorMappingVerificationVerifiableCredentialAttributes WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowAttributes: type: object properties: status: type: string 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. name: type: string created-at: type: string format: date-time title: WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowAttributes WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersionData: type: object properties: type: type: string enum: - workflow-version id: type: string title: >- WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersionData WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersion: type: object properties: data: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersionData description: latest published version title: >- WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersion WorkflowDeploymentAttributesConfigurationVersionsItems: type: object properties: token: type: string description: The token of the workflow version percentage: type: integer description: The percentage of traffic this version should receive label: type: string description: The label of the version (treatment or control) title: WorkflowDeploymentAttributesConfigurationVersionsItems WorkflowDeploymentAttributesConfiguration: type: object properties: versions: type: array items: $ref: >- #/components/schemas/WorkflowDeploymentAttributesConfigurationVersionsItems description: The deployment configuration containing version information title: WorkflowDeploymentAttributesConfiguration WorkflowDeploymentAttributes: type: object properties: status: type: string 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. configuration: $ref: '#/components/schemas/WorkflowDeploymentAttributesConfiguration' description: The deployment configuration containing version information created-at: type: string format: date-time updated-at: type: string format: date-time title: WorkflowDeploymentAttributes workflow-deployment: type: object properties: type: type: string enum: - workflow-deployment id: type: string attributes: $ref: '#/components/schemas/WorkflowDeploymentAttributes' description: A Workflow Deployment object title: workflow-deployment WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsActiveDeployment: type: object properties: data: oneOf: - $ref: '#/components/schemas/workflow-deployment' - type: 'null' description: latest active deployment title: >- WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsActiveDeployment WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationships: type: object properties: latest-published-version: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersion description: latest published version active-deployment: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsActiveDeployment description: latest active deployment title: WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationships InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes: type: object properties: completed-at: type: - string - 'null' format: date-time created-at: type: string format: date-time status: type: string title: InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData0: type: object properties: type: type: string enum: - administrator id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData0 InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData1: type: object properties: type: type: string enum: - user id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData1 InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData2: type: object properties: type: type: string enum: - event id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData2 InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData: oneOf: - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData0 - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData1 - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData2 title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator: type: object properties: data: oneOf: - $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData - type: 'null' title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowData: type: object properties: type: type: string enum: - workflow id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowData InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow: type: object properties: data: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowData title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersionData: type: object properties: type: type: string enum: - workflow-version id: type: string title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersionData InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion: type: object properties: data: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersionData title: >- InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships: type: object properties: creator: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator workflow: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow workflow-version: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion title: InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta: type: object properties: processing-time-seconds: type: - number - 'null' format: double title: InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta InquiryIncludedObjectsItems: oneOf: - type: object properties: type: type: string enum: - account description: 'Discriminator value: account' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributes relationships: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationships required: - type description: account variant - type: object properties: type: type: string enum: - document/generic description: 'Discriminator value: document/generic' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributes relationships: $ref: '#/components/schemas/document-shared-relationships' required: - type description: document/generic variant - type: object properties: type: type: string enum: - document/government-id description: 'Discriminator value: document/government-id' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGovernmentIdAttributes relationships: $ref: '#/components/schemas/document-shared-relationships' required: - type description: document/government-id variant - type: object properties: type: type: string enum: - document/government-id-nfc description: 'Discriminator value: document/government-id-nfc' id: type: string attributes: $ref: '#/components/schemas/document-shared-attributes' relationships: $ref: '#/components/schemas/document-shared-relationships' required: - type description: document/government-id-nfc variant - type: object properties: type: type: string enum: - document/mdoc description: 'Discriminator value: document/mdoc' id: type: string attributes: $ref: '#/components/schemas/document-shared-attributes' relationships: $ref: '#/components/schemas/document-shared-relationships' required: - type description: document/mdoc variant - type: object properties: type: type: string enum: - user description: 'Discriminator value: user' id: type: string attributes: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingUserAttributes required: - type description: user variant - type: object properties: type: type: string enum: - inquiry-template description: 'Discriminator value: inquiry-template' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateAttributes relationships: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationships required: - type description: inquiry-template variant - type: object properties: type: type: string enum: - inquiry-template-version description: 'Discriminator value: inquiry-template-version' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributes relationships: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationships required: - type description: inquiry-template-version variant - type: object properties: type: type: string enum: - template description: 'Discriminator value: template' id: type: string attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTemplateAttributes required: - type description: template variant - type: object properties: type: type: string enum: - report/address-lookup description: 'Discriminator value: report/address-lookup' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportAddressLookupAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/address-lookup variant - type: object properties: type: type: string enum: - report/adverse-media description: 'Discriminator value: report/adverse-media' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportAdverseMediaAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/adverse-media variant - type: object properties: type: type: string enum: - report/business-adverse-media description: 'Discriminator value: report/business-adverse-media' id: type: string description: A unique identifier for the report. attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAdverseMediaAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes description: report/business-adverse-media variant - type: object properties: type: type: string enum: - report/business-associated-persons description: 'Discriminator value: report/business-associated-persons' id: type: string description: A unique identifier for the report. attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes description: report/business-associated-persons variant - type: object properties: type: type: string enum: - report/business-registrations-lookup description: 'Discriminator value: report/business-registrations-lookup' id: type: string description: A unique identifier for the report. attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type - id - attributes description: report/business-registrations-lookup variant - type: object properties: type: type: string enum: - report/business-lookup description: 'Discriminator value: report/business-lookup' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessLookupAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/business-lookup variant - type: object properties: type: type: string enum: - report/business-watchlist description: 'Discriminator value: report/business-watchlist' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportBusinessWatchlistAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/business-watchlist variant - type: object properties: type: type: string enum: - report/crypto-address-watchlist description: 'Discriminator value: report/crypto-address-watchlist' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/crypto-address-watchlist variant - type: object properties: type: type: string enum: - report/email-address description: 'Discriminator value: report/email-address' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportEmailAddressAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/email-address variant - type: object properties: type: type: string enum: - report/phone-number description: 'Discriminator value: report/phone-number' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPhoneNumberAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/phone-number variant - type: object properties: type: type: string enum: - report/politically-exposed-person description: 'Discriminator value: report/politically-exposed-person' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/politically-exposed-person variant - type: object properties: type: type: string enum: - report/profile description: 'Discriminator value: report/profile' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/profile variant - type: object properties: type: type: string enum: - report/profile-non-authoritative description: 'Discriminator value: report/profile-non-authoritative' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/profile-non-authoritative variant - type: object properties: type: type: string enum: - report/integration/sentilink-scores description: 'Discriminator value: report/integration/sentilink-scores' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/integration/sentilink-scores variant - type: object properties: type: type: string enum: - report/social-media description: 'Discriminator value: report/social-media' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportSocialMediaAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/social-media variant - type: object properties: type: type: string enum: - report/synthetic description: 'Discriminator value: report/synthetic' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportSyntheticAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/synthetic variant - type: object properties: type: type: string enum: - report/watchlist description: 'Discriminator value: report/watchlist' id: type: string description: The ID of the report attributes: $ref: >- #/components/schemas/ReportDiscriminatorMappingReportWatchlistAttributes relationships: $ref: '#/components/schemas/report-shared-relationships' required: - type description: report/watchlist variant - type: object properties: type: type: string enum: - selfie/profile-and-center description: 'Discriminator value: selfie/profile-and-center' id: type: string description: Unique identifier for this Selfie object. Starts with `self_`. attributes: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesAttributes relationships: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationships required: - type description: selfie/profile-and-center variant - type: object properties: type: type: string enum: - selfie/center-only description: 'Discriminator value: selfie/center-only' id: type: string description: Unique identifier for this Selfie object. Starts with `self_`. attributes: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesAttributes relationships: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationships required: - type description: selfie/center-only variant - type: object properties: type: type: string enum: - selfie/configurable-poses description: 'Discriminator value: selfie/configurable-poses' id: type: string description: Unique identifier for this Selfie object. Starts with `self_`. attributes: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesAttributes relationships: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingSelfieConfigurablePosesRelationships required: - type description: selfie/configurable-poses variant - type: object properties: type: type: string enum: - inquiry-session description: 'Discriminator value: inquiry-session' id: type: string attributes: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes relationships: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships required: - type description: inquiry-session variant - type: object properties: type: type: string enum: - transaction description: 'Discriminator value: transaction' id: type: string description: Unique identifier for this Transaction. Starts with `txn_`. attributes: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionAttributes relationships: $ref: >- #/components/schemas/VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationships required: - type description: transaction variant - type: object properties: type: type: string enum: - verification/aamva description: 'Discriminator value: verification/aamva' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationAamvaAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/aamva variant - type: object properties: type: type: string enum: - verification/bank-pennydrop description: 'Discriminator value: verification/bank-pennydrop' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/bank-pennydrop variant - type: object properties: type: type: string enum: - verification/brand-asset description: 'Discriminator value: verification/brand-asset' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationBrandAssetAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/brand-asset variant - type: object properties: type: type: string enum: - verification/business-website description: 'Discriminator value: verification/business-website' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationBusinessWebsiteAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/business-website variant - type: object properties: type: type: string enum: - verification/certificate-korea description: 'Discriminator value: verification/certificate-korea' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationCertificateKoreaAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/certificate-korea variant - type: object properties: type: type: string enum: - verification/credit-card description: 'Discriminator value: verification/credit-card' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/credit-card variant - type: object properties: type: type: string enum: - verification/database description: 'Discriminator value: verification/database' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database variant - type: object properties: type: type: string enum: - verification/database-aadhaar description: 'Discriminator value: verification/database-aadhaar' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseAadhaarAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-aadhaar variant - type: object properties: type: type: string enum: - verification/database-business description: 'Discriminator value: verification/database-business' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseBusinessAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-business variant - type: object properties: type: type: string enum: - verification/database-business-footprint description: 'Discriminator value: verification/database-business-footprint' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-business-footprint variant - type: object properties: type: type: string enum: - verification/database-ecbsv description: 'Discriminator value: verification/database-ecbsv' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseEcbsvAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-ecbsv variant - type: object properties: type: type: string enum: - verification/database-phone-carrier description: 'Discriminator value: verification/database-phone-carrier' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabasePhoneCarrierAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-phone-carrier variant - type: object properties: type: type: string enum: - verification/database-serpro description: 'Discriminator value: verification/database-serpro' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseSerproAttributes relationships: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseSerproRelationships required: - type description: verification/database-serpro variant - type: object properties: type: type: string enum: - verification/database-standard description: 'Discriminator value: verification/database-standard' id: type: string attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseStandardAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-standard variant - type: object properties: type: type: string enum: - verification/database-tin description: 'Discriminator value: verification/database-tin' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseTinAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-tin variant - type: object properties: type: type: string enum: - verification/database-vat-number description: 'Discriminator value: verification/database-vat-number' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDatabaseVatNumberAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/database-vat-number variant - type: object properties: type: type: string enum: - verification/digital-id-connect-id description: 'Discriminator value: verification/digital-id-connect-id' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-connect-id variant - type: object properties: type: type: string enum: - verification/digital-id-e-do-app description: 'Discriminator value: verification/digital-id-e-do-app' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdEDoAppAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-e-do-app variant - type: object properties: type: type: string enum: - verification/digital-id-finnish-trust-network description: >- Discriminator value: verification/digital-id-finnish-trust-network id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdFinnishTrustNetworkAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-finnish-trust-network variant - type: object properties: type: type: string enum: - verification/digital-id-france-identite description: 'Discriminator value: verification/digital-id-france-identite' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdFranceIdentiteAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-france-identite variant - type: object properties: type: type: string enum: - verification/digital-id-generic description: 'Discriminator value: verification/digital-id-generic' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdGenericAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-generic variant - type: object properties: type: type: string enum: - verification/digital-id-idin description: 'Discriminator value: verification/digital-id-idin' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdIdinAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-idin variant - type: object properties: type: type: string enum: - verification/digital-id-its-me description: 'Discriminator value: verification/digital-id-its-me' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdItsMeAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-its-me variant - type: object properties: type: type: string enum: - verification/digital-id-kcb-credit-card description: 'Discriminator value: verification/digital-id-kcb-credit-card' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdKcbCreditCardAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-kcb-credit-card variant - type: object properties: type: type: string enum: - verification/digital-id-mit-id description: 'Discriminator value: verification/digital-id-mit-id' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdMitIdAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-mit-id variant - type: object properties: type: type: string enum: - verification/digital-id-one-id description: 'Discriminator value: verification/digital-id-one-id' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdOneIdAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-one-id variant - type: object properties: type: type: string enum: - verification/digital-id-philsys description: 'Discriminator value: verification/digital-id-philsys' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdPhilsysAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-philsys variant - type: object properties: type: type: string enum: - verification/digital-id-serpro description: 'Discriminator value: verification/digital-id-serpro' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdSerproAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-serpro variant - type: object properties: type: type: string enum: - verification/digital-id-singpass description: 'Discriminator value: verification/digital-id-singpass' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdSingpassAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-singpass variant - type: object properties: type: type: string enum: - verification/digital-id-swedish-bank-id description: 'Discriminator value: verification/digital-id-swedish-bank-id' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdSwedishBankIdAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-swedish-bank-id variant - type: object properties: type: type: string enum: - verification/digital-id-uk-sharecode description: 'Discriminator value: verification/digital-id-uk-sharecode' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDigitalIdUkSharecodeAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-uk-sharecode variant - type: object properties: type: type: string enum: - verification/digital-id-world-id description: 'Discriminator value: verification/digital-id-world-id' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/digital-id-world-id variant - type: object properties: type: type: string enum: - verification/document description: 'Discriminator value: verification/document' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDocumentAttributes relationships: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationDocumentRelationships required: - type description: verification/document variant - type: object properties: type: type: string enum: - verification/email-address description: 'Discriminator value: verification/email-address' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationEmailAddressAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/email-address variant - type: object properties: type: type: string enum: - verification/government-id description: 'Discriminator value: verification/government-id' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdAttributes relationships: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdRelationships required: - type description: verification/government-id variant - type: object properties: type: type: string enum: - verification/government-id-nfc description: 'Discriminator value: verification/government-id-nfc' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcAttributes relationships: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationGovernmentIdNfcRelationships required: - type description: verification/government-id-nfc variant - type: object properties: type: type: string enum: - verification/jp-my-number-nfc-scan description: 'Discriminator value: verification/jp-my-number-nfc-scan' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationJpMyNumberNfcScanAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/jp-my-number-nfc-scan variant - type: object properties: type: type: string enum: - verification/mdoc description: 'Discriminator value: verification/mdoc' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationMdocAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/mdoc variant - type: object properties: type: type: string enum: - verification/persona-fff-inquiry description: 'Discriminator value: verification/persona-fff-inquiry' id: type: string description: The token of the verification attributes: $ref: '#/components/schemas/verification-shared-attributes' relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/persona-fff-inquiry variant - type: object properties: type: type: string enum: - verification/phone-number description: 'Discriminator value: verification/phone-number' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationPhoneNumberAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/phone-number variant - type: object properties: type: type: string enum: - verification/phone-number-silent-network-authentication description: >- Discriminator value: verification/phone-number-silent-network-authentication id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationPhoneNumberSilentNetworkAuthenticationAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/phone-number-silent-network-authentication variant - type: object properties: type: type: string enum: - verification/qes-infocert description: 'Discriminator value: verification/qes-infocert' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationQesInfocertAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/qes-infocert variant - type: object properties: type: type: string enum: - verification/selfie description: 'Discriminator value: verification/selfie' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationSelfieAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/selfie variant - type: object properties: type: type: string enum: - verification/verifiable-credential description: 'Discriminator value: verification/verifiable-credential' id: type: string description: The token of the verification attributes: $ref: >- #/components/schemas/VerificationDiscriminatorMappingVerificationVerifiableCredentialAttributes relationships: $ref: '#/components/schemas/verification-shared-relationships' required: - type description: verification/verifiable-credential variant - type: object properties: type: type: string enum: - workflow description: 'Discriminator value: workflow' id: type: string attributes: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowAttributes relationships: $ref: >- #/components/schemas/WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationships required: - type description: workflow variant - type: object properties: type: type: string enum: - workflow-run description: 'Discriminator value: workflow-run' id: type: string attributes: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes relationships: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships meta: $ref: >- #/components/schemas/InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta required: - type description: workflow-run variant discriminator: propertyName: type title: InquiryIncludedObjectsItems inquiry-included-objects: type: array items: $ref: '#/components/schemas/InquiryIncludedObjectsItems' title: inquiry-included-objects InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaMeta: type: object properties: one-time-link: type: string one-time-link-short: type: string required: - one-time-link - one-time-link-short title: >- InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaMeta Inquiries_generate-a-one-time-link_Response_200: type: object properties: data: $ref: '#/components/schemas/inquiry' included: $ref: '#/components/schemas/inquiry-included-objects' description: >- Objects that _may_ be returned if specified via the `include` query parameter in the request. meta: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaMeta required: - data - meta title: Inquiries_generate-a-one-time-link_Response_200 InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: title: type: string details: type: string title: >- InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems Generate-a-one-time-linkRequestBadRequestError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestBadRequestError Generate-a-one-time-linkRequestUnauthorizedError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestUnauthorizedError Generate-a-one-time-linkRequestForbiddenError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestForbiddenError Generate-a-one-time-linkRequestNotFoundError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestNotFoundError Generate-a-one-time-linkRequestConflictError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestConflictError Generate-a-one-time-linkRequestUnprocessableEntityError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestUnprocessableEntityError Generate-a-one-time-linkRequestTooManyRequestsError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InquiriesInquiryIdGenerateOneTimeLinkPostResponsesContentApplicationJsonSchemaErrorsItems title: Generate-a-one-time-linkRequestTooManyRequestsError securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "data": { "id": "inq_zEx4jL84ShbUyuwX6AzPSqt6", "attributes": { "status": "pending", "reference-id": "abc-123", "note": "A helpful note", "behaviors": {}, "tags": [], "creator": "creator@withpersona.com", "reviewer-comment": "This is a comment for this inquiry!", "created-at": "2023-03-29T19:06:45.000Z", "updated-at": "2023-03-30T19:07:01.000Z", "started-at": "2023-03-30T19:07:01.000Z", "expires-at": "2023-03-31T19:07:01.000Z", "completed-at": "2023-03-28T18:35:10.000Z", "failed-at": "2023-03-28T18:35:10.000Z", "marked-for-review-at": "2023-03-28T18:35:10.000Z", "decisioned-at": "2023-03-28T18:35:10.000Z", "expired-at": "2023-03-28T18:35:10.000Z", "redacted-at": "2023-03-28T18:35:10.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" }, "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" }, "identification-number": { "type": "string" } } }, "relationships": { "account": { "data": { "id": "act_n2uq9eKMboaCQzu9ALWYcVdN", "type": "account" } }, "documents": { "data": [] }, "template": { "data": {} }, "inquiry-template": { "data": { "id": "itmpl_p8ANAJy9iqadm2buF2xcVgqH", "type": "inquiry-template" } }, "inquiry-template-version": { "data": { "id": "itmplv_iXhqfNWqwYLAWs9G8Fm8hPfo", "type": "inquiry-template-version" } }, "reports": { "data": [] }, "reviewer": { "data": {} }, "selfies": { "data": [] }, "sessions": { "data": [] }, "verifications": { "data": [ { "id": "ver_uHDiwtcx3htjajvEaeMjPQcE", "type": "verification/database" } ] } }, "type": "inquiry" }, "meta": { "one-time-link": "https://withpersona.com/verify?code=us1-asdf", "one-time-link-short": "https://perso.na/verify?code=ABC123" } } ``` **SDK Code** ```python Success import requests url = "https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Success const url = 'https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Success package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Success require 'uri' require 'net/http' url = URI("https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java Success import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php Success request('POST', 'https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Success using RestSharp; var client = new RestClient("https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Success import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.withpersona.com/api/v1/inquiries/inquiry-id/generate-one-time-link")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```