Search
K
workspace v1

CancellationReason

string

Allowed values: [APPLICANT_DECIDED_NOT_TO_PROCEED, TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE, LAW_FIRM_NO_LONGER_ACTING, LENDER_DECIDED_NOT_TO_PROCEED, LOAN_INVOLVES_MULTIPLE_TITLES, OTHER]

Match pattern:^(APPLICANT_DECIDED_NOT_TO_PROCEED|TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE|LAW_FIRM_NO_LONGER_ACTING|LENDER_DECIDED_NOT_TO_PROCEED|LOAN_INVOLVES_MULTIPLE_TITLES|OTHER)$

BorrowersValidationStatus

string

Allowed values: [VALID, INVALID, PENDING, COUNT_INVALID, TYPE_INVALID, NOT_REQUIRED, UNSUPPORTED_TYPE]

Match pattern:^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$

ReferenceDto

object
referenceIdstring(uuid)read-only
representativeIdstring(uuid)
referenceNumberstringrequired

>= 1 characters<= 25 characters

Example:123456

representativeRolestringrequired

Representative role: [BORROWER_REPRESENTATIVE, INCOMING_LENDER, INCOMING_LENDER_REPRESENTATIVE, WORKSPACE_LAW_FIRM, BUYER_REPRESENTATIVE, SELLER_REPRESENTATIVE, OUTGOING_PROPRIETOR_REPRESENTATIVE]
Note - Representative role WORKSPACE_LAW_FIRM will be replaced with INCOMING_LENDER_REPRESENTATIVE soon

Match pattern:^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$

Example:BORROWER_REPRESENTATIVE

Example

RepresentativeRole

string

Representative role: [BORROWER_REPRESENTATIVE, INCOMING_LENDER, INCOMING_LENDER_REPRESENTATIVE, WORKSPACE_LAW_FIRM, BUYER_REPRESENTATIVE, SELLER_REPRESENTATIVE, OUTGOING_PROPRIETOR_REPRESENTATIVE]
Note - Representative role WORKSPACE_LAW_FIRM will be replaced with INCOMING_LENDER_REPRESENTATIVE soon

Match pattern:^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|SELLER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$

Example

PartyDto

object
partyIdstring(uuid)read-only
rolestring

Allowed values: [BORROWER, BUYER, SELLER, OUTGOING_PROPRIETOR, OUTGOING_LENDER]

Match pattern:^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$

Example:BORROWER

proprietorMatchStatusarray[string]

Allowed values: [MATCH, NAME_MISMATCH, PENDING, PROPRIETOR_NAME_CHANGE_REQUIRED, TYPE_MISMATCH, REGISTRATION_NUMBER_MISMATCH, NOT_REQUIRED, PARTY_NAME_UPDATED]

Match pattern:^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$

Example:NAME_MISMATCH

typestringrequired

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

partyDetailsOne Of
Variant 1object
Show Child Parameters
representationTypestring

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

Match pattern:^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$

Example:NO_REPRESENTATION

representationIdstring(uuid)
representativeTypestring

Allowed values: [EXTERNAL_LAW_FIRM, PARTICIPANT]

Match pattern:^(EXTERNAL_LAW_FIRM|PARTICIPANT)$

Example:EXTERNAL_LAW_FIRM

sourceProprietorIdstring(uuid)
addressesarray[object]
Show Child Parameters
verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example