Workspace
objectworkspaceIdstring(uuid)
workspaceReferencestring
externalReferencestring
Integrator-supplied reference echoed from the request
workspaceUrlstring(uri)
URL to access the workspace in PEXA Clear
Example
ErrorResponse
objecterrorsarray[object]
Show Child Parameters
Example
Error
objectcodestring
messagestring
fieldstring
Example
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
PrimaryContact
objectPrimary contact for ASSISTED servicing mode. Required when servicingMode is ASSISTED.
firstNamestring
First name of the primary contact
>= 1 characters<= 50 characters
middleNamestring
Middle name of the primary contact
>= 1 characters<= 50 characters
familyNamestringrequired
Last name of the primary contact
>= 1 characters<= 50 characters
mobilestringrequired
International mobile number
Match pattern:^\+[1-9]\d{6,14}$
Example:+61400000000
emailstring(email)required
Email address
Match pattern:^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
<= 320 characters
Example