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

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

# PartyToAdd

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.

## 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:
    PartyToAdd:
      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
```
