openapi: 3.1.0
info:
  title: BNDRY API
  description: API for the BNDRY platform
  license:
    name: MIT License
    url: https://github.com/bndry-co/docs.bndry.net
  version: v1alpha
servers:
  - url: https://api.bndry.app
    description: BNDRY API
paths:
  /v1alpha/forms/{form}:
    get:
      tags:
        - Forms
      summary: Retrieve a form
      description: Retrieves a form.
      operationId: FormService_GetForm
      parameters:
        - name: form
          in: path
          description: The form id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.datacollection.forms.v1alpha.Form
    patch:
      tags:
        - Forms
      summary: Update a form
      description: Updates a form.
      operationId: FormService_UpdateForm
      parameters:
        - name: form
          in: path
          description: The form id.
          required: true
          schema:
            type: string
        - name: updateMask.paths
          in: query
          description: The set of field mask paths.
          schema:
            type: array
            items:
              type: string
            title: paths
            description: The set of field mask paths.
      requestBody:
        description: |-
          Required. The form to update.

           The form's `name` field is used to identify the form to update.
           Format: forms/{form}
           Format: workspaces/{workspace}/forms/{form}
        content:
          application/json:
            schema:
              title: form
              description: |-
                Required. The form to update.

                 The form's `name` field is used to identify the form to update.
                 Format: forms/{form}
                 Format: workspaces/{workspace}/forms/{form}
              $ref: '#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.datacollection.forms.v1alpha.Form
  /v1alpha/forms:
    get:
      tags:
        - Forms
      summary: List all forms
      description: List all forms.
      operationId: FormService_ListForms
      parameters:
        - name: parent
          in: query
          description: |-
            Required. The parent workspace for which to list forms.
             Format: forms/
             Format: workspaces/{workspace}
          required: true
          schema:
            type: string
            examples:
              - workspaces/aml-monitoring-ws-456
            title: parent
            description: |
              Required. The parent workspace for which to list forms.
               Format: forms/
               Format: workspaces/{workspace}
              string.example = ["workspaces/aml-monitoring-ws-456"]
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of forms to return. The service may
            return fewer than
             this value.
             If unspecified, at most 50 forms will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
          schema:
            type: integer
            title: page_size
            format: int32
            description: >-
              (OPTIONAL) Optional. The maximum number of forms to return. The
              service may return fewer than
               this value.
               If unspecified, at most 50 forms will be returned.
               The maximum value is 1000; values above 1000 will be coerced to 1000.
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous
            `ListWorkspaceForms` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListWorkspaceForms` must
             match the call that provided the page token.
          schema:
            type: string
            title: page_token
            description: >-
              (OPTIONAL) Optional. A page token, received from a previous
              `ListWorkspaceForms` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListWorkspaceForms` must
               match the call that provided the page token.
        - name: skip
          in: query
          description: >-
            Optional. The number of forms to skip before starting to collect the
            result set.
          schema:
            type: integer
            title: skip
            format: int32
            description: >-
              (OPTIONAL) Optional. The number of forms to skip before starting
              to collect the result set.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.datacollection.forms.v1alpha.ListFormsResponse
    post:
      tags:
        - Forms
      summary: Create a form
      description: Creates a form.
      operationId: FormService_CreateForm
      parameters:
        - name: formId
          in: query
          schema:
            type: string
            examples:
              - compliance-form-202412-001
            title: form_id
            description: |
              (OPTIONAL) string.example = ["compliance-form-202412-001"]
      requestBody:
        content:
          application/json:
            schema:
              title: form
              $ref: '#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.datacollection.forms.v1alpha.Form
  /v1alpha/forms/{form}:submit:
    post:
      tags:
        - Forms
      summary: Submit a form
      description: Submits a form.
      operationId: FormService_SubmitForm
      parameters:
        - name: form
          in: path
          description: The form id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.datacollection.forms.v1alpha.SubmitFormResponse
  /v1alpha/entities:
    get:
      tags:
        - Entities
      summary: List all entities
      description: Lists entities.
      operationId: EntityService_ListEntities
      parameters:
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of entities to return. The service may
            return fewer than
             this value.
             If unspecified, at most 50 entities will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
          schema:
            type: integer
            examples:
              - 25
            title: page_size
            format: int32
            description: >
              (OPTIONAL) Optional. The maximum number of entities to return. The
              service may return fewer than
               this value.
               If unspecified, at most 50 entities will be returned.
               The maximum value is 1000; values above 1000 will be coerced to 1000.
              int32.example = [25]
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous `ListEntities`
            call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListEntities` must
             match the call that provided the page token.
          schema:
            type: string
            examples:
              - ChAIAhABGAE
            title: page_token
            description: >
              (OPTIONAL) Optional. A page token, received from a previous
              `ListEntities` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListEntities` must
               match the call that provided the page token.
              string.example = ["ChAIAhABGAE"]
        - name: showDeleted
          in: query
          description: >-
            Optional. If true, soft-deleted entities will be included in the
            response.
             See AIP-164.
          schema:
            type: boolean
            title: show_deleted
            description: >-
              (OPTIONAL) Optional. If true, soft-deleted entities will be
              included in the response.
               See AIP-164.
        - name: skip
          in: query
          description: >-
            Optional. The number of entities to skip before starting to collect
            the result set.
          schema:
            type: integer
            examples:
              - 50
            title: skip
            format: int32
            description: >
              (OPTIONAL) Optional. The number of entities to skip before
              starting to collect the result set.

              int32.example = [50]
        - name: filter
          in: query
          description: >-
            Optional. A filter expression that filters the results listed in the
            response.
             Filter only currently supports a fuzzy search on display name.
             See AIP-160 for more details.
          schema:
            type: string
            examples:
              - John Smith
            title: filter
            description: >
              (OPTIONAL) Optional. A filter expression that filters the results
              listed in the response.
               Filter only currently supports a fuzzy search on display name.
               See AIP-160 for more details.
              string.example = ["John Smith"]
        - name: orderBy
          in: query
          schema:
            type: string
            examples:
              - displayName desc
            title: order_by
            description: |
              (OPTIONAL) string.example = ["displayName desc"]
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ListEntitiesResponse
    post:
      tags:
        - Entities
      summary: Create an entity
      description: Creates a new entity.
      operationId: EntityService_CreateEntity
      parameters:
        - name: entityId
          in: query
          description: >-
            Optional. The ID to use for the entity, which will become the final
            component of
             the entity's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
          schema:
            type: string
            examples:
              - john-smith-001
            title: entity_id
            maxLength: 63
            minLength: 4
            description: >
              (OPTIONAL) Optional. The ID to use for the entity, which will
              become the final component of
               the entity's resource name. This value should be 4-63 characters,
               and valid characters are /[a-z][0-9]-/.
              string.example = ["john-smith-001"]

              string.max_len = 63

              string.min_len = 4
      requestBody:
        description: Required. The entity to create.
        content:
          application/json:
            schema:
              title: entity
              description: Required. The entity to create.
              $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
  /v1alpha/entities/{entity}:
    get:
      tags:
        - Entities
      summary: Retrieve an entity
      description: Retrieves an entity.
      operationId: EntityService_GetEntity
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: system
          in: query
          description: |-
            Optional. External system identifier for external ID lookup.
             When provided, the entity ID in name is treated as an external ID.
          schema:
            type: string
            examples:
              - salesforce
            title: system
            description: >
              (OPTIONAL) Optional. External system identifier for external ID
              lookup.
               When provided, the entity ID in name is treated as an external ID.
              string.example = ["salesforce"]
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
    delete:
      tags:
        - Entities
      summary: Delete an entity
      description: Soft-deletes an entity.
      operationId: EntityService_DeleteEntity
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
    patch:
      tags:
        - Entities
      summary: Update an entity
      description: Updates an entity.
      operationId: EntityService_UpdateEntity
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: updateMask.paths
          in: query
          description: The set of field mask paths.
          schema:
            type: array
            items:
              type: string
            title: paths
            description: The set of field mask paths.
      requestBody:
        description: |-
          Required. The entity to update.

           The entity's `name` field is used to identify the entity to update.
           Format: entities/{entity}
        content:
          application/json:
            schema:
              title: entity
              description: |-
                Required. The entity to update.

                 The entity's `name` field is used to identify the entity to update.
                 Format: entities/{entity}
              $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
  /v1alpha/entities/{entity}:undelete:
    post:
      tags:
        - Entities
      summary: Undelete an entity
      description: Undeletes a soft-deleted entity.
      operationId: EntityService_UndeleteEntity
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
  /v1alpha/entities/{entity}:addEntityRelationship:
    post:
      tags:
        - Entities
      summary: Add an entity relationship
      operationId: EntityService_AddEntityRelationship
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targetEntity:
                  type: string
                  examples:
                    - entities/example-financial-services
                  title: target_entity
                  description: |
                    correct_name_format // name must start with 'entities/'
                    string.example = ["entities/example-financial-services"]
                relationshipType:
                  title: relationship_type
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
              title: AddEntityRelationshipRequest
              required:
                - targetEntity
                - relationshipType
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
  /v1alpha/entities/{entity}:removeEntityRelationship:
    post:
      tags:
        - Entities
      summary: Remove an entity relationship
      operationId: EntityService_RemoveEntityRelationship
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                targetEntity:
                  type: string
                  examples:
                    - entities/john-smith-001
                  title: target_entity
                  description: |
                    correct_name_format // name must start with 'entities/'
                    string.example = ["entities/john-smith-001"]
                relationshipType:
                  title: relationship_type
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
              title: RemoveEntityRelationshipRequest
              required:
                - targetEntity
                - relationshipType
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
  /v1alpha/entities/{entity}:EntityRelationships:
    get:
      tags:
        - Entities
      summary: View entity relationships
      operationId: EntityService_ViewEntityRelationships
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: view
          in: query
          schema:
            title: view
            description: '(OPTIONAL) '
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipView
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse
  /v1alpha/entities/{entity}/activityLogs:
    get:
      tags:
        - Entities
      summary: List activity logs for an entity
      description: Lists activities for an entity.
      operationId: EntityService_ListActivityLogs
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of activities to return. The service
            may return fewer than
             this value.
             If unspecified, at most 50 activities will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
          schema:
            type: integer
            examples:
              - 25
            title: page_size
            format: int32
            description: >
              (OPTIONAL) Optional. The maximum number of activities to return.
              The service may return fewer than
               this value.
               If unspecified, at most 50 activities will be returned.
               The maximum value is 1000; values above 1000 will be coerced to 1000.
              int32.example = [25]
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous
            `ListEntityActivities` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListEntityActivities` must
             match the call that provided the page token.
          schema:
            type: string
            examples:
              - ChAIAhABGAE
            title: page_token
            description: >
              (OPTIONAL) Optional. A page token, received from a previous
              `ListEntityActivities` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListEntityActivities` must
               match the call that provided the page token.
              string.example = ["ChAIAhABGAE"]
        - name: skip
          in: query
          description: >-
            Optional. The number of resources to skip over before returning
            resources.
             Default is 0. See: https://google.aip.dev/158#skipping-results
          schema:
            type: integer
            examples:
              - 0
            title: skip
            format: int32
            description: >
              (OPTIONAL) Optional. The number of resources to skip over before
              returning resources.
               Default is 0. See: https://google.aip.dev/158#skipping-results
              int32.example = [0]
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ListActivityLogsResponse
  /v1alpha/activityLogs/{activityLog}:
    get:
      tags:
        - Entities
      summary: Retrieve an activity log
      description: Retrieves an activity.
      operationId: EntityService_GetActivityLog
      parameters:
        - name: activityLog
          in: path
          description: The activityLog id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog
  /v1alpha/activityLogs:
    post:
      tags:
        - Entities
      summary: Create an activity log
      operationId: EntityService_CreateActivityLog
      parameters:
        - name: activityLogId
          in: query
          description: >-
            Optional. The ID to use for the entity, which will become the final
            component of
             the entity's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
          schema:
            type: string
            examples:
              - activity-log-001
            title: activity_log_id
            maxLength: 63
            minLength: 4
            description: >
              (OPTIONAL) Optional. The ID to use for the entity, which will
              become the final component of
               the entity's resource name. This value should be 4-63 characters,
               and valid characters are /[a-z][0-9]-/.
              string.example = ["activity-log-001"]

              string.max_len = 63

              string.min_len = 4
      requestBody:
        description: Required. The entity to create.
        content:
          application/json:
            schema:
              title: activity_log
              description: Required. The entity to create.
              $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog
  /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:
    get:
      tags:
        - Entity Risk Rating
      summary: Retrieve a risk rating job
      description: Retrieves details about a specific risk rating job.
      operationId: IndividualEntityRiskRatingJobService_GetIndividualEntityRiskRatingJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: individualEntityRiskRatingJob
          in: path
          description: The individualEntityRiskRatingJob id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob
  /v1alpha/entities/{entity}/individualEntityRiskRatingJobs:
    get:
      tags:
        - Entity Risk Rating
      summary: List risk rating jobs
      description: Lists risk rating jobs for a specific entity.
      operationId: IndividualEntityRiskRatingJobService_ListIndividualEntityRiskRatingJobs
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of jobs to return. The service may
            return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
          schema:
            type: integer
            examples:
              - 25
            title: page_size
            format: int32
            description: >
              (OPTIONAL) Optional. The maximum number of jobs to return. The
              service may return fewer than
               this value.
               If unspecified, at most 10 jobs will be returned.
               The maximum value is 100; values above 100 will be coerced to 100.
              int32.example = [25]
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous
            `ListIndividualEntityRiskRatingJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must
             match the call that provided the page token.
          schema:
            type: string
            examples:
              - ChAIAhABGAEiAggC
            title: page_token
            description: >
              (OPTIONAL) Optional. A page token, received from a previous
              `ListIndividualEntityRiskRatingJobs` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must
               match the call that provided the page token.
              string.example = ["ChAIAhABGAEiAggC"]
        - name: skip
          in: query
          description: >-
            Optional. The number of jobs to skip before starting to collect the
            result set.
          schema:
            type: integer
            examples:
              - 0
            title: skip
            minimum: 0
            format: int32
            description: >
              (OPTIONAL) Optional. The number of jobs to skip before starting to
              collect the result set.

              int32.example = [0]

              int32.gte = 0

              int32.gte_lt = 0

              int32.gte_lt_exclusive = 0

              int32.gte_lte = 0

              int32.gte_lte_exclusive = 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsResponse
    post:
      tags:
        - Entity Risk Rating
      summary: Create a risk rating job
      description: Creates a new risk rating job.
      operationId: IndividualEntityRiskRatingJobService_CreateIndividualEntityRiskRatingJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: individualEntityRiskRatingJobId
          in: query
          description: >-
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
          required: true
          schema:
            type: string
            examples:
              - pep-sanction-screen-001
            title: individual_entity_risk_rating_job_id
            maxLength: 63
            minLength: 4
            description: >
              REQUIRED. The ID to use for the job, which will become the final
              component of
               the job's resource name. This value should be 4-63 characters,
               and valid characters are /[a-z][0-9]-/.
              string.example = ["pep-sanction-screen-001"]

              string.max_len = 63

              string.min_len = 4
      requestBody:
        description: Required. The risk rating job to create.
        content:
          application/json:
            schema:
              title: individual_entity_risk_rating_job
              description: Required. The risk rating job to create.
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob
  /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:run:
    post:
      tags:
        - Entity Risk Rating
      summary: Run a risk rating job
      description: Runs a risk rating job.
      operationId: IndividualEntityRiskRatingJobService_RunIndividualEntityRiskRatingJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: individualEntityRiskRatingJob
          in: path
          description: The individualEntityRiskRatingJob id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
  /v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}/operations/{operation}:
    get:
      tags:
        - Entity Risk Rating
      summary: GetOperation
      description: |-
        Gets the latest state of a long-running operation.  Clients can use this
         method to poll the operation result at intervals as recommended by the API
         service.
      operationId: IndividualEntityRiskRatingJobService_GetOperation
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: individualEntityRiskRatingJob
          in: path
          description: The individualEntityRiskRatingJob id.
          required: true
          schema:
            type: string
        - name: operation
          in: path
          description: The operation id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
  /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}:
    get:
      tags:
        - Onboard Individual (Verify Identity)
      summary: Retrieve an onboard individual entity job
      description: Retrieves details about a specific onboard individual entity job.
      operationId: OnboardIndividualEntityJobService_GetOnboardIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: onboardIndividualEntityJob
          in: path
          description: The onboardIndividualEntityJob id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob
  /v1alpha/entities/{entity}/onboardIndividualEntityJobs:
    get:
      tags:
        - Onboard Individual (Verify Identity)
      summary: List onboard individual entity jobs
      description: Lists onboard individual entity jobs for a specific entity.
      operationId: OnboardIndividualEntityJobService_ListOnboardIndividualEntityJobs
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of jobs to return. The service may
            return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
          schema:
            type: integer
            examples:
              - 25
            title: page_size
            format: int32
            description: >
              (OPTIONAL) Optional. The maximum number of jobs to return. The
              service may return fewer than
               this value.
               If unspecified, at most 10 jobs will be returned.
               The maximum value is 100; values above 100 will be coerced to 100.
              int32.example = [25]
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous
            `ListOnboardIndividualEntityJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must
             match the call that provided the page token.
          schema:
            type: string
            examples:
              - ChAIAhABGAEiAggC
            title: page_token
            description: >
              (OPTIONAL) Optional. A page token, received from a previous
              `ListOnboardIndividualEntityJobs` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must
               match the call that provided the page token.
              string.example = ["ChAIAhABGAEiAggC"]
        - name: skip
          in: query
          description: >-
            Optional. The number of jobs to skip before starting to collect the
            result set.
          schema:
            type: integer
            examples:
              - 0
            title: skip
            minimum: 0
            format: int32
            description: >
              (OPTIONAL) Optional. The number of jobs to skip before starting to
              collect the result set.

              int32.example = [0]

              int32.gte = 0

              int32.gte_lt = 0

              int32.gte_lt_exclusive = 0

              int32.gte_lte = 0

              int32.gte_lte_exclusive = 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsResponse
    post:
      tags:
        - Onboard Individual (Verify Identity)
      summary: Create an onboard individual entity job
      description: Creates a new onboard individual entity job.
      operationId: OnboardIndividualEntityJobService_CreateOnboardIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: onboardIndividualEntityJobId
          in: query
          description: >-
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
          required: true
          schema:
            type: string
            examples:
              - kyc-individual-mfs-001
            title: onboard_individual_entity_job_id
            maxLength: 63
            minLength: 4
            description: >
              REQUIRED. The ID to use for the job, which will become the final
              component of
               the job's resource name. This value should be 4-63 characters,
               and valid characters are /[a-z][0-9]-/.
              string.example = ["kyc-individual-mfs-001"]

              string.max_len = 63

              string.min_len = 4
      requestBody:
        description: Required. The onboard individual entity job to create.
        content:
          application/json:
            schema:
              title: onboard_individual_entity_job
              description: Required. The onboard individual entity job to create.
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob
  /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}:run:
    post:
      tags:
        - Onboard Individual (Verify Identity)
      summary: Run an onboard individual entity job
      description: Runs an onboard individual entity job.
      operationId: OnboardIndividualEntityJobService_RunOnboardIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: onboardIndividualEntityJob
          in: path
          description: The onboardIndividualEntityJob id.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                redirectUri:
                  type: string
                  examples:
                    - https://app.example.com/kyc/complete
                  title: redirect_uri
                  format: uri
                  description: >
                    The final redirect URI where the user should be sent after
                    onboarding is complete.

                    string.example = ["https://app.example.com/kyc/complete"]

                    string.uri = true // value must be a valid URI

                    string.uri_empty = true // value is empty, which is not a
                    valid URI
                entityAnnotations:
                  type: object
                  title: entity_annotations
                  additionalProperties:
                    type: string
                    title: value
                  description: >-
                    (OPTIONAL) Optional. Arbitrary annotations to be applied to
                    the entity being created.
              title: RunOnboardIndividualEntityJobRequest
              required:
                - redirectUri
              additionalProperties: false
              description: >-
                Request message for
                [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob].
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
  /v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}/operations/{operation}:
    get:
      tags:
        - Onboard Individual (Verify Identity)
      summary: GetOperation
      description: |-
        Gets the latest state of a long-running operation.  Clients can use this
         method to poll the operation result at intervals as recommended by the API
         service.
      operationId: OnboardIndividualEntityJobService_GetOperation
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: onboardIndividualEntityJob
          in: path
          description: The onboardIndividualEntityJob id.
          required: true
          schema:
            type: string
        - name: operation
          in: path
          description: The operation id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
  /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}:
    get:
      tags:
        - Entity PEP Sanctions Check
      summary: Retrieve a PEP and sanctions screening job
      description: Retrieves details about a specific PEP and sanctions screening job.
      operationId: PepSanctionIndividualEntityJobService_GetPepSanctionIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pepSanctionIndividualEntityJob
          in: path
          description: The pepSanctionIndividualEntityJob id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob
  /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs:
    get:
      tags:
        - Entity PEP Sanctions Check
      summary: List PEP and sanctions screening jobs
      description: Lists PEP and sanctions screening jobs for a specific entity.
      operationId: >-
        PepSanctionIndividualEntityJobService_ListPepSanctionIndividualEntityJobs
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pageSize
          in: query
          description: >-
            Optional. The maximum number of jobs to return. The service may
            return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
          schema:
            type: integer
            examples:
              - 25
            title: page_size
            format: int32
            description: >
              (OPTIONAL) Optional. The maximum number of jobs to return. The
              service may return fewer than
               this value.
               If unspecified, at most 10 jobs will be returned.
               The maximum value is 100; values above 100 will be coerced to 100.
              int32.example = [25]
        - name: pageToken
          in: query
          description: >-
            Optional. A page token, received from a previous
            `ListPepSanctionIndividualEntityJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must
             match the call that provided the page token.
          schema:
            type: string
            examples:
              - ChAIAhABGAEiAggC
            title: page_token
            description: >
              (OPTIONAL) Optional. A page token, received from a previous
              `ListPepSanctionIndividualEntityJobs` call.
               Provide this to retrieve the subsequent page.
               When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must
               match the call that provided the page token.
              string.example = ["ChAIAhABGAEiAggC"]
        - name: skip
          in: query
          description: >-
            Optional. The number of jobs to skip before starting to collect the
            result set.
          schema:
            type: integer
            examples:
              - 0
            title: skip
            minimum: 0
            format: int32
            description: >
              (OPTIONAL) Optional. The number of jobs to skip before starting to
              collect the result set.

              int32.example = [0]

              int32.gte = 0

              int32.gte_lt = 0

              int32.gte_lt_exclusive = 0

              int32.gte_lte = 0

              int32.gte_lte_exclusive = 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsResponse
    post:
      tags:
        - Entity PEP Sanctions Check
      summary: Create a PEP and sanctions screening job
      description: Creates a new PEP and sanctions screening job.
      operationId: >-
        PepSanctionIndividualEntityJobService_CreatePepSanctionIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pepSanctionIndividualEntityJobId
          in: query
          description: >-
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
          required: true
          schema:
            type: string
            examples:
              - pep-sanction-screen-001
            title: pep_sanction_individual_entity_job_id
            maxLength: 63
            minLength: 4
            description: >
              REQUIRED. The ID to use for the job, which will become the final
              component of
               the job's resource name. This value should be 4-63 characters,
               and valid characters are /[a-z][0-9]-/.
              string.example = ["pep-sanction-screen-001"]

              string.max_len = 63

              string.min_len = 4
      requestBody:
        description: Required. The PEP and sanctions screening job to create.
        content:
          application/json:
            schema:
              title: pep_sanction_individual_entity_job
              description: Required. The PEP and sanctions screening job to create.
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob
  /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}:run:
    post:
      tags:
        - Entity PEP Sanctions Check
      summary: Run a PEP and sanctions screening job
      description: Runs a PEP and sanctions screening job.
      operationId: PepSanctionIndividualEntityJobService_RunPepSanctionIndividualEntityJob
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pepSanctionIndividualEntityJob
          in: path
          description: The pepSanctionIndividualEntityJob id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
  /v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}/operations/{operation}:
    get:
      tags:
        - Entity PEP Sanctions Check
      summary: GetOperation
      description: |-
        Gets the latest state of a long-running operation.  Clients can use this
         method to poll the operation result at intervals as recommended by the API
         service.
      operationId: PepSanctionIndividualEntityJobService_GetOperation
      parameters:
        - name: entity
          in: path
          description: The entity id.
          required: true
          schema:
            type: string
        - name: pepSanctionIndividualEntityJob
          in: path
          description: The pepSanctionIndividualEntityJob id.
          required: true
          schema:
            type: string
        - name: operation
          in: path
          description: The operation id.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.longrunning.Operation'
components:
  schemas:
    bndry.api.datacollection.documents.v1alpha.DocumentView:
      type: string
      title: DocumentView
      enum:
        - DOCUMENT_VIEW_UNSPECIFIED
        - DOCUMENT_VIEW_BASIC
        - DOCUMENT_VIEW_FULL
      description: Specifies the level of detail to return for a document.
    bndry.api.datacollection.documents.v1alpha.CreateDocumentRequest:
      type: object
      properties:
        document:
          title: document
          description: Required. The document to create.
          $ref: >-
            #/components/schemas/bndry.api.datacollection.documents.v1alpha.Document
      title: CreateDocumentRequest
      required:
        - document
      additionalProperties: false
      description: >-
        Request message for
        [DocumentService.CreateDocument][bndry.api.core.v1alpha.DocumentService.CreateDocument].
    bndry.api.datacollection.documents.v1alpha.DeleteDocumentRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - documents/aml-screening-doc-xyz789
          title: name
          description: |
            Required. The resource name of the document to delete.
             Format: documents/{document}
            correct_name_format // name must start with 'documents/'
            string.example = ["documents/aml-screening-doc-xyz789"]
      title: DeleteDocumentRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [DocumentService.DeleteDocument][bndry.api.core.v1alpha.DocumentService.DeleteDocument].
    bndry.api.datacollection.documents.v1alpha.Document:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |-
            (IDENTIFIER) The resource name of the document.
             Format: documents/{document}
        displayName:
          type: string
          examples:
            - John Doe - Driver's License
          title: display_name
          maxLength: 128
          minLength: 1
          description: >
            Optional. A mutable, user-settable field for providing a
            human-readable
             name for the document, to be used in user interfaces. Must be <= 63
             characters.
            string.example = ["John Doe - Driver's License"]

            string.max_len = 128

            string.min_len = 1
        content:
          type: string
          title: content
          maxLength: 10485760
          minLength: 1
          format: byte
          description: |
            The content of the document. Maximum file size is 10Mib.
            bytes.max_len = 10485760
            bytes.min_len = 1
        createTime:
          title: create_time
          description: Output only. The timestamp when the document was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: >-
            Output only. The timestamp when the document was most recently
            updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: Document
      required:
        - displayName
        - content
      additionalProperties: false
    bndry.api.datacollection.documents.v1alpha.GetDocumentRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - documents/kyc-doc-abc123
          title: name
          description: |
            Required. The resource name of the document to retrieve.
             Format: documents/{document}
            correct_name_format // name must start with 'documents/'
            string.example = ["documents/kyc-doc-abc123"]
        view:
          title: view
          description: (OPTIONAL) Optional. Specifies the view of the document to retrieve.
          $ref: >-
            #/components/schemas/bndry.api.datacollection.documents.v1alpha.DocumentView
      title: GetDocumentRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [DocumentService.GetDocument][bndry.api.core.v1alpha.DocumentService.GetDocument].
    google.protobuf.Empty:
      type: object
      description: |-
        A generic empty message that you can re-use to avoid defining duplicated
         empty messages in your APIs. A typical example is to use it as the request
         or the response type of an API method. For instance:

             service Foo {
               rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
             }
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2023-01-15T01:30:15.01Z'
        - '2024-12-25T12:00:00Z'
      format: date-time
      description: >-
        A Timestamp represents a point in time independent of any time zone or
        local
         calendar, encoded as a count of seconds and fractions of seconds at
         nanosecond resolution. The count is relative to an epoch at UTC midnight on
         January 1, 1970, in the proleptic Gregorian calendar which extends the
         Gregorian calendar backwards to year one.

         All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
         second table is needed for interpretation, using a [24-hour linear
         smear](https://developers.google.com/time/smear).

         The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
         restricting to that range, we ensure that we can convert to and from [RFC
         3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

         # Examples

         Example 1: Compute Timestamp from POSIX `time()`.

             Timestamp timestamp;
             timestamp.set_seconds(time(NULL));
             timestamp.set_nanos(0);

         Example 2: Compute Timestamp from POSIX `gettimeofday()`.

             struct timeval tv;
             gettimeofday(&tv, NULL);

             Timestamp timestamp;
             timestamp.set_seconds(tv.tv_sec);
             timestamp.set_nanos(tv.tv_usec * 1000);

         Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.

             FILETIME ft;
             GetSystemTimeAsFileTime(&ft);
             UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

             // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
             // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
             Timestamp timestamp;
             timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
             timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

         Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.

             long millis = System.currentTimeMillis();

             Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
                 .setNanos((int) ((millis % 1000) * 1000000)).build();

         Example 5: Compute Timestamp from Java `Instant.now()`.

             Instant now = Instant.now();

             Timestamp timestamp =
                 Timestamp.newBuilder().setSeconds(now.getEpochSecond())
                     .setNanos(now.getNano()).build();

         Example 6: Compute Timestamp from current time in Python.

             timestamp = Timestamp()
             timestamp.GetCurrentTime()

         # JSON Mapping

         In JSON format, the Timestamp type is encoded as a string in the
         [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
         format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
         where {year} is always expressed using four digits while {month}, {day},
         {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
         seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
         are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
         is required. A proto3 JSON serializer should always use UTC (as indicated by
         "Z") when printing the Timestamp type and a proto3 JSON parser should be
         able to accept both UTC and other timezones (as indicated by an offset).

         For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
         01:30 UTC on January 15, 2017.

         In JavaScript, one can convert a Date object to this format using the
         standard
         [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
         method. In Python, a standard `datetime.datetime` object can be converted
         to this format using
         [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
         the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
         the Joda Time's [`ISODateTimeFormat.dateTime()`](
         http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
         ) to obtain a formatter capable of generating timestamps in this format.
    google.protobuf.NullValue:
      type: string
      title: NullValue
      enum:
        - NULL_VALUE
      description: >-
        `NullValue` is a singleton enumeration to represent the null value for
        the
         `Value` type union.

         The JSON representation for `NullValue` is JSON `null`.
    bndry.api.datacollection.forms.v1alpha.CloneFormDefinitionRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - formDefinitions/kyc-corporate-customer-template
          title: name
          description: |
            Required. The resource name of the form definition to clone.
             Format: formDefinitions/{form_definition}
            string.example = ["formDefinitions/kyc-corporate-customer-template"]
      title: CloneFormDefinitionRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [FormDefinitionService.CloneFormDefinition][bndry.api.forms.v1alpha.FormDefinitionService.CloneFormDefinition].
    bndry.api.datacollection.forms.v1alpha.CreateFormDefinitionRequest:
      type: object
      properties:
        formDefinition:
          title: form_definition
          description: Required. The form definition to create.
          $ref: >-
            #/components/schemas/bndry.api.datacollection.forms.v1alpha.FormDefinition
        formDefinitionId:
          type: string
          examples:
            - kyc-enhanced-due-diligence-v2
          title: form_definition_id
          description: >
            (OPTIONAL) Optional. The ID to use for the form definition, which
            will become the final component of
             the form definition's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["kyc-enhanced-due-diligence-v2"]
      title: CreateFormDefinitionRequest
      required:
        - formDefinition
      additionalProperties: false
      description: >-
        Request message for
        [bndry.api.forms.v1alpha.FormDefinitionService.CreateFormDefinition].
    bndry.api.datacollection.forms.v1alpha.DeleteFormDefinitionRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - formDefinitions/legacy-customer-intake-form
          title: name
          description: |
            Required. The resource name of the form definition to delete.
             Format: formDefinitions/{form_definition}
            string.example = ["formDefinitions/legacy-customer-intake-form"]
      title: DeleteFormDefinitionRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [FormDefinitionService.DeleteFormDefinition][bndry.api.forms.v1alpha.FormDefinitionService.DeleteFormDefinition].
    bndry.api.datacollection.forms.v1alpha.FormDefinition:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |
            (IDENTIFIER) Output only. The resource name of the form definition.
             Format: formDefinitions/{form_definition}
            correct_name_format // name must start with 'formDefinitions/'
          readOnly: true
        displayName:
          type: string
          examples:
            - Enhanced Due Diligence Form
          title: display_name
          description: >
            (OPTIONAL) Optional. A mutable, user-settable field for providing a
            human-readable
             name for the form definition, to be used in user interfaces. Must be <= 63
             characters.
            string.example = ["Enhanced Due Diligence Form"]
        description:
          type: string
          examples:
            - >-
              Comprehensive form for collecting customer information required
              for enhanced due diligence as per KYC/AML regulations
          title: description
          description: >
            (OPTIONAL) Optional. A description of the form definition.

            string.example = ["Comprehensive form for collecting customer
            information required for enhanced due diligence as per KYC/AML
            regulations"]
        formkitSchema:
          title: formkit_schema
          description: Required. The schema of the form, defined using FormKit.
          $ref: >-
            #/components/schemas/bndry.api.datacollection.forms.v1alpha.FormKitSchema
        createTime:
          title: create_time
          description: Output only. The timestamp when the form definition was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: >-
            Output only. The timestamp when the form definition was most
            recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        purgeTime:
          title: purge_time
          description: >-
            Output only. The timestamp when the form definition will be purged
            if soft-deleted.
             See AIP-164.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        etag:
          type: string
          title: etag
          description: >-
            (OPTIONAL) Optional. The etag of the resource. Used for optimistic
            concurrency control
             as per AIP-154.
      title: FormDefinition
      required:
        - formkitSchema
      additionalProperties: false
      description: Represents a definition of a form, including its schema and metadata.
    bndry.api.datacollection.forms.v1alpha.FormKitSchema:
      type: object
      properties:
        nodes:
          title: nodes
          $ref: '#/components/schemas/google.protobuf.ListValue'
      title: FormKitSchema
      required:
        - nodes
      additionalProperties: false
    bndry.api.datacollection.forms.v1alpha.GetFormDefinitionRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - formDefinitions/aml-risk-assessment-form
          title: name
          description: |
            Required. The resource name of the form definition to retrieve.
             Format: formDefinitions/{form_definition}
            string.example = ["formDefinitions/aml-risk-assessment-form"]
      title: GetFormDefinitionRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [FormDefinitionService.GetFormDefinition][bndry.api.forms.v1alpha.FormDefinitionService.GetFormDefinition].
    bndry.api.datacollection.forms.v1alpha.ListFormDefinitionsRequest:
      type: object
      properties:
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of form definitions to
            return. The service may return fewer than
             this value.
             If unspecified, at most 50 form definitions will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListFormDefinitions` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListFormDefinitions` must
             match the call that provided the page token.
        showDeleted:
          type: boolean
          title: show_deleted
          description: >-
            (OPTIONAL) Optional. If true, soft-deleted form definitions will be
            included in the response.
             See AIP-164.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of form definitions to skip before
            starting to collect the result set.
        filter:
          type: string
          title: filter
          description: >-
            (OPTIONAL) Optional. A filter expression that filters the results
            listed in the response.
             See AIP-160 for more details.
      title: ListFormDefinitionsRequest
      additionalProperties: false
      description: >-
        Request message for
        [FormDefinitionService.ListFormDefinitions][bndry.api.forms.v1alpha.FormDefinitionService.ListFormDefinitions].
    bndry.api.datacollection.forms.v1alpha.ListFormDefinitionsResponse:
      type: object
      properties:
        formDefinitions:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.datacollection.forms.v1alpha.FormDefinition
          title: form_definitions
          description: The list of form definitions.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of form definitions matching the request.
      title: ListFormDefinitionsResponse
      additionalProperties: false
      description: >-
        Response message for
        [FormDefinitionService.ListFormDefinitions][bndry.api.forms.v1alpha.FormDefinitionService.ListFormDefinitions].
    bndry.api.datacollection.forms.v1alpha.UpdateFormDefinitionRequest:
      type: object
      properties:
        formDefinition:
          title: form_definition
          description: |-
            Required. The form definition to update.

             The form definition's `name` field is used to identify the form definition
             to update.
             Format: formDefinitions/{form_definition}
          $ref: >-
            #/components/schemas/bndry.api.datacollection.forms.v1alpha.FormDefinition
        updateMask:
          title: update_mask
          description: |-
            (OPTIONAL) Optional. The list of fields to be updated.

             If not provided (i.e., the mask is omitted), the server will update all
             fields that are populated in the `form_definition` message in this request
             (i.e., fields that have a non-empty value).

             The special value `*` can be used for a full replacement of the resource,
             equivalent to a PUT operation. When using `*`, be cautious as new fields
             added to the resource in the future will also be updated.

             For robust updates, explicitly specifying the fields is recommended.

             See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
      title: UpdateFormDefinitionRequest
      required:
        - formDefinition
      additionalProperties: false
      description: >-
        Request message for
        [FormDefinitionService.UpdateFormDefinition][bndry.api.forms.v1alpha.FormDefinitionService.UpdateFormDefinition].
    google.protobuf.FieldMask:
      type: string
      description: |-
        `FieldMask` represents a set of symbolic field paths, for example:

             paths: "f.a"
             paths: "f.b.d"

         Here `f` represents a field in some root message, `a` and `b`
         fields in the message found in `f`, and `d` a field found in the
         message in `f.b`.

         Field masks are used to specify a subset of fields that should be
         returned by a get operation or modified by an update operation.
         Field masks also have a custom JSON encoding (see below).

         # Field Masks in Projections

         When used in the context of a projection, a response message or
         sub-message is filtered by the API to only contain those fields as
         specified in the mask. For example, if the mask in the previous
         example is applied to a response message as follows:

             f {
               a : 22
               b {
                 d : 1
                 x : 2
               }
               y : 13
             }
             z: 8

         The result will not contain specific values for fields x,y and z
         (their value will be set to the default, and omitted in proto text
         output):


             f {
               a : 22
               b {
                 d : 1
               }
             }

         A repeated field is not allowed except at the last position of a
         paths string.

         If a FieldMask object is not present in a get operation, the
         operation applies to all fields (as if a FieldMask of all fields
         had been specified).

         Note that a field mask does not necessarily apply to the
         top-level response message. In case of a REST get operation, the
         field mask applies directly to the response, but in case of a REST
         list operation, the mask instead applies to each individual message
         in the returned resource list. In case of a REST custom method,
         other definitions may be used. Where the mask applies will be
         clearly documented together with its declaration in the API.  In
         any case, the effect on the returned resource/resources is required
         behavior for APIs.

         # Field Masks in Update Operations

         A field mask in update operations specifies which fields of the
         targeted resource are going to be updated. The API is required
         to only change the values of the fields as specified in the mask
         and leave the others untouched. If a resource is passed in to
         describe the updated values, the API ignores the values of all
         fields not covered by the mask.

         If a repeated field is specified for an update operation, new values will
         be appended to the existing repeated field in the target resource. Note that
         a repeated field is only allowed in the last position of a `paths` string.

         If a sub-message is specified in the last position of the field mask for an
         update operation, then new value will be merged into the existing sub-message
         in the target resource.

         For example, given the target message:

             f {
               b {
                 d: 1
                 x: 2
               }
               c: [1]
             }

         And an update message:

             f {
               b {
                 d: 10
               }
               c: [2]
             }

         then if the field mask is:

          paths: ["f.b", "f.c"]

         then the result will be:

             f {
               b {
                 d: 10
                 x: 2
               }
               c: [1, 2]
             }

         An implementation may provide options to override this default behavior for
         repeated and message fields.

         In order to reset a field's value to the default, the field must
         be in the mask and set to the default value in the provided resource.
         Hence, in order to reset all fields of a resource, provide a default
         instance of the resource and set all fields in the mask, or do
         not provide a mask as described below.

         If a field mask is not present on update, the operation applies to
         all fields (as if a field mask of all fields has been specified).
         Note that in the presence of schema evolution, this may mean that
         fields the client does not know and has therefore not filled into
         the request will be reset to their default. If this is unwanted
         behavior, a specific service may require a client to always specify
         a field mask, producing an error if not.

         As with get operations, the location of the resource which
         describes the updated values in the request message depends on the
         operation kind. In any case, the effect of the field mask is
         required to be honored by the API.

         ## Considerations for HTTP REST

         The HTTP kind of an update operation which uses a field mask must
         be set to PATCH instead of PUT in order to satisfy HTTP semantics
         (PUT must only be used for full updates).

         # JSON Encoding of Field Masks

         In JSON, a field mask is encoded as a single string where paths are
         separated by a comma. Fields name in each path are converted
         to/from lower-camel naming conventions.

         As an example, consider the following message declarations:

             message Profile {
               User user = 1;
               Photo photo = 2;
             }
             message User {
               string display_name = 1;
               string address = 2;
             }

         In proto a field mask for `Profile` may look as such:

             mask {
               paths: "user.display_name"
               paths: "photo"
             }

         In JSON, the same mask is represented as below:

             {
               mask: "user.displayName,photo"
             }

         # Field Masks and Oneof Fields

         Field masks treat fields in oneofs just as regular fields. Consider the
         following message:

             message SampleMessage {
               oneof test_oneof {
                 string name = 4;
                 SubMessage sub_message = 9;
               }
             }

         The field mask can be:

             mask {
               paths: "name"
             }

         Or:

             mask {
               paths: "sub_message"
             }

         Note that oneof type names ("test_oneof" in this case) cannot be used in
         paths.

         ## Field Mask Verification

         The implementation of any API method which has a FieldMask type field in the
         request should verify the included field paths, and return an
         `INVALID_ARGUMENT` error if any path is unmappable.
    google.protobuf.ListValue:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Value'
          title: values
          description: Repeated field of dynamically typed values.
      title: ListValue
      additionalProperties: false
      description: |-
        `ListValue` is a wrapper around a repeated field of values.

         The JSON representation for `ListValue` is JSON array.
    google.protobuf.Struct:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/google.protobuf.Value'
      description: |-
        `Struct` represents a structured data value, consisting of fields
         which map to dynamically typed values. In some languages, `Struct`
         might be supported by a native representation. For example, in
         scripting languages like JS a struct is represented as an
         object. The details of that representation are described together
         with the proto support for the language.

         The JSON representation for `Struct` is JSON object.
    google.protobuf.Struct.FieldsEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: '#/components/schemas/google.protobuf.Value'
      title: FieldsEntry
      additionalProperties: false
    google.protobuf.Value:
      oneOf:
        - type: 'null'
        - type: number
        - type: string
        - type: boolean
        - type: array
        - type: object
          additionalProperties: true
      description: |-
        `Value` represents a dynamically typed value which can be either
         null, a number, a string, a boolean, a recursive struct value, or a
         list of values. A producer of value is expected to set one of these
         variants. Absence of any variant indicates an error.

         The JSON representation for `Value` is JSON value.
    bndry.api.datacollection.forms.v1alpha.Form.State:
      type: string
      title: State
      enum:
        - STATE_UNSPECIFIED
        - OPEN
        - EXPIRED
        - SUBMITTED
      description: The state of the form
    bndry.api.datacollection.forms.v1alpha.CreateFormRequest:
      type: object
      properties:
        form:
          title: form
          $ref: '#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form'
        formId:
          type: string
          examples:
            - compliance-form-202412-001
          title: form_id
          description: |
            (OPTIONAL) string.example = ["compliance-form-202412-001"]
      title: CreateFormRequest
      required:
        - form
      additionalProperties: false
      description: Request message for [bndry.api.forms.v1alpha.FormService.CreateForm].
    bndry.api.datacollection.forms.v1alpha.Form:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |-
            (IDENTIFIER) The resource name of the form.
             Format: forms/{form}
             Format: workspaces/{workspace}/forms/{form}
        formDefinition:
          type: string
          examples:
            - formDefinitions/kyc-beneficial-ownership
          title: form_definition
          description: >
            (IMMUTABLE) Immutable. The resource name of the form definition used
            to create this form.
             Format: formDefinitions/{form_definition}
            string.example = ["formDefinitions/kyc-beneficial-ownership"]
        formkitSchema:
          title: formkit_schema
          description: >-
            Output only. The schema of the form, derived from the form
            definition.
          readOnly: true
          $ref: >-
            #/components/schemas/bndry.api.datacollection.forms.v1alpha.FormKitSchema
        response:
          title: response
          description: >-
            Required. The responses to the form questions, stored as a JSON
            object.
          $ref: '#/components/schemas/google.protobuf.Struct'
        createTime:
          title: create_time
          description: Output only. The timestamp when the form was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the form was most recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        etag:
          type: string
          title: etag
          description: >-
            (OPTIONAL) Optional. The etag of the resource. Used for optimistic
            concurrency control
             as per AIP-154.
        displayName:
          type: string
          examples:
            - KYC Identity Verification - Jane Smith
          title: display_name
          description: >
            (OPTIONAL) Optional. A mutable, user-settable field for providing a
            human-readable
             name for the form, to be used in user interfaces. Must be <= 63
             characters.
            string.example = ["KYC Identity Verification - Jane Smith"]
        workspaces:
          type: array
          items:
            type: string
            examples:
              - workspaces/due-diligence-ws-123
            description: |
              (OPTIONAL)
              string.example = ["workspaces/due-diligence-ws-123"]
          title: workspaces
          description: '(OPTIONAL) '
        automations:
          type: array
          items:
            type: string
            examples:
              - automations/kyc-risk-assessment-auto-456
            description: |
              (OPTIONAL)
              string.example = ["automations/kyc-risk-assessment-auto-456"]
          title: automations
          description: '(OPTIONAL) '
        state:
          title: state
          description: |-
            Output only. The current state of the form.
             State can be changed using custom methods like `CloseForm` or `SubmitForm`.
          readOnly: true
          $ref: >-
            #/components/schemas/bndry.api.datacollection.forms.v1alpha.Form.State
      title: Form
      required:
        - response
      additionalProperties: false
      description: Represents a form instance, including its responses.
    bndry.api.datacollection.forms.v1alpha.GetFormRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - workspaces/kyc-review-ws-789/forms/identity-verification-form
          title: name
          description: >
            Required. The resource name of the workspace form to retrieve.
             Format: forms/{form}
             Format: workspaces/{workspace}/forms/{form}
            string.example =
            ["workspaces/kyc-review-ws-789/forms/identity-verification-form"]
      title: GetFormRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [FormService.GetForm][bndry.api.forms.v1alpha.FormService.GetForm].
    bndry.api.datacollection.forms.v1alpha.ListFormsRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - workspaces/aml-monitoring-ws-456
          title: parent
          description: |
            Required. The parent workspace for which to list forms.
             Format: forms/
             Format: workspaces/{workspace}
            string.example = ["workspaces/aml-monitoring-ws-456"]
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of forms to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 forms will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListWorkspaceForms` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListWorkspaceForms` must
             match the call that provided the page token.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of forms to skip before starting to
            collect the result set.
      title: ListFormsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.ListForms][bndry.api.forms.v1alpha.WorkspaceService.ListForms].
         Request message for [FomrService.ListForms][bndry.api.forms.v1alpha.FormService.ListForms].
    bndry.api.datacollection.forms.v1alpha.ListFormsResponse:
      type: object
      properties:
        forms:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form'
          title: forms
          description: The list of workspace forms.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of forms matching the request.
      title: ListFormsResponse
      additionalProperties: false
      description: >-
        Response message for
        [WorkspaceService.ListForms][bndry.api.forms.v1alpha.WorkspaceService.ListForms].
         Response message for [FomrService.ListForms][bndry.api.forms.v1alpha.FormService.ListForms].
    bndry.api.datacollection.forms.v1alpha.SubmitFormRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - forms/customer-due-diligence-form-789
          title: name
          description: |
            Required. The resource name of the form to submit.
             Format: forms/{form}
            string.example = ["forms/customer-due-diligence-form-789"]
      title: SubmitFormRequest
      required:
        - name
      additionalProperties: false
      description: Request message for [bndry.api.forms.v1alpha.FormService.SubmitForm].
    bndry.api.datacollection.forms.v1alpha.SubmitFormResponse:
      type: object
      properties:
        submitTime:
          title: submit_time
          description: The timestamp when the form was submitted.
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: SubmitFormResponse
      additionalProperties: false
      description: Response message for [bndry.api.forms.v1alpha.FormService.SubmitForm].
    bndry.api.datacollection.forms.v1alpha.UpdateFormRequest:
      type: object
      properties:
        form:
          title: form
          description: |-
            Required. The form to update.

             The form's `name` field is used to identify the form to update.
             Format: forms/{form}
             Format: workspaces/{workspace}/forms/{form}
          $ref: '#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form'
        updateMask:
          title: update_mask
          description: |-
            (OPTIONAL) Optional. The list of fields to be updated.

             If not provided (i.e., the mask is omitted), the server will update all
             fields that are populated in the `workspace_form` message in this request
             (i.e., fields that have a non-empty value).

             The special value `*` can be used for a full replacement of the resource,
             equivalent to a PUT operation. When using `*`, be cautious as new fields
             added to the resource in the future will also be updated.

             For robust updates, explicitly specifying the fields is recommended.

             See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
      title: UpdateFormRequest
      required:
        - form
      additionalProperties: false
      description: >-
        Request message for
        [FormService.UpdateForm][bndry.api.forms.v1alpha.FormService.UpdateForm].
    bndry.api.datacollection.workspaces.v1alpha.Workspace.State:
      type: string
      title: State
      enum:
        - STATE_UNSPECIFIED
        - OPEN
        - CLOSED
      description: The state of the workspace.
    bndry.api.datacollection.documents.v1alpha.ListDocumentsRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - workspaces/customer-onboarding-ws-456
          title: parent
          description: |
            Required. The parent workspace for which to list documents.
             Format: workspaces/{workspace}
            string.example = ["workspaces/customer-onboarding-ws-456"]
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of documents to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 documents will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListWorkspaceDocuments` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListWorkspaceDocuments` must
             match the call that provided the page token.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of documents to skip before starting
            to collect the result set.
      title: ListDocumentsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.ListDocuments][bndry.api.forms.v1alpha.WorkspaceService.ListDocuments].
    bndry.api.datacollection.documents.v1alpha.ListDocumentsResponse:
      type: object
      properties:
        documents:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.datacollection.documents.v1alpha.Document
          title: documents
          description: The list of documents.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of documents matching the request.
      title: ListDocumentsResponse
      additionalProperties: false
      description: >-
        Response message for
        [WorkspaceService.ListWorkspaceDocuments][bndry.api.forms.v1alpha.WorkspaceService.ListWorkspaceDocuments].
    bndry.api.datacollection.workspaces.v1alpha.CloseWorkspaceRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - workspaces/compliance-review-ws-456
          title: name
          description: |
            Required. The resource name of the workspace to close.
             Format: workspaces/{workspace}
            string.example = ["workspaces/compliance-review-ws-456"]
      title: CloseWorkspaceRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.CloseWorkspace][bndry.api.forms.v1alpha.WorkspaceService.CloseWorkspace].
    bndry.api.datacollection.workspaces.v1alpha.CreateWorkspaceRequest:
      type: object
      properties:
        workspace:
          title: workspace
          description: Required. The workspace to create.
          $ref: >-
            #/components/schemas/bndry.api.datacollection.workspaces.v1alpha.Workspace
        workspaceId:
          type: string
          examples:
            - aml-review-ws-202412
          title: workspace_id
          maxLength: 63
          minLength: 4
          description: >
            (OPTIONAL) Optional. The ID to use for the workspace, which will
            become the final component of
             the workspace's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["aml-review-ws-202412"]

            string.max_len = 63

            string.min_len = 4
      title: CreateWorkspaceRequest
      required:
        - workspace
      additionalProperties: false
      description: >-
        Request message for
        [bndry.api.forms.v1alpha.WorkspaceService.CreateWorkspace].
    bndry.api.datacollection.workspaces.v1alpha.GetWorkspaceRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - workspaces/kyc-onboarding-ws-789
          title: name
          description: |
            Required. The resource name of the workspace to retrieve.
             Format: workspaces/{workspace}
            no_wildcards // name must not contain wildcards
            string.example = ["workspaces/kyc-onboarding-ws-789"]
      title: GetWorkspaceRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.GetWorkspace][bndry.api.forms.v1alpha.WorkspaceService.GetWorkspace].
    bndry.api.datacollection.workspaces.v1alpha.ListWorkspacesRequest:
      type: object
      properties:
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of workspaces to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 workspaces will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListWorkspaces` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListWorkspaces` must
             match the call that provided the page token.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of workspaces to skip before
            starting to collect the result set.
        filter:
          type: string
          title: filter
          description: >-
            (OPTIONAL) Optional. A filter expression that filters the results
            listed in the response.
             See AIP-160 for more details.
      title: ListWorkspacesRequest
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.ListWorkspaces][bndry.api.forms.v1alpha.WorkspaceService.ListWorkspaces].
    bndry.api.datacollection.workspaces.v1alpha.ListWorkspacesResponse:
      type: object
      properties:
        workspaces:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.datacollection.workspaces.v1alpha.Workspace
          title: workspaces
          description: The list of workspaces.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of workspaces matching the request.
      title: ListWorkspacesResponse
      additionalProperties: false
      description: >-
        Response message for
        [WorkspaceService.ListWorkspaces][bndry.api.forms.v1alpha.WorkspaceService.ListWorkspaces].
    bndry.api.datacollection.workspaces.v1alpha.UpdateWorkspaceRequest:
      type: object
      properties:
        workspace:
          title: workspace
          description: |-
            Required. The workspace to update.

             The workspace's `name` field is used to identify the workspace to update.
             Format: workspaces/{workspace}
          $ref: >-
            #/components/schemas/bndry.api.datacollection.workspaces.v1alpha.Workspace
        updateMask:
          title: update_mask
          description: |-
            (OPTIONAL) Optional. The list of fields to be updated.

             If not provided (i.e., the mask is omitted), the server will update all
             fields that are populated in the `workspace` message in this request
             (i.e., fields that have a non-empty value).

             The special value `*` can be used for a full replacement of the resource,
             equivalent to a PUT operation. When using `*`, be cautious as new fields
             added to the resource in the future will also be updated.

             For robust updates, explicitly specifying the fields is recommended.

             See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
      title: UpdateWorkspaceRequest
      required:
        - workspace
      additionalProperties: false
      description: >-
        Request message for
        [bndry.api.forms.v1alpha.WorkspaceService.UpdateWorkspace].
    bndry.api.datacollection.workspaces.v1alpha.Workspace:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |-
            (IDENTIFIER) The resource name of the workspace.
             Format: workspaces/{workspace}
        displayName:
          type: string
          examples:
            - Customer Onboarding - Jane Smith
          title: display_name
          maxLength: 63
          minLength: 1
          description: >
            Required. A mutable, user-settable field for providing a
            human-readable
             name for the workspace, to be used in user interfaces. Must be <= 63
             characters.
            string.example = ["Customer Onboarding - Jane Smith"]

            string.max_len = 63

            string.min_len = 1
        formDefinitions:
          type: array
          items:
            type: string
            examples:
              - formDefinitions/kyc-personal-info
            description: |
              (IMMUTABLE)
              string.example = ["formDefinitions/kyc-personal-info"]
          title: form_definitions
          description: >-
            (IMMUTABLE) The resource names of the form definitions used to
            create the initial set of forms in the workspace.
             Format: formDefinitions/{form_definition}
        createTime:
          title: create_time
          description: Output only. The timestamp when the workspace was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: >-
            Output only. The timestamp when the workspace was most recently
            updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        entities:
          type: array
          items:
            type: string
            examples:
              - entities/example-customer-jsmith-001
            description: |
              (UNORDERED_LIST) (OPTIONAL)
              string.example = ["entities/example-customer-jsmith-001"]
          title: entities
          description: >-
            (UNORDERED_LIST) (OPTIONAL) The resource names of the entities
            associated with the workspace.
             Format: entities/{entity}
        state:
          title: state
          description: Output only. The current state of the workspace.
          readOnly: true
          $ref: >-
            #/components/schemas/bndry.api.datacollection.workspaces.v1alpha.Workspace.State
      title: Workspace
      required:
        - displayName
      additionalProperties: false
      description: Represents a workspace, which is a container for forms and related data.
    bndry.api.datacollection.workspaces.v1alpha.WorkspaceMagicLinkRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - workspaces/customer-portal-ws-789
          title: name
          description: >
            Required. The resource name of the workspace for which to create a
            magic link.
             Format: workspaces/{workspace}
            string.example = ["workspaces/customer-portal-ws-789"]
        email:
          type: string
          examples:
            - jane.smith@example.com
          title: email
          format: email
          description: >
            Required. Email address associated with the User to generate the
            magic link for.
             If a user does not exist with this email, they will be created.
            string.email = true // value must be a valid email address

            string.email_empty = true // value is empty, which is not a valid
            email address

            string.example = ["jane.smith@example.com"]
        expirationSecondsTime:
          title: expiration_seconds_time
          description: |-
            (OPTIONAL) Optional. The expiration time of the magic link.
             If not provided, defaults to 1 day.
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: WorkspaceMagicLinkRequest
      required:
        - name
        - email
      additionalProperties: false
      description: >-
        Request message for
        [WorkspaceService.WorkspaceMagicLink][bndry.api.forms.v1alpha.WorkspaceService.WorkspaceMagicLink].
    bndry.api.datacollection.workspaces.v1alpha.WorkspaceMagicLinkResponse:
      type: object
      properties:
        magicLink:
          type: string
          title: magic_link
          description: The generated magic link URL.
      title: WorkspaceMagicLinkResponse
      additionalProperties: false
      description: >-
        Response message for
        [WorkspaceService.WorkspaceMagicLink][bndry.api.forms.v1alpha.WorkspaceService.WorkspaceMagicLink].
    bndry.api.platform.automations.v1alpha.AutomationExecution.State:
      type: string
      title: State
      enum:
        - STATE_UNSPECIFIED
        - ACTIVE
        - REQUIRES_INPUT
        - SUCCEEDED
        - FAILED
        - CANCELLED
    bndry.api.platform.automations.v1alpha.Automation:
      type: object
      properties:
        name:
          type: string
          examples:
            - automations/credit-approval-workflow
          title: name
          description: |
            (IDENTIFIER) The resource name of the automation.
             Format: automations/{automation}
            string.example = ["automations/credit-approval-workflow"]
        displayName:
          type: string
          examples:
            - Credit Approval Workflow
          title: display_name
          description: |
            Human-readable display name.
            string.example = ["Credit Approval Workflow"]
          readOnly: true
        description:
          type: string
          examples:
            - >-
              Automates credit approval process for loan applications, including
              risk assessment, document verification, and compliance checks
          title: description
          description: >
            Description of what the automation does.

            string.example = ["Automates credit approval process for loan
            applications, including risk assessment, document verification, and
            compliance checks"]
          readOnly: true
        inputSchema:
          title: input_schema
          description: Input schema for parameters (JSON schema).
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Struct'
      title: Automation
      additionalProperties: false
      description: >-
        Represents a BNDRY Automation definition and the input parameters (as a
        JSON schema)
         required to run the automation.
         An Automation is a runnable unit of work that might take longer than a request to complete.
         When an Automation is run, an AutomationExecution is created and used to track the state
         of the running execution.
    bndry.api.platform.automations.v1alpha.AutomationExecution:
      type: object
      properties:
        name:
          type: string
          examples:
            - automations/credit-approval-workflow/executions/exec-20240315-001
          title: name
          description: >
            (IDENTIFIER) The resource name of the automation.
             Format: automations/{automation}/executions/{execution}
            string.example =
            ["automations/credit-approval-workflow/executions/exec-20240315-001"]
        automation:
          type: string
          examples:
            - automations/credit-approval-workflow
          title: automation
          description: |
            The automation being executed.
             Format: automations/{automation}
            string.example = ["automations/credit-approval-workflow"]
          readOnly: true
        inputParameters:
          title: input_parameters
          description: Input parameters provided for the execution.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Struct'
        state:
          title: state
          description: Current execution state.
          readOnly: true
          $ref: >-
            #/components/schemas/bndry.api.platform.automations.v1alpha.AutomationExecution.State
        forms:
          type: array
          items:
            type: string
            examples:
              - workspaces/example-financial/forms/kyc-verification-form
            description: >
              string.example =
              ["workspaces/example-financial/forms/kyc-verification-form"]
            readOnly: true
          title: forms
          description: >-
            The resource names of the forms that require a response to continue
            the execution.
          readOnly: true
        error:
          title: error
          description: >-
            Output only. The error which caused the execution to finish
            prematurely.
             The value is only present if the execution's state is `FAILED`
             or `CANCELLED`.
          readOnly: true
          $ref: '#/components/schemas/google.rpc.Status'
        startTime:
          title: start_time
          description: Output only. Timestamp when execution started.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        endTime:
          title: end_time
          description: Output only. Marks the end of execution, successful or not.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: AutomationExecution
      additionalProperties: false
      description: |-
        An AutomationExecution is the running execution of an Automation and
         includes metadata about the current state of the execution and any actions
         that require manual intervention.
    bndry.api.platform.automations.v1alpha.CancelAutomationExecutionRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          description: >
            Required. The resource name of the automation execution to cancel.
             Format: automations/{automation}/executions/{execution}
            correct_name_format // name must follow format
            'automations/*/executions/*'
      title: CancelAutomationExecutionRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.CancelAutomationExecution][bndry.api.core.v1alpha.AutomationService.CancelAutomationExecution].
    bndry.api.platform.automations.v1alpha.GetAutomationExecutionRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          description: >
            Required. The resource name of the automation execution to retrieve.
             Format: automations/{automation}/executions/{execution}
            correct_name_format // name must follow format
            'automations/*/executions/*'
      title: GetAutomationExecutionRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.GetAutomationExecution][bndry.api.core.v1alpha.AutomationService.GetAutomationExecution].
    bndry.api.platform.automations.v1alpha.GetAutomationRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |
            Required. The resource name of the automation to retrieve.
             Format: automations/{automation}
            correct_name_format // name must start with 'automations/'
      title: GetAutomationRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.GetAutomation][bndry.api.core.v1alpha.AutomationService.GetAutomation].
    bndry.api.platform.automations.v1alpha.ListAutomationExecutionsRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: |
            Required. The parent automation resource name.
             Format: automations/{automation}
            correct_parent_format // parent must start with 'automations/'
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of executions to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 executions will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListAutomationExecutions` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListAutomationExecutions` must
             match the call that provided the page token.
        filter:
          type: string
          title: filter
          description: >-
            (OPTIONAL) Optional. A filter expression that filters the results
            listed in the response.
             See AIP-160 for filter syntax.
      title: ListAutomationExecutionsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.ListAutomationExecutions][bndry.api.core.v1alpha.AutomationService.ListAutomationExecutions].
    bndry.api.platform.automations.v1alpha.ListAutomationExecutionsResponse:
      type: object
      properties:
        automationExecutions:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.platform.automations.v1alpha.AutomationExecution
          title: automation_executions
          description: The list of automation executions.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of executions matching the request.
      title: ListAutomationExecutionsResponse
      additionalProperties: false
      description: >-
        Response message for
        [AutomationService.ListAutomationExecutions][bndry.api.core.v1alpha.AutomationService.ListAutomationExecutions].
    bndry.api.platform.automations.v1alpha.ListAutomationsRequest:
      type: object
      properties:
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) Optional. The maximum number of automations to return.
            The service may return fewer than
             this value.
             If unspecified, at most 50 automations will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
        pageToken:
          type: string
          title: page_token
          description: >-
            (OPTIONAL) Optional. A page token, received from a previous
            `ListAutomations` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListAutomations` must
             match the call that provided the page token.
        filter:
          type: string
          title: filter
          description: >-
            (OPTIONAL) Optional. A filter expression that filters the results
            listed in the response.
             See AIP-160 for filter syntax.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of automations to skip before
            starting to collect the result set.
      title: ListAutomationsRequest
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.ListAutomations][bndry.api.core.v1alpha.AutomationService.ListAutomations].
    bndry.api.platform.automations.v1alpha.ListAutomationsResponse:
      type: object
      properties:
        automations:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.platform.automations.v1alpha.Automation
          title: automations
          description: The list of automations.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of automations matching the request.
      title: ListAutomationsResponse
      additionalProperties: false
      description: >-
        Response message for
        [AutomationService.ListAutomations][bndry.api.core.v1alpha.AutomationService.ListAutomations].
    bndry.api.platform.automations.v1alpha.RunAutomationRequest:
      type: object
      properties:
        automation:
          type: string
          title: automation
          description: >
            Required. The resource name of the automation to execute.
             Format: automations/{automation}
            correct_automation_format // automation must start with
            'automations/'
        parameters:
          title: parameters
          description: (OPTIONAL) Optional. Input parameters for the automation execution.
          $ref: '#/components/schemas/google.protobuf.Struct'
      title: RunAutomationRequest
      required:
        - automation
      additionalProperties: false
      description: >-
        Request message for
        [AutomationService.RunAutomation][bndry.api.core.v1alpha.AutomationService.RunAutomation].
    google.longrunning.Operation:
      type: object
      allOf:
        - properties:
            name:
              type: string
              title: name
              description: >-
                The server-assigned name, which is only unique within the same
                service that
                 originally returns it. If you use the default HTTP mapping, the
                 `name` should be a resource name ending with `operations/{unique_id}`.
            metadata:
              title: metadata
              description: >-
                Service-specific metadata associated with the operation.  It
                typically
                 contains progress information and common metadata such as create time.
                 Some services might not provide such metadata.  Any method that returns a
                 long-running operation should document the metadata type, if any.
              $ref: '#/components/schemas/google.protobuf.Any'
            done:
              type: boolean
              title: done
              description: >-
                If the value is `false`, it means the operation is still in
                progress.
                 If `true`, the operation is completed, and either `error` or `response` is
                 available.
        - oneOf:
            - properties:
                error:
                  title: error
                  description: >-
                    The error result of the operation in case of failure or
                    cancellation.
                  $ref: '#/components/schemas/google.rpc.Status'
              title: error
              required:
                - error
            - properties:
                response:
                  title: response
                  description: >-
                    The normal, successful response of the operation.  If the
                    original
                     method returns no data on success, such as `Delete`, the response is
                     `google.protobuf.Empty`.  If the original method is standard
                     `Get`/`Create`/`Update`, the response should be the resource.  For other
                     methods, the response should have the type `XxxResponse`, where `Xxx`
                     is the original method name.  For example, if the original method name
                     is `TakeSnapshot()`, the inferred response type is
                     `TakeSnapshotResponse`.
                  $ref: '#/components/schemas/google.protobuf.Any'
              title: response
              required:
                - response
      title: Operation
      additionalProperties: false
      description: >-
        This resource represents a long-running operation that is the result of
        a
         network API call.
    google.protobuf.Any:
      type: object
      properties:
        type:
          type: string
        value:
          type: string
          format: binary
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
    google.rpc.Status:
      type: object
      properties:
        code:
          type: integer
          title: code
          format: int32
          description: |-
            The status code, which should be an enum value of
             [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          title: message
          description: |-
            A developer-facing error message, which should be in English. Any
             user-facing error message should be localized and sent in the
             [google.rpc.Status.details][google.rpc.Status.details] field, or localized
             by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
          title: details
          description: >-
            A list of messages that carry the error details.  There is a common
            set of
             message types for APIs to use.
      title: Status
      additionalProperties: false
      description: |-
        The `Status` type defines a logical error model that is suitable for
         different programming environments, including REST APIs and RPC APIs. It is
         used by [gRPC](https://github.com/grpc). Each `Status` message contains
         three pieces of data: error code, error message, and error details.

         You can find out more about this error model and how to work with it in the
         [API Design Guide](https://cloud.google.com/apis/design/errors).
    bndry.api.risk.truuth.v1alpha.VerificationStatus:
      type: string
      title: VerificationStatus
      enum:
        - VERIFICATION_STATUS_UNSPECIFIED
        - VERIFICATION_STATUS_DONE
        - VERIFICATION_STATUS_IN_PROGRESS
        - VERIFICATION_STATUS_PROCESSING
        - VERIFICATION_STATUS_ERROR
      description: VerificationStatus indicates the current status of the verification
    bndry.api.risk.truuth.v1alpha.CallbackRequest:
      type: object
      properties:
        verificationId:
          type: string
          title: verification_id
          description: Unique verification identifier
        externalRefId:
          type: string
          title: external_ref_id
          description: Reference identifier for easy identification
        status:
          title: status
          description: Verification status
          $ref: >-
            #/components/schemas/bndry.api.risk.truuth.v1alpha.VerificationStatus
        identityOwner:
          title: identity_owner
          description: Identity owner details from verification
          $ref: >-
            #/components/schemas/bndry.api.risk.truuth.v1alpha.WebhookIdentityOwner
        results:
          title: results
          description: Verification results containing proofing outcomes
          $ref: >-
            #/components/schemas/bndry.api.risk.truuth.v1alpha.VerificationResults
        createdAt:
          title: created_at
          description: Verification created date-time
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: CallbackRequest
      additionalProperties: false
      description: >-
        CallbackRequest represents the webhook payload from Truuth verification
        completion
    bndry.api.risk.truuth.v1alpha.CallbackResponse:
      type: object
      properties:
        success:
          type: boolean
          title: success
          description: Success status
        message:
          type: string
          title: message
          description: Optional message
      title: CallbackResponse
      additionalProperties: false
      description: CallbackResponse acknowledges receipt of the webhook
    bndry.api.risk.truuth.v1alpha.CreateVerificationSessionRequest:
      type: object
      properties:
        identityOwner:
          title: identity_owner
          description: Details of the person being verified.
          $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.IdentityOwner'
      title: CreateVerificationSessionRequest
      required:
        - identityOwner
      additionalProperties: false
      description: CreateSessionRequest initiates a new verification session
    bndry.api.risk.truuth.v1alpha.CreateVerificationSessionResponse:
      type: object
      properties:
        token:
          type: string
          examples:
            - tk_live_abc123xyz789
          title: token
          minLength: 1
          description: |
            The access token required for calling SDK endpoints.
            string.example = ["tk_live_abc123xyz789"]
            string.min_len = 1
        tenant:
          type: string
          examples:
            - example-financial
          title: tenant
          pattern: ^[a-z0-9-]+$
          description: |
            Tenant alias with all letters in lower case.
            string.example = ["example-financial"]
            string.pattern = "^[a-z0-9-]+$"
        apiUrl:
          type: string
          examples:
            - https://api.truuth.com/v1
          title: api_url
          format: uri
          description: |
            The base URL used for the verification submission process.
            string.example = ["https://api.truuth.com/v1"]
            string.uri = true // value must be a valid URI
            string.uri_empty = true // value is empty, which is not a valid URI
        identityOwner:
          title: identity_owner
          description: Details of the person being verified.
          $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.IdentityOwner'
      title: CreateVerificationSessionResponse
      required:
        - identityOwner
      additionalProperties: false
      description: >-
        CreateSessionResponse contains the session details for SDK
        initialization
    bndry.api.risk.truuth.v1alpha.Document:
      type: object
      properties:
        documentType:
          type: string
          title: document_type
        documentDisplayName:
          type: string
          title: document_display_name
        documentClassificationCode:
          type: string
          title: document_classification_code
        category:
          type: string
          title: category
        documentData:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.truuth.v1alpha.Document.DocumentData
          title: document_data
        countryCode:
          type: string
          title: country_code
        securityChecks:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.SecurityCheck'
          title: security_checks
        images:
          type: array
          items:
            type: string
          title: images
        status:
          type: string
          title: status
      title: Document
      additionalProperties: false
      description: Document represents a verified document
    bndry.api.risk.truuth.v1alpha.Document.DocumentData:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          type: string
          title: value
        confidence:
          type: number
          title: confidence
          format: double
      title: DocumentData
      additionalProperties: false
    bndry.api.risk.truuth.v1alpha.IdentityOwner:
      type: object
      oneOf:
        - properties:
            email:
              type: string
              examples:
                - john.smith@example.com
              title: email
              format: email
              description: >
                Customer's email address.

                string.email = true // value must be a valid email address

                string.email_empty = true // value is empty, which is not a
                valid email address

                string.example = ["john.smith@example.com"]
          title: email
          required:
            - email
        - properties:
            mobileNumber:
              type: string
              examples:
                - '+1234567890'
              title: mobile_number
              pattern: ^\+[1-9]\d{6,14}$
              description: |
                Customer's mobile phone number.
                string.example = ["+1234567890"]
                string.pattern = "^\\+[1-9]\\d{6,14}$"
          title: mobile_number
          required:
            - mobileNumber
      title: IdentityOwner
      additionalProperties: false
      description: IdentityOwner contains details of the person being verified.
    bndry.api.risk.truuth.v1alpha.OtherCheckOutcome:
      type: object
      properties:
        type:
          type: string
          title: type
        name:
          type: string
          title: name
        status:
          type: string
          title: status
      title: OtherCheckOutcome
      additionalProperties: false
      description: OtherCheckOutcome represents additional verification checks
    bndry.api.risk.truuth.v1alpha.ProofingOutcome:
      type: object
      properties:
        proofingStatus:
          type: string
          title: proofing_status
          description: 'Status: PASS, FAIL, WARNING'
        proofingType:
          title: proofing_type
          description: Proofing type details
          $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.ProofingType'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.Document'
          title: documents
          description: Document details
        userBehaviourChecks:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.truuth.v1alpha.UserBehaviorCheck
          title: user_behaviour_checks
          description: User behavior checks
      title: ProofingOutcome
      additionalProperties: false
      description: ProofingOutcome represents a single proofing result
    bndry.api.risk.truuth.v1alpha.ProofingType:
      type: object
      properties:
        code:
          type: string
          title: code
        name:
          type: string
          title: name
      title: ProofingType
      additionalProperties: false
      description: ProofingType defines the type of proofing performed
    bndry.api.risk.truuth.v1alpha.Report:
      type: object
      properties:
        type:
          type: string
          title: type
        url:
          type: string
          title: url
        metadata:
          type: object
          title: metadata
          additionalProperties:
            type: string
            title: value
      title: Report
      additionalProperties: false
      description: Report represents additional verification reports
    bndry.api.risk.truuth.v1alpha.Report.MetadataEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          type: string
          title: value
      title: MetadataEntry
      additionalProperties: false
    bndry.api.risk.truuth.v1alpha.SecurityCheck:
      type: object
      properties:
        type:
          type: string
          title: type
        name:
          type: string
          title: name
        status:
          type: string
          title: status
        score:
          type: number
          title: score
          format: double
        subChecks:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.truuth.v1alpha.SecurityCheck.SubCheck
          title: sub_checks
      title: SecurityCheck
      additionalProperties: false
    bndry.api.risk.truuth.v1alpha.SecurityCheck.SubCheck:
      type: object
      properties:
        type:
          type: string
          title: type
        name:
          type: string
          title: name
        score:
          type: number
          title: score
          format: double
      title: SubCheck
      additionalProperties: false
    bndry.api.risk.truuth.v1alpha.UserBehaviorCheck:
      type: object
      properties:
        type:
          type: string
          title: type
        name:
          type: string
          title: name
        status:
          type: string
          title: status
        score:
          type: number
          title: score
          format: double
      title: UserBehaviorCheck
      additionalProperties: false
      description: UserBehaviorCheck represents behavioral verification checks
    bndry.api.risk.truuth.v1alpha.VerificationResults:
      type: object
      properties:
        proofingOutcomes:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.ProofingOutcome'
          title: proofing_outcomes
          description: Proofing outcomes array
        otherCheckOutcomes:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.truuth.v1alpha.OtherCheckOutcome
          title: other_check_outcomes
          description: Other check outcomes
        faceImage:
          type: string
          title: face_image
          description: Face image URL
        reports:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.truuth.v1alpha.Report'
          title: reports
          description: Additional reports
      title: VerificationResults
      additionalProperties: false
      description: VerificationResults contains the verification outcome details
    bndry.api.risk.truuth.v1alpha.WebhookIdentityOwner:
      type: object
      properties:
        givenName:
          type: string
          title: given_name
        familyName:
          type: string
          title: family_name
        middleName:
          type: string
          title: middle_name
        dateOfBirth:
          type: string
          title: date_of_birth
        email:
          type: string
          title: email
        gender:
          type: string
          title: gender
        mobileNumber:
          type: string
          title: mobile_number
      title: WebhookIdentityOwner
      additionalProperties: false
      description: WebhookIdentityOwner contains identity details from webhook
    connect-protocol-version:
      type: number
      title: Connect-Protocol-Version
      enum:
        - 1
      description: Define the version of the Connect protocol
      const: 1
    connect-timeout-header:
      type: number
      title: Connect-Timeout-Ms
      description: Define the timeout, in ms
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/connect.error_details.Any'
          description: >-
            A list of messages that carry the error details. There is no limit
            on the number of messages.
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    connect.error_details.Any:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URL that acts as a globally unique identifier for the type of the
            serialized message. For example:
            `type.googleapis.com/google.rpc.ErrorInfo`. This is used to
            determine the schema of the data in the `value` field and is the
            discriminator for the `debug` field.
        value:
          type: string
          format: binary
          description: >-
            The Protobuf message, serialized as bytes and base64-encoded. The
            specific message type is identified by the `type` field.
        debug:
          oneOf:
            - type: object
              title: Any
              additionalProperties: true
              description: Detailed error information.
          discriminator:
            propertyName: type
          title: Debug
          description: >-
            Deserialized error detail payload. The 'type' field indicates the
            schema. This field is for easier debugging and should not be relied
            upon for application logic.
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message, with an additional debug
        field for ConnectRPC error details.
    bndry.api.platform.events.v1alpha.Event:
      type: object
      properties:
        name:
          type: string
          title: name
          minLength: 1
          description: |
            (IDENTIFIER) The resource name of the event
             Format: "events/{event}" or "entities/{entity}/events/{event}"
            string.min_len = 1
        eventType:
          type: string
          title: event_type
          minLength: 1
          description: |
            The type of event
            string.min_len = 1
        eventPayload:
          type: string
          title: event_payload
          format: byte
          description: (OPTIONAL) The event payload as raw bytes
        createTime:
          title: create_time
          description: The time when the event was created
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        creator:
          type: string
          title: creator
          minLength: 1
          description: |
            The user ID who created the event
            string.min_len = 1
      title: Event
      required:
        - eventType
        - createTime
        - creator
      additionalProperties: false
      description: Event represents a single event in the system
    bndry.api.platform.events.v1alpha.GetEventRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          minLength: 1
          description: |
            The resource name of the event to retrieve
             Format: "events/{event}" or "entities/{entity}/events/{event}"
            string.min_len = 1
      title: GetEventRequest
      required:
        - name
      additionalProperties: false
      description: Request message for GetEvent
    bndry.api.platform.events.v1alpha.ListEventsRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: |-
            The parent resource name to list events for
             Format: "entities/{entity}" - if provided, lists events for the specific entity
             If not provided, lists all events
        pageSize:
          type: integer
          title: page_size
          format: int32
          description: >-
            (OPTIONAL) The maximum number of events to return. The service may
            return fewer than this value.
             If unspecified, at most 10 events will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
        pageToken:
          type: string
          title: page_token
          description: |-
            (OPTIONAL) A page token, received from a previous `ListEvents` call.
             Provide this to retrieve the subsequent page.
        skip:
          type: integer
          title: skip
          format: int32
          description: >-
            (OPTIONAL) Optional. The number of resources to skip over before
            returning resources.
             Default is 0. See: https://google.aip.dev/158#skipping-results
      title: ListEventsRequest
      required:
        - parent
      additionalProperties: false
      description: Request message for ListEvents
    bndry.api.platform.events.v1alpha.ListEventsResponse:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.platform.events.v1alpha.Event'
          title: events
          description: The list of events
        nextPageToken:
          type: string
          title: next_page_token
          description: |-
            A token to retrieve the next page of results.
             If this field is omitted, there are no subsequent pages.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of events (may be an estimate)
      title: ListEventsResponse
      additionalProperties: false
      description: Response message for ListEvents
    bndry.api.platform.notes.v1alpha.CreateNoteRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - entities/customer-acme-corp
          title: parent
          description: >
            Required. The parent resource name.
             Format: entities/{entity} or workspaces/{workspace}
            correct_parent_format // parent must start with 'entities/' or
            'workspaces/'

            string.example = ["entities/customer-acme-corp"]
        note:
          title: note
          description: Required. The note to create.
          $ref: '#/components/schemas/bndry.api.platform.notes.v1alpha.Note'
        noteId:
          type: string
          examples:
            - note-20240315-compliance-review
          title: note_id
          maxLength: 63
          minLength: 4
          description: >
            (OPTIONAL) Optional. The ID to use for the note, which will become
            the final component of
             the note's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["note-20240315-compliance-review"]

            string.max_len = 63

            string.min_len = 4
      title: CreateNoteRequest
      required:
        - parent
        - note
      additionalProperties: false
      description: Request message for CreateNote.
    bndry.api.platform.notes.v1alpha.DeleteNoteRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/customer-acme-corp/notes/note-20240315-compliance-review
          title: name
          description: >
            Required. The resource name of the note to delete.
             Format: notes/{note}
            string.example =
            ["entities/customer-acme-corp/notes/note-20240315-compliance-review"]
      title: DeleteNoteRequest
      required:
        - name
      additionalProperties: false
      description: Request message for DeleteNote.
    bndry.api.platform.notes.v1alpha.GetNoteRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/customer-acme-corp/notes/note-20240315-compliance-review
          title: name
          description: >
            Required. The resource name of the note to retrieve.
             Format: notes/{note}
            correct_name_format // name must follow format 'entities/*/notes/*'
            or 'workspaces/*/notes/*'

            string.example =
            ["entities/customer-acme-corp/notes/note-20240315-compliance-review"]
      title: GetNoteRequest
      required:
        - name
      additionalProperties: false
      description: Request message for GetNote.
    bndry.api.platform.notes.v1alpha.ListNotesRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - workspaces/example-financial
          title: parent
          description: >
            Required. The parent resource name.
             Format: entities/{entity} or workspaces/{workspace}
            correct_parent_format // parent must start with 'entities/' or
            'workspaces/'

            string.example = ["workspaces/example-financial"]
        pageSize:
          type: integer
          examples:
            - 50
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of notes to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 notes will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
            int32.example = [50]
        pageToken:
          type: string
          examples:
            - CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA
          title: page_token
          description: |
            (OPTIONAL) Optional. A page token, received from a previous call.
             Provide this to retrieve the subsequent page.
            string.example = ["CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          format: int32
          description: >
            (OPTIONAL) Optional. The number of resources to skip over before
            returning resources.
             Default is 0. See: https://google.aip.dev/158#skipping-results
            int32.example = [0]
      title: ListNotesRequest
      required:
        - parent
      additionalProperties: false
      description: Request message for ListNotes.
    bndry.api.platform.notes.v1alpha.ListNotesResponse:
      type: object
      properties:
        notes:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.platform.notes.v1alpha.Note'
          title: notes
          description: The list of notes.
        nextPageToken:
          type: string
          title: next_page_token
          description: >-
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
        totalSize:
          type: integer
          title: total_size
          format: int32
          description: The total number of notes matching the request.
      title: ListNotesResponse
      additionalProperties: false
      description: Response message for list notes operations.
    bndry.api.platform.notes.v1alpha.Note:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/customer-acme-corp/notes/note-20240315-compliance-review
          title: name
          description: >
            (IDENTIFIER) The resource name of the note.
             Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}
            string.example =
            ["entities/customer-acme-corp/notes/note-20240315-compliance-review"]
        content:
          type: string
          examples:
            - >-
              Customer completed KYC verification. All documents reviewed and
              approved. Credit score: 750. Ready for loan processing.
          title: content
          description: >
            The content of the note.

            string.example = ["Customer completed KYC verification. All
            documents reviewed and approved. Credit score: 750. Ready for loan
            processing."]
        authorId:
          type: string
          examples:
            - user-sarah-johnson
          title: author_id
          description: |
            The ID of the user who authored the note.
            string.example = ["user-sarah-johnson"]
          readOnly: true
        author:
          type: string
          examples:
            - Sarah Johnson
          title: author
          description: |
            The display name of the author.
            string.example = ["Sarah Johnson"]
          readOnly: true
        createTime:
          title: create_time
          description: Output only. The time when the note was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The time when the note was last updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        isEdited:
          type: boolean
          title: is_edited
          description: Output only. Whether the note has been modified since creation.
          readOnly: true
      title: Note
      required:
        - content
      additionalProperties: false
      description: >-
        A note attached to a resource for internal collaboration and audit
        trails.
    bndry.api.platform.notes.v1alpha.UpdateNoteRequest:
      type: object
      properties:
        note:
          title: note
          description: |-
            Required. The note to update.
             The note's `name` field is used to identify the note to update.
             Format: notes/{note}
          $ref: '#/components/schemas/bndry.api.platform.notes.v1alpha.Note'
        updateMask:
          title: update_mask
          description: |-
            (OPTIONAL) Optional. The list of fields to be updated.
             Currently only 'content' can be updated.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
      title: UpdateNoteRequest
      required:
        - note
      additionalProperties: false
      description: Request message for UpdateNote.
    bndry.api.platform.tenants.v1alpha.GetTenantRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - tenants/example-financial
          title: name
          description: |
            Required. The resource name of the tenant to retrieve.
             Format: tenants/{tenant}
            no_wildcards // name must not contain wildcards
            string.example = ["tenants/example-financial"]
      title: GetTenantRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [TenantService.GetTenant][bndry.api.core.v1alpha.TenantService.GetTenant].
    bndry.api.platform.tenants.v1alpha.Tenant:
      type: object
      properties:
        name:
          type: string
          examples:
            - tenants/example-financial
          title: name
          description: |
            (IDENTIFIER) The resource name of the tenant.
             Format: tenants/{tenant}
            string.example = ["tenants/example-financial"]
        displayName:
          type: string
          examples:
            - Example Financial Services
          title: display_name
          maxLength: 63
          minLength: 1
          description: >
            Optional. A mutable, user-settable field for providing a
            human-readable
             name for the tenant, to be used in user interfaces. Must be <= 63
             characters.
            string.example = ["Example Financial Services"]

            string.max_len = 63

            string.min_len = 1
        createTime:
          title: create_time
          description: Output only. The timestamp when the tenant was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: >-
            Output only. The timestamp when the tenant was most recently
            updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: Tenant
      required:
        - displayName
      additionalProperties: false
    bndry.api.risk.connectid.v1alpha.RetrieveTokensRequest:
      type: object
      properties:
        authorisationServerId:
          type: string
          title: authorisation_server_id
          description: Same authorization server ID from StartAuthorisation
        callbackQuery:
          type: string
          title: callback_query
          description: Raw query string from the callback (e.g. "code=abc&state=xyz")
        codeVerifier:
          type: string
          title: code_verifier
          description: >-
            Transient values from StartAuthorisation for PKCE and replay
            protection
        expectedState:
          type: string
          title: expected_state
        expectedNonce:
          type: string
          title: expected_nonce
      title: RetrieveTokensRequest
      additionalProperties: false
      description: Request to retrieve tokens after authorization callback
    bndry.api.risk.connectid.v1alpha.RetrieveTokensResponse:
      type: object
      properties:
        tokens:
          title: tokens
          description: Raw token set as received from the RP Connector
          $ref: '#/components/schemas/bndry.api.risk.connectid.v1alpha.TokenSet'
        idTokenClaims:
          title: id_token_claims
          description: Decoded ID token claims (schema varies by bank/profile)
          $ref: '#/components/schemas/google.protobuf.Struct'
        xFapiInteractionId:
          type: string
          title: x_fapi_interaction_id
          description: AU-CDR specific header for interaction tracking
      title: RetrieveTokensResponse
      additionalProperties: false
      description: Response containing tokens and decoded claims
    bndry.api.risk.connectid.v1alpha.StartAuthorisationRequest:
      type: object
      properties:
        authorisationServerId:
          type: string
          title: authorisation_server_id
          description: >-
            Identifier of the bank/authorization server (e.g. "au-nab",
            "au-anz")
        essentialClaims:
          type: array
          items:
            type: string
          title: essential_claims
          description: Essential OpenID Connect claims to request
      title: StartAuthorisationRequest
      additionalProperties: false
      description: Request to start the authorization flow
    bndry.api.risk.connectid.v1alpha.StartAuthorisationResponse:
      type: object
      properties:
        authUrl:
          type: string
          title: auth_url
          description: URL the browser must be redirected to
        state:
          type: string
          title: state
          description: Transient values that must be preserved for RetrieveTokens call
        nonce:
          type: string
          title: nonce
        codeVerifier:
          type: string
          title: code_verifier
      title: StartAuthorisationResponse
      additionalProperties: false
      description: Response containing authorization URL and transient values
    bndry.api.risk.connectid.v1alpha.TokenSet:
      type: object
      properties:
        accessToken:
          type: string
          title: access_token
        idToken:
          type: string
          title: id_token
        refreshToken:
          type: string
          title: refresh_token
        expiresIn:
          type:
            - integer
            - string
          title: expires_in
          format: int64
          description: seconds
      title: TokenSet
      additionalProperties: false
      description: Token set returned from the authorization server
    bndry.api.risk.entities.v1alpha.ActivitySource:
      type: string
      title: ActivitySource
      enum:
        - ACTIVITY_SOURCE_UNSPECIFIED
        - ACTIVITY_SOURCE_BNDRY
        - ACTIVITY_SOURCE_RAPID_ID
        - ACTIVITY_SOURCE_TRUUTH
        - ACTIVITY_SOURCE_CONNECT_ID
        - ACTIVITY_SOURCE_HAWK_AI
        - ACTIVITY_SOURCE_KYC6
        - ACTIVITY_SOURCE_CUSTOMER
      description: Sources that can perform activities.
    bndry.api.risk.entities.v1alpha.ActivityType:
      type: string
      title: ActivityType
      enum:
        - ACTIVITY_TYPE_UNSPECIFIED
        - ACTIVITY_TYPE_PEP_AND_SANCTIONS
        - ACTIVITY_TYPE_DOCUMENT_VERIFICATION
        - ACTIVITY_TYPE_IDENTITY_CHECK
        - ACTIVITY_TYPE_RISK_RATING
        - ACTIVITY_TYPE_UNUSUAL_ACTIVITY_REPORT
        - ACTIVITY_TYPE_SUSPICIOUS_MATTER_REPORT
      description: Types of activities.
    bndry.api.risk.entities.v1alpha.Entity.Company.CompanyType:
      type: string
      title: CompanyType
      enum:
        - COMPANY_TYPE_UNSPECIFIED
        - PUBLIC_COMPANY
        - PRIVATE_COMPANY
        - NON_PROFIT
        - GOVERNMENTAL_ORG
        - ASSOCIATION_INCORPORATION
    bndry.api.risk.entities.v1alpha.Entity.Individual.Gender:
      type: string
      title: Gender
      enum:
        - GENDER_UNSPECIFIED
        - MALE
        - FEMALE
        - OTHER
    bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId.GovernmentIdType:
      type: string
      title: GovernmentIdType
      enum:
        - GOVERNMENT_ID_TYPE_UNSPECIFIED
        - PASSPORT
        - DRIVERS_LICENSE
        - NATIONAL_ID
        - RESIDENCE_PERMIT
        - VISA
        - OTHER
        - MEDICARE
    bndry.api.risk.entities.v1alpha.Entity.Partnership.PartnershipType:
      type: string
      title: PartnershipType
      enum:
        - PARTNERSHIP_TYPE_UNSPECIFIED
        - GENERAL_PARTNERSHIP
        - LIMITED_PARTNERSHIP
        - LIMITED_LIABILITY_PARTNERSHIP
    bndry.api.risk.entities.v1alpha.Entity.RegistrationType:
      type: string
      title: RegistrationType
      enum:
        - REGISTRATION_TYPE_UNSPECIFIED
        - ABN
        - ACN
    bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskRating:
      type: string
      title: RiskRating
      enum:
        - RISK_RATING_UNSPECIFIED
        - LOW
        - MEDIUM
        - HIGH
        - CRITICAL
    bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatus:
      type: string
      title: RiskStatus
      enum:
        - RISK_STATUS_UNSPECIFIED
        - ACTIVE
        - PENDING_REVIEW
        - SUSPENDED
        - OFFBOARDED
        - INACTIVE
    bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatusReason:
      type: string
      title: RiskStatusReason
      enum:
        - RISK_STATUS_REASON_UNSPECIFIED
        - NA
        - SUSPECTED_FRAUD
        - CONFIRMED_FRAUD
        - NON_COMPLIANCE
        - OUTSIDE_RISK_APPETITE
        - EXCESSIVE_COMPLAINTS_OR_DISPUTES_CHARGEBACKS
        - EXCESSIVE_ACTIVITY_OR_UNPLANNED_CHANGES_IN_VOLUME
        - BUSINESS_CLOSED_OR_NO_LONGER_PROVIDING_SERVICES
        - OTHER
    bndry.api.risk.entities.v1alpha.Entity.Trust.TrustType:
      type: string
      title: TrustType
      enum:
        - TRUST_TYPE_UNSPECIFIED
        - SPECIAL_DISABILITY
        - DECEASED_ESTATE
        - HYBRID_TRUST
        - FIXED_TRUST
        - DISCRETIONARY_TRUST
        - CASH_MANAGEMENT_UNIT_TRUST
        - PUBLIC_UNIT_TRUST
        - FIXED_UNIT_TRUST
    bndry.api.risk.entities.v1alpha.EntityType:
      type: string
      title: EntityType
      enum:
        - ENTITY_TYPE_UNSPECIFIED
        - INDIVIDUAL
        - COMPANY
        - TRUST
        - PARTNERSHIP
        - SOLE_PROPRIETOR
    bndry.api.risk.entities.v1alpha.RelationshipType:
      type: string
      title: RelationshipType
      enum:
        - RELATIONSHIP_TYPE_UNSPECIFIED
        - DIRECTOR_OF
        - INVERSE_DIRECTOR_OF
        - SHAREHOLDER_OF
        - INVERSE_SHAREHOLDER_OF
        - BENEFICIAL_OWNER_OF
        - INVERSE_BENEFICIAL_OWNER_OF
        - OWNER_OF
        - INVERSE_OWNER_OF
        - UBO_OF
        - INVERSE_UBO_OF
        - EMPLOYEE_OF
        - INVERSE_EMPLOYEE_OF
        - SUPPLIER_OF
        - INVERSE_SUPPLIER_OF
        - AUTHORIZED_REPRESENTATIVE_OF
        - INVERSE_AUTHORIZED_REPRESENTATIVE_OF
        - CUSTOMER_OF
        - INVERSE_CUSTOMER_OF
        - TRUSTEE_OF
        - INVERSE_TRUSTEE_OF
        - SETTLOR_OF
        - INVERSE_SETTLOR_OF
        - BENEFICIARIES_OF
        - INVERSE_BENEFICIARIES_OF
        - PROTECTORS_OF
        - INVERSE_PROTECTORS_OF
        - TRUST_ADMINISTRATOR_OF
        - INVERSE_TRUST_ADMINISTRATOR_OF
        - FAMILY
        - FRIEND
    bndry.api.risk.entities.v1alpha.RelationshipView:
      type: string
      title: RelationshipView
      enum:
        - RELATIONSHIP_VIEW_UNSPECIFIED
        - RELATIONSHIP_VIEW_BASIC
        - RELATIONSHIP_VIEW_TARGET_PARTIAL
        - RELATIONSHIP_VIEW_FULL
    hawk.v1alpha.ScreeningType:
      type: string
      title: ScreeningType
      enum:
        - SCREENING_TYPE_UNSPECIFIED
        - SCREENING_TYPE_SPECIAL_INTEREST_PERSON
        - SCREENING_TYPE_SANCTIONED_ENTITY
        - SCREENING_TYPE_PEP
      description: Possible screening result types
    kyc6.individual.v1alpha.AliasType:
      type: string
      title: AliasType
      enum:
        - ALIAS_TYPE_UNSPECIFIED
        - ALIAS_TYPE_ORIGINAL_SCRIPT_NAME
        - ALIAS_TYPE_NAME_SPELLING_VARIATION
        - ALIAS_TYPE_SHORTENED_NAME
        - ALIAS_TYPE_MAIDEN_NAME
        - ALIAS_TYPE_NICKNAME
        - ALIAS_TYPE_PREVIOUS_NAME
        - ALIAS_TYPE_FAKE_NAME
    kyc6.individual.v1alpha.BusinessDataset:
      type: string
      title: BusinessDataset
      enum:
        - BUSINESS_DATASET_UNSPECIFIED
        - BUSINESS_DATASET_PEP_LINKED
        - BUSINESS_DATASET_SAN_CURRENT
        - BUSINESS_DATASET_SAN_FORMER
        - BUSINESS_DATASET_INS
        - BUSINESS_DATASET_RRE
        - BUSINESS_DATASET_POI
        - BUSINESS_DATASET_REL
        - BUSINESS_DATASET_SOE_CURRENT
        - BUSINESS_DATASET_SOE_FORMER
        - BUSINESS_DATASET_GRI
      description: Business profile datasets
    kyc6.individual.v1alpha.ContactEntryCategory:
      type: string
      title: ContactEntryCategory
      enum:
        - CONTACT_ENTRY_CATEGORY_UNSPECIFIED
        - CONTACT_ENTRY_CATEGORY_TELEPHONE
        - CONTACT_ENTRY_CATEGORY_FAX
        - CONTACT_ENTRY_CATEGORY_MOBILE
        - CONTACT_ENTRY_CATEGORY_EMAIL
    kyc6.individual.v1alpha.DeletionReasonType:
      type: string
      title: DeletionReasonType
      enum:
        - DELETION_REASON_TYPE_UNSPECIFIED
        - DELETION_REASON_TYPE_GOVERNMENT_POSITION_OUT_OF_SCOPE
        - DELETION_REASON_TYPE_ADVERSE_MEDIA_CATEGORY_OUT_OF_SCOPE
        - DELETION_REASON_TYPE_DUPLICATE_PROFILE
        - DELETION_REASON_TYPE_REDUNDANT_PROFILE
        - DELETION_REASON_TYPE_EXPIRED_RISK_RELEVANCE
        - DELETION_REASON_TYPE_OTHER
    kyc6.individual.v1alpha.EvidenceCredibility:
      type: string
      title: EvidenceCredibility
      enum:
        - EVIDENCE_CREDIBILITY_UNSPECIFIED
        - EVIDENCE_CREDIBILITY_LOW
        - EVIDENCE_CREDIBILITY_MEDIUM
        - EVIDENCE_CREDIBILITY_HIGH
    kyc6.individual.v1alpha.Gender:
      type: string
      title: Gender
      enum:
        - GENDER_UNSPECIFIED
        - GENDER_MALE
        - GENDER_FEMALE
      description: Gender enumeration
    kyc6.individual.v1alpha.IndividualAddressType:
      type: string
      title: IndividualAddressType
      enum:
        - INDIVIDUAL_ADDRESS_TYPE_UNSPECIFIED
        - INDIVIDUAL_ADDRESS_TYPE_PLACE_OF_BIRTH
        - INDIVIDUAL_ADDRESS_TYPE_RESIDENTIAL
        - INDIVIDUAL_ADDRESS_TYPE_BUSINESS
        - INDIVIDUAL_ADDRESS_TYPE_PREVIOUS_RESIDENTIAL
        - INDIVIDUAL_ADDRESS_TYPE_PREVIOUS_BUSINESS
    kyc6.individual.v1alpha.IndividualDataset:
      type: string
      title: IndividualDataset
      enum:
        - INDIVIDUAL_DATASET_UNSPECIFIED
        - INDIVIDUAL_DATASET_PEP_CURRENT
        - INDIVIDUAL_DATASET_PEP_FORMER
        - INDIVIDUAL_DATASET_PEP_LINKED
        - INDIVIDUAL_DATASET_SAN_CURRENT
        - INDIVIDUAL_DATASET_SAN_FORMER
        - INDIVIDUAL_DATASET_INS
        - INDIVIDUAL_DATASET_RRE
        - INDIVIDUAL_DATASET_DD
        - INDIVIDUAL_DATASET_POI
        - INDIVIDUAL_DATASET_REL
        - INDIVIDUAL_DATASET_GRI
      description: Individual profile datasets
    kyc6.individual.v1alpha.PepTier:
      type: string
      title: PepTier
      enum:
        - PEP_TIER_UNSPECIFIED
        - PEP_TIER_1
        - PEP_TIER_2
        - PEP_TIER_3
        - PEP_TIER_BY_ASSOCIATION
      description: PEP tier levels
    kyc6.individual.v1alpha.RelCategory:
      type: string
      title: RelCategory
      enum:
        - REL_CATEGORY_UNSPECIFIED
        - REL_CATEGORY_FINANCIAL_REGULATOR
        - REL_CATEGORY_LAW_ENFORCEMENT
    kyc6.individual.v1alpha.SanctionEventType:
      type: string
      title: SanctionEventType
      enum:
        - SANCTION_EVENT_TYPE_UNSPECIFIED
        - SANCTION_EVENT_TYPE_ADDED
        - SANCTION_EVENT_TYPE_AMENDED
        - SANCTION_EVENT_TYPE_REMOVED
    kyc6.individual.v1alpha.SanctionType:
      type: string
      title: SanctionType
      enum:
        - SANCTION_TYPE_UNSPECIFIED
        - SANCTION_TYPE_COUNTER_NARCOTICS
        - SANCTION_TYPE_HOSTILE_ACTIVITIES
        - SANCTION_TYPE_HUMAN_RIGHTS
        - SANCTION_TYPE_NON_PROLIFERATION
        - SANCTION_TYPE_TERRITORIAL_VIOLATION
        - SANCTION_TYPE_TERRORISM
    rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchStatus:
      type: string
      title: MatchStatus
      enum:
        - MATCH_STATUS_UNSPECIFIED
        - MATCH_STATUS_TRUE_POSITIVE
        - MATCH_STATUS_POTENTIAL_MATCH
        - MATCH_STATUS_NO_MATCH
      description: Match status
    bndry.api.reference.geography.v1alpha.Country:
      type: object
      properties:
        label:
          type: string
          examples:
            - United States
          title: label
          minLength: 1
          description: |
            string.example = ["United States"]
            string.min_len = 1
        alphaCode2:
          type: string
          examples:
            - US
          title: alpha_code2
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          description: |
            string.example = ["US"]
            string.len = 2
            string.pattern = "^[A-Z]{2}$"
      title: Country
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.ActivityLog:
      type: object
      properties:
        name:
          type: string
          examples:
            - activityLogs/01234567-89ab-cdef-0123-456789abcdef
          title: name
          description: >
            (IDENTIFIER) The resource name of the activity.
             Format: activityLog/{activity_log}
            string.example =
            ["activityLogs/01234567-89ab-cdef-0123-456789abcdef"]
        type:
          title: type
          description: Required. The type of the activity.
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityType'
        source:
          title: source
          description: Required. The source that performed the activity.
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.ActivitySource'
        payload:
          title: payload
          description: Required. The payload containing activity-specific data.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogPayload
        createTime:
          title: create_time
          description: Output only. The timestamp when the activity was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the activity was last updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        entityNames:
          type: array
          examples:
            - entities/john-smith-001
          items:
            type: string
            examples:
              - entities/john-smith-001
            description: |
              string.example = ["entities/john-smith-001"]
            readOnly: true
          title: entity_names
          description: |
            Output only. The entities involved in this activity.
            string.example = ["entities/john-smith-001"]
          readOnly: true
      title: ActivityLog
      required:
        - type
        - source
        - payload
      additionalProperties: false
      description: Represents an activity performed against one or more entities.
    bndry.api.risk.entities.v1alpha.ActivityLogPayload:
      type: object
      oneOf:
        - properties:
            hawkRiskRatingResult:
              title: hawk_risk_rating_result
              readOnly: true
              $ref: '#/components/schemas/hawk.v1alpha.CheckCustomerResponse'
          title: hawk_risk_rating_result
          required:
            - hawkRiskRatingResult
        - properties:
            kyc6PepSanctionsResult:
              title: kyc6_pep_sanctions_result
              readOnly: true
              $ref: '#/components/schemas/kyc6.individual.v1alpha.ActivityLog'
          title: kyc6_pep_sanctions_result
          required:
            - kyc6PepSanctionsResult
        - properties:
            rapidIdPepSanctionsResult:
              title: rapid_id_pep_sanctions_result
              readOnly: true
              $ref: '#/components/schemas/rapidid.api.aml.v1alpha.ActivityLog'
          title: rapid_id_pep_sanctions_result
          required:
            - rapidIdPepSanctionsResult
        - properties:
            truuthIdentityVerificationResult:
              title: truuth_identity_verification_result
              readOnly: true
              $ref: >-
                #/components/schemas/bndry.api.risk.truuth.v1alpha.CallbackRequest
          title: truuth_identity_verification_result
          required:
            - truuthIdentityVerificationResult
        - properties:
            unusualActivityReport:
              title: unusual_activity_report
              $ref: >-
                #/components/schemas/bndry.api.risk.reporting.v1alpha.UARActivityLog
          title: unusual_activity_report
          required:
            - unusualActivityReport
      title: ActivityLogPayload
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.AddEntityRelationshipRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/john-smith-001
          title: name
          description: |
            correct_name_format // name must start with 'entities/'
            string.example = ["entities/john-smith-001"]
        targetEntity:
          type: string
          examples:
            - entities/example-financial-services
          title: target_entity
          description: |
            correct_name_format // name must start with 'entities/'
            string.example = ["entities/example-financial-services"]
        relationshipType:
          title: relationship_type
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
      title: AddEntityRelationshipRequest
      required:
        - name
        - targetEntity
        - relationshipType
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.CreateActivityLogRequest:
      type: object
      properties:
        activityLog:
          title: activity_log
          description: Required. The entity to create.
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog'
        activityLogId:
          type: string
          examples:
            - activity-log-001
          title: activity_log_id
          maxLength: 63
          minLength: 4
          description: >
            (OPTIONAL) Optional. The ID to use for the entity, which will become
            the final component of
             the entity's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["activity-log-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreateActivityLogRequest
      required:
        - activityLog
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.CreateEntityRequest:
      type: object
      properties:
        entity:
          title: entity
          description: Required. The entity to create.
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
        entityId:
          type: string
          examples:
            - john-smith-001
          title: entity_id
          maxLength: 63
          minLength: 4
          description: >
            (OPTIONAL) Optional. The ID to use for the entity, which will become
            the final component of
             the entity's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["john-smith-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreateEntityRequest
      required:
        - entity
      additionalProperties: false
      description: Request message for [bndry.api.risk.v1alpha.EntityService.CreateEntity].
    bndry.api.risk.entities.v1alpha.DeleteEntityRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/example-financial-services
          title: name
          description: |
            Required. The resource name of the entity to delete.
             Format: entities/{entity}
            string.example = ["entities/example-financial-services"]
      title: DeleteEntityRequest
      required:
        - name
      additionalProperties: false
      description: Request message for [bndry.api.risk.v1alpha.EntityService.DeleteEntity].
    bndry.api.risk.entities.v1alpha.Entity:
      type: object
      allOf:
        - properties:
            name:
              type: string
              title: name
              description: |-
                (IDENTIFIER) The resource name of the entity.
                 Format: entities/{entity}
            displayName:
              type: string
              examples:
                - Example Financial Services Ltd
              title: display_name
              description: >
                (OPTIONAL) Optional. A mutable, user-settable field for
                providing a human-readable
                 name for the entity, to be used in user interfaces. Must be <= 63
                 characters.
                string.example = ["Example Financial Services Ltd"]
            contactInfo:
              title: contact_info
              description: '(OPTIONAL) '
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.ContactInfo
            registration:
              type: object
              title: registration
              additionalProperties:
                title: value
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails
              description: '(OPTIONAL) '
            riskDetails:
              title: risk_details
              description: '(OPTIONAL) '
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails
            entityRelationships:
              type: array
              items:
                $ref: >-
                  #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.EntityRelationship
              title: entity_relationships
              description: '(OPTIONAL) '
            externalIds:
              title: external_ids
              description: '(OPTIONAL) '
              $ref: >-
                #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.ExternalIds
            createTime:
              title: create_time
              description: Output only. The timestamp when the entity was created.
              readOnly: true
              $ref: '#/components/schemas/google.protobuf.Timestamp'
            updateTime:
              title: update_time
              description: >-
                Output only. The timestamp when the entity was most recently
                updated.
              readOnly: true
              $ref: '#/components/schemas/google.protobuf.Timestamp'
            purgeTime:
              title: purge_time
              description: >-
                Output only. The timestamp when the entity will be purged if
                soft-deleted.
                 See AIP-164.
              readOnly: true
              $ref: '#/components/schemas/google.protobuf.Timestamp'
            annotations:
              type: object
              title: annotations
              additionalProperties:
                type: string
                title: value
              description: |-
                (OPTIONAL) Optional. Annotations for arbitrary metadata.
                 See AIP-148.
            etag:
              type: string
              examples:
                - abc123
              title: etag
              description: >
                Optional. The etag of the resource. Used for optimistic
                concurrency control
                 as per AIP-154.
                string.example = ["abc123"]
        - oneOf:
            - properties:
                company:
                  title: company
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Company
              title: company
              required:
                - company
            - properties:
                individual:
                  title: individual
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual
              title: individual
              required:
                - individual
            - properties:
                partnership:
                  title: partnership
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Partnership
              title: partnership
              required:
                - partnership
            - properties:
                soleProprietor:
                  title: sole_proprietor
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.SoleProprietor
              title: sole_proprietor
              required:
                - soleProprietor
            - properties:
                trust:
                  title: trust
                  $ref: >-
                    #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Trust
              title: trust
              required:
                - trust
      title: Entity
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.AnnotationsEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          type: string
          title: value
      title: AnnotationsEntry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Company:
      type: object
      properties:
        type:
          title: type
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Company.CompanyType
        industry:
          type: string
          examples:
            - Financial Services
          title: industry
          description: |
            string.example = ["Financial Services"]
      title: Company
      required:
        - type
        - industry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.ContactInfo:
      type: object
      properties:
        telephone:
          type: array
          items:
            type: string
            examples:
              - +61 2 9876 5432
            description: |
              (OPTIONAL)
              string.example = ["+61 2 9876 5432"]
          title: telephone
          description: '(OPTIONAL) '
        businessTelephone:
          type: array
          items:
            type: string
            examples:
              - +61 2 9876 5400
            description: |
              (OPTIONAL)
              string.example = ["+61 2 9876 5400"]
          title: business_telephone
          description: '(OPTIONAL) '
        emailAddress:
          type: array
          items:
            type: string
            examples:
              - john.smith@example.com
            format: email
            description: >
              (OPTIONAL)

              string.email = true // value must be a valid email address

              string.email_empty = true // value is empty, which is not a valid
              email address

              string.example = ["john.smith@example.com"]
          title: email_address
          description: '(OPTIONAL) '
        primaryContact:
          type: array
          items:
            type: string
            examples:
              - Sarah Johnson
            description: |
              (OPTIONAL)
              string.example = ["Sarah Johnson"]
          title: primary_contact
          description: '(OPTIONAL) '
        website:
          type: array
          items:
            type: string
            examples:
              - https://www.example.com
            description: |
              (OPTIONAL)
              string.example = ["https://www.example.com"]
          title: website
          description: '(OPTIONAL) '
        registeredBusinessAddresses:
          type: array
          items:
            $ref: '#/components/schemas/google.type.PostalAddress'
          title: registered_business_addresses
          description: '(OPTIONAL) '
        principalBusinessAddresses:
          type: array
          items:
            $ref: '#/components/schemas/google.type.PostalAddress'
          title: principal_business_addresses
          description: '(OPTIONAL) '
        residentialAddresses:
          type: array
          items:
            $ref: '#/components/schemas/google.type.PostalAddress'
          title: residential_addresses
          description: '(OPTIONAL) '
      title: ContactInfo
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.EntityRelationship:
      type: object
      properties:
        id:
          type: string
          title: id
          readOnly: true
        sourceEntity:
          type: string
          examples:
            - entities/john-smith
          title: source_entity
          description: |
            (OPTIONAL) string.example = ["entities/john-smith"]
        targetEntity:
          type: string
          examples:
            - entities/example-financial-services
          title: target_entity
          description: |
            (OPTIONAL) string.example = ["entities/example-financial-services"]
        type:
          title: type
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
        displayName:
          type: string
          title: display_name
          readOnly: true
        entityType:
          type: string
          title: entity_type
          readOnly: true
      title: EntityRelationship
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.ExternalIds:
      type: object
      properties:
        cherryhub:
          type: string
          title: cherryhub
          description: (OPTIONAL) CherryHub external identifier.
        custom:
          type: object
          title: custom
          additionalProperties:
            type: string
            title: value
          description: (OPTIONAL) Custom external identifiers as key-value pairs.
      title: ExternalIds
      additionalProperties: false
      description: External ID mappings for an entity.
    bndry.api.risk.entities.v1alpha.Entity.ExternalIds.CustomEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          type: string
          title: value
      title: CustomEntry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Individual:
      type: object
      properties:
        title:
          type: string
          examples:
            - Mr.
          title: title
          description: |
            (OPTIONAL) Optional. The individual's title, e.g., "Mr.", "Dr.".
            string.example = ["Mr."]
        givenName:
          type: string
          examples:
            - John
          title: given_name
          description: |
            (OPTIONAL) Optional. The individual's given name.
            string.example = ["John"]
        middleName:
          type: string
          examples:
            - Robert
          title: middle_name
          description: |
            (OPTIONAL) Optional. The individual's middle name or initial.
            string.example = ["Robert"]
        familyName:
          type: string
          examples:
            - Smith
          title: family_name
          description: |
            (OPTIONAL) Optional. The individual's family name.
            string.example = ["Smith"]
        birthDate:
          title: birth_date
          description: |
            (OPTIONAL) Optional. The individual's date and time of birth.
            birth_date.year_range // birth year must be on or after 1900
          $ref: '#/components/schemas/google.type.Date'
        birthPlace:
          type: string
          examples:
            - Sydney, NSW, Australia
          title: birth_place
          description: |
            (OPTIONAL) string.example = ["Sydney, NSW, Australia"]
        gender:
          title: gender
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.Gender
        nationality:
          type: string
          examples:
            - Australian
          title: nationality
          description: |
            (OPTIONAL) string.example = ["Australian"]
        residenceCountry:
          type: string
          examples:
            - AU
          title: residence_country
          description: |
            (OPTIONAL) string.example = ["AU"]
        citizenshipCountry:
          type: array
          items:
            type: string
            examples:
              - AU
            description: |
              (OPTIONAL)
              string.example = ["AU"]
          title: citizenship_country
          description: '(OPTIONAL) '
        occupation:
          type: string
          examples:
            - Senior Financial Analyst
          title: occupation
          description: |
            (OPTIONAL) string.example = ["Senior Financial Analyst"]
        employer:
          type: string
          examples:
            - Example Financial Services Ltd
          title: employer
          description: |
            (OPTIONAL) string.example = ["Example Financial Services Ltd"]
        alias:
          type: string
          examples:
            - Johnny
          title: alias
          description: |
            (OPTIONAL) string.example = ["Johnny"]
        governmentId:
          type: object
          title: government_id
          additionalProperties:
            title: value
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId
          description: '(OPTIONAL) '
      title: Individual
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId:
      type: object
      properties:
        number:
          type: string
          examples:
            - N1234567
          title: number
          description: |
            string.example = ["N1234567"]
        issuer:
          type: string
          examples:
            - Service NSW
          title: issuer
          description: |
            string.example = ["Service NSW"]
        regionCode:
          type: string
          examples:
            - NSW
          title: region_code
          description: |
            string.example = ["NSW"]
        expiryDateTime:
          title: expiry_date_time
          description: '(OPTIONAL) '
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: GovernmentId
      required:
        - number
        - issuer
        - regionCode
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentIdEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId
      title: GovernmentIdEntry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Partnership:
      type: object
      properties:
        type:
          title: type
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Partnership.PartnershipType
        industry:
          type: string
          examples:
            - Financial Advisory
          title: industry
          description: |
            string.example = ["Financial Advisory"]
      title: Partnership
      required:
        - type
        - industry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails:
      type: object
      properties:
        value:
          type: string
          examples:
            - 12 345 678 901
          title: value
          description: |
            (OPTIONAL) string.example = ["12 345 678 901"]
        registrationDateTime:
          title: registration_date_time
          description: '(OPTIONAL) '
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        regionCode:
          type: string
          examples:
            - NSW
          title: region_code
          description: |
            (OPTIONAL) string.example = ["NSW"]
        tradingName:
          type: string
          examples:
            - Example Financial Services
          title: trading_name
          description: |
            (OPTIONAL) string.example = ["Example Financial Services"]
        registeredName:
          type: string
          examples:
            - Example Financial Services Pty Ltd
          title: registered_name
          description: |
            (OPTIONAL) string.example = ["Example Financial Services Pty Ltd"]
      title: RegistrationDetails
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.RegistrationEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails
      title: RegistrationEntry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.RiskDetails:
      type: object
      properties:
        riskStatus:
          title: risk_status
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatus
        riskStatusReason:
          title: risk_status_reason
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatusReason
        riskRating:
          title: risk_rating
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskRating
      title: RiskDetails
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.SoleProprietor:
      type: object
      properties:
        industry:
          type: string
          examples:
            - Financial Planning
          title: industry
          description: |
            string.example = ["Financial Planning"]
      title: SoleProprietor
      required:
        - industry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.Entity.Trust:
      type: object
      properties:
        type:
          title: type
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Trust.TrustType
        trust:
          type: string
          examples:
            - Smith Family Trust
          title: trust
          description: |
            (OPTIONAL) string.example = ["Smith Family Trust"]
        settler:
          type: string
          examples:
            - John Robert Smith
          title: settler
          description: |
            (OPTIONAL) string.example = ["John Robert Smith"]
        trustee:
          type: string
          examples:
            - Example Trust Services Pty Ltd
          title: trustee
          description: |
            (OPTIONAL) string.example = ["Example Trust Services Pty Ltd"]
        deed:
          type: string
          examples:
            - Smith Family Trust Deed 2024
          title: deed
          description: |
            (OPTIONAL) string.example = ["Smith Family Trust Deed 2024"]
      title: Trust
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.GetActivityLogRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - activityLogs/01234567-89ab-cdef-0123-456789abcdef
          title: name
          description: >
            Required. The resource name of the activity to retrieve.
             Format: activityLog/{activity_log}
            correct_name_format // name must start with 'activityLogs/'

            string.example =
            ["activityLogs/01234567-89ab-cdef-0123-456789abcdef"]
      title: GetActivityLogRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.GetActivityLog][bndry.api.risk.v1alpha.EntityService.GetActivityLog].
    bndry.api.risk.entities.v1alpha.GetEntityRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/john-smith-001
          title: name
          description: |
            Required. The resource name of the entity to retrieve.
             Format: entities/{entity}
             For external ID lookup, use format: entities/{external_id}?system={external_system}
             Examples:
               - entities/john-smith-001 (direct lookup)
               - entities/12345?system=salesforce (external ID lookup)
            correct_name_format // name must start with 'entities/'
            string.example = ["entities/john-smith-001"]
        system:
          type: string
          examples:
            - salesforce
          title: system
          description: >
            (OPTIONAL) Optional. External system identifier for external ID
            lookup.
             When provided, the entity ID in name is treated as an external ID.
            string.example = ["salesforce"]
      title: GetEntityRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.GetEntity][bndry.api.risk.v1alpha.EntityService.GetEntity].
    bndry.api.risk.entities.v1alpha.ListActivityLogsRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - entities/john-smith-001
          title: parent
          description: >
            Required. The resource name of the entity for which to list
            activities.
             Format: entities/{entity}
            correct_parent_format // parent must start with 'entities/'

            string.example = ["entities/john-smith-001"]
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of activities to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 activities will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListEntityActivities` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListEntityActivities` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAE"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          format: int32
          description: >
            (OPTIONAL) Optional. The number of resources to skip over before
            returning resources.
             Default is 0. See: https://google.aip.dev/158#skipping-results
            int32.example = [0]
      title: ListActivityLogsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.ListEntityActivities][bndry.api.risk.v1alpha.EntityService.ListEntityActivities].
    bndry.api.risk.entities.v1alpha.ListActivityLogsResponse:
      type: object
      properties:
        activityLogs:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog'
          title: activity_logs
          description: The list of activities.
        nextPageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example = ["ChAIAhABGAE"]
        totalSize:
          type: integer
          examples:
            - 127
          title: total_size
          format: int32
          description: |
            The total number of entities matching the request.
            int32.example = [127]
      title: ListActivityLogsResponse
      additionalProperties: false
      description: >-
        Response message for
        [EntityService.ListEntityActivities][bndry.api.risk.v1alpha.EntityService.ListEntityActivities].
    bndry.api.risk.entities.v1alpha.ListCountriesRequest:
      type: object
      properties:
        pageSize:
          type: integer
          examples:
            - 50
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of countries to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 countries will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
            int32.example = [50]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListCountries` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListCountries` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAE"]
      title: ListCountriesRequest
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.ListCountries][bndry.api.risk.v1alpha.EntityService.ListCountries].
    bndry.api.risk.entities.v1alpha.ListCountriesResponse:
      type: object
      properties:
        countries:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.reference.geography.v1alpha.Country'
          title: countries
          description: The list of countries.
        nextPageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example = ["ChAIAhABGAE"]
        totalSize:
          type: integer
          examples:
            - 249
          title: total_size
          format: int32
          description: |
            The total number of countries matching the request.
            int32.example = [249]
      title: ListCountriesResponse
      additionalProperties: false
      description: >-
        Response message for
        [EntityService.ListCountries][bndry.api.risk.v1alpha.EntityService.ListCountries].
    bndry.api.risk.entities.v1alpha.ListEntitiesRequest:
      type: object
      properties:
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of entities to return. The
            service may return fewer than
             this value.
             If unspecified, at most 50 entities will be returned.
             The maximum value is 1000; values above 1000 will be coerced to 1000.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListEntities` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListEntities` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAE"]
        showDeleted:
          type: boolean
          title: show_deleted
          description: >-
            (OPTIONAL) Optional. If true, soft-deleted entities will be included
            in the response.
             See AIP-164.
        skip:
          type: integer
          examples:
            - 50
          title: skip
          format: int32
          description: >
            (OPTIONAL) Optional. The number of entities to skip before starting
            to collect the result set.

            int32.example = [50]
        filter:
          type: string
          examples:
            - John Smith
          title: filter
          description: >
            (OPTIONAL) Optional. A filter expression that filters the results
            listed in the response.
             Filter only currently supports a fuzzy search on display name.
             See AIP-160 for more details.
            string.example = ["John Smith"]
        orderBy:
          type: string
          examples:
            - displayName desc
          title: order_by
          description: |
            (OPTIONAL) string.example = ["displayName desc"]
      title: ListEntitiesRequest
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.ListEntities][bndry.api.risk.v1alpha.EntityService.ListEntities].
    bndry.api.risk.entities.v1alpha.ListEntitiesResponse:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
          title: entities
          description: The list of entities.
        nextPageToken:
          type: string
          examples:
            - ChAIAhABGAE
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example = ["ChAIAhABGAE"]
        totalSize:
          type: integer
          examples:
            - 127
          title: total_size
          format: int32
          description: |
            The total number of entities matching the request.
            int32.example = [127]
      title: ListEntitiesResponse
      additionalProperties: false
      description: >-
        Response message for
        [EntityService.ListEntities][bndry.api.risk.v1alpha.EntityService.ListEntities].
    bndry.api.risk.entities.v1alpha.RemoveEntityRelationshipRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/example-financial-services
          title: name
          description: |
            correct_name_format // name must start with 'entities/'
            string.example = ["entities/example-financial-services"]
        targetEntity:
          type: string
          examples:
            - entities/john-smith-001
          title: target_entity
          description: |
            correct_name_format // name must start with 'entities/'
            string.example = ["entities/john-smith-001"]
        relationshipType:
          title: relationship_type
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
      title: RemoveEntityRelationshipRequest
      required:
        - name
        - targetEntity
        - relationshipType
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.UndeleteEntityRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/john-smith-001
          title: name
          description: |
            Required. The resource name of the entity to undelete.
             Format: entities/{entity}
            string.example = ["entities/john-smith-001"]
      title: UndeleteEntityRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [bndry.api.risk.v1alpha.EntityService.UndeleteEntity].
    bndry.api.risk.entities.v1alpha.UpdateEntityRequest:
      type: object
      properties:
        entity:
          title: entity
          description: |-
            Required. The entity to update.

             The entity's `name` field is used to identify the entity to update.
             Format: entities/{entity}
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.Entity'
        updateMask:
          title: update_mask
          description: |-
            (OPTIONAL) Optional. The list of fields to be updated.

             If not provided (i.e., the mask is omitted), the server will update all
             fields that are populated in the `entity` message in this request
             (i.e., fields that have a non-empty value).

             The special value `*` can be used for a full replacement of the resource,
             equivalent to a PUT operation. When using `*`, be cautious as new fields
             added to the resource in the future will also be updated.

             For robust updates, explicitly specifying the fields is recommended.

             See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
      title: UpdateEntityRequest
      required:
        - entity
      additionalProperties: false
      description: Request message for [bndry.api.risk.v1alpha.EntityService.UpdateEntity].
    bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/john-smith-001
          title: name
          description: >
            Required. The resource name of the entity for which to view
            relationships.
             Format: entities/{entity}
            string.example = ["entities/john-smith-001"]
        view:
          title: view
          description: '(OPTIONAL) '
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipView
      title: ViewEntityRelationshipsRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [EntityService.ViewEntityRelationships][bndry.api.risk.v1alpha.EntityService.ViewEntityRelationships].
    bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse:
      type: object
      properties:
        entityRelationships:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse.EntityRelationships
          title: entity_relationships
      title: ViewEntityRelationshipsResponse
      additionalProperties: false
      description: >-
        Response message for
        [EntityService.ViewEntityRelationships][bndry.api.risk.v1alpha.EntityService.ViewEntityRelationships].
    bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse.EntityRelationships:
      type: object
      properties:
        relationshipType:
          title: relationship_type
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType
        name:
          type: string
          examples:
            - entities/example-financial-services
          title: name
          description: |
            The resource name of the related entity.
             Format: entities/{entity}
            string.example = ["entities/example-financial-services"]
        displayName:
          type: string
          examples:
            - Example Financial Services Ltd
          title: display_name
          description: |
            (OPTIONAL) Optional. The display name of the related entity.
            string.example = ["Example Financial Services Ltd"]
        entityType:
          title: entity_type
          description: (OPTIONAL) Optional. The type of the related entity.
          $ref: '#/components/schemas/bndry.api.risk.entities.v1alpha.EntityType'
      title: EntityRelationships
      additionalProperties: false
    bndry.api.risk.reporting.v1alpha.ReportDetails:
      type: object
      properties:
        documentIds:
          type: array
          items:
            type: string
          title: document_ids
          description: document_ids of the uploaded report
        comments:
          type: string
          title: comments
          description: Additional comments to be included
        incidentDate:
          title: incident_date
          description: Date the incident occurred
          $ref: '#/components/schemas/google.type.Date'
        reportedDate:
          title: reported_date
          description: Date the incident was reported
          $ref: '#/components/schemas/google.type.Date'
      title: ReportDetails
      required:
        - documentIds
        - incidentDate
        - reportedDate
      additionalProperties: false
    bndry.api.risk.reporting.v1alpha.UARActivityLog:
      type: object
      properties:
        reportDetails:
          title: report_details
          $ref: '#/components/schemas/bndry.api.risk.reporting.v1alpha.ReportDetails'
      title: UARActivityLog
      required:
        - reportDetails
      additionalProperties: false
    google.type.Date:
      type: object
      properties:
        year:
          type: integer
          title: year
          format: int32
          description: >-
            Year of the date. Must be from 1 to 9999, or 0 to specify a date
            without
             a year.
        month:
          type: integer
          title: month
          format: int32
          description: >-
            Month of a year. Must be from 1 to 12, or 0 to specify a year
            without a
             month and day.
        day:
          type: integer
          title: day
          format: int32
          description: >-
            Day of a month. Must be from 1 to 31 and valid for the year and
            month, or 0
             to specify a year by itself or a year and month where the day isn't
             significant.
      title: Date
      additionalProperties: false
      description: >-
        Represents a whole or partial calendar date, such as a birthday. The
        time of
         day and time zone are either specified elsewhere or are insignificant. The
         date is relative to the Gregorian Calendar. This can represent one of the
         following:

         * A full date, with non-zero year, month, and day values
         * A month and day value, with a zero year, such as an anniversary
         * A year on its own, with zero month and day values
         * A year and month value, with a zero day, such as a credit card expiration
         date

         Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
         `google.protobuf.Timestamp`.
    google.type.PostalAddress:
      type: object
      properties:
        revision:
          type: integer
          title: revision
          format: int32
          description: >-
            The schema revision of the `PostalAddress`. This must be set to 0,
            which is
             the latest revision.

             All new revisions **must** be backward compatible with old revisions.
        regionCode:
          type: string
          title: region_code
          description: >-
            Required. CLDR region code of the country/region of the address.
            This
             is never inferred and it is up to the user to ensure the value is
             correct. See http://cldr.unicode.org/ and
             http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
             for details. Example: "CH" for Switzerland.
        languageCode:
          type: string
          title: language_code
          description: |-
            Optional. BCP-47 language code of the contents of this address (if
             known). This is often the UI language of the input form or is expected
             to match one of the languages used in the address' country/region, or their
             transliterated equivalents.
             This can affect formatting in certain countries, but is not critical
             to the correctness of the data and will never affect any validation or
             other non-formatting related operations.

             If this value is not known, it should be omitted (rather than specifying a
             possibly incorrect default).

             Examples: "zh-Hant", "ja", "ja-Latn", "en".
        postalCode:
          type: string
          title: postal_code
          description: >-
            Optional. Postal code of the address. Not all countries use or
            require
             postal codes to be present, but where they are used, they may trigger
             additional validation with other parts of the address (e.g. state/zip
             validation in the U.S.A.).
        sortingCode:
          type: string
          title: sorting_code
          description: >-
            Optional. Additional, country-specific, sorting code. This is not
            used
             in most regions. Where it is used, the value is either a string like
             "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
             alone, representing the "sector code" (Jamaica), "delivery area indicator"
             (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
        administrativeArea:
          type: string
          title: administrative_area
          description: >-
            Optional. Highest administrative subdivision which is used for
            postal
             addresses of a country or region.
             For example, this can be a state, a province, an oblast, or a prefecture.
             Specifically, for Spain this is the province and not the autonomous
             community (e.g. "Barcelona" and not "Catalonia").
             Many countries don't use an administrative area in postal addresses. E.g.
             in Switzerland this should be left unpopulated.
        locality:
          type: string
          title: locality
          description: |-
            Optional. Generally refers to the city/town portion of the address.
             Examples: US city, IT comune, UK post town.
             In regions of the world where localities are not well defined or do not fit
             into this structure well, leave locality empty and use address_lines.
        sublocality:
          type: string
          title: sublocality
          description: |-
            Optional. Sublocality of the address.
             For example, this can be neighborhoods, boroughs, districts.
        addressLines:
          type: array
          items:
            type: string
          title: address_lines
          description: >-
            Unstructured address lines describing the lower levels of an
            address.

             Because values in address_lines do not have type information and may
             sometimes contain multiple values in a single field (e.g.
             "Austin, TX"), it is important that the line order is clear. The order of
             address lines should be "envelope order" for the country/region of the
             address. In places where this can vary (e.g. Japan), address_language is
             used to make it explicit (e.g. "ja" for large-to-small ordering and
             "ja-Latn" or "en" for small-to-large). This way, the most specific line of
             an address can be selected based on the language.

             The minimum permitted structural representation of an address consists
             of a region_code with all remaining information placed in the
             address_lines. It would be possible to format such an address very
             approximately without geocoding, but no semantic reasoning could be
             made about any of the address components until it was at least
             partially resolved.

             Creating an address only containing a region_code and address_lines, and
             then geocoding is the recommended way to handle completely unstructured
             addresses (as opposed to guessing which parts of the address should be
             localities or administrative areas).
        recipients:
          type: array
          items:
            type: string
          title: recipients
          description: |-
            Optional. The recipient at the address.
             This field may, under certain circumstances, contain multiline information.
             For example, it might contain "care of" information.
        organization:
          type: string
          title: organization
          description: Optional. The name of the organization at the address.
      title: PostalAddress
      additionalProperties: false
      description: >-
        Represents a postal address, e.g. for postal delivery or payments
        addresses.
         Given a postal address, a postal service can deliver items to a premise, P.O.
         Box or similar.
         It is not intended to model geographical locations (roads, towns,
         mountains).

         In typical usage an address would be created via user input or from importing
         existing data, depending on the type of process.

         Advice on address input / editing:
          - Use an i18n-ready address widget such as
            https://github.com/google/libaddressinput)
         - Users should not be presented with UI elements for input or editing of
           fields outside countries where that field is used.

         For more guidance on how to use this schema, please see:
         https://support.google.com/business/answer/6397478
    hawk.v1alpha.CheckCustomerResponse:
      type: object
      properties:
        caseId:
          type: string
          title: case_id
          description: Unique identifier for the case (UUID format)
        customerId:
          type: string
          title: customer_id
          description: Unique identifier for the customer
        flaggingResults:
          type: array
          items:
            $ref: >-
              #/components/schemas/hawk.v1alpha.CheckCustomerResponse.FlaggingResult
          title: flagging_results
        riskFactors:
          type: array
          items:
            $ref: >-
              #/components/schemas/hawk.v1alpha.CheckCustomerResponse.RiskFactorsResult
          title: risk_factors
        riskLevel:
          type: string
          title: risk_level
        screeningResults:
          type: array
          items:
            $ref: >-
              #/components/schemas/hawk.v1alpha.CheckCustomerResponse.ScreeningResult
          title: screening_results
      title: CheckCustomerResponse
      additionalProperties: false
    hawk.v1alpha.CheckCustomerResponse.FlaggingResult:
      type: object
      properties:
        flag:
          type: string
          title: flag
          description: Name of the flag
      title: FlaggingResult
      additionalProperties: false
    hawk.v1alpha.CheckCustomerResponse.RiskFactorsResult:
      type: object
      properties:
        factor:
          type: string
          title: factor
          description: Name of risk factor being checked
      title: RiskFactorsResult
      additionalProperties: false
    hawk.v1alpha.CheckCustomerResponse.ScreeningResult:
      type: object
      properties:
        type:
          title: type
          $ref: '#/components/schemas/hawk.v1alpha.ScreeningType'
      title: ScreeningResult
      additionalProperties: false
    kyc6.individual.v1alpha.ActivityLog:
      type: object
      properties:
        matches:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.ResultAndProfile'
          title: matches
          description: string should be the kyc6 resource id
      title: ActivityLog
      additionalProperties: false
    kyc6.individual.v1alpha.Address:
      type: object
      properties:
        geography:
          type: string
          title: geography
          description: >-
            An upper-case two-letter ISO-3166-2 code of a country or dependent
            territory
        city:
          type: string
          title: city
          description: The city name of the profile address
          nullable: true
      title: Address
      additionalProperties: false
      description: Address information
    kyc6.individual.v1alpha.Alias:
      type: object
      properties:
        firstName:
          type: string
          title: first_name
          nullable: true
        middleName:
          type: string
          title: middle_name
          nullable: true
        lastName:
          type: string
          title: last_name
          nullable: true
        type:
          title: type
          $ref: '#/components/schemas/kyc6.individual.v1alpha.AliasType'
      title: Alias
      additionalProperties: false
      description: Alias information
    kyc6.individual.v1alpha.ContactEntry:
      type: object
      properties:
        category:
          title: category
          $ref: '#/components/schemas/kyc6.individual.v1alpha.ContactEntryCategory'
        value:
          type: string
          title: value
      title: ContactEntry
      additionalProperties: false
      description: Contact entry information
    kyc6.individual.v1alpha.DdEntry:
      type: object
      properties:
        caseReference:
          type: string
          title: case_reference
          nullable: true
        reason:
          type: string
          title: reason
        conduct:
          type: string
          title: conduct
          nullable: true
        dateFromIso:
          type: string
          title: date_from_iso
          nullable: true
        dateToIso:
          type: string
          title: date_to_iso
          nullable: true
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: DdEntry
      additionalProperties: false
      description: Disqualified Director entry information
    kyc6.individual.v1alpha.DeletionReason:
      type: object
      properties:
        reason:
          title: reason
          $ref: '#/components/schemas/kyc6.individual.v1alpha.DeletionReasonType'
        otherReason:
          type: string
          title: other_reason
          description: Populated when reason is "Other"
          nullable: true
      title: DeletionReason
      additionalProperties: false
      description: Deletion reason information
    kyc6.individual.v1alpha.Evidence:
      type: object
      properties:
        evidenceId:
          type: string
          title: evidence_id
        originalUrl:
          type: string
          title: original_url
        isCopyrighted:
          type: boolean
          title: is_copyrighted
        title:
          type: string
          title: title
          nullable: true
        credibility:
          title: credibility
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.EvidenceCredibility'
        language:
          type: string
          title: language
          nullable: true
        summary:
          type: string
          title: summary
          nullable: true
        keywords:
          type: string
          title: keywords
          nullable: true
        captureDateIso:
          type: string
          title: capture_date_iso
          nullable: true
        publicationDateIso:
          type: string
          title: publication_date_iso
          nullable: true
        assetUrl:
          type: string
          title: asset_url
          nullable: true
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualDataset'
          title: datasets
      title: Evidence
      additionalProperties: false
      description: Evidence information
    kyc6.individual.v1alpha.GriEntry:
      type: object
      properties:
        evidenceId:
          type: string
          title: evidence_id
        title:
          type: string
          title: title
        summary:
          type: string
          title: summary
        keywords:
          type: string
          title: keywords
      title: GriEntry
      additionalProperties: false
      description: Gambling Risk Intelligence entry information
    kyc6.individual.v1alpha.Identifier:
      type: object
      properties:
        category:
          type: string
          title: category
        value:
          type: string
          title: value
      title: Identifier
      additionalProperties: false
      description: Identifier information
    kyc6.individual.v1alpha.IndividualAddress:
      type: object
      properties:
        addressType:
          title: address_type
          $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualAddressType'
        line1:
          type: string
          title: line1
          nullable: true
        line2:
          type: string
          title: line2
          nullable: true
        postcode:
          type: string
          title: postcode
          nullable: true
        city:
          type: string
          title: city
          nullable: true
        county:
          type: string
          title: county
          nullable: true
        countyAbbrev:
          type: string
          title: county_abbrev
          nullable: true
        countryIsoCode:
          type: string
          title: country_iso_code
      title: IndividualAddress
      additionalProperties: false
      description: Individual address information
    kyc6.individual.v1alpha.IndividualProfile:
      type: object
      properties:
        qrCode:
          type: string
          title: qr_code
          description: The unique Quick Reference code of the individual
        version:
          type:
            - integer
            - string
          title: version
          format: int64
          description: >-
            The version number can be used by clients to detect when a profile
            has changed
        resourceUri:
          type: string
          title: resource_uri
          description: >-
            The resource URI can be used to query the API to retrieve the
            profile
        resourceId:
          type: string
          title: resource_id
          description: The resource ID can be used to retrieve the full profile or the PDF
        firstName:
          type: string
          title: first_name
          description: The first name of the individual
          nullable: true
        middleName:
          type: string
          title: middle_name
          description: The middle name of the individual
          nullable: true
        lastName:
          type: string
          title: last_name
          description: The last name of the individual
        gender:
          title: gender
          description: The gender of the individual
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.Gender'
        isDeleted:
          type: boolean
          title: is_deleted
          description: Indicates if the individual has been deleted by research team
        deletionReason:
          title: deletion_reason
          description: Reason for deletion if applicable
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.DeletionReason'
        isDeceased:
          type: boolean
          title: is_deceased
          description: Indicates if the individual is deceased
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.Alias'
          title: aliases
          description: List of aliases for the individual
        datesOfBirthIso:
          type: array
          items:
            type: string
          title: dates_of_birth_iso
          description: List of birth dates for the individual
        datesOfDeathIso:
          type: array
          items:
            type: string
          title: dates_of_death_iso
          description: List of death dates for the individual
        nationalitiesIsoCodes:
          type: array
          items:
            type: string
          title: nationalities_iso_codes
          description: List of the individual's nationalities (ISO country codes)
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualAddress'
          title: addresses
          description: List of the individual's addresses
        profileImages:
          type: array
          items:
            type: string
          title: profile_images
          description: URLs to profile images
        notes:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.Note'
          title: notes
          description: Notes associated with the profile
        contactEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.ContactEntry'
          title: contact_entries
          description: Contact entries for the individual
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.Identifier'
          title: identifiers
          description: Identifiers for the individual
        evidences:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.Evidence'
          title: evidences
          description: Evidence supporting the profile
        sanEntries:
          title: san_entries
          description: Sanction entries
          $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionEntries'
        relEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.RelEntry'
          title: rel_entries
          description: Regulatory Enforcement List entries
        rreEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.RreEntry'
          title: rre_entries
          description: Reputational Risk Exposure entries
        poiEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.PoiEntry'
          title: poi_entries
          description: Profile of Interest entries
        insEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.InsEntry'
          title: ins_entries
          description: Insolvency entries
        ddEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.DdEntry'
          title: dd_entries
          description: Disqualified Director entries
        pepEntries:
          title: pep_entries
          description: PEP entries
          $ref: '#/components/schemas/kyc6.individual.v1alpha.PepEntries'
        pepByAssociationEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.PepAssociationEntry'
          title: pep_by_association_entries
          description: PEP by association entries
        individualLinks:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.LinkedIndividual'
          title: individual_links
          description: Linked individuals
        businessLinks:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.LinkedBusiness'
          title: business_links
          description: Linked businesses
        griEntries:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.GriEntry'
          title: gri_entries
          description: Gambling Risk Intelligence entries
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualDataset'
          title: datasets
          description: The profile datasets
      title: IndividualProfile
      additionalProperties: false
      description: Individual profile response from /individuals/{resourceId} endpoint
    kyc6.individual.v1alpha.IndividualSearchResult:
      type: object
      properties:
        qrCode:
          type: string
          title: qr_code
          description: The unique Quick Reference code of the individual
        version:
          type:
            - integer
            - string
          title: version
          format: int64
          description: >-
            The version number can be used by clients to detect when a profile
            has changed
          nullable: true
        resourceUri:
          type: string
          title: resource_uri
          description: >-
            The resource URI can be used to retrieve the full profile of the
            individual
        resourceId:
          type: string
          title: resource_id
          description: >-
            The resource ID can be used to retrieve the full profile or the PDF
            of the Individual
        score:
          type: integer
          title: score
          format: int32
          description: The match score of the profile (75-100)
        match:
          type: string
          title: match
          description: The name of the profile that has been matched in the search
        name:
          type: string
          title: name
          description: The primary name of the profile
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.Address'
          title: addresses
          description: The list of profile addresses and nationalities
        countries:
          type: array
          items:
            type: string
            deprecated: true
          title: countries
          description: >-
            The list of countries from addresses and nationalities (deprecated,
            use addresses instead)
          deprecated: true
        datesOfBirth:
          type: array
          items:
            type: string
          title: dates_of_birth
          description: Date of birth entries
        gender:
          title: gender
          description: Gender (for individuals), if known
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.Gender'
        profileImage:
          type: string
          title: profile_image
          description: The primary profile image URL
          nullable: true
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualDataset'
          title: datasets
          description: The profile datasets
        currentSanBodyIds:
          type: array
          items:
            type: integer
            format: int32
          title: current_san_body_ids
          description: >-
            The list of IDs of all sanctioning bodies currently sanctioning the
            profile
        formerSanBodyIds:
          type: array
          items:
            type: integer
            format: int32
          title: former_san_body_ids
          description: >-
            The list of IDs of all sanctioning bodies that were sanctioning the
            profile in the past
        pepTier:
          title: pep_tier
          description: PEP tier level if applicable
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.PepTier'
      title: IndividualSearchResult
      additionalProperties: false
      description: Individual search result from the /individuals endpoint
    kyc6.individual.v1alpha.InsEntry:
      type: object
      properties:
        type:
          type: string
          title: type
        insolvencyIdNumber:
          type: string
          title: insolvency_id_number
          nullable: true
        solicitor:
          type: string
          title: solicitor
          nullable: true
        court:
          type: string
          title: court
          nullable: true
        petitioner:
          type: string
          title: petitioner
          nullable: true
        debt:
          type: string
          title: debt
          nullable: true
        accountantInBankruptcyCaseNumber:
          type: string
          title: accountant_in_bankruptcy_case_number
          nullable: true
        insolvencyStartDateIso:
          type: string
          title: insolvency_start_date_iso
          nullable: true
        insolvencyEndDateIso:
          type: string
          title: insolvency_end_date_iso
          nullable: true
        hearingDateIso:
          type: string
          title: hearing_date_iso
          nullable: true
        presentedDateOfPetitionIso:
          type: string
          title: presented_date_of_petition_iso
          nullable: true
        gazetteIssueDateIso:
          type: string
          title: gazette_issue_date_iso
          nullable: true
        awardDateIso:
          type: string
          title: award_date_iso
          nullable: true
        firstOrderDateIso:
          type: string
          title: first_order_date_iso
          nullable: true
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: InsEntry
      additionalProperties: false
      description: Insolvency entry information
    kyc6.individual.v1alpha.LinkedBusiness:
      type: object
      properties:
        qrCode:
          type: string
          title: qr_code
        name:
          type: string
          title: name
        resourceUri:
          type: string
          title: resource_uri
        resourceId:
          type: string
          title: resource_id
        relationship:
          type: string
          title: relationship
        ownershipPercentage:
          type: integer
          title: ownership_percentage
          format: int32
          nullable: true
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.BusinessDataset'
          title: datasets
        individualLinks:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.LinkedIndividual'
          title: individual_links
      title: LinkedBusiness
      additionalProperties: false
      description: Linked business information
    kyc6.individual.v1alpha.LinkedIndividual:
      type: object
      properties:
        qrCode:
          type: string
          title: qr_code
        firstName:
          type: string
          title: first_name
          nullable: true
        middleName:
          type: string
          title: middle_name
          nullable: true
        lastName:
          type: string
          title: last_name
        relationship:
          type: string
          title: relationship
        ownershipPercentage:
          type: integer
          title: ownership_percentage
          format: int32
          nullable: true
        resourceUri:
          type: string
          title: resource_uri
        resourceId:
          type: string
          title: resource_id
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualDataset'
          title: datasets
      title: LinkedIndividual
      additionalProperties: false
      description: Linked individual information
    kyc6.individual.v1alpha.Note:
      type: object
      properties:
        value:
          type: string
          title: value
      title: Note
      additionalProperties: false
      description: Note information
    kyc6.individual.v1alpha.PepAssociationEntry:
      type: object
      properties:
        qrCode:
          type: string
          title: qr_code
        resourceUri:
          type: string
          title: resource_uri
        resourceId:
          type: string
          title: resource_id
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: PepAssociationEntry
      additionalProperties: false
      description: PEP by association entry information
    kyc6.individual.v1alpha.PepEntries:
      type: object
      properties:
        pepTier:
          title: pep_tier
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.PepTier'
        current:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.PepEntry'
          title: current
        former:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.PepEntry'
          title: former
      title: PepEntries
      additionalProperties: false
      description: PEP entries container
    kyc6.individual.v1alpha.PepEntry:
      type: object
      properties:
        countryIsoCode:
          type: string
          title: country_iso_code
        segment:
          type: string
          title: segment
          nullable: true
        position:
          type: string
          title: position
        dateFromIso:
          type: string
          title: date_from_iso
          nullable: true
        dateToIso:
          type: string
          title: date_to_iso
          nullable: true
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: PepEntry
      additionalProperties: false
      description: PEP entry information
    kyc6.individual.v1alpha.PoiEntry:
      type: object
      properties:
        category:
          type: string
          title: category
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
        positions:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.PoiPosition'
          title: positions
      title: PoiEntry
      additionalProperties: false
      description: Profile of Interest entry information
    kyc6.individual.v1alpha.PoiPosition:
      type: object
      properties:
        position:
          type: string
          title: position
        segment:
          type: string
          title: segment
          nullable: true
        countryIsoCode:
          type: string
          title: country_iso_code
          nullable: true
        dateFromIso:
          type: string
          title: date_from_iso
          nullable: true
        dateToIso:
          type: string
          title: date_to_iso
          nullable: true
      title: PoiPosition
      additionalProperties: false
      description: POI position information
    kyc6.individual.v1alpha.RelEntry:
      type: object
      properties:
        category:
          title: category
          $ref: '#/components/schemas/kyc6.individual.v1alpha.RelCategory'
        subcategory:
          type: string
          title: subcategory
        events:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.RelEvent'
          title: events
      title: RelEntry
      additionalProperties: false
      description: Regulatory Enforcement List entry information
    kyc6.individual.v1alpha.RelEvent:
      type: object
      properties:
        type:
          type: string
          title: type
        currencyCode:
          type: string
          title: currency_code
          nullable: true
        amount:
          type: integer
          title: amount
          format: int32
          nullable: true
        period:
          title: period
          nullable: true
          $ref: '#/components/schemas/kyc6.individual.v1alpha.RelPeriod'
        dateIso:
          type: string
          title: date_iso
          nullable: true
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: RelEvent
      additionalProperties: false
      description: REL event information
    kyc6.individual.v1alpha.RelPeriod:
      type: object
      properties:
        days:
          type: integer
          title: days
          format: int32
          nullable: true
        months:
          type: integer
          title: months
          format: int32
          nullable: true
        years:
          type: integer
          title: years
          format: int32
          nullable: true
      title: RelPeriod
      additionalProperties: false
      description: Time period information for REL events
    kyc6.individual.v1alpha.ResultAndProfile:
      type: object
      properties:
        searchResult:
          title: search_result
          description: The initial search result
          $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualSearchResult'
        profile:
          title: profile
          description: The profile that matches that result
          $ref: '#/components/schemas/kyc6.individual.v1alpha.IndividualProfile'
      title: ResultAndProfile
      additionalProperties: false
    kyc6.individual.v1alpha.RreEntry:
      type: object
      properties:
        category:
          type: string
          title: category
        subcategory:
          type: string
          title: subcategory
          nullable: true
        events:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.RreEvent'
          title: events
      title: RreEntry
      additionalProperties: false
      description: Reputational Risk Exposure entry information
    kyc6.individual.v1alpha.RreEvent:
      type: object
      properties:
        type:
          type: string
          title: type
        dateIso:
          type: string
          title: date_iso
          nullable: true
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: RreEvent
      additionalProperties: false
      description: RRE event information
    kyc6.individual.v1alpha.SanctionEntries:
      type: object
      properties:
        current:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionEntry'
          title: current
        former:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionEntry'
          title: former
      title: SanctionEntries
      additionalProperties: false
      description: Sanction entries container
    kyc6.individual.v1alpha.SanctionEntry:
      type: object
      properties:
        sanctionId:
          type: string
          title: sanction_id
          nullable: true
        measures:
          type: array
          items:
            type: string
          title: measures
        regime:
          title: regime
          $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionRegime'
        events:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionEvent'
          title: events
      title: SanctionEntry
      additionalProperties: false
      description: Sanction entry information
    kyc6.individual.v1alpha.SanctionEvent:
      type: object
      properties:
        type:
          title: type
          $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionEventType'
        dateIso:
          type: string
          title: date_iso
        evidenceIds:
          type: array
          items:
            type: string
          title: evidence_ids
      title: SanctionEvent
      additionalProperties: false
      description: Sanction event information
    kyc6.individual.v1alpha.SanctionRegime:
      type: object
      properties:
        body:
          type: string
          title: body
        bodyId:
          type: integer
          title: body_id
          format: int32
          nullable: true
        name:
          type: string
          title: name
          nullable: true
        origin:
          type: string
          title: origin
        types:
          type: array
          items:
            $ref: '#/components/schemas/kyc6.individual.v1alpha.SanctionType'
          title: types
      title: SanctionRegime
      additionalProperties: false
      description: Sanction regime information
    rapidid.api.aml.v1alpha.ActivityLog:
      type: object
      properties:
        result:
          title: result
          description: The result data to store
          $ref: '#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse'
        request:
          title: request
          description: The initial request that was used
          $ref: '#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsRequest'
      title: ActivityLog
      additionalProperties: false
    rapidid.api.aml.v1alpha.PepSanctionsRequest:
      type: object
      properties:
        fuzziness:
          type: number
          title: fuzziness
          format: float
          description: Search fuzziness level
          nullable: true
        searchName:
          title: search_name
          nullable: true
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsRequest.SearchName
        searchQuery:
          type: string
          title: search_query
          description: Name of person to search for
          nullable: true
        birthYear:
          type: string
          title: birth_year
          description: Birth year of person in YYYY format
          nullable: true
        exactMatch:
          type: boolean
          title: exact_match
          description: Exact match disables all standard and optional matching behaviours
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          title: country_codes
          description: >-
            Results are filtered by entity nationality or country of residence
            (ISO 3166-1 alpha-2)
      title: PepSanctionsRequest
      additionalProperties: false
      description: PEP sanctions request
    rapidid.api.aml.v1alpha.PepSanctionsRequest.SearchName:
      type: object
      properties:
        firstName:
          type: string
          title: first_name
        middleNames:
          type: string
          title: middle_names
          nullable: true
        lastName:
          type: string
          title: last_name
      title: SearchName
      additionalProperties: false
      description: Structured name search (overridden by search_query if present)
    rapidid.api.aml.v1alpha.PepSanctionsResponse:
      type: object
      properties:
        matchStatus:
          title: match_status
          description: Main response data
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchStatus
        totalHits:
          type:
            - integer
            - string
          title: total_hits
          format: int64
        hits:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit
          title: hits
        error:
          title: error
          nullable: true
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Error
        blacklistHits:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit
          title: blacklist_hits
        id:
          type:
            - integer
            - string
          title: id
          format: int64
        ref:
          type: string
          title: ref
        searcherId:
          type:
            - integer
            - string
          title: searcher_id
          format: int64
        assigneeId:
          type:
            - integer
            - string
          title: assignee_id
          format: int64
        filters:
          title: filters
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Filters
        riskLevel:
          type: string
          title: risk_level
          nullable: true
        searchTerm:
          type: string
          title: search_term
        submittedTerm:
          type: string
          title: submitted_term
        clientRef:
          type: string
          title: client_ref
        totalMatches:
          type:
            - integer
            - string
          title: total_matches
          format: int64
        totalBlacklistHits:
          type:
            - integer
            - string
          title: total_blacklist_hits
          format: int64
        createdAt:
          type: string
          title: created_at
        updatedAt:
          type: string
          title: updated_at
        tags:
          type: array
          items:
            type: string
          title: tags
        labels:
          type: array
          items:
            type: string
          title: labels
        limit:
          type: integer
          title: limit
          format: int32
        offset:
          type: integer
          title: offset
          format: int32
        searcher:
          title: searcher
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.User
        assignee:
          title: assignee
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.User
        code:
          type: integer
          title: code
          format: int32
          description: Top-level response metadata
          nullable: true
        status:
          type: string
          title: status
          nullable: true
        rapidId:
          type: string
          title: rapid_id
          nullable: true
      title: PepSanctionsResponse
      additionalProperties: false
      description: PEP sanctions response
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Aka:
      type: object
      properties:
        name:
          type: string
          title: name
      title: Aka
      additionalProperties: false
      description: AKA (also known as) information
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Associate:
      type: object
      properties:
        association:
          type: string
          title: association
          description: parent, child, spouse, sibling, etc.
        name:
          type: string
          title: name
      title: Associate
      additionalProperties: false
      description: Associated person information
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Document:
      type: object
      properties:
        id:
          type: string
          title: id
        name:
          type: string
          title: name
        entityType:
          type: string
          title: entity_type
        aka:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Aka
          title: aka
        associates:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Associate
          title: associates
        fields:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Field
          title: fields
        keywords:
          type: array
          items:
            type: string
          title: keywords
        lastUpdatedUtc:
          type: string
          title: last_updated_utc
        createdUtc:
          type: string
          title: created_utc
          nullable: true
        media:
          type: array
          items:
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Media
          title: media
        sourceNotes:
          type: object
          title: source_notes
          additionalProperties:
            title: value
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote
        types:
          type: array
          items:
            type: string
          title: types
      title: Document
      additionalProperties: false
      description: Document information
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Document.SourceNotesEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote
      title: SourceNotesEntry
      additionalProperties: false
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Error:
      type: object
      properties:
        code:
          type: integer
          title: code
          format: int32
          nullable: true
        status:
          type: string
          title: status
          nullable: true
        message:
          type: string
          title: message
          nullable: true
      title: Error
      additionalProperties: false
      description: Standard error handling
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Field:
      type: object
      properties:
        name:
          type: string
          title: name
        tag:
          type: string
          title: tag
          nullable: true
        value:
          type: string
          title: value
        locale:
          type: string
          title: locale
          nullable: true
      title: Field
      additionalProperties: false
      description: Field information in documents
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Filters:
      type: object
      properties:
        birthYear:
          type: integer
          title: birth_year
          format: int32
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          title: country_codes
        exactMatch:
          type: boolean
          title: exact_match
        fuzziness:
          type: number
          title: fuzziness
          format: float
        removeDeceased:
          type: integer
          title: remove_deceased
          format: int32
        types:
          type: array
          items:
            type: string
          title: types
      title: Filters
      additionalProperties: false
      description: Search filters applied
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit:
      type: object
      properties:
        score:
          type: number
          title: score
          format: float
        doc:
          title: doc
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Document
        matchTypes:
          type: array
          items:
            type: string
          title: match_types
        matchTypesDetails:
          type: object
          title: match_types_details
          additionalProperties:
            title: value
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails
        matchStatus:
          type: string
          title: match_status
          nullable: true
        isWhitelisted:
          type: boolean
          title: is_whitelisted
          nullable: true
      title: Hit
      additionalProperties: false
      description: Individual hit information
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit.MatchTypesDetailsEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails
      title: MatchTypesDetailsEntry
      additionalProperties: false
    rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails:
      type: object
      properties:
        matchTypes:
          type: object
          title: match_types
          additionalProperties:
            title: value
            $ref: >-
              #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList
          description: nested string arrays simplified to strings
        type:
          type: string
          title: type
      title: MatchTypeDetails
      additionalProperties: false
      description: Match type details
    rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList:
      type: object
      properties:
        values:
          type: array
          items:
            type: string
          title: values
      title: MatchTypeList
      additionalProperties: false
      description: 'Nested string arrays: use a wrapper message around repeated string'
    rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypesEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          title: value
          $ref: >-
            #/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList
      title: MatchTypesEntry
      additionalProperties: false
    rapidid.api.aml.v1alpha.PepSanctionsResponse.Media:
      type: object
      properties:
        date:
          type: string
          title: date
        snippet:
          type: string
          title: snippet
        title:
          type: string
          title: title
        url:
          type: string
          title: url
      title: Media
      additionalProperties: false
      description: Media information in documents
    rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote:
      type: object
      properties:
        name:
          type: string
          title: name
        url:
          type: string
          title: url
      title: SourceNote
      additionalProperties: false
      description: Source note information
    rapidid.api.aml.v1alpha.PepSanctionsResponse.User:
      type: object
      properties:
        id:
          type:
            - integer
            - string
          title: id
          format: int64
        email:
          type: string
          title: email
        name:
          type: string
          title: name
        phone:
          type: string
          title: phone
          nullable: true
        createdAt:
          type: string
          title: created_at
        userIsActive:
          type: boolean
          title: user_is_active
      title: User
      additionalProperties: false
      description: User information
    bndry.api.risk.entities.v1alpha.CreateIndividualEntityRiskRatingJobRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - entities/-
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
            string.example = ["entities/-"]
          const: entities/-
        individualEntityRiskRatingJob:
          title: individual_entity_risk_rating_job
          description: Required. The risk rating job to create.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob
        individualEntityRiskRatingJobId:
          type: string
          examples:
            - pep-sanction-screen-001
          title: individual_entity_risk_rating_job_id
          maxLength: 63
          minLength: 4
          description: >
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["pep-sanction-screen-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreateIndividualEntityRiskRatingJobRequest
      required:
        - parent
        - individualEntityRiskRatingJob
        - individualEntityRiskRatingJobId
      additionalProperties: false
      description: >-
        Request message for
        [CreateIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.CreateIndividualEntityRiskRatingJob].
    bndry.api.risk.entities.v1alpha.GetIndividualEntityRiskRatingJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/-/individualEntityRiskRatingJobs/pep-sanction-screen-001
          title: name
          description: >
            Required. The resource name of the job to retrieve.
             Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}
            correct_name_format // name must follow format
            'entities/-/individualEntityRiskRatingJobs/*'

            string.example =
            ["entities/-/individualEntityRiskRatingJobs/pep-sanction-screen-001"]
      title: GetIndividualEntityRiskRatingJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [GetIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.GetIndividualEntityRiskRatingJob].
    bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891
          title: name
          description: >
            (IDENTIFIER) Output only. The resource name of the job.
             Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}
            correct_name_format // name must follow format
            'entities/-/individualEntityRiskRatingJobs/*'

            string.example =
            ["entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891"]
        createTime:
          title: create_time
          description: Output only. The timestamp when the job was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the job was most recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: IndividualEntityRiskRatingJob
      additionalProperties: false
      description: Represents a job for performing risk rating on individual entities.
    bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
          const: entities/-
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of jobs to return. The
            service may return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggC
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListIndividualEntityRiskRatingJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAEiAggC"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          minimum: 0
          format: int32
          description: >
            (OPTIONAL) Optional. The number of jobs to skip before starting to
            collect the result set.

            int32.example = [0]

            int32.gte = 0

            int32.gte_lt = 0

            int32.gte_lt_exclusive = 0

            int32.gte_lte = 0

            int32.gte_lte_exclusive = 0
      title: ListIndividualEntityRiskRatingJobsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [ListIndividualEntityRiskRatingJobs][hawk.v1alpha.IndividualEntityRiskRatingJobService.ListIndividualEntityRiskRatingJobs].
    bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsResponse:
      type: object
      properties:
        individualEntityRiskRatingJobs:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob
          title: individual_entity_risk_rating_jobs
          description: The list of risk rating jobs.
        nextPageToken:
          type: string
          examples:
            - >-
              cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example =
            ["cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA=="]
        totalSize:
          type: integer
          examples:
            - 47
          title: total_size
          format: int32
          description: |
            The total number of jobs matching the request.
            int32.example = [47]
      title: ListIndividualEntityRiskRatingJobsResponse
      additionalProperties: false
      description: >-
        Response message for
        [ListIndividualEntityRiskRatingJobs][hawk.v1alpha.IndividualEntityRiskRatingJobService.ListIndividualEntityRiskRatingJobs].
    bndry.api.risk.entities.v1alpha.RunIndividualEntityRiskRatingJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              entities/john-smith-001/individualEntityRiskRatingJobs/risk-rating-screen-001
          title: name
          description: >
            Required. The resource name of the job to run.
             Format: entities/{entity}/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}
             The entity resource name will be extracted from the path.
            correct_name_format // name must follow format
            'entities/*/individualEntityRiskRatingJobs/*'

            string.example =
            ["entities/john-smith-001/individualEntityRiskRatingJobs/risk-rating-screen-001"]
      title: RunIndividualEntityRiskRatingJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [RunIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.RunIndividualEntityRiskRatingJob].
    google.longrunning.GetOperationRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          description: The name of the operation resource.
      title: GetOperationRequest
      additionalProperties: false
      description: |-
        The request message for
         [Operations.GetOperation][google.longrunning.Operations.GetOperation].
    bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob.VerificationType:
      type: string
      title: VerificationType
      enum:
        - VERIFICATION_TYPE_UNSPECIFIED
        - AUS_ALL
        - AUS_CHECK
      description: |-
        Corresponds to the framework used by Truuth to perform the verification
         TODO: Make this provider agnostic
    bndry.api.risk.entities.v1alpha.CreateIndividualEntityVerificationJobRequest:
      type: object
      properties:
        individualEntityVerificationJob:
          title: individual_entity_verification_job
          description: Required. The individual entity verification job to create.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob
        individualEntityVerificationJobId:
          type: string
          examples:
            - verification-001
          title: individual_entity_verification_job_id
          maxLength: 63
          minLength: 4
          description: >
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["verification-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreateIndividualEntityVerificationJobRequest
      required:
        - individualEntityVerificationJob
        - individualEntityVerificationJobId
      additionalProperties: false
      description: >-
        Request message for
        [CreateIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.CreateIndividualEntityVerificationJob].
    bndry.api.risk.entities.v1alpha.GetIndividualEntityVerificationJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - individualEntityVerificationJobs/verification-001
          title: name
          description: >
            Required. The resource name of the job to retrieve.
             Format: individualEntityVerificationJobs/{individual_entity_verification_job}
            correct_name_format // name must follow format
            'individualEntityVerificationJobs/*'

            string.example =
            ["individualEntityVerificationJobs/verification-001"]
      title: GetIndividualEntityVerificationJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [GetIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.GetIndividualEntityVerificationJob].
    bndry.api.risk.entities.v1alpha.GetOperationRequest:
      type: object
      properties:
        name:
          type: string
          title: name
          description: |-
            The name of the operation resource.
             The format depends on the specific job type:
             - OnboardIndividualEntityJob: entities/-/onboardIndividualEntityJobs/{job}/operations/{operation}
             - IndividualEntityVerificationJob: individualEntityVerificationJobs/{job}/operations/{operation}
      title: GetOperationRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for getting the status of a long-running operation, used
        by job services to poll operation results.
    bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              individualEntityVerificationJobs/verification-job-2024-0127-kycind-743891
          title: name
          description: >
            (IDENTIFIER) Output only. The resource name of the job.
             Format: individualEntityVerificationJobs/{individual_entity_verification_job}
            correct_name_format // name must follow format
            'individualEntityVerificationJobs/*'

            string.example =
            ["individualEntityVerificationJobs/verification-job-2024-0127-kycind-743891"]
        verificationType:
          title: verification_type
          description: Required. The type of verification to perform.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob.VerificationType
        enrichEntity:
          type: boolean
          title: enrich_entity
          description: >-
            (OPTIONAL) Optional. If true, entity will be enriched by
            verification response.
             TODO: Implement this logic
        webhookUri:
          type: string
          examples:
            - >-
              https://api.example.com/webhooks/onboarding/individual/entity-job-status
          title: webhook_uri
          format: uri
          description: >
            Required. Webhook target URI for notifications.

            string.example =
            ["https://api.example.com/webhooks/onboarding/individual/entity-job-status"]

            string.uri = true // value must be a valid URI

            string.uri_empty = true // value is empty, which is not a valid URI
        createTime:
          title: create_time
          description: Output only. The timestamp when the job was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the job was most recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: IndividualEntityVerificationJob
      required:
        - verificationType
        - webhookUri
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.ListIndividualEntityVerificationJobsRequest:
      type: object
      properties:
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of jobs to return. The
            service may return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggC
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListIndividualEntityVerificationJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListIndividualEntityVerificationJobs` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAEiAggC"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          minimum: 0
          format: int32
          description: >
            (OPTIONAL) Optional. The number of jobs to skip before starting to
            collect the result set.

            int32.example = [0]

            int32.gte = 0

            int32.gte_lt = 0

            int32.gte_lt_exclusive = 0

            int32.gte_lte = 0

            int32.gte_lte_exclusive = 0
      title: ListIndividualEntityVerificationJobsRequest
      additionalProperties: false
      description: >-
        Request message for
        [ListIndividualEntityVerificationJobs][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.ListIndividualEntityVerificationJobs].
    bndry.api.risk.entities.v1alpha.ListIndividualEntityVerificationJobsResponse:
      type: object
      properties:
        individualEntityVerificationJobs:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob
          title: individual_entity_verification_jobs
          description: The list of individual entity verification jobs.
        nextPageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggD
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example = ["ChAIAhABGAEiAggD"]
        totalSize:
          type: integer
          examples:
            - 47
          title: total_size
          format: int32
          description: |
            The total number of jobs matching the request.
            int32.example = [47]
      title: ListIndividualEntityVerificationJobsResponse
      additionalProperties: false
      description: >-
        Response message for
        [ListIndividualEntityVerificationJobs][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.ListIndividualEntityVerificationJobs].
    bndry.api.risk.entities.v1alpha.RunIndividualEntityVerificationJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - individualEntityVerificationJobs/verification-001
          title: name
          description: >
            Required. The resource name of the job to run.
             Format: individualEntityVerificationJobs/{individual_entity_verification_job}
            correct_name_format // name must follow format
            'individualEntityVerificationJobs/*'

            string.example =
            ["individualEntityVerificationJobs/verification-001"]
        entityResourceName:
          type: string
          examples:
            - entities/john-smith-001
          title: entity_resource_name
          description: |
            Required. The resource name of the entity to verify.
             Format: entities/{entity}
            correct_entity_format // entity must follow format 'entities/*'
            string.example = ["entities/john-smith-001"]
      title: RunIndividualEntityVerificationJobRequest
      required:
        - name
        - entityResourceName
      additionalProperties: false
      description: >-
        Request message for
        [RunIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.RunIndividualEntityVerificationJob].
    bndry.api.risk.entities.v1alpha.CreateOnboardIndividualEntityJobRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - entities/-
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
            string.example = ["entities/-"]
          const: entities/-
        onboardIndividualEntityJob:
          title: onboard_individual_entity_job
          description: Required. The onboard individual entity job to create.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob
        onboardIndividualEntityJobId:
          type: string
          examples:
            - kyc-individual-mfs-001
          title: onboard_individual_entity_job_id
          maxLength: 63
          minLength: 4
          description: >
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["kyc-individual-mfs-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreateOnboardIndividualEntityJobRequest
      required:
        - parent
        - onboardIndividualEntityJob
        - onboardIndividualEntityJobId
      additionalProperties: false
      description: >-
        Request message for
        [CreateOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.CreateOnboardIndividualEntityJob].
    bndry.api.risk.entities.v1alpha.GetOnboardIndividualEntityJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001
          title: name
          description: >
            Required. The resource name of the job to retrieve.
             Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}
            correct_name_format // name must follow format
            'entities/-/onboardIndividualEntityJobs/*'

            string.example =
            ["entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001"]
      title: GetOnboardIndividualEntityJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [GetOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.GetOnboardIndividualEntityJob].
    bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
          const: entities/-
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of jobs to return. The
            service may return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggC
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListOnboardIndividualEntityJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAEiAggC"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          minimum: 0
          format: int32
          description: >
            (OPTIONAL) Optional. The number of jobs to skip before starting to
            collect the result set.

            int32.example = [0]

            int32.gte = 0

            int32.gte_lt = 0

            int32.gte_lt_exclusive = 0

            int32.gte_lte = 0

            int32.gte_lte_exclusive = 0
      title: ListOnboardIndividualEntityJobsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [ListOnboardIndividualEntityJobs][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.ListOnboardIndividualEntityJobs].
    bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsResponse:
      type: object
      properties:
        onboardIndividualEntityJobs:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob
          title: onboard_individual_entity_jobs
          description: The list of onboard individual entity jobs.
        nextPageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggD
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example = ["ChAIAhABGAEiAggD"]
        totalSize:
          type: integer
          examples:
            - 47
          title: total_size
          format: int32
          description: |
            The total number of jobs matching the request.
            int32.example = [47]
      title: ListOnboardIndividualEntityJobsResponse
      additionalProperties: false
      description: >-
        Response message for
        [ListOnboardIndividualEntityJobs][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.ListOnboardIndividualEntityJobs].
    bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              entities/-/onboardIndividualEntityJobs/mfs-onboard-job-2024-0127-kycind-743891
          title: name
          description: >
            (IDENTIFIER) Output only. The resource name of the job.
             Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}
            correct_name_format // name must follow format
            'entities/-/onboardIndividualEntityJobs/*'

            string.example =
            ["entities/-/onboardIndividualEntityJobs/mfs-onboard-job-2024-0127-kycind-743891"]
        formDefinition:
          type: string
          examples:
            - formDefinitions/mfs-individual-kyc-form-v2.1
          title: form_definition
          description: >
            Required. The resource name of the form definition to use for data
            collection.
             Format: formDefinitions/{form_definition}
            correct_form_definition_format // form_definition must start with
            'formDefinitions/'

            string.example = ["formDefinitions/mfs-individual-kyc-form-v2.1"]
        jsonataExpression:
          type: string
          examples:
            - |-
              {
                "legal_name": {
                  "given_name": $$.form_data.personal_info.first_name,
                  "family_name": $$.form_data.personal_info.last_name
                },
                "date_of_birth": $$.form_data.personal_info.dob,
                "addresses": [{
                  "type": "RESIDENTIAL",
                  "street_address": $$.form_data.address.street,
                  "city": $$.form_data.address.city,
                  "postal_code": $$.form_data.address.zip
                }],
                "tax_identification": {
                  "tax_id_number": $$.form_data.tax_info.ssn,
                  "tax_id_type": "US_SSN"
                }
              }
          title: jsonata_expression
          minLength: 1
          format: byte
          description: >-
            Required. JSONata expression to transform form response into
            IndividualEntity. This must be base64-encoded when sent in JSON
            requests.
        webhookUri:
          type: string
          examples:
            - >-
              https://api.example.com/webhooks/onboarding/individual/entity-job-status
          title: webhook_uri
          format: uri
          description: >
            Required. Webhook target URI for notifications.

            string.example =
            ["https://api.example.com/webhooks/onboarding/individual/entity-job-status"]

            string.uri = true // value must be a valid URI

            string.uri_empty = true // value is empty, which is not a valid URI
        createTime:
          title: create_time
          description: Output only. The timestamp when the job was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the job was most recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: OnboardIndividualEntityJob
      required:
        - formDefinition
        - jsonataExpression
        - webhookUri
      additionalProperties: false
      description: >-
        Represents a job for onboarding individual entities through data
        capture,
         entity creation, and verification workflows.
    bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001
          title: name
          description: >
            Required. The resource name of the job to run.
             Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}
            correct_name_format // name must follow format
            'entities/-/onboardIndividualEntityJobs/*'

            string.example =
            ["entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001"]
        redirectUri:
          type: string
          examples:
            - https://app.example.com/kyc/complete
          title: redirect_uri
          format: uri
          description: >
            The final redirect URI where the user should be sent after
            onboarding is complete.

            string.example = ["https://app.example.com/kyc/complete"]

            string.uri = true // value must be a valid URI

            string.uri_empty = true // value is empty, which is not a valid URI
        entityAnnotations:
          type: object
          title: entity_annotations
          additionalProperties:
            type: string
            title: value
          description: >-
            (OPTIONAL) Optional. Arbitrary annotations to be applied to the
            entity being created.
      title: RunOnboardIndividualEntityJobRequest
      required:
        - name
        - redirectUri
      additionalProperties: false
      description: >-
        Request message for
        [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob].
    bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobRequest.EntityAnnotationsEntry:
      type: object
      properties:
        key:
          type: string
          title: key
        value:
          type: string
          title: value
      title: EntityAnnotationsEntry
      additionalProperties: false
    bndry.api.risk.entities.v1alpha.CreatePepSanctionIndividualEntityJobRequest:
      type: object
      properties:
        parent:
          type: string
          examples:
            - entities/-
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
            string.example = ["entities/-"]
          const: entities/-
        pepSanctionIndividualEntityJob:
          title: pep_sanction_individual_entity_job
          description: Required. The PEP and sanctions screening job to create.
          $ref: >-
            #/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob
        pepSanctionIndividualEntityJobId:
          type: string
          examples:
            - pep-sanction-screen-001
          title: pep_sanction_individual_entity_job_id
          maxLength: 63
          minLength: 4
          description: >
            REQUIRED. The ID to use for the job, which will become the final
            component of
             the job's resource name. This value should be 4-63 characters,
             and valid characters are /[a-z][0-9]-/.
            string.example = ["pep-sanction-screen-001"]

            string.max_len = 63

            string.min_len = 4
      title: CreatePepSanctionIndividualEntityJobRequest
      required:
        - parent
        - pepSanctionIndividualEntityJob
        - pepSanctionIndividualEntityJobId
      additionalProperties: false
      description: >-
        Request message for
        [CreatePepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.CreatePepSanctionIndividualEntityJob].
    bndry.api.risk.entities.v1alpha.GetPepSanctionIndividualEntityJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-001
          title: name
          description: >
            Required. The resource name of the job to retrieve.
             Format: entities/-/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}
            correct_name_format // name must follow format
            'entities/-/pepSanctionIndividualEntityJobs/*'

            string.example =
            ["entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-001"]
      title: GetPepSanctionIndividualEntityJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [GetPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.GetPepSanctionIndividualEntityJob].
    bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: |
            Required. The parent entity resource name.
             Format: entities/-
            string.const = "entities/-"
          const: entities/-
        pageSize:
          type: integer
          examples:
            - 25
          title: page_size
          format: int32
          description: >
            (OPTIONAL) Optional. The maximum number of jobs to return. The
            service may return fewer than
             this value.
             If unspecified, at most 10 jobs will be returned.
             The maximum value is 100; values above 100 will be coerced to 100.
            int32.example = [25]
        pageToken:
          type: string
          examples:
            - ChAIAhABGAEiAggC
          title: page_token
          description: >
            (OPTIONAL) Optional. A page token, received from a previous
            `ListPepSanctionIndividualEntityJobs` call.
             Provide this to retrieve the subsequent page.
             When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must
             match the call that provided the page token.
            string.example = ["ChAIAhABGAEiAggC"]
        skip:
          type: integer
          examples:
            - 0
          title: skip
          minimum: 0
          format: int32
          description: >
            (OPTIONAL) Optional. The number of jobs to skip before starting to
            collect the result set.

            int32.example = [0]

            int32.gte = 0

            int32.gte_lt = 0

            int32.gte_lt_exclusive = 0

            int32.gte_lte = 0

            int32.gte_lte_exclusive = 0
      title: ListPepSanctionIndividualEntityJobsRequest
      required:
        - parent
      additionalProperties: false
      description: >-
        Request message for
        [ListPepSanctionIndividualEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.ListPepSanctionIndividualEntityJobs].
    bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsResponse:
      type: object
      properties:
        pepSanctionIndividualEntityJobs:
          type: array
          items:
            $ref: >-
              #/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob
          title: pep_sanction_individual_entity_jobs
          description: The list of PEP and sanctions screening jobs.
        nextPageToken:
          type: string
          examples:
            - >-
              cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==
          title: next_page_token
          description: >
            A token to retrieve the next page of results, or empty if there are
            no
             more results in the list.
            string.example =
            ["cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA=="]
        totalSize:
          type: integer
          examples:
            - 47
          title: total_size
          format: int32
          description: |
            The total number of jobs matching the request.
            int32.example = [47]
      title: ListPepSanctionIndividualEntityJobsResponse
      additionalProperties: false
      description: >-
        Response message for
        [ListPepSanctionIndividualEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.ListPepSanctionIndividualEntityJobs].
    bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-2024-0127-743891
          title: name
          description: >
            (IDENTIFIER) Output only. The resource name of the job.
             Format: entities/-/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}
            correct_name_format // name must follow format
            'entities/-/pepSanctionIndividualEntityJobs/*'

            string.example =
            ["entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-2024-0127-743891"]
        createTime:
          title: create_time
          description: Output only. The timestamp when the job was created.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
        updateTime:
          title: update_time
          description: Output only. The timestamp when the job was most recently updated.
          readOnly: true
          $ref: '#/components/schemas/google.protobuf.Timestamp'
      title: PepSanctionIndividualEntityJob
      additionalProperties: false
      description: >-
        Represents a job for performing PEP and sanctions screening on
        individual entities.
    bndry.api.risk.entities.v1alpha.RunPepSanctionIndividualEntityJobRequest:
      type: object
      properties:
        name:
          type: string
          examples:
            - >-
              entities/john-smith-001/pepSanctionIndividualEntityJobs/pep-sanction-screen-001
          title: name
          description: >
            Required. The resource name of the job to run.
             Format: entities/{entity}/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}
             The entity resource name will be extracted from the path.
            correct_name_format // name must follow format
            'entities/*/pepSanctionIndividualEntityJobs/*'

            string.example =
            ["entities/john-smith-001/pepSanctionIndividualEntityJobs/pep-sanction-screen-001"]
      title: RunPepSanctionIndividualEntityJobRequest
      required:
        - name
      additionalProperties: false
      description: >-
        Request message for
        [RunPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.RunPepSanctionIndividualEntityJob].
    bndry.api.ui.v1alpha.Data:
      type: object
      properties:
        name:
          type: string
          title: name
        value:
          type:
            - integer
            - string
          title: value
          format: int64
      title: Data
      additionalProperties: false
    bndry.api.ui.v1alpha.GetRiskAggregateResponse:
      type: object
      properties:
        series:
          title: series
          $ref: '#/components/schemas/bndry.api.ui.v1alpha.Series'
      title: GetRiskAggregateResponse
      additionalProperties: false
    bndry.api.ui.v1alpha.Series:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/bndry.api.ui.v1alpha.Data'
          title: data
      title: Series
      additionalProperties: false
    bndry.api.ui.v1alpha.CreateEventRequest.EventType:
      type: string
      title: EventType
      enum:
        - EVENT_UNSPECIFIED
        - IDENTITY_VERIFICATION_PROCESSING_STARTED
    bndry.api.ui.v1alpha.CreateEventRequest:
      type: object
      properties:
        entityResourceName:
          type: string
          examples:
            - entities/john-smith-001
          title: entity_resource_name
          maxLength: 255
          minLength: 1
          pattern: ^entities/[a-zA-Z0-9-_]+$
          description: |
            string.example = ["entities/john-smith-001"]
            string.max_len = 255
            string.min_len = 1
            string.pattern = "^entities/[a-zA-Z0-9-_]+$"
        webhookUri:
          type: string
          examples:
            - https://hooks.bndry.app/xyz
          title: webhook_uri
          maxLength: 2048
          format: uri
          description: |
            string.example = ["https://hooks.bndry.app/xyz"]
            string.max_len = 2048
            string.min_len = 0
            string.uri = true // value must be a valid URI
            string.uri_empty = true // value is empty, which is not a valid URI
        eventType:
          title: event_type
          $ref: >-
            #/components/schemas/bndry.api.ui.v1alpha.CreateEventRequest.EventType
      title: CreateEventRequest
      required:
        - eventType
      additionalProperties: false
  securitySchemes:
    oauth2_client_credentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.bndry.app/realms/bndry/protocol/openid-connect/token
          scopes: {}
    oauth2_authorization_code:
      type: oauth2
      flows:
        authorizationCode:
          x-usePkce:
            disableManualConfiguration: true
            hideClientSecretInput: true
          authorizationUrl: https://auth.bndry.app/realms/bndry/protocol/openid-connect/auth
          tokenUrl: https://auth.bndry.app/realms/bndry/protocol/openid-connect/token
security:
  - oauth2_client_credentials: []
  - oauth2_authorization_code: []
tags:
  - name: Forms
  - name: Entities
  - name: Entity Risk Rating
    description: Service for managing risk rating jobs for individual entities.
  - name: Onboard Individual (Verify Identity)
    description: Service for managing individual entity onboarding jobs.
  - name: Entity PEP Sanctions Check
    description: >-
      Service for managing PEP and sanctions screening jobs for individual
      entities.
