---
title: "IndividualPartyRequest"
url: "https://apiportal.pexaclear.com.au/apis/gap-au-aml-customer-experience-standard-v1-v1/versions/9c31c4c2-000c-418b-ad44-c201d75d8af9/schemas/IndividualPartyRequest"
---

> Full API specification: https://apiportal.pexaclear.com.au/apis/gap-au-aml-customer-experience-standard-v1-v1/versions/9c31c4c2-000c-418b-ad44-c201d75d8af9.md

# IndividualPartyRequest

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: AML Verification API
  version: v1
servers:
  - url: https://api.pexaclear.com.au
    description: API Gateway URL
components:
  schemas:
    IndividualPartyRequest:
      oneOf:
        - allOf:
            - allOf:
                - type: object
                  discriminator:
                    propertyName: partyType
                    mapping:
                      INDIVIDUAL: "#/components/schemas/IndividualPartyRequest"
                      ENTITY: "#/components/schemas/EntityPartyRequest"
                  required:
                    - partyType
                    - role
                  properties:
                    partyType:
                      type: string
                      pattern: ^(INDIVIDUAL|ENTITY)$
                      description: "Party type. Allowed values: INDIVIDUAL, ENTITY"
                    role:
                      type: string
                      pattern: ^(BUYER|SELLER)$
                      description: "Party role. Allowed values: BUYER, SELLER"
              type: object
              required:
                - partyType
                - familyName
                - partySubType
                - countryCode
                - mobileNumber
                - email
              properties:
                partyType:
                  type: string
                  pattern: ^(INDIVIDUAL)$
                partySubType:
                  type: string
                  pattern: ^(SELF|SOLE_TRADER)$
                  description: Subtype of the individual party. Use "SELF" for a standard
                    individual or "SOLE_TRADER" for a sole trader.
                firstName:
                  type: string
                  nullable: true
                  minLength: 1
                  maxLength: 50
                middleNames:
                  type: string
                  nullable: true
                  minLength: 1
                  maxLength: 50
                familyName:
                  type: string
                  minLength: 1
                  maxLength: 50
                dateOfBirth:
                  type: string
                  format: date
                  nullable: true
                countryCode:
                  type: string
                  minLength: 1
                  maxLength: 5
                  pattern: ^\+[0-9]{1,4}$
                  description: Country calling code, e.g. "+61"
                  example: "+61"
                mobileNumber:
                  type: string
                  minLength: 8
                  maxLength: 20
                  pattern: ^[\d\s\-\+\(\)]{8,25}$
                  description: Must contain between 8 and 20 digits
                email:
                  type: string
                  format: email
                  maxLength: 320
                  pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
                  description: Email address
          type: object
          required:
            - partySubType
          properties:
            partySubType:
              type: string
              pattern: ^(SELF)$
        - allOf:
            - allOf:
                - type: object
                  discriminator:
                    propertyName: partyType
                    mapping:
                      INDIVIDUAL: "#/components/schemas/IndividualPartyRequest"
                      ENTITY: "#/components/schemas/EntityPartyRequest"
                  required:
                    - partyType
                    - role
                  properties:
                    partyType:
                      type: string
                      pattern: ^(INDIVIDUAL|ENTITY)$
                      description: "Party type. Allowed values: INDIVIDUAL, ENTITY"
                    role:
                      type: string
                      pattern: ^(BUYER|SELLER)$
                      description: "Party role. Allowed values: BUYER, SELLER"
              type: object
              required:
                - partyType
                - familyName
                - partySubType
                - countryCode
                - mobileNumber
                - email
              properties:
                partyType:
                  type: string
                  pattern: ^(INDIVIDUAL)$
                partySubType:
                  type: string
                  pattern: ^(SELF|SOLE_TRADER)$
                  description: Subtype of the individual party. Use "SELF" for a standard
                    individual or "SOLE_TRADER" for a sole trader.
                firstName:
                  type: string
                  nullable: true
                  minLength: 1
                  maxLength: 50
                middleNames:
                  type: string
                  nullable: true
                  minLength: 1
                  maxLength: 50
                familyName:
                  type: string
                  minLength: 1
                  maxLength: 50
                dateOfBirth:
                  type: string
                  format: date
                  nullable: true
                countryCode:
                  type: string
                  minLength: 1
                  maxLength: 5
                  pattern: ^\+[0-9]{1,4}$
                  description: Country calling code, e.g. "+61"
                  example: "+61"
                mobileNumber:
                  type: string
                  minLength: 8
                  maxLength: 20
                  pattern: ^[\d\s\-\+\(\)]{8,25}$
                  description: Must contain between 8 and 20 digits
                email:
                  type: string
                  format: email
                  maxLength: 320
                  pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
                  description: Email address
          type: object
          required:
            - partySubType
            - abn
            - entityName
            - mainBusinessLocation
          properties:
            partySubType:
              type: string
              pattern: ^(SOLE_TRADER)$
            abn:
              type: string
              description: Australian Business Number (ABN) or Australian Company Number
                (ACN). Required when partySubType is SOLE_TRADER.
            entityName:
              type: string
              minLength: 1
              maxLength: 100
              description: Trading entity name. Required when partySubType is SOLE_TRADER.
            tradingName:
              type: string
              nullable: true
              minLength: 1
              maxLength: 100
              description: Trading name or business name.
            mainBusinessLocation:
              type: string
              minLength: 1
              maxLength: 20
              description: State and postcode. Required when partySubType is SOLE_TRADER.
              example: SA 5045
      discriminator:
        propertyName: partySubType
        mapping:
          SELF: "#/components/schemas/IndividualSelfRequest"
          SOLE_TRADER: "#/components/schemas/IndividualSoleTraderRequest"
```