openapi: 3.2.0
info:
  title: Clients API
  description: Operations for Clients
  version: '1'
servers:
- url: https://sandbox-api.integrated.finance/v1/{instanceId}
  description: Sandbox
  variables: {}
- url: https://api.integrated.finance/v1/{instanceId}
  description: Production
  variables: {}
tags:
- name: Clients
paths:
  /clients:
    get:
      tags:
      - Clients
      summary: List Clients
      operationId: clients.list
      parameters:
      - name: metadata.page.number
        in: query
        description: 0-indexed page number
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: metadata.page.size
        in: query
        description: page size
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 20
      - name: metadata.sort
        in: query
        description: default direction is ascending
        schema:
          type: string
        example: data.client.fullName,desc
      - name: data.client.identity.type
        in: query
        schema:
          $ref: '#/components/schemas/LegalEntityType'
      - name: data.client.fullName
        in: query
        schema:
          type: string
      - name: data.client.status
        in: query
        schema:
          type: string
          enum:
          - active
          - inactive
      - name: data.client.clientNumber
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Client list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientListResponse'
              example: '{  "workflow": {},  "data": {    "clients": [      {        "id": "59f39ef4-31e7-495d-9deb-c483e817a02c",        "clientNumber": "21429493",        "status": "active",        "identity": {          "type": "corporate",          "country": "GB",          "identifications": null,          "legalName": "I.F Technology Ltd",          "incorporationDate": "2019-09-09",          "corporationType": null        },        "profile": {          "identityType": "corporate"          "phone": "+441234567890",          "email": "test@integrated.finance"        },        "fullName": "I.F Technology Ltd"      },      {        "id": "94fdd97a-8f63-4406-9d4e-e946848ae9bb",        "clientNumber": "23668817",        "status": "active",        "identity": {          "type": "individual",          "country": "GB",          "identifications": [            {              "type": "identity-card",              "identificationNumber": "12345678",              "issuingCountry": "GB",              "issueDate": "2022-01-01",              "expirationDate": "2032-01-01"            }          ],          "givenName": "Sherlock",          "familyName": "Holmes",          "birthDate": "1953-01-06"        },        "profile": {          "identityType": "individual",          "phone": "+441234567890"        },        "fullName": "Sherlock Holmes"      }    ]  },  "connect": {},  "metadata": {    "page": {      "size": 20,      "number": 0,      "totalElements": 2,      "totalPages": 1    }  }}'
    post:
      tags:
      - Clients
      summary: Create a Client
      operationId: clients.create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientCreateRequest'
            examples:
              direct-individual:
                description: direct-individual
                value:
                  workflow:
                    code: direct
                  data:
                    client:
                      identity:
                        type: individual
                        givenName: Sherlock
                        familyName: Holmes
                        birthDate: '1953-01-06'
                        country: GB
                        identifications:
                        - type: identity-card
                          identificationNumber: '12345678'
                          issuingCountry: GB
                          issueDate: '2022-01-01'
                          expirationDate: '2032-01-01'
                      profile:
                        identityType: individual
                        phone: '+441234567890'
                        email: test@integrated.finance
                        residentialAddress:
                          country: GB
                          region: England
                          city: London
                          street: Baker Street
                          houseNumber: 221B
                          postalCode: XYZ ABC
                          refinement: ''
                  connect: {}
                  metadata: {}
              direct-individual-with-user:
                description: direct-individual-with-user
                value:
                  workflow:
                    code: direct
                    createUser: true
                  data:
                    client:
                      identity:
                        type: individual
                        givenName: Bruce
                        familyName: Wayne
                        birthDate: '1987-01-01'
                        country: GB
                        identifications:
                        - type: identity-card
                          identificationNumber: '12345678'
                          issuingCountry: GB
                          issueDate: '2022-01-01'
                          expirationDate: '2023-01-01'
                      profile:
                        identityType: individual
                        residentialAddress:
                          country: GB
                          region: England
                          city: London
                          street: Baker Street
                          houseNumber: 221B
                          postalCode: XYZ ABC
                          refinement: ''
                        phone: '+441234567890'
                        email: abc@integrated.finance
                  connect: {}
                  metadata: {}
              direct-corporate:
                description: direct-corporate
                value:
                  workflow:
                    code: direct
                  data:
                    client:
                      identity:
                        type: corporate
                        legalName: I.F Technology Ltd
                        incorporationDate: '2019-01-01'
                        country: GB
                        identifications:
                        - type: registration-number
                          identificationNumber: '12345678'
                          issuingCountry: GB
                      profile:
                        identityType: corporate
                        phone: '+441234567890'
                        email: test@integrated.finance
                        registrationAddress:
                          country: GB
                          region: England
                          city: London
                          street: City Road
                          houseNumber: Epworth House
                          postalCode: EC1Y 1AA
                          refinement: ''
                      relations:
                      - relation: director
                        identity:
                          type: individual
                          givenName: John
                          familyName: Doe
                          birthDate: '2000-01-01'
                          country: GB
                          identifications:
                          - type: passport
                            identificationNumber: '12345678'
                            issuingCountry: GB
                        profile:
                          identityType: individual
                          phone: '+441234567890'
                          email: test@integrated.finance
                          residentialAddress:
                            country: GB
                            region: England
                            city: London
                            street: Baker Street
                            houseNumber: 221B
                            postalCode: XYZ ABC
                            refinement: ''
                          percentageOfOwnership: '55'
                  connect: {}
                  metadata: {}
              migration:
                description: migration
                value:
                  workflow:
                    code: migration
                  data:
                    sourceId: 00000000-0000-0000-0000-000000000000
                  connect:
                    type: explicit
                    serviceProvider: currencycloud
                  metadata: {}
      responses:
        '201':
          description: Client created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientCreateResponse'
              examples:
                direct-individual:
                  description: direct-individual
                  value:
                    workflow:
                      code: direct
                    data:
                      client:
                        id: 94fdd97a-8f63-4406-9d4e-e946848ae9bb
                        clientNumber: '23668817'
                        status: active
                        identity:
                          type: individual
                          country: GB
                          identifications:
                          - type: identity-card
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: '2022-01-01'
                            expirationDate: '2032-01-01'
                          givenName: Sherlock
                          familyName: Holmes
                          birthDate: '1953-01-06'
                        profile:
                          identityType: individual
                          phone: '+441234567890'
                          email: test@integrated.finance
                          residentialAddress:
                            country: GB
                            region: England
                            city: London
                            street: Baker Street
                            postalCode: XYZ ABC
                            houseNumber: 221B
                        fullName: Sherlock Holmes
                    connect: {}
                    metadata: {}
                direct-individual-with-user:
                  description: direct-individual-with-user
                  value:
                    workflow:
                      code: direct
                      createUser: true
                    data:
                      client:
                        id: 00000000-0000-0000-0000-000000000000
                        clientNumber: '20663251'
                        status: active
                        identity:
                          type: individual
                          givenName: Bruce
                          familyName: Wayne
                          birthDate: '1987-01-01'
                          country: GB
                          identifications:
                          - type: identity-card
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: '2022-01-01'
                            expirationDate: '2023-01-01'
                        profile:
                          identityType: individual
                          residentialAddress:
                            country: GB
                            region: England
                            city: London
                            street: Baker Street
                            houseNumber: 221B
                            postalCode: XYZ ABC
                            refinement: ''
                          phone: '+441234567890'
                          email: bruce.wayne@integrated.finance
                        fullName: Bruce Wayne
                      user:
                        id: 00000000-0000-0000-0000-000000000000
                        email: bruce.wayne@integrated.finance
                        identity:
                          type: individual
                          givenName: Bruce
                          familyName: Wayne
                          birthDate: '1987-01-01'
                          country: GB
                          identifications:
                          - type: identity-card
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: '2022-01-01'
                            expirationDate: '2023-01-01'
                        category: external
                        type: human
                      userClientRelation:
                        id: 00000000-0000-0000-0000-000000000000
                        userId: 00000000-0000-0000-0000-000000000000
                        clientId: 00000000-0000-0000-0000-000000000000
                        status: allowed
                    connect: {}
                    metadata: {}
                direct-corporate:
                  description: direct-corporate
                  value:
                    workflow:
                      code: direct
                    data:
                      client:
                        id: 26646076-3413-4139-b8a7-a2e97aeb0052
                        clientNumber: '23478648'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications:
                          - type: registration-number
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: null
                            expirationDate: null
                          legalName: I.F Technology Ltd
                          incorporationDate: '2019-01-01'
                          corporationType: null
                        profile:
                          identityType: corporate
                          phone: '+441234567890'
                          email: test@integrated.finance
                          registrationAddress:
                            country: GB
                            region: England
                            city: London
                            street: City Road
                            postalCode: EC1Y 1AA
                            houseNumber: Epworth House
                        relations:
                        - id: 68fe2462-8cd1-4337-b79c-5df4edeba219
                          relation: director
                          identity:
                            type: individual
                            country: GB
                            identifications:
                            - type: passport
                              identificationNumber: '12345678'
                              issuingCountry: GB
                              issueDate: null
                              expirationDate: null
                            givenName: John
                            familyName: Doe
                            birthDate: '2000-01-01'
                          profile:
                            identityType: individual
                            phone: '+441234567890'
                            email: test@integrated.finance
                            residentialAddress:
                              country: GB
                              region: England
                              city: London
                              street: Baker Street
                              postalCode: XYZ ABC
                              houseNumber: 221B
                          percentageOfOwnership: '55'
                          fullName: John Doe
                        fullName: I.F Technology Ltd
                    connect: {}
                    metadata: {}
                migration:
                  description: migration
                  value:
                    workflow:
                      code: migration
                    data:
                      client:
                        id: ce7913d9-4cba-461d-854b-2fa88acf1816
                        clientNumber: '23908141'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications: null
                          legalName: Strak Industry
                          incorporationDate: null
                          corporationType: null
                        profile:
                          identityType: corporate
                          phone: '+441234567890'
                          email: test@integrated.finance
                          registrationAddress:
                            country: GB
                            region: London
                            street: 542nd Street
                            houseNumber: ''
                            postalCode: '10000'
                            refinement: ''
                        fullName: Strak Industry
                    connect:
                      type: explicit
                      serviceProvider: currencycloud
                    metadata: {}
        '400':
          description: Missing required field
          content:
            application/json:
              examples:
                error-required-validation:
                  description: error-required-validation
                  value:
                    timestamp: '2023-02-12T13:06:35.0286835'
                    message: Parameter data.client.identity cannot be null or empty.
                    code: common.coding.functional.invalid_input
                    messageParameters:
                    - data.client.identity
  /clients/{id}:
    get:
      tags:
      - Clients
      summary: Get a Client
      operationId: clients.get
      parameters:
      - name: metadata.include
        in: query
        description: include additional information about the client
        style: form
        schema:
          type: string
          enum:
          - data.client.profile.primaryAddress
          - data.client.profile.registrationAddress
          - data.client.profile.residentialAddress
          - connect.connections
      - name: id
        in: path
        description: ID of the client in UUID format
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Client resource returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientGetResponse'
              examples:
                default-response:
                  description: default-response
                  value:
                    workflow: {}
                    data:
                      client:
                        id: e4b3c646-53d6-48e0-8560-1a510923af62
                        clientNumber: '23337634'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications:
                          - type: registration-number
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: null
                            expirationDate: null
                          legalName: I.F Technology Corp
                          incorporationDate: '2019-01-01'
                          corporationType: null
                        profile:
                          identityType: corporate
                          phone: '+441234567890'
                          email: test@integrated.finance
                        fullName: I.F Technology Corp
                    connect: {}
                    metadata: {}
                primary-address-included:
                  description: primary-address-included
                  value:
                    workflow: {}
                    data:
                      client:
                        id: e4b3c646-53d6-48e0-8560-1a510923af62
                        clientNumber: '23337634'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications:
                          - type: registration-number
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: null
                            expirationDate: null
                          legalName: I.F Technology Corp
                          incorporationDate: '2019-01-01'
                          corporationType: null
                        profile:
                          identityType: corporate
                          phone: '+441234567890'
                          email: test@integrated.finance
                          registrationAddress:
                            country: GB
                            region: England
                            city: London
                            street: City Road
                            postalCode: EC1Y 1AA
                            houseNumber: Epworth House
                        fullName: I.F Technology Corp
                    connect: {}
                    metadata:
                      include:
                      - data.client.profile.primaryAddress
                connections-included:
                  description: connections-included
                  value:
                    workflow: {}
                    data:
                      client:
                        id: ce7913d9-4cba-461d-854b-2fa88acf1816
                        clientNumber: '23908141'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications: null
                          legalName: Strak Industry
                          incorporationDate: null
                          corporationType: null
                        profile:
                          identityType: corporate
                        fullName: Strak Industry
                    connect:
                      connections:
                      - id: 224a2729-f720-49ed-a9ec-78f4954611ea
                        serviceProvider: currencycloud
                    metadata:
                      include:
                      - connect.connections
    patch:
      tags:
      - Clients
      summary: Update a Client
      operationId: clients.update
      parameters:
      - name: id
        in: path
        description: ID of the client in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientUpdateRequest'
            examples:
              corporate-name-update:
                description: corporate-name-update
                value:
                  workflow:
                    code: direct
                  data:
                    client:
                      identity:
                        type: corporate
                        legalName: I.F Technology Corp
                  connect: {}
                  metadata: {}
              individual-address-update:
                description: individual-address-update
                value:
                  workflow:
                    code: direct
                  data:
                    client:
                      profile:
                        identityType: individual
                        phone: '+441234567890'
                        email: test@integrated.finance
                        residentialAddress:
                          country: GB
                          region: England
                          city: London
                          street: Baker Street
                          postalCode: XYZ ABC
                          houseNumber: 222B
                  connect: {}
                  metadata: {}
              update-via-migration:
                description: update-via-migration
                value:
                  workflow:
                    code: migration
                  data:
                    sourceId: 00000000-0000-0000-0000-000000000000
                  connect:
                    type: explicit
                    serviceProvider: currencycloud
                  metadata: {}
      responses:
        '202':
          description: Client updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientUpdateResponse'
              examples:
                corporate-name-update:
                  description: corporate-name-update
                  value:
                    workflow:
                      code: direct
                    data:
                      client:
                        id: e4b3c646-53d6-48e0-8560-1a510923af62
                        clientNumber: '23337634'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications:
                          - type: registration-number
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: null
                            expirationDate: null
                          legalName: I.F Technology Corp
                          incorporationDate: '2019-01-01'
                          corporationType: null
                        fullName: I.F Technology Corp
                    connect: {}
                    metadata: {}
                individual-address-update:
                  description: individual-address-update
                  value:
                    workflow:
                      code: direct
                    data:
                      client:
                        id: 94fdd97a-8f63-4406-9d4e-e946848ae9bb
                        clientNumber: '23668817'
                        status: active
                        identity:
                          type: individual
                          country: GB
                          identifications:
                          - type: identity-card
                            identificationNumber: '12345678'
                            issuingCountry: GB
                            issueDate: '2022-01-01'
                            expirationDate: '2032-01-01'
                          givenName: Sherlock
                          familyName: Holmes
                          birthDate: '1953-01-06'
                        profile:
                          identityType: individual
                          phone: '+441234567890'
                          email: test@integrated.finance
                          residentialAddress:
                            country: GB
                            region: England
                            city: London
                            street: Baker Street
                            postalCode: XYZ ABC
                            houseNumber: 222B
                        fullName: Sherlock Holmes
                    connect: {}
                    metadata: {}
                migration:
                  description: migration
                  value:
                    workflow:
                      code: migration
                    data:
                      client:
                        id: ce7913d9-4cba-461d-854b-2fa88acf1816
                        clientNumber: '23908141'
                        status: active
                        identity:
                          type: corporate
                          country: GB
                          identifications: null
                          legalName: Strak Industry
                          incorporationDate: null
                          corporationType: null
                        profile:
                          identityType: corporate
                          phone: '+441234567890'
                          email: test@integrated.finance
                          registrationAddress:
                            country: GB
                            region: London
                            street: 542nd Street
                            houseNumber: ''
                            postalCode: '10000'
                            refinement: ''
                        fullName: Strak Industry
                    connect:
                      type: explicit
                      serviceProvider: currencycloud
                    metadata: {}
components:
  schemas:
    ClientCreateWorkflow:
      type: string
      description: unique workflow code
      enum:
      - direct
      - migration
    BankingUserProfile:
      type: object
      properties:
        phone:
          type: string
        residentialAddress:
          $ref: '#/components/schemas/Address'
    ClientUpdateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/ClientUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/ClientUpdateMetadataContainer'
    ClientRisk:
      type: string
      description: client risk level
      enum:
      - low
      - medium
      - high
      - severe
    ClientUpdateConnect:
      type: string
      description: connect type
      enum:
      - explicit
      - explicit
    UserIdentityResource:
      required:
      - familyName
      - givenName
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LegalEntityType'
        givenName:
          type: string
          description: user given name
        familyName:
          type: string
          description: user family name
        birthDate:
          type: string
          description: user birthdate
          format: date
      description: user identity information
    ClientCreateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientCreateDataContainer'
        connect:
          $ref: '#/components/schemas/ClientCreateConnectContainer'
        metadata:
          $ref: '#/components/schemas/ClientCreateMetadataContainer'
    LegalEntityIdentityIndividual:
      required:
      - familyName
      - givenName
      type: object
      allOf:
      - $ref: '#/components/schemas/LegalEntityIdentity'
      - type: object
        properties:
          type:
            $ref: '#/components/schemas/LegalEntityType'
          country:
            maxLength: 2
            minLength: 2
            pattern: ^[A-Z]{2}$
            type: string
          identifications:
            type: array
            items:
              $ref: '#/components/schemas/LegalEntityIdentification'
          givenName:
            type: string
          familyName:
            type: string
          birthDate:
            type: string
            format: date
    ClientUpdateDataContainer:
      type: object
      properties:
        client:
          type: object
          additionalProperties:
            type: object
            description: custom map including fields to update, required if workflow is direct
          description: custom map including fields to update, required if workflow is direct
        sourceId:
          type: string
          description: id of the client to be migrated, required if workflow is migration
          writeOnly: true
    ClientUpdateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/ClientUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/ClientUpdateMetadataContainer'
    ClientListDataContainer:
      required:
      - clients
      type: object
      properties:
        client:
          $ref: '#/components/schemas/ClientResourceListQueryInput'
        clients:
          type: array
          description: collection of clients
          readOnly: true
          items:
            $ref: '#/components/schemas/Client'
    ClientRelatedLegalEntityRelation:
      type: string
      description: relation of legal entity with client
      enum:
      - director
      - shareholder
      - director-and-shareholder
      - authorized-person
    UserClientStatus:
      type: string
      readOnly: true
      enum:
      - allowed
      - revoked
    BankingUserStatus:
      type: string
      readOnly: true
      enum:
      - active
      - inactive
    ClientRelation:
      required:
      - clientId
      - id
      - identity
      - relation
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AttributeMap'
        id:
          type: string
          description: client relation id
          format: uuid
          readOnly: true
        clientId:
          type: string
          description: id of client
          format: uuid
          readOnly: true
        relation:
          $ref: '#/components/schemas/ClientRelatedLegalEntityRelation'
        identity:
          type: object
          description: client relation identity object
          oneOf:
          - $ref: '#/components/schemas/LegalEntityIdentityCorporate'
          - $ref: '#/components/schemas/LegalEntityIdentityIndividual'
        percentageOfOwnership:
          type: number
          description: percentage of ownership
        profile:
          type: object
          description: client relation profile object
          oneOf:
          - $ref: '#/components/schemas/ClientProfileCorporate'
          - $ref: '#/components/schemas/ClientProfileIndividual'
      description: client relation data model
    ClientUpdateWorkflow:
      type: string
      description: unique workflow code
      enum:
      - direct
      - migration
    ClientGetConnectContainer:
      type: object
      properties:
        connections:
          type: array
          description: client connection data models
          items:
            $ref: '#/components/schemas/ClientConnection'
    ClientCreateMetadataContainer:
      type: object
    ClientGetDataContainer:
      required:
      - client
      type: object
      properties:
        client:
          $ref: '#/components/schemas/Client'
    LegalEntityIdentityCorporate:
      required:
      - legalName
      type: object
      allOf:
      - $ref: '#/components/schemas/LegalEntityIdentity'
      - type: object
        properties:
          type:
            $ref: '#/components/schemas/LegalEntityType'
          country:
            maxLength: 2
            minLength: 2
            pattern: ^[A-Z]{2}$
            type: string
          identifications:
            type: array
            items:
              $ref: '#/components/schemas/LegalEntityIdentification'
          legalName:
            type: string
          incorporationDate:
            type: string
            format: date
          corporationType:
            $ref: '#/components/schemas/CorporationType'
    ClientCreateConnect:
      type: string
      description: connection source type
      enum:
      - explicit
    ClientGetWorkflowContainer:
      type: object
    ClientUpdateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ClientUpdateWorkflow'
    ClientGetMetadataContainer:
      type: object
      properties:
        include:
          uniqueItems: true
          type: array
          items:
            type: string
    ClientProfileIndividual:
      type: object
      allOf:
      - $ref: '#/components/schemas/ClientProfile'
      - type: object
        properties:
          identityType:
            $ref: '#/components/schemas/LegalEntityType'
          phone:
            type: string
            description: client contact phone number
          email:
            type: string
            description: client contact email
          residentialAddress:
            $ref: '#/components/schemas/Address'
    ClientListWorkflowContainer:
      type: object
    AttributeMap:
      type: object
    ClientListConnectContainer:
      type: object
    ClientListMetadataContainer:
      required:
      - page
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
    ClientUpdateMetadataContainer:
      type: object
    ClientStatus:
      type: string
      description: status of the client
      readOnly: true
      enum:
      - active
      - inactive
    ClientProfileCorporate:
      type: object
      allOf:
      - $ref: '#/components/schemas/ClientProfile'
      - type: object
        properties:
          identityType:
            $ref: '#/components/schemas/LegalEntityType'
          phone:
            type: string
            description: client contact phone number
          email:
            type: string
            description: client contact email
          registrationAddress:
            $ref: '#/components/schemas/Address'
    Address:
      required:
      - city
      - country
      - street
      type: object
      properties:
        country:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        region:
          type: string
        postalCode:
          type: string
        city:
          type: string
        street:
          type: string
        houseNumber:
          type: string
        refinement:
          type: string
      description: residential address object for individual clients
    ClientResourceListQueryInput:
      type: object
      properties:
        identityType:
          $ref: '#/components/schemas/LegalEntityType'
        fullName:
          type: string
        status:
          $ref: '#/components/schemas/ClientStatus'
        clientNumber:
          type: string
        risk:
          $ref: '#/components/schemas/ClientRisk'
      writeOnly: true
    ClientGetResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientGetWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientGetDataContainer'
        connect:
          $ref: '#/components/schemas/ClientGetConnectContainer'
        metadata:
          $ref: '#/components/schemas/ClientGetMetadataContainer'
    CorporationType:
      type: string
      enum:
      - ltd
      - plc
      - llp
      - lp
      - gp
      - st
      - other
    LegalEntityType:
      type: string
      enum:
      - corporate
      - individual
    ClientListResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientListWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientListDataContainer'
        connect:
          $ref: '#/components/schemas/ClientListConnectContainer'
        metadata:
          $ref: '#/components/schemas/ClientListMetadataContainer'
    UserClientRelation:
      required:
      - clientId
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        userId:
          type: string
          format: uuid
          readOnly: true
        clientId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/UserClientStatus'
      description: automatically created user client resource. Convenient for individual clients
      readOnly: true
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        size:
          minimum: 0
          type: integer
          description: number of elements in this page
          format: int32
        number:
          minimum: 0
          type: integer
          description: index of page starting from 0
          format: int32
        totalElements:
          minimum: 0
          type: integer
          description: total number of elements in all of the pages
          format: int64
          readOnly: true
        totalPages:
          minimum: 0
          type: integer
          description: number of total pages
          format: int32
          readOnly: true
    ClientUpdateConnectContainer:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientUpdateConnect'
        serviceProvider:
          type: string
          description: service provider that will be used to source the client data
    ClientCreateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ClientCreateWorkflow'
        createUser:
          type: boolean
          description: create a user related with the client
    LegalEntityIdentity:
      required:
      - type
      type: object
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
        mapping:
          corporate: '#/components/schemas/LegalEntityIdentityCorporate'
          individual: '#/components/schemas/LegalEntityIdentityIndividual'
    User:
      required:
      - category
      - email
      - identity
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
        givenName:
          type: string
        familyName:
          type: string
        identity:
          $ref: '#/components/schemas/UserIdentityResource'
        category:
          type: string
          readOnly: true
          enum:
          - external
        type:
          type: string
          readOnly: true
          enum:
          - human
        profile:
          $ref: '#/components/schemas/BankingUserProfile'
        status:
          $ref: '#/components/schemas/BankingUserStatus'
      description: automatically created user resource. Convenient for individual clients
      readOnly: true
    Client:
      required:
      - clientNumber
      - id
      - identity
      - status
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AttributeMap'
        id:
          type: string
          description: client id
          format: uuid
          readOnly: true
        clientNumber:
          maxLength: 8
          minLength: 8
          pattern: ^d{8}$
          type: string
          description: user friendly client identifier
          readOnly: true
        status:
          $ref: '#/components/schemas/ClientStatus'
        identity:
          type: object
          description: client identity object
          oneOf:
          - $ref: '#/components/schemas/LegalEntityIdentityCorporate'
          - $ref: '#/components/schemas/LegalEntityIdentityIndividual'
        profile:
          type: object
          description: client profile object
          oneOf:
          - $ref: '#/components/schemas/ClientProfileCorporate'
          - $ref: '#/components/schemas/ClientProfileIndividual'
        relations:
          type: array
          description: client related legal entities
          items:
            $ref: '#/components/schemas/ClientRelation'
        risk:
          $ref: '#/components/schemas/ClientRisk'
    ClientConnection:
      type: object
      properties:
        serviceProvider:
          type: string
          description: service provider which this client connected to
        id:
          type: string
      description: client connection data models
    LegalEntityIdentification:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LegalEntityIdentificationType'
        identificationNumber:
          type: string
        issuingCountry:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        issueDate:
          type: string
          format: date
        expirationDate:
          type: string
          format: date
    ClientCreateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/ClientCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/ClientCreateDataContainer'
        connect:
          $ref: '#/components/schemas/ClientCreateConnectContainer'
        metadata:
          $ref: '#/components/schemas/PlatformAPIMetadataContainer'
    PlatformAPIMetadataContainer:
      type: object
    ClientCreateDataContainer:
      type: object
      properties:
        client:
          $ref: '#/components/schemas/Client'
        sourceId:
          type: string
          description: id of the client to be migrated, required if workflow is migration
          writeOnly: true
        user:
          $ref: '#/components/schemas/User'
        userClientRelations:
          type: array
          description: automatically created user client resource. Convenient for individual clients
          readOnly: true
          items:
            $ref: '#/components/schemas/UserClientRelation'
    ClientProfile:
      required:
      - identityType
      type: object
      properties:
        identityType:
          type: string
      discriminator:
        propertyName: identityType
        mapping:
          corporate: '#/components/schemas/ClientProfileCorporate'
          individual: '#/components/schemas/ClientProfileIndividual'
    LegalEntityIdentificationType:
      type: string
      enum:
      - registration-number
      - passport
      - identity-card
      - driving-licence
      - foreign-identity-card
      - tax-number
    ClientCreateConnectContainer:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientCreateConnect'
        serviceProvider:
          type: string
          description: service provider that will be used to source the client data
x-provenance:
  method: searched
  source: https://developer.integrated.finance/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.integrated.finance/reference/client-relationscreate.md
  - https://developer.integrated.finance/reference/client-relationsdelete.md
  - https://developer.integrated.finance/reference/client-relationsget.md
  - https://developer.integrated.finance/reference/client-relationslist.md
  - https://developer.integrated.finance/reference/client-relationsupdate.md
  - https://developer.integrated.finance/reference/clientscreate-1.md
  - https://developer.integrated.finance/reference/clientsget.md
  - https://developer.integrated.finance/reference/clientslist.md
  - https://developer.integrated.finance/reference/clientsupdate-1.md
  merge:
    pages: 9
    deduped: 91
    conflicts_kept_first: 0