FrankieOne Individual Workflows API

openapi: 3.0.3
info:
  title: Core V2 Audit Individual Workflows API
  version: 2.0.0
  description: This is the APIs for V2 Core. It allows you to do common operations, such as read audit entries or get workflow lists.
  contact:
    name: FrankieOne
    url: https://www.frankieone.com/
    email: help@frankieone.com
servers:
- url: https://api.uat.frankie.one
security:
- Api-Key: []
tags:
- name: Individual Workflows
paths:
  /v2/workflows:
    get:
      summary: Get a list of executable workflows
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflows:
                    type: array
                    description: Provide a set of workflow lookup objects.
                    items:
                      $ref: '#/components/schemas/Workflow-Lookup'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getWorkflows
      description: Get a list of workflows that can be executed
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      - $ref: '#/components/parameters/serviceNameQuery'
      - $ref: '#/components/parameters/includeQuery'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute:
    parameters:
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/levelQuery'
    post:
      summary: Create an individual and execute a workflow for the given service profile
      responses:
        '200':
          description: Execution request completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  serviceProfile:
                    $ref: '#/components/schemas/Service-Profile'
                  individual:
                    $ref: '#/components/schemas/Individual'
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
        '202':
          description: Asynchronous execution request accepted, use requestId to retrieve results
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionId:
                    $ref: '#/components/schemas/Workflow-Execution-ID'
                  entityId:
                    $ref: '#/components/schemas/Entity-ID'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: createAndExecuteWorkflow
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                individual:
                  $ref: '#/components/schemas/Individual'
                comment:
                  $ref: '#/components/schemas/Comment'
      description: Create an individual and execute a workflow for the given service profile
      parameters:
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/levelQuery'
    post:
      summary: Execute a workflow for the given service profile
      responses:
        '200':
          description: Execution request completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  serviceProfile:
                    $ref: '#/components/schemas/Service-Profile'
                  individual:
                    $ref: '#/components/schemas/Individual'
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
        '202':
          description: Asynchronous execution request accepted, use requestId to retrieve results
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionId:
                    $ref: '#/components/schemas/Workflow-Execution-ID'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: executeWorkflow
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  $ref: '#/components/schemas/Comment'
      description: Execute a workflow for the given service profile.
      parameters:
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/page'
    - $ref: '#/components/parameters/sort'
    - $ref: '#/components/parameters/sortFields'
    - $ref: '#/components/parameters/query_filter_workflowresults'
    - $ref: '#/components/parameters/query_filter_workflowexecutionstates'
    - $ref: '#/components/parameters/query_filter_startedatbefore'
    - $ref: '#/components/parameters/query_filter_startedatafter'
    - $ref: '#/components/parameters/query_filter_endedatbefore'
    - $ref: '#/components/parameters/query_filter_endedatafter'
    get:
      summary: Get a list of executions and their results
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResults:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workflow-Result'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getResults
      description: Get a list of entity results. Always sorted in reverse chrono order
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/executionId'
    - $ref: '#/components/parameters/levelNoIdQuery'
    get:
      summary: Get the result of a specific execution by its executionId.
      responses:
        '102':
          description: '**[DEPRECATED]** Workflow is still processing'
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionState:
                    $ref: '#/components/schemas/Workflow-Execution-State'
        '200':
          description: Workflow has completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  individual:
                    $ref: '#/components/schemas/Individual'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getWorkflowExecutionResult
      description: Get the result of a specific execution by its executionId.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    patch:
      summary: Override the status of a specific workflow execution.
      responses:
        '200':
          description: Status has been updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  $ref: '#/components/schemas/Workflow-Execution-ResultEnum'
                comment:
                  $ref: '#/components/schemas/Comment'
      operationId: overrideWorkflowExecutionResult
      description: Override the result of a specific workflow execution by its id.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
components:
  schemas:
    Session:
      type: object
      description: Session details for an activity, this is always scoped to a singular entity.
      properties:
        token:
          type: string
          description: A token to identify the specific session for the activity
    Phone-Number-ID:
      type: string
      description: 'As phone numbers are added to an entity, they are assigned an ID to assist with tracking.

        If you are adjusting phone numbers, you will need to include the ID to reference it correctly in the list.'
      example: ad165f64-5717-4562-b3fc-2c963f66bfa9
    Supplementary-Data-Activity-Device:
      type: object
      description: 'Defines the details of an activity device result.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-Base'
      - type: object
        properties:
          riskLevel:
            type: string
          activityResults:
            type: array
            items:
              $ref: '#/components/schemas/Supplementary-Data-Activity-Result-Detail'
    Workflow-Step-Summary-KYC:
      type: object
      description: 'Captures the overall summary of the KYC step, including which matches have been made, with which sources, and under which ruleset.

        '
      required:
      - stepName
      properties:
        matchedRules:
          type: array
          description: List of KYC rulesets that have matched, along with a summary of those matches.
          items:
            $ref: '#/components/schemas/Workflow-Step-Summary-KYC-MatchRule'
        unmatchedRules:
          type: array
          description: List of KYC rulesets that did not have sufficient results to be considered a match.
          items:
            $ref: '#/components/schemas/Workflow-Step-Summary-KYC-MatchRule'
        stepName:
          type: string
    Process-ResultEnum:
      type: string
      enum:
      - MATCH
      - PARTIAL_MATCH
      - INVALID_MATCH
      - NO_MATCH
      - CLEAR
      - HIT
      - BAD_DATA
      - CREATED
      - UPDATED
      - DELETED
      - FAIL
      - NOT_APPLICABLE
      - SUSPECTED
      - REJECTED
      - MANUAL
      - CLEAR_AUTO
      - OVERRIDE
      readOnly: true
      description: 'The actual pass/fail result of the element check

        - MATCH: The element check matched the expected criteria.

        - PARTIAL_MATCH: The element check partially matched the expected criteria.

        - INVALID_MATCH: The element check matched but was invalid.

        - NO_MATCH: The element check did not match the expected criteria.

        - CLEAR: The element check was cleared.

        - HIT: The element check hit a specific condition or threshold.

        - BAD_DATA: The element check encountered bad data.

        - CREATED: The element check resulted in the creation of a new record.

        - UPDATED: The element check resulted in the update of an existing record.

        - DELETED: The element check resulted in the deletion of a record.

        - FAIL: The element check failed.

        - NOT_APPLICABLE: The element check was not applicable in the given context.

        - SUSPECTED: The element check raised a suspicion but did not confirm it.

        - REJECTED: The element check was rejected.

        - MANUAL: The element check was manually reviewed or processed.

        - CLEAR_AUTO: The element check was cleared automatically.

        - OVERRIDE: The element check was overridden by a manual action or system rule.

        '
    Workflow-Step-Summary-AML-ProviderSummary:
      type: object
      description: 'Summary of individual provider results for AML checks.

        '
      properties:
        name:
          type: string
          description: Name of the provider.
        lastRetrievedAt:
          type: string
          format: date-time
          description: The date and time this data was last retrieved from the provider. An earlier date may indicate previously retrieved data.
        numHits:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits from this provider.
        numFalsePositives:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits marked as false positive from this provider.
        numTruePositives:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits marked as true positive from this provider.
        numUnknown:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits marked as unknown from this provider.
        numUnresolved:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits that remain unresolved from this provider.
        pepCountries:
          type: array
          items:
            type: string
            description: ISO-3166-alpha3 country code where PEP hits were found.
        sanctionCountries:
          type: array
          items:
            type: string
            description: ISO-3166-alpha3 country code where sanction hits were found.
        watchlistCountries:
          type: array
          items:
            type: string
            description: ISO-3166-alpha3 country code where watchlist hits were found.
        adverseMediaCountries:
          type: array
          items:
            type: string
            description: ISO-3166-alpha3 country code where adverse media hits were found.
        numUnresolvedPEP:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits with unresolved PEP entries from this provider.
        numUnresolvedSanction:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits with unresolved sanction entries from this provider.
        numUnresolvedWatchlist:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits with unresolved watchlist entries from this provider.
        numUnresolvedAdverseMedia:
          type: integer
          format: int32
          minimum: 0
          description: Total number of AML hits with unresolved adverse media entries from this provider.
        searchQuery:
          $ref: '#/components/schemas/Workflow-Step-Summary-AML-Search-Parameters'
    Workflow-Step-Type:
      type: string
      enum:
      - BLOCKLIST
      - DUPLICATE
      - DECISION
      - BRANCH
      - MONITOR_TOGGLE
      - OTHER
      - KYC
      - AML
      - IDV
      - START
      - FINISH
    Document-Supplementary-Data-National-ID:
      type: object
      description: Supplementary information relevant to a national ID.
      allOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-Base'
      - type: object
        properties:
          homeCountryFullName:
            type: string
            description: The original full name from the individual's home country national ID.
            example: 张伟明
          paternalFamilyName:
            type: string
            description: The individual's family name inherited from the father's side.
            example: MENDOZA
          maternalFamilyName:
            type: string
            description: The individual's family name inherited from the mother's side.
            example: GARCIA
    Workflow-Errors:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        description:
          type: string
          description: Description of the error.
        location:
          type: string
          description: Location or context where the error occurred.
    Supplementary-Data-Matchlist:
      type: object
      description: 'Each match against a matchlist entry generates a PRO (Process Result Object), and this object describes the details of the matched entry.

        '
      allOf:
      - $ref: '#/com

# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-individual-workflows-api-openapi.yml