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

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

# AddPartyResponse

Response for the add-party request. The workspaceId is returned once at the top level as it is common to all parties. The parties array mirrors the request order; it currently contains a single element, matching the one-party-per-request limit.

## 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:
    AddPartyResponse:
      type: object
      description: Response for the add-party request. The workspaceId is returned
        once at the top level as it is common to all parties. The parties array
        mirrors the request order; it currently contains a single element,
        matching the one-party-per-request limit.
      required:
        - workspaceId
        - parties
      properties:
        workspaceId:
          type: string
          format: uuid
          description: Identifier of the workspace the parties were added to
        parties:
          type: array
          description: Parties created by this request, in the same order as the request.
            Currently contains a single element, mirroring the
            one-party-per-request limit.
          items:
            type: object
            properties:
              partyId:
                type: string
                format: uuid
                description: Identifier of the newly created party
              partyType:
                type: string
                enum:
                  - INDIVIDUAL
                  - ENTITY
                description: "Party type of the added party. Allowed values: INDIVIDUAL,
                  ENTITY."
              role:
                type: string
                enum:
                  - BUYER
                  - SELLER
                nullable: true
                description: "Role of the added party. Allowed values: BUYER, SELLER."
              organisationPartyId:
                type: string
                format: uuid
                nullable: true
                description: Present only for entity-linked individuals; the entity party this
                  individual is linked to
              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.
              partyDetails:
                type: object
                additionalProperties: true
                description: The submitted party details echoed back (e.g. names, contact,
                  entity information), so the returned party is self-describing
                  and can be matched to the party you submitted.
```
