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

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

# IndividualPartyToAdd

An individual party to add. The presence of organisationPartyId is the sole discriminator between the two individual cases: when provided, the individual is linked to that entity and role is inherited; when omitted, the individual is standalone and role is required.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: AML Customer Experience API
  version: v1
servers:
  - url: https://api.pexaclear.com.au
    description: API Gateway URL
components:
  schemas:
    IndividualPartyToAdd:
      description: "An individual party to add. The presence of organisationPartyId is
        the sole discriminator between the two individual cases: when provided,
        the individual is linked to that entity and role is inherited; when
        omitted, the individual is standalone and role is required."
      allOf:
        - type: object
          description: "Base fields shared by the add-party party variants. Discriminated
            on partyType at the point of use: INDIVIDUAL adds a person
            (standalone or entity-linked); ENTITY adds an organisation."
          required:
            - partyType
          properties:
            partyType:
              type: string
              pattern: ^(INDIVIDUAL|ENTITY)$
              description: "Party type. Allowed values: INDIVIDUAL, ENTITY."
            role:
              type: string
              nullable: true
              pattern: ^(BUYER|SELLER)$
              description: "Party role. Required for a standalone individual and for an
                entity. Ignored for an entity-linked individual, which inherits
                the entity's role. Allowed values: BUYER, SELLER."
            externalPartyId:
              type: string
              maxLength: 50
              nullable: true
              description: Optional integrator-supplied identifier for this party. May be any
                string value up to 50 characters (for example, an identifier
                from your own system). If provided, it is echoed back in the
                response so you can correlate your party to the PEXA partyId.
              example: cust123
      type: object
      required:
        - partyType
        - partySubType
        - familyName
        - countryCode
        - mobileNumber
        - email
      properties:
        partyType:
          type: string
          pattern: ^(INDIVIDUAL)$
        organisationPartyId:
          type: string
          format: uuid
          nullable: true
          description: References an existing ENTITY party on the workspace to link this
            individual to; the linked individual inherits the entity's role.
            Optional for a SELF individual (when omitted the individual is
            standalone and role is required). Required when partySubType is UBO
            — a UBO only exists under an entity. Applies only to individuals.
        partySubType:
          type: string
          pattern: ^(SELF|UBO)$
          description: "Subtype of the individual party. Allowed values: SELF, UBO. Use
            SELF for a standard individual (standalone or entity-linked). Use
            UBO for an ultimate beneficial owner, which must be linked to an
            entity (organisationPartyId is required for UBO)."
        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
```
