v1OAS 3.0

This API enables you to create a PEXA Clear AML workspace, initiate identity verification for individual and entity buyers and sellers, and add further parties to an existing workspace.

API Base URL
  • Server 1:https://api.pexaclear.com.au

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://auth.pexa-group.com.au/oauth/token

Scopes:

  • x-api:initiate:verifications - Permission to initiate verifications
  • x-api:add:parties - Permission to add parties to an existing workspace
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Initiate AML Verification

Initiates an AML verification by creating a workspace, triggering identity verification (IDV) and risk assessment for the specified parties.

post
https://api.pexaclear.com.au/api/experience/v1/verifications

Body

application/json
transactionTypestringrequired

Transaction type. Allowed values: AML

Match pattern:^(AML)$

externalReferencestring | null

Optional integrator-supplied reference for this workspace

<= 50 characters

Example:123e4567-e89b-12d3-a456-426614174000

settlementDatestring | null(date)
propertyobject | null
Show Child Parameters
partiesOne Of
arrayrequired

List of parties to be verified. Minimum 1 and maximum 4 parties per request.

>= 1 items<= 4 items

Variant 1One Of
Variant 1object
Show Child Parameters

Response

application/json

Verification initiated successfully

workspaceIdstring(uuid)required
workspaceReferencestring | null
externalReferencestring | null

Integrator-supplied reference echoed from the request

workspaceUrlstring | null(uri)

URL to access the workspace in PEXA Clear

partiesarray[object]required

The parties created in the workspace during initiation. Each entry includes the PEXA-assigned partyId, the integrator-supplied externalPartyId (echoed back when provided, otherwise null), and the party details. Use partyId (or externalPartyId when supplied) to reference a party in subsequent calls.

Show Child Parameters
post/api/experience/v1/verifications

Body

{ "transactionType": "AML", "externalReference": "123e4567-e89b-12d3-a456-426614174000", "settlementDate": "2026-06-15", "property": { "address": { "unitNumber": "4", "streetNumber": "12", "streetName": "Collins", "streetType": "Street", "suburb": "Melbourne", "state": "VIC", "postcode": "3000" } }, "parties": [ { "partyType": "INDIVIDUAL", "externalPartyId": "cust123", "role": "BUYER", "familyName": "Smith", "firstName": "Jane", "middleNames": "Marie", "dateOfBirth": "1990-05-20", "partySubType": "SELF", "countryCode": "+61", "mobileNumber": 412345678, "email": "jane.smith@example.com" } ] }
 
application/json

Add Parties to an Existing Workspace

Add one or more parties to an existing workspace. A party may be an individual or an entity (organisation). The request and response are array-shaped to accommodate future bulk party addition without a contract change. At present a single party per request is supported; supplying more than one party, or none, returns 400. An individual may be standalone (organisationPartyId omitted; role required) or linked to an existing entity party on the workspace (organisationPartyId provided; role inherited from the entity). An entity is added with its own role. Added parties undergo the same IDV/compliance verification flow as parties supplied at workspace creation.

post
https://api.pexaclear.com.au/api/experience/v1/workspaces/{workspaceId}/parties

Path Parameters

workspaceIdstring(uuid)required

Identifier of the workspace to add the party to

Body

application/json

Request to add parties (individual or entity) to an existing workspace. The parties field is an array to support adding multiple parties in a single request in future. Currently, exactly one party may be supplied per request — requests containing more than one party, or an empty array, are rejected with 400. Bulk addition (more than one party) is planned and will be enabled without any change to this contract.

partiesOne Of
arrayrequired

List of parties to add to the workspace. Structured as an array to support adding multiple parties in a single request in future. Currently, exactly one party may be supplied per request — requests containing more than one party, or an empty array, are rejected with 400. Bulk addition (more than one party) is planned and will be enabled without any change to this contract.

Variant 1object

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.

Show Child Parameters

Response

application/json

Party added successfully

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.

workspaceIdstring(uuid)required

Identifier of the workspace the parties were added to

partiesarray[object]required

Parties created by this request, in the same order as the request. Currently contains a single element, mirroring the one-party-per-request limit.

Show Child Parameters
post/api/experience/v1/workspaces/{workspaceId}/parties

Body

{ "parties": [ { "partyType": "INDIVIDUAL", "partySubType": "SELF", "role": "BUYER", "familyName": "Smith", "firstName": "Jane", "dateOfBirth": "1990-05-20", "countryCode": "+61", "mobileNumber": 412345678, "email": "jane.smith@example.com" } ] }
 
application/json