FrankieOne Individual Documents API

openapi: 3.0.3
info:
  title: Core V2 Audit Individual Documents 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 Documents
  description: Manage documents for individuals
paths:
  /v2/individuals/{entityId}/documents:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/levelQuery'
    post:
      summary: Create a new document for an individual.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/individuals_entity_document_response'
        '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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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:
                document:
                  allOf:
                  - type: object
                    properties:
                      class:
                        $ref: '#/components/schemas/Document-Class'
                  - $ref: '#/components/schemas/Document-Information'
                comment:
                  $ref: '#/components/schemas/Comment'
      operationId: createDocuments
      description: Add a new document to an entity.
      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 Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    get:
      summary: Get all documents for an entity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entity-Documents'
        '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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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: getDocuments
      description: Get all documents for an entity.
      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 Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/documents/{documentId}:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/documentId'
    patch:
      summary: Update a single document by it's id.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/individuals_entity_document_response'
        '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'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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:
                document:
                  $ref: '#/components/schemas/Document-Information'
                comment:
                  $ref: '#/components/schemas/Comment'
      operationId: updateDocument
      description: Update document by 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'
      - $ref: '#/components/parameters/levelNoIdQuery'
      tags:
      - Individual Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    get:
      summary: Get a single document by it's id.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document-Information'
        '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'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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: getDocument
      description: Get a single document by it's 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'
      - $ref: '#/components/parameters/levelNoIdQuery'
      tags:
      - Individual Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    delete:
      summary: Delete a document
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entityId:
                    $ref: '#/components/schemas/Entity-ID'
                  documentId:
                    $ref: '#/components/schemas/Document-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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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: deleteDocument
      description: Delete a single document and all of it's attachments.
      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 Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/documents/{documentId}/attachments/{attachmentId}:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/documentId'
    - $ref: '#/components/parameters/attachmentId'
    delete:
      summary: Delete an attachment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entityId:
                    $ref: '#/components/schemas/Entity-ID'
                  documentId:
                    $ref: '#/components/schemas/Document-ID'
                  attachmentId:
                    type: string
        '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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Internal Server Error:
                  value:
                    errorCode: SYS-1063,
                    errorMsg: Failed to generate KYC report
                    requestId: 01HM5EM2QNNSC9K0PX9VC06HX3
        '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: deleteAttachments
      description: Delete an attachment from a given document.
      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 Documents
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
components:
  schemas:
    Error-Base:
      type: object
      properties:
        errorCode:
          type: string
        errorMsg:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
    Document-ID:
      type: string
      format: uuid
      description: 'As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference.

        To modify a document, include the documentId in an update request.'
      example: 92de15f64-5717-4562-b3fc-2c963f6665a7
    Document-Attachment-ID:
      type: string
      format: uuid
      description: When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data.
    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
    Error:
      type: object
      x-examples:
        '400':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0400
          errorMsg: Parsing credentials from "<invalid>" failed, because invalid.
          httpStatusCode: 400
        '401':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0401
          errorMsg: Unauthenticated due to invalid credentials.
          httpStatusCode: 401
        '409':
          requestId: 0123456789ABCDEFGHIJKLMNOP
          errorCode: API-0409
          errorMsg: Conflict.
          httpStatusCode: 409
      allOf:
      - $ref: '#/components/schemas/Error-Base'
      - type: object
        properties:
          requestId:
            $ref: '#/components/schemas/Request-ID'
    Document-Supplementary-Data-Base:
      type: object
      description: Supplementary data associated with a document.
      required:
      - type
      properties:
        type:
          type: string
          description: The document type that defines the type of supplementary data returned.
          enum:
          - NATIONAL_HEALTH_ID
          - BIRTH_CERT
          - NATIONAL_ID
          - CITIZENSHIP
          - PASSPORT
          - MARRIAGE_CERT
    Document-Supplementary-Data:
      type: object
      description: Supplementary information relevant to a specific document or report type.
      oneOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-National-Health-ID'
      - $ref: '#/components/schemas/Document-Supplementary-Data-Birth-Certificate'
      - $ref: '#/components/schemas/Document-Supplementary-Data-National-ID'
      - $ref: '#/components/schemas/Document-Supplementary-Data-Citizenship'
      - $ref: '#/components/schemas/Document-Supplementary-Data-Passport'
      - $ref: '#/components/schemas/Document-Supplementary-Data-Marriage-Certificate'
      discriminator:
        propertyName: type
        mapping:
          NATIONAL_HEALTH_ID: '#/components/schemas/Document-Supplementary-Data-National-Health-ID'
          BIRTH_CERT: '#/components/schemas/Document-Supplementary-Data-Birth-Certificate'
          NATIONAL_ID: '#/components/schemas/Document-Supplementary-Data-National-ID'
          CITIZENSHIP: '#/components/schemas/Document-Supplementary-Data-Citizenship'
          PASSPORT: '#/components/schemas/Document-Supplementary-Data-Passport'
          MARRIAGE_CERT: '#/components/schemas/Document-Supplementary-Data-Marriage-Certificate'
    Issue:
      type: object
      properties:
        issue:
          type: string
          description: Description of the issue.
        issueLocation:
          type: string
          description: The location or context where the issue was identified.
        issueType:
          type: string
          description: The type or category of the issue.
    Document-Supplementary-Data-Passport:
      type: object
      description: Supplementary information relevant to a national health id.
      allOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-Base'
      - type: object
        properties:
          homeCountryFullName:
            type: string
            description: The original name from the home country of passport.
            example: 张伟明
    Document-Supplementary-Data-Marriage-Certificate:
      type: object
      description: Supplementary information relevant to a marriage certificate.
      allOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-Base'
      - type: object
        description: Supplementary information relevant to a marriage certificate.
        properties:
          partner1GivenName:
            type: string
            description: The given name of partner 1.
            example: Harry
          partner1FamilyName:
            type: string
            description: The family name of partner 1.
            example: Versailles
          partner1OtherName:
            type: string
            description: The other name of partner 1.
            example: S.
          partner2GivenName:
            type: string
            description: The given name of partner 2.
            example: Harry
          partner2FamilyName:
            type: string
            description: The family name of partner 2.
            example: Versailles
          partner2OtherName:
            type: string
            description: The other name of partner 2.
            example: S.
          registrationDate:
            type: string
            description: The date the marriage was registered.
            example: '2023'
          marriageDate:
            type: string
            description: The date the marriage was held.
            example: '2023-10-01'
          dateOfPrint:
            type: string
            description: The date the birth certificate was printed.
            example: '2023-10-01'
    Document-Attachment-Retrieval-Status:
      type: string
      readOnly: true
      enum:
      - NORMAL
      - EXCLUDED
      - FAILED
      description: "The reason why the data in a response is missing.\n\n- \"NORMAL\": The data was retrieved and is included. If it is empty, then\n  it was never provided or was provided empty.\n\n- \"EXCLUDED\": The retrieval request was not for 'full' data, or the object\n  has been deleted, so the data is not included.\n\n- \"FAILED\": The data could not be retrieved from the secure document\n  store.\n\nThe retrievalStatus enum will not usually be set in a request. If an\nattachment in a response has a 'FAILED' retrieval state, then\nthat object should not be sent back in a future update. It should\neither be omitted or the original data should be resent if it is available\nfrom another source. However, it is safe to send the object in an update\nwith the state received in a response. Any state other than 'NORMAL' (or\n'') will cause the blank data to be ignored, but other fields in the\nobject will be updated if needed."
    Comment:
      type: object
      properties:
        commentId:
          type: string
          description: Unique identifier for the comment.
          example: 55fc5d54-46f7-49c8-bf78-e07ec79cd6e7
          readOnly: true
        text:
          type: string
          description: The text content of the comment.
          example: Update after speaking to customer over the phone directly.
    Document-Supplementary-Data-Birth-Certificate:
      type: object
      description: Supplementary information relevant to a birth certificate.
      allOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-Base'
      - type: object
        description: Supplementary information relevant to a birth certificate.
        properties:
          registrationDate:
            type: string
            description: The date the birth was registered.
            example: '2000'
          registrationDistrict:
            type: string
            description: The district where the birth was registered.
            example: Sydney
          dateOfPrint:
            type: string
            description: The date the birth certificate was printed.
            example: '2000'
          givenName:
            type: string
            description: The given name as printed on the certificate.
          otherNames:
            type: string
            description: Other name(s) as printed on the certificate.
          familyName:
            type: string
            description: The family name as printed on the certificate.
    individuals_entity_document_response:
      type: object
      required:
      - requestId
      properties:
        entity:
          $ref: '#/components/schemas/Entity-ID'
        document:
          $ref: '#/components/schemas/Document-Information'
        requestId:
          $ref: '#/components/schemas/Request-ID'
    Document-Supplementary-Data-National-Health-ID:
      type: object
      description: Supplementary information relevant to a national health id.
      allOf:
      - $ref: '#/components/schemas/Document-Supplementary-Data-Base'
      - type: object
        properties:
          reference:
            type: string
            description: The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card).
            example: '1'
          nameOnCardLine1:
            type: string
            description: The individual's name as it appears on the card.
          nameOnCardLine2:
            type: string
            description: If the individual's name spans more than one line, this is the part of the name that appears on line 2.
          nameOnCardLine3:
            type: string
            description: If the individual's name spans more than two lines, this is the part of the name that appears on line 3.
          nameOnCardLine4:
            type: string
            description: If the individual's name spans more than three lines, this is the part of the name that appears on line 4.
          middleNameOnCard:
            type: string
            description: The individual's middle name or initial as it appears on the card.
    Date:
      type: object
      allOf:
      - $ref: '#/components/schemas/Date-Base'
      - type: object
        properties:
          normalized:
            type: string
            format: date
            description: Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field.
            example: '1990-03-31'
            readOnly: true
    Attribute:
      type: object
      required:
      - type
      - value
      properties:
        type:
          description: The attribute type.
          type: string
          maxLength: 64
        value:
          description: The value assigned to the attribute.
          type: string
    Request-ID:
      type: string
      example: 01HN9XHZN6MGXM9JXG50K59Q85
      description: The unique request identifier for the API call made.
    Entity-Documents:
      type: object
      properties:

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