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

# AML Verification API

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"AML Verification API","version":"v1","description":"Standard API for initiating AML verification","x-pexa-products":"Pexa","x-pexa-domain":"Experience","x-api-version":"1.0.0","x-pexa-segments":["experience"],"x-idp-audience":"gap-au-aml-customer-experience-standard","x-idp-audience-identifier":"https://api.pexa-group.com.au/api/gap-au-aml-customer-experience-standard"},"servers":[{"url":"https://api.pexaclear.com.au","description":"API Gateway URL"}],"security":[{"bearerAuth":[]}],"paths":{},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.pexa-group.com.au/oauth/token","scopes":{"x-api:initiate:verifications":"Permission to initiate verifications"}}}},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CreateWorkspaceRequest":{"type":"object","required":["transactionType","parties"],"properties":{"transactionType":{"type":"string","pattern":"^(AML)$","description":"Transaction type. Allowed values: AML"},"externalReference":{"type":"string","nullable":true,"maxLength":50,"description":"Optional integrator-supplied reference for this workspace","example":"123e4567-e89b-12d3-a456-426614174000"},"settlementDate":{"type":"string","format":"date","nullable":true},"property":{"nullable":true,"type":"object","properties":{"address":{"nullable":true,"type":"object","required":["streetNumber","streetName","streetType","suburb","state","postcode"],"properties":{"unitNumber":{"type":"string","nullable":true,"maxLength":20},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"streetName":{"type":"string","minLength":1,"maxLength":100},"streetType":{"type":"string","minLength":1,"maxLength":50,"description":"e.g. Street, Road, Avenue, Drive, Court"},"suburb":{"type":"string","minLength":1,"maxLength":50},"state":{"type":"string","minLength":2,"maxLength":3,"pattern":"^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$","description":"Australian state or territory code"},"postcode":{"type":"string","minLength":4,"maxLength":4,"pattern":"^[0-9]{4}$","description":"4-digit Australian postcode"}}}}},"parties":{"type":"array","minItems":1,"maxItems":30,"description":"List of parties to be verified. Minimum 1 and maximum 30 parties per request.","items":{"oneOf":[{"oneOf":[{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType"],"properties":{"partySubType":{"type":"string","pattern":"^(SELF)$"}}},{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType","abn","entityName","mainBusinessLocation"],"properties":{"partySubType":{"type":"string","pattern":"^(SOLE_TRADER)$"},"abn":{"type":"string","description":"Australian Business Number (ABN) or Australian Company Number (ACN). Required when partySubType is SOLE_TRADER."},"entityName":{"type":"string","minLength":1,"maxLength":100,"description":"Trading entity name. Required when partySubType is SOLE_TRADER."},"tradingName":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Trading name or business name."},"mainBusinessLocation":{"type":"string","minLength":1,"maxLength":20,"description":"State and postcode. Required when partySubType is SOLE_TRADER.","example":"SA 5045"}}}],"discriminator":{"propertyName":"partySubType","mapping":{"SELF":"#/components/schemas/IndividualSelfRequest","SOLE_TRADER":"#/components/schemas/IndividualSoleTraderRequest"}}},{"description":"Entity party for AML verification. Supports trusts, companies, partnerships, government bodies, and other organisation types.","allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","entityName","mainBusinessLocation","partySubType","servicingMode"],"properties":{"partyType":{"type":"string","pattern":"^(ENTITY)$"},"partySubType":{"type":"string","pattern":"^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$","description":"Organisation subtype. Allowed values: TRUST, BODY_CORPORATE_COMPANY, PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY, OTHER"},"partySubTypeDescription":{"type":"string","nullable":true,"minLength":3,"maxLength":100,"pattern":"^[a-zA-Z0-9 \\-&/()]+$","description":"Required when partySubType is OTHER. Must not be provided otherwise."},"servicingMode":{"type":"string","pattern":"^(SELF_SERVE|ASSISTED)$","description":"Servicing mode. Allowed values: SELF_SERVE, ASSISTED"},"entityName":{"type":"string","minLength":4,"maxLength":100},"abn":{"type":"string","nullable":true,"description":"Australian Business Number (ABN) or Australian Company Number (ACN)"},"tradingName":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Trading name or business name"},"mainBusinessLocation":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z]{2,3} [0-9]{4}$","description":"State and postcode in format 'STATE POSTCODE' (e.g. VIC 3000, NSW 2000)","example":"VIC 3000"},"primaryContact":{"nullable":true,"allOf":[{"type":"object","description":"Primary contact for ASSISTED servicing mode. Required when servicingMode is ASSISTED.","required":["familyName","mobile","email"],"properties":{"firstName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"First name of the primary contact"},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"Middle name of the primary contact"},"familyName":{"type":"string","minLength":1,"maxLength":50,"description":"Last name of the primary contact"},"mobile":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"International mobile number","example":"+61400000000"},"email":{"type":"string","format":"email","maxLength":320,"pattern":"^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":"Email address"}}}],"description":"Required when servicingMode is ASSISTED. Contact details for the primary person managing the entity verification."}}}]}}}},"Property":{"type":"object","properties":{"address":{"nullable":true,"type":"object","required":["streetNumber","streetName","streetType","suburb","state","postcode"],"properties":{"unitNumber":{"type":"string","nullable":true,"maxLength":20},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"streetName":{"type":"string","minLength":1,"maxLength":100},"streetType":{"type":"string","minLength":1,"maxLength":50,"description":"e.g. Street, Road, Avenue, Drive, Court"},"suburb":{"type":"string","minLength":1,"maxLength":50},"state":{"type":"string","minLength":2,"maxLength":3,"pattern":"^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$","description":"Australian state or territory code"},"postcode":{"type":"string","minLength":4,"maxLength":4,"pattern":"^[0-9]{4}$","description":"4-digit Australian postcode"}}}}},"Address":{"type":"object","required":["streetNumber","streetName","streetType","suburb","state","postcode"],"properties":{"unitNumber":{"type":"string","nullable":true,"maxLength":20},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"streetName":{"type":"string","minLength":1,"maxLength":100},"streetType":{"type":"string","minLength":1,"maxLength":50,"description":"e.g. Street, Road, Avenue, Drive, Court"},"suburb":{"type":"string","minLength":1,"maxLength":50},"state":{"type":"string","minLength":2,"maxLength":3,"pattern":"^(NSW|VIC|QLD|WA|SA|TAS|ACT|NT)$","description":"Australian state or territory code"},"postcode":{"type":"string","minLength":4,"maxLength":4,"pattern":"^[0-9]{4}$","description":"4-digit Australian postcode"}}},"PartyRequest":{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}},"IndividualPartyRequest":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType"],"properties":{"partySubType":{"type":"string","pattern":"^(SELF)$"}}},{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType","abn","entityName","mainBusinessLocation"],"properties":{"partySubType":{"type":"string","pattern":"^(SOLE_TRADER)$"},"abn":{"type":"string","description":"Australian Business Number (ABN) or Australian Company Number (ACN). Required when partySubType is SOLE_TRADER."},"entityName":{"type":"string","minLength":1,"maxLength":100,"description":"Trading entity name. Required when partySubType is SOLE_TRADER."},"tradingName":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Trading name or business name."},"mainBusinessLocation":{"type":"string","minLength":1,"maxLength":20,"description":"State and postcode. Required when partySubType is SOLE_TRADER.","example":"SA 5045"}}}],"discriminator":{"propertyName":"partySubType","mapping":{"SELF":"#/components/schemas/IndividualSelfRequest","SOLE_TRADER":"#/components/schemas/IndividualSoleTraderRequest"}}},"IndividualPartyBase":{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}},"IndividualSelfRequest":{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType"],"properties":{"partySubType":{"type":"string","pattern":"^(SELF)$"}}},"IndividualSoleTraderRequest":{"allOf":[{"allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","familyName","partySubType","countryCode","mobileNumber","email"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL)$"},"partySubType":{"type":"string","pattern":"^(SELF|SOLE_TRADER)$","description":"Subtype of the individual party. Use \"SELF\" for a standard individual or \"SOLE_TRADER\" for a sole trader."},"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"}}}],"type":"object","required":["partySubType","abn","entityName","mainBusinessLocation"],"properties":{"partySubType":{"type":"string","pattern":"^(SOLE_TRADER)$"},"abn":{"type":"string","description":"Australian Business Number (ABN) or Australian Company Number (ACN). Required when partySubType is SOLE_TRADER."},"entityName":{"type":"string","minLength":1,"maxLength":100,"description":"Trading entity name. Required when partySubType is SOLE_TRADER."},"tradingName":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Trading name or business name."},"mainBusinessLocation":{"type":"string","minLength":1,"maxLength":20,"description":"State and postcode. Required when partySubType is SOLE_TRADER.","example":"SA 5045"}}},"EntityPartyRequest":{"description":"Entity party for AML verification. Supports trusts, companies, partnerships, government bodies, and other organisation types.","allOf":[{"type":"object","discriminator":{"propertyName":"partyType","mapping":{"INDIVIDUAL":"#/components/schemas/IndividualPartyRequest","ENTITY":"#/components/schemas/EntityPartyRequest"}},"required":["partyType","role"],"properties":{"partyType":{"type":"string","pattern":"^(INDIVIDUAL|ENTITY)$","description":"Party type. Allowed values: INDIVIDUAL, ENTITY"},"role":{"type":"string","pattern":"^(BUYER|SELLER)$","description":"Party role. Allowed values: BUYER, SELLER"}}}],"type":"object","required":["partyType","entityName","mainBusinessLocation","partySubType","servicingMode"],"properties":{"partyType":{"type":"string","pattern":"^(ENTITY)$"},"partySubType":{"type":"string","pattern":"^(TRUST|BODY_CORPORATE_COMPANY|PARTNERSHIP_ASSOCIATION|GOVERNMENT_BODY|OTHER)$","description":"Organisation subtype. Allowed values: TRUST, BODY_CORPORATE_COMPANY, PARTNERSHIP_ASSOCIATION, GOVERNMENT_BODY, OTHER"},"partySubTypeDescription":{"type":"string","nullable":true,"minLength":3,"maxLength":100,"pattern":"^[a-zA-Z0-9 \\-&/()]+$","description":"Required when partySubType is OTHER. Must not be provided otherwise."},"servicingMode":{"type":"string","pattern":"^(SELF_SERVE|ASSISTED)$","description":"Servicing mode. Allowed values: SELF_SERVE, ASSISTED"},"entityName":{"type":"string","minLength":4,"maxLength":100},"abn":{"type":"string","nullable":true,"description":"Australian Business Number (ABN) or Australian Company Number (ACN)"},"tradingName":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Trading name or business name"},"mainBusinessLocation":{"type":"string","minLength":6,"maxLength":8,"pattern":"^[A-Z]{2,3} [0-9]{4}$","description":"State and postcode in format 'STATE POSTCODE' (e.g. VIC 3000, NSW 2000)","example":"VIC 3000"},"primaryContact":{"nullable":true,"allOf":[{"type":"object","description":"Primary contact for ASSISTED servicing mode. Required when servicingMode is ASSISTED.","required":["familyName","mobile","email"],"properties":{"firstName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"First name of the primary contact"},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"Middle name of the primary contact"},"familyName":{"type":"string","minLength":1,"maxLength":50,"description":"Last name of the primary contact"},"mobile":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"International mobile number","example":"+61400000000"},"email":{"type":"string","format":"email","maxLength":320,"pattern":"^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":"Email address"}}}],"description":"Required when servicingMode is ASSISTED. Contact details for the primary person managing the entity verification."}}},"Workspace":{"type":"object","properties":{"workspaceId":{"type":"string","format":"uuid"},"workspaceReference":{"type":"string","nullable":true},"externalReference":{"type":"string","nullable":true,"description":"Integrator-supplied reference echoed from the request"},"workspaceUrl":{"type":"string","format":"uri","nullable":true,"description":"URL to access the workspace in PEXA Clear"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}}}}}},"Error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}}},"Email":{"type":"string","format":"email","maxLength":320,"pattern":"^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":"Email address"},"PrimaryContact":{"type":"object","description":"Primary contact for ASSISTED servicing mode. Required when servicingMode is ASSISTED.","required":["familyName","mobile","email"],"properties":{"firstName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"First name of the primary contact"},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"description":"Middle name of the primary contact"},"familyName":{"type":"string","minLength":1,"maxLength":50,"description":"Last name of the primary contact"},"mobile":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","description":"International mobile number","example":"+61400000000"},"email":{"type":"string","format":"email","maxLength":320,"pattern":"^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":"Email address"}}}}}}
```