Search
K
workspace v1

PrimaryKeyId

string

schemas-RepresentativeRole

string

Representative role: [BORROWER_REPRESENTATIVE, INCOMING_LENDER, INCOMING_LENDER_REPRESENTATIVE, WORKSPACE_LAW_FIRM, BUYER_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|OUTGOING_PROPRIETOR_REPRESENTATIVE)$

Example

schemas-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, 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|OUTGOING_PROPRIETOR_REPRESENTATIVE)$

Example:BORROWER_REPRESENTATIVE

Example

PartyType

string

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example

PartyDetails

One Of
forenamesstringrequired

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 90 characters

Example:James Thomas

surnamestringrequired

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 50 characters

Example:Smith

Example