Search
K
workspace v1

AddRepresentationRequest

object
partyIdstring(uuid)required

The unique identifier of the party

representedBystringrequired

Type of legal representation: * PEXA_SUBSCRIBER_LAW_FIRM - Represented by a PEXA subscriber law firm (subscriber ID extracted from JWT token) * EXTERNAL_LAW_FIRM - Represented by an external (non-PEXA subscriber) law firm * NOT_REPRESENTED - Not represented (requires verification of identity)

Match pattern:^(PEXA_SUBSCRIBER_LAW_FIRM|EXTERNAL_LAW_FIRM|NOT_REPRESENTED)$

externalLawFirmobject
Show Child Parameters
representationIdstring(uuid)

Existing representation ID to reuse (for external law firms only)

referenceNumberstring

Reference number for the representation (required for external law firms when not reusing)

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 18 characters

verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example

UpdateRepresentationRequest

object
namestringrequired

Updated external law firm name

>= 1 characters<= 160 characters

addressobjectrequired
Show Child Parameters
Example

ExternalLawFirmDto

object
namestringrequired

External law firm name

>= 1 characters<= 160 characters

addressobjectrequired
Show Child Parameters
Example

RepresentationResponse

object
representationIdstring(uuid)

Unique identifier for the representation

partyIdstring(uuid)

The party identifier

representedBystring

Type of representation

subscriberIdstring(uuid)

PEXA subscriber ID (for PEXA subscriber representations)

externalLawFirmobject
Show Child Parameters
referenceNumberstring

Reference number (for external law firms)

verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example

AddRepresentationAcknowledgement

object
workspaceIdstring(uuid)required

The workspace ID

partyIdstring(uuid)required

The party ID

representationIdstring(uuid)

Representation ID (for EXTERNAL_LAW_FIRM types only)

representedBystring

Type of representation

Allowed values:EXTERNAL_LAW_FIRMPEXA_SUBSCRIBER_LAW_FIRMNOT_REPRESENTED

subscriberIdstring(uuid)

Subscriber ID (for PEXA_SUBSCRIBER_LAW_FIRM only)

externalLawFirmobject

External law firm details (for NEW EXTERNAL_LAW_FIRM only)

Show Child Parameters
verificationOfIdentitystring

Verification of identity method (for NOT_REPRESENTED only)

Example