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

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

# PartyResponse

## 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:
    PartyResponse:
      type: object
      required:
        - partyId
        - partyType
        - role
        - externalPartyId
        - partyDetails
      properties:
        partyId:
          type: string
          format: uuid
          description: PEXA-assigned party identifier
        externalPartyId:
          type: string
          maxLength: 50
          nullable: true
          description: >
            The integrator-supplied identifier echoed from the request for this
            party. Null when no externalPartyId was supplied for the party.
          example: cust123
        partyType:
          type: string
          enum:
            - INDIVIDUAL
            - ENTITY
          description: Party type echoed from the request
        role:
          type: string
          enum:
            - BUYER
            - SELLER
          description: Party role echoed from the request
        partyDetails:
          type: object
          additionalProperties: true
          description: >
            The submitted party details echoed back (e.g. names, contact, entity
            information), so each returned party is self-describing and can be
            matched to the party you submitted.
```
