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

OfficerRole

string

Allowed values: [DIRECTOR, SECRETARY]

Match pattern:^(DIRECTOR|SECRETARY)$

Example

Officer

object
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

emailstringrequired

Match pattern:^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

>= 1 characters

Example:approver@lawfirm.com

rolestringrequired

Allowed values: [DIRECTOR, SECRETARY]

Match pattern:^(DIRECTOR|SECRETARY)$

Example:DIRECTOR

Example

RepresentationType

string

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

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

Example